wvuing/IMPSServiceSettingsUI/SharedDataSrc/MIMPSSharedData.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Tls holder used to check if resource file is loaded or not
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __MIMPSSHAREDDATA_H
       
    19 #define __MIMPSSHAREDDATA_H
       
    20 
       
    21 //  INCLUDES
       
    22 #include <e32base.h>
       
    23 
       
    24 // FORWARD DECLARATIONS
       
    25 
       
    26 /**
       
    27  * Keys to be used with sharing data
       
    28  * @since 2.6
       
    29  */
       
    30 
       
    31 const TInt KIMPSSharedKeysServiceSettingsUIBase = 100;
       
    32 const TInt KIMPSSharedKeysConnectionUIBase = 200;
       
    33 const TInt KIMPSSharedKeysAlwayOnlineBase = 300;
       
    34 
       
    35 enum TIMPSSharedKeys
       
    36     {
       
    37     // Service Settings UI keys
       
    38     EIMPSSharedKeysIMLogin = KIMPSSharedKeysServiceSettingsUIBase + 1,
       
    39     EIMPSSharedKeysIMConnStart = KIMPSSharedKeysServiceSettingsUIBase + 2,
       
    40     EIMPSSharedKeysIMConnEnd = KIMPSSharedKeysServiceSettingsUIBase + 3,
       
    41     EIMPSSharedKeysIMConnDays = KIMPSSharedKeysServiceSettingsUIBase + 4,
       
    42 
       
    43     EIMPSSharedKeysPECLogin = KIMPSSharedKeysServiceSettingsUIBase + 5,
       
    44     EIMPSSharedKeysPECConnStart = KIMPSSharedKeysServiceSettingsUIBase + 6,
       
    45     EIMPSSharedKeysPECConnEnd = KIMPSSharedKeysServiceSettingsUIBase + 7,
       
    46     EIMPSSharedKeysPECConnDays = KIMPSSharedKeysServiceSettingsUIBase + 8,
       
    47 
       
    48 #ifdef RD_MULTIPLE_DRIVE
       
    49 
       
    50     EIMPSSharedKeysMemoryDrive = KIMPSSharedKeysServiceSettingsUIBase + 9,
       
    51 
       
    52 #endif
       
    53 
       
    54     EIMPSSharedKeysServSettLoginTypeChangedPEC = KIMPSSharedKeysServiceSettingsUIBase + 51,
       
    55     EIMPSSharedKeysServSettLoginTypeChangedIM = KIMPSSharedKeysServiceSettingsUIBase + 52,
       
    56     EIMPSSharedKeysServSettScheduleChangedPEC = KIMPSSharedKeysServiceSettingsUIBase + 53,
       
    57     EIMPSSharedKeysServSettScheduleChangedIM = KIMPSSharedKeysServiceSettingsUIBase + 54,
       
    58 
       
    59     // Connection UI keys
       
    60 
       
    61     // Connection UI Group channel keys
       
    62     EIMPSSharedKeysIMClientLoginLogoutStateChannel = KIMPSSharedKeysConnectionUIBase + 1,
       
    63     EIMPSSharedKeysIMLoginLogoutEventChannel = KIMPSSharedKeysConnectionUIBase + 2,
       
    64     EIMPSSharedKeysIMSSClientReqistrationChannel = KIMPSSharedKeysConnectionUIBase + 3,
       
    65     EIMPSSharedKeysIMGlobalOperationSignalChannel = KIMPSSharedKeysConnectionUIBase + 4,
       
    66     EIMPSSharedKeysIMRemoteUiNotificationsChannel = KIMPSSharedKeysConnectionUIBase + 5,
       
    67 
       
    68     EIMPSSharedKeysPECClientLoginLogoutStateChannel = KIMPSSharedKeysConnectionUIBase + 6,
       
    69     EIMPSSharedKeysPECLoginLogoutEventChannel = KIMPSSharedKeysConnectionUIBase + 7,
       
    70     EIMPSSharedKeysPECSSClientReqistrationChannel = KIMPSSharedKeysConnectionUIBase + 8,
       
    71     EIMPSSharedKeysPECGlobalOperationSignalChannel = KIMPSSharedKeysConnectionUIBase + 9,
       
    72     EIMPSSharedKeysPECRemoteUiNotificationsChannel = KIMPSSharedKeysConnectionUIBase + 10,
       
    73 
       
    74     EIMPSSharedKeysCommonClientLoginLogoutStateChannel = KIMPSSharedKeysConnectionUIBase + 11,
       
    75     EIMPSSharedKeysCommonLoginLogoutEventChannel = KIMPSSharedKeysConnectionUIBase + 12,
       
    76     EIMPSSharedKeysCommonSSClientReqistrationChannel = KIMPSSharedKeysConnectionUIBase + 13,
       
    77     EIMPSSharedKeysCommonGlobalOperationSignalChannel = KIMPSSharedKeysConnectionUIBase + 14,
       
    78     EIMPSSharedKeysCommonRemoteUiNotificationsChannel = KIMPSSharedKeysConnectionUIBase + 15,
       
    79 
       
    80     // Connection UI Group data keys
       
    81 
       
    82     EIMPSSharedKeysIMClientLoginLogoutStateData = KIMPSSharedKeysConnectionUIBase + 41,
       
    83     EIMPSSharedKeysIMLoginLogoutEventData = KIMPSSharedKeysConnectionUIBase + 42,
       
    84     EIMPSSharedKeysIMSSClientReqistrationData = KIMPSSharedKeysConnectionUIBase + 43,
       
    85     EIMPSSharedKeysIMGlobalOperationSignalData = KIMPSSharedKeysConnectionUIBase + 44,
       
    86     EIMPSSharedKeysIMRemoteUiNotificationsData = KIMPSSharedKeysConnectionUIBase + 45,
       
    87 
       
    88     EIMPSSharedKeysPECClientLoginLogoutStateData = KIMPSSharedKeysConnectionUIBase + 46,
       
    89     EIMPSSharedKeysPECLoginLogoutEventData = KIMPSSharedKeysConnectionUIBase + 47,
       
    90     EIMPSSharedKeysPECSSClientReqistrationData = KIMPSSharedKeysConnectionUIBase + 48,
       
    91     EIMPSSharedKeysPECGlobalOperationSignalData = KIMPSSharedKeysConnectionUIBase + 49,
       
    92     EIMPSSharedKeysPECRemoteUiNotificationsData = KIMPSSharedKeysConnectionUIBase + 50,
       
    93 
       
    94     EIMPSSharedKeysCommonClientLoginLogoutStateData = KIMPSSharedKeysConnectionUIBase + 51,
       
    95     EIMPSSharedKeysCommonLoginLogoutEventData = KIMPSSharedKeysConnectionUIBase + 52,
       
    96     EIMPSSharedKeysCommonSSClientReqistrationData = KIMPSSharedKeysConnectionUIBase + 53,
       
    97     EIMPSSharedKeysCommonGlobalOperationSignalData = KIMPSSharedKeysConnectionUIBase + 54,
       
    98     EIMPSSharedKeysCommonRemoteUiNotificationsData = KIMPSSharedKeysConnectionUIBase + 55,
       
    99 
       
   100     // Connection UI Global channel keys
       
   101 
       
   102     EIMPSSharedKeysIMGlobalChannel = KIMPSSharedKeysConnectionUIBase + 71,
       
   103     EIMPSSharedKeysPECGlobalChannel = KIMPSSharedKeysConnectionUIBase + 72,
       
   104 
       
   105     // Connection UI Global data keys
       
   106 
       
   107     EIMPSSharedKeysIMGlobalData = KIMPSSharedKeysConnectionUIBase + 81,
       
   108     EIMPSSharedKeysPECGlobalData = KIMPSSharedKeysConnectionUIBase + 82,
       
   109 
       
   110     // Connection UI pernanent global data key
       
   111     EIMPSSharedKeysPermanentGlobalChannel = KIMPSSharedKeysConnectionUIBase + 83,
       
   112     EIMPSSharedKeysPermanentGlobalData = KIMPSSharedKeysConnectionUIBase + 84,
       
   113 
       
   114     // Connection UI IM Presence Auth Setting Key
       
   115     EIMPSSharedKeysIMPresenceAuthSettingKey = 0x00000004,
       
   116     EIMPSSharedKeysIMStatusMsgOnlineKey     = 0x0000000e,
       
   117 
       
   118     // Profile engines key
       
   119     EIMPSSharedKeysProEngAllowUpdatePresence = 0x80000200,
       
   120     // Presence UI keys
       
   121 
       
   122     EIMPSSharedKeysPECAppKeyNamePublishing = 0x00000001,
       
   123 
       
   124     // IM keys
       
   125     EIMPSSharedKeysIMUserId             = 0x0000000a,
       
   126     EIMPSSharedKeysIMAliasName			= 0x0000000b,
       
   127 
       
   128 
       
   129     EIMPSSharedKeysRoaming,
       
   130     EIMPSSharedKeysRoamingDlgShown
       
   131     };
       
   132 
       
   133 // CLASS DECLARATION
       
   134 
       
   135 /**
       
   136 *  Shared data handler
       
   137 *
       
   138 *  @lib WVServiceSettingsUi.dll
       
   139 *  @since 2.6
       
   140 */
       
   141 NONSHARABLE_CLASS( MIMPSSharedData )
       
   142     {
       
   143 public: // New functions
       
   144 
       
   145     /**
       
   146     * Subscribes to listen for change of a key
       
   147     * @param aUid       TUid identifying the shared data file that this
       
   148     *                   request is involved with.
       
   149     * @param aKey       Keyword of which changes are to be observed.
       
   150     * @return error code
       
   151     */
       
   152     virtual TInt SubscribeChange( const TUid aUid, const TIMPSSharedKeys aKey ) = 0;
       
   153 
       
   154     /**
       
   155     * Subscribes to listen for set of a key
       
   156     * @param aUid       TUid identifying the shared data file that this
       
   157     *                   request is involved with.
       
   158     * @param aKey       Keyword of which changes are to be observed.
       
   159     * @return error code
       
   160     */
       
   161     virtual TInt SubscribeSet( const TUid aUid, const TIMPSSharedKeys aKey ) = 0;
       
   162 
       
   163     /**
       
   164     * Unsubscribes a request to listen for change of a key
       
   165     * @param aUid       TUid identifying the shared data file that this
       
   166     *                   request is involved with.
       
   167     * @param aKey       Keyword of which changes are to be observed.
       
   168     * @return error code
       
   169     */
       
   170     virtual void UnSubscribe( const TUid aUid, const TIMPSSharedKeys aKey ) = 0;
       
   171 
       
   172     /**
       
   173     * Gets the string value corresponding the given key.
       
   174     * @param aKey       keyword
       
   175     * @param aValue     descriptor containing the string
       
   176     *                   associated with the keyword
       
   177     * @return error code
       
   178     */
       
   179     virtual TInt GetStringKey( const TIMPSSharedKeys aKey, TDes& aValue ) = 0;
       
   180 
       
   181     /**
       
   182     * Gets the integer value corresponding the given key.
       
   183     * @param aKey keyword
       
   184     * @param aValue integer value associated with the keyword
       
   185     * @return error code
       
   186     */
       
   187     virtual TInt GetIntKey( const TIMPSSharedKeys aKey, TInt& aValue ) = 0;
       
   188 
       
   189     /**
       
   190     * Sets the string value associated with the given key.
       
   191     * @param aKey keyword
       
   192     * @param aValue integer value associated with the keyword
       
   193     * @return error code
       
   194     */
       
   195     virtual TInt SetStringKey( const TIMPSSharedKeys aKey, const TDesC& aValue ) = 0;
       
   196 
       
   197     /**
       
   198     * Sets the integer value associated with the given key.
       
   199     * @param aKey keyword
       
   200     * @param aValue integer value associated with the keyword
       
   201     * @return error code
       
   202     */
       
   203     virtual TInt SetIntKey( const TIMPSSharedKeys aKey, TInt aValue ) = 0;
       
   204 
       
   205     /**
       
   206     * Signals the given key.
       
   207     * @param aKey keyword
       
   208     * @return error code
       
   209     */
       
   210     virtual TInt Signal( const TIMPSSharedKeys aKey ) = 0;
       
   211 
       
   212     /**
       
   213     * Cancels the signals to the given key.
       
   214     * @param aKey keyword
       
   215     * @return error code
       
   216     */
       
   217     virtual TInt CancelSignal( const TIMPSSharedKeys aKey ) = 0;
       
   218 
       
   219     /**
       
   220     * Converts shared data keys to TIMPSSharedKeys
       
   221     * @param aSrc source
       
   222     * @param aDest destination
       
   223     * @return error code
       
   224     */
       
   225     virtual TInt ConvertSharedDataKey( const TDesC& aSrc, TIMPSSharedKeys& aDest ) = 0;
       
   226 
       
   227     /**
       
   228     * Destructor
       
   229     */
       
   230     virtual ~MIMPSSharedData() {};
       
   231 
       
   232     };
       
   233 
       
   234 #endif      // __MIMPSSHAREDDATA_H
       
   235 
       
   236 // End of File