epoc32/include/app/cmmssettings.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/cmmssettings.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __CMMSSETTINGS_H__
williamr@2
    17
#define __CMMSSETTINGS_H__
williamr@2
    18
williamr@2
    19
williamr@2
    20
#include <e32base.h>
williamr@2
    21
williamr@2
    22
williamr@2
    23
class CRepository;
williamr@2
    24
williamr@2
    25
williamr@2
    26
/**
williamr@2
    27
Automatic Download Options.
williamr@2
    28
williamr@2
    29
@publishedAll
williamr@2
    30
@released
williamr@2
    31
*/
williamr@2
    32
enum TAutomaticDownloadOptions
williamr@2
    33
 	{
williamr@2
    34
 	/** Automatic Download Option Off */
williamr@2
    35
	EAutomaticDownloadOff = 0,
williamr@2
    36
 	/** Automatic Download Option On */
williamr@2
    37
	EAutomaticDownloadOn,
williamr@2
    38
	/** Automatic Download Only When Roaming */
williamr@2
    39
	EAutomaticDownloadOnlyWhenRoaming
williamr@2
    40
	};
williamr@2
    41
williamr@2
    42
williamr@2
    43
/**
williamr@2
    44
Creation Mode Options.
williamr@2
    45
williamr@2
    46
@publishedAll
williamr@2
    47
@released
williamr@2
    48
*/
williamr@2
    49
enum TCreationMode
williamr@2
    50
 	{
williamr@2
    51
	/** Creation Mode Free */
williamr@2
    52
	ECreationModeFree = 0,
williamr@2
    53
	/** Creation Mode Warning */
williamr@2
    54
	ECreationModeWarning,
williamr@2
    55
	/** Creation Mode Restricted */
williamr@2
    56
	ECreationModeRestricted
williamr@2
    57
	};
williamr@2
    58
williamr@2
    59
williamr@2
    60
/**
williamr@2
    61
Run-time MMS configuration settings.
williamr@2
    62
williamr@2
    63
Messaging clients should use an instance of this class to specify
williamr@2
    64
and retrieve configuration settings.
williamr@2
    65
williamr@2
    66
This class should be used with CMmsAccounts to store and restore settings.
williamr@2
    67
williamr@2
    68
@see CMmsAccounts
williamr@2
    69
williamr@2
    70
@publishedAll
williamr@2
    71
@released
williamr@2
    72
*/
williamr@2
    73
class CMmsSettings : public CBase
williamr@2
    74
     {
williamr@2
    75
public:
williamr@2
    76
	IMPORT_C static CMmsSettings* NewL( );
williamr@2
    77
	IMPORT_C static CMmsSettings* NewLC( );
williamr@2
    78
    IMPORT_C ~CMmsSettings( );
williamr@2
    79
    IMPORT_C void CopyL(const CMmsSettings& aMmsSettings);    
williamr@2
    80
williamr@2
    81
    IMPORT_C TInt ApplicationID( ) const;
williamr@2
    82
	IMPORT_C void SetApplicationID(const TInt aAppID);
williamr@2
    83
williamr@2
    84
	IMPORT_C TPtrC Address( ) const;
williamr@2
    85
   	IMPORT_C void SetAddressL(const TDesC& aAddress);
williamr@2
    86
	
williamr@2
    87
	IMPORT_C TCreationMode CreationMode( ) const;
williamr@2
    88
   	IMPORT_C void SetCreationModeL(TCreationMode aCreationMode);
williamr@2
    89
williamr@2
    90
    IMPORT_C TInt ProxyCount( ) const;
williamr@2
    91
    IMPORT_C TUid GetProxy(TInt aIndex) const;
williamr@2
    92
    IMPORT_C void AddProxyL(const TUid aProxy);
williamr@2
    93
    IMPORT_C void RemoveProxy(TInt aIndex);
williamr@2
    94
williamr@2
    95
    IMPORT_C TInt NapIdCount( ) const;
williamr@2
    96
    IMPORT_C TUid GetNapId (TInt aIndex) const;
williamr@2
    97
    IMPORT_C void AddNapIdL(const TUid aNapId);
williamr@2
    98
    IMPORT_C void RemoveNapId(TInt aIndex);
williamr@2
    99
williamr@2
   100
    IMPORT_C TBool DisplayNotification( ) const;
williamr@2
   101
    IMPORT_C void SetDisplayNotification(TBool aFlag);
williamr@2
   102
williamr@2
   103
    IMPORT_C TAutomaticDownloadOptions AutomaticDownload( ) const;
williamr@2
   104
    IMPORT_C void SetAutomaticDownload(TAutomaticDownloadOptions aDownloadOptions);
williamr@2
   105
williamr@2
   106
    IMPORT_C TBool CreationModeReadOnly( ) const;
williamr@2
   107
    IMPORT_C void SetCreationModeReadOnly(TBool aFlag);
williamr@2
   108
williamr@2
   109
    IMPORT_C TInt ValidityPeriod( ) const;
williamr@2
   110
    IMPORT_C void SetValidityPeriod(const TInt aValidityPeriod);
williamr@2
   111
williamr@2
   112
    IMPORT_C TInt MaxDownloadSize( ) const;
williamr@2
   113
    IMPORT_C void SetMaxDownloadSize (const TInt aSize);
williamr@2
   114
williamr@2
   115
    IMPORT_C TBool Priority( ) const;
williamr@2
   116
    IMPORT_C void SetPriority (TBool aFlag);
williamr@2
   117
williamr@2
   118
    IMPORT_C TBool HideNumber( ) const;
williamr@2
   119
    IMPORT_C void SetHideNumber(TBool aFlag);
williamr@2
   120
williamr@2
   121
    IMPORT_C TBool ReadReport( ) const;
williamr@2
   122
    IMPORT_C void SetReadReport(TBool aFlag);
williamr@2
   123
williamr@2
   124
    IMPORT_C TBool DeliveryReport( ) const;
williamr@2
   125
    IMPORT_C void SetDeliveryReport(TBool aFlag);
williamr@2
   126
williamr@2
   127
    IMPORT_C TBool ReplyWithHistory( ) const;
williamr@2
   128
    IMPORT_C void SetReplyWithHistory (TBool aFlag);
williamr@2
   129
williamr@2
   130
    IMPORT_C TBool AllowDeliveryNotification( ) const;
williamr@2
   131
    IMPORT_C void SetAllowDeliveryNotification(TBool aFlag);
williamr@2
   132
williamr@2
   133
    IMPORT_C TBool FilterAdvertisements( ) const;
williamr@2
   134
    IMPORT_C void SetFilterAdvertisements(TBool aFlag);
williamr@2
   135
williamr@2
   136
    IMPORT_C TInt MaxDownloadRetries( ) const;
williamr@2
   137
    IMPORT_C void SetMaxDownloadRetries(const TInt aRetries);
williamr@2
   138
williamr@2
   139
    IMPORT_C TInt DownloadRetryInterval( ) const;
williamr@2
   140
    IMPORT_C void SetDownloadRetryInterval(const TInt aInterval);
williamr@2
   141
williamr@2
   142
    IMPORT_C TInt MaxSendMsgSize( ) const;
williamr@2
   143
    IMPORT_C void SetMaxSendMsgSize (const TInt aSize);
williamr@2
   144
williamr@2
   145
    IMPORT_C TBool FullScreenPreview( ) const;
williamr@2
   146
    IMPORT_C void SetFullScreenPreview(TBool aFlag);
williamr@2
   147
williamr@2
   148
    IMPORT_C TInt DeviceContentClass( ) const;
williamr@2
   149
    IMPORT_C void SetDeviceContentClass(const TInt aClass);
williamr@2
   150
williamr@2
   151
    IMPORT_C TInt MaxImageHeight( ) const;
williamr@2
   152
    IMPORT_C void SetMaxImageHeight(const TInt aHeight);
williamr@2
   153
williamr@2
   154
    IMPORT_C TInt MaxImageWidth( ) const;
williamr@2
   155
    IMPORT_C void SetMaxImageWidth(const TInt aWidth);   
williamr@2
   156
    
williamr@2
   157
	void RemoveAllProxies();
williamr@2
   158
	void RemoveAllNapIds();
williamr@2
   159
	
williamr@2
   160
	TUint32 MmsSettingsFlags() const;
williamr@2
   161
	void SetMmsSettingsFlags(TUint32 aFlags);
williamr@2
   162
	    
williamr@2
   163
private:
williamr@2
   164
    CMmsSettings();
williamr@2
   165
williamr@2
   166
	enum TMmsSettingsFlags
williamr@2
   167
		{
williamr@2
   168
		ESmsSettingsNoFlags					= 0x00000000,
williamr@2
   169
		ESmsSettingsDisplayNotification		= 0x00000002,
williamr@2
   170
		ESmsSettingsCreationModeReadOnly	= 0x00000004,
williamr@2
   171
		ESmsSettingsPriority				= 0x00000008,
williamr@2
   172
		ESmsSettingsHideNumber				= 0x00000010,
williamr@2
   173
		ESmsSettingsReadReport				= 0x00000020,
williamr@2
   174
		ESmsSettingsDeliveryReport			= 0x00000040,
williamr@2
   175
		ESmsSettingsReplyWithHistory		= 0x00000080,
williamr@2
   176
		ESmsSettingsAllowDeliveryNotification	= 0x00000100,
williamr@2
   177
		ESmsSettingsFilterAdvertisements	= 0x00000200,
williamr@2
   178
		ESmsSettingsFullScreenPreview		= 0x00000400
williamr@2
   179
		};
williamr@2
   180
williamr@2
   181
private:
williamr@2
   182
williamr@2
   183
	TUint32 iMmsSettingsFlags;
williamr@2
   184
	TInt iApplicationId;
williamr@2
   185
	HBufC* iAddress;
williamr@2
   186
	TCreationMode iCreationMode;
williamr@2
   187
	RArray<TUid> iProxy;
williamr@2
   188
	RArray<TUid> iNapId;
williamr@2
   189
	TAutomaticDownloadOptions iAutomaticDownloadOptions;
williamr@2
   190
	TInt iValidityPeriod;
williamr@2
   191
	TInt iMaxDownloadSize;
williamr@2
   192
	TInt iMaxDownloadRetries;
williamr@2
   193
	TInt iDownloadRetryInterval;
williamr@2
   194
	TInt iMaxSendMsgSize;
williamr@2
   195
	TInt iDeviceContentClass;
williamr@2
   196
	TInt iMaxImageHeight;
williamr@2
   197
	TInt iMaxImageWidth;
williamr@2
   198
   	};
williamr@2
   199
   	
williamr@2
   200
#endif // __CSMSACCOUNT_H__