appsupport_plat/system_application_notification_api/inc/coreapplicationuisdomainpskeys.h
changeset 0 2e3d3ce01487
child 46 eea20ed08f4b
child 58 0818dd463d41
equal deleted inserted replaced
-1:000000000000 0:2e3d3ce01487
       
     1 /*
       
     2 * Copyright (c) 2006-2007 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:  Domain Publish&Subscribe definitions of the Core Application UIs subsystem
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef COREAPPLICATIONUISDOMAINPSKEYS_H
       
    20 #define COREAPPLICATIONUISDOMAINPSKEYS_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32property.h>
       
    24 #include <e32err.h>
       
    25 
       
    26 const TUid KPSUidCoreApplicationUIs = { 0x101F8767 };
       
    27 
       
    28 // =============================================================================
       
    29 // System Application Notification API
       
    30 // =============================================================================
       
    31 // Use TUid KPSUidCoreApplicationUIs = { 0x101F8767 } 
       
    32 
       
    33 /**
       
    34 * SysAp notifies Alarm UI to hide alarm when powerkey pressed.
       
    35 * Old Shared Data constant name: KSysApHideAlarm
       
    36 */
       
    37 const TUint32 KCoreAppUIsHideAlarm = 0x00000101;
       
    38 enum TCoreAppUIsHideAlarm
       
    39     {
       
    40     ECoreAppUIsHideAlarmUninitialized = 0,
       
    41     ECoreAppUIsDoNotHideAlarm,
       
    42     ECoreAppUIsHideAlarm
       
    43     };
       
    44 
       
    45 /**
       
    46 * Alarm UI notifies SysAp to disable keyguard when an alarm occurs.
       
    47 * Old Shared Data constant name: KSysApKeyGuardInactive
       
    48 */
       
    49 const TUint32 KCoreAppUIsDisableKeyguard = 0x00000102;
       
    50 enum TCoreAppUIsDisableKeyguard
       
    51     {
       
    52     ECoreAppUIsDisableKeyguardUninitialized = 0,
       
    53     ECoreAppUIsEnableKeyguard,
       
    54     ECoreAppUIsDisableKeyguard
       
    55     };
       
    56 
       
    57 /**
       
    58 * Phone notifies SysAp not to enable keylock after Soft Reject
       
    59 * Old Shared Data constant name: KSysApSoftReject
       
    60 */
       
    61 const TUint32 KCoreAppUIsSoftReject = 0x00000103;
       
    62 enum TCoreAppUIsSoftReject
       
    63     {
       
    64     ECoreAppUIsSoftRejectUninitialized = 0,
       
    65     ECoreAppUIsReactivateKeyguard,  
       
    66     ECoreAppUIsSoftReject   // do not re-activate keyguard after the call
       
    67     };
       
    68 
       
    69 /**
       
    70 * Used for notifying SysAp of the Instant Messaging indicator status
       
    71 * Old Shared Data constant name: KSysApUipInd
       
    72 */
       
    73 const TUint32 KCoreAppUIsUipInd = 0x00000104;
       
    74 enum TCoreAppUIsUipInd
       
    75     {
       
    76     ECoreAppUIsUipIndUninitialized = 0,
       
    77     ECoreAppUIsDoNotShow,
       
    78     ECoreAppUIsShow
       
    79     };
       
    80 
       
    81 /**
       
    82 * Used by SysAp for getting raw key events from NspsWsPlugin and
       
    83 * disabling playing message tone
       
    84 * Old Shared Data constant name: KSysApMessageToneQuit
       
    85 */
       
    86 const TUint32 KCoreAppUIsMessageToneQuit = 0x00000106;
       
    87 enum TCoreAppUIsMessageToneQuit
       
    88     {
       
    89     ECoreAppUIsTonePlayingUninitialized = 0,
       
    90     ECoreAppUIsStopTonePlaying, // both notification and state
       
    91     ECoreAppUIsTonePlaying
       
    92     };
       
    93 
       
    94 /**
       
    95 * Used by SysAp for getting raw key events from NspsWsPlugin in order to launch
       
    96 * network scan when NSPS is active
       
    97 * Old Shared Data constant name: KSysApNspsRawKeyEvent
       
    98 */
       
    99 const TUint32 KCoreAppUIsNspsRawKeyEvent = 0x00000107;
       
   100 
       
   101 /**
       
   102 * Used by SysAp for getting raw key events from NspsWsPlugin in order to switch lights on
       
   103 * Old Shared Data constant name: KSysApLightsControl
       
   104 */
       
   105 const TUint32 KCoreAppUIsLightsRawKeyEvent = 0x00000108;
       
   106 
       
   107 enum TCoreAppUIsRawKeyEvent
       
   108     {
       
   109     ECoreAppUIsKeyEventUninitialized = 0, 
       
   110     ECoreAppUIsNoKeyEvent,
       
   111     ECoreAppUIsKeyEvent        // this launches network scan or switches lights on
       
   112     };
       
   113 
       
   114 /**
       
   115 * Memory Card App notifies SysAp that the user has selected "Eject memory card"
       
   116 * Old Shared Data constant name: KSysApMmcRemovedWithoutEject
       
   117 */
       
   118 const TUint32 KCoreAppUIsMmcRemovedWithoutEject = 0x00000109;
       
   119 enum TCoreAppUIsMmcRemovedWithoutEject
       
   120     {
       
   121     ECoreAppUIsEjectCommandUsedUninitialized = 0,
       
   122     ECoreAppUIsEjectCommandNotUsed,
       
   123     ECoreAppUIsEjectCommandUsed,
       
   124     ECoreAppUIsEjectCommandUsedToDrive // Low 16-bits contain this value and high 16-bits TDriveNumber to eject
       
   125     };
       
   126 
       
   127 /**
       
   128 * Used for notifying SysAp of the PoC indicator state.
       
   129 */
       
   130 const TUint32 KCoreAppUIsPoCIndicator = 0x00000110;
       
   131 enum TCoreAppUIsPocIndicator
       
   132     {
       
   133     ECoreAppUIsPocIndicatorUninitialized = 0,
       
   134     ECoreAppUIsPocIndicatorOff,
       
   135     ECoreAppUIsPocIndicatorDoNotDisturb,
       
   136     ECoreAppUIsPocIndicatorConnectionOn 
       
   137     };
       
   138 
       
   139 /**
       
   140 * Used for notifying SysAp of the USB File Transfer status. SysAp disables
       
   141 * all Powerkey Menu items during USB File Transfer except for "Switch Off".
       
   142 */
       
   143 const TUint32 KCoreAppUIsUSBFileTransfer = 0x00000111;
       
   144 enum TCoreAppUIsUSBFileTransfer
       
   145     {
       
   146     ECoreAppUIsUSBFileTransferUninitialized = 0,
       
   147     ECoreAppUIsUSBFileTransferNotActive,
       
   148     ECoreAppUIsUSBFileTransferActive
       
   149     };
       
   150 
       
   151 /**
       
   152 * Used for notifying SysAp about a new email. This information is used to
       
   153 * display the email indicator.
       
   154 */
       
   155 const TUint32 KCoreAppUIsNewEmailStatus = 0x00000112;
       
   156 enum TCoreAppUIsNewEmailStatus
       
   157     {
       
   158     ECoreAppUIsNewEmailStatusUninitialized = 0,
       
   159     ECoreAppUIsNoNewEmail,
       
   160     ECoreAppUIsNewEmail
       
   161     };
       
   162 
       
   163 /**
       
   164 * Used for notifying SysAp about TARM indicator state.
       
   165 */
       
   166 const TUint32 KCoreAppUIsTarmIndicator = 0x00000113;
       
   167 enum TCoreAppUIsTarmIndicator
       
   168     {
       
   169     ECoreAppUIsTarmIndicatorUninitialized = 0,
       
   170     ECoreAppUIsTarmTerminalSecurityOnIndicatorOn,
       
   171     ECoreAppUIsTarmMngActiveIndicatorOn,
       
   172     ECoreAppUIsTarmIndicatorsOff
       
   173     };
       
   174 
       
   175 /**
       
   176 * Used for notifying SysAp about Mobile TV recording status.
       
   177 */
       
   178 const TUint32 KCoreAppUIsMtvRecStatus = 0x00000114;
       
   179 enum TCoreAppUIsMtvRecStatus
       
   180     {
       
   181     ECoreAppUIsMtvRecStatusUninitialized = 0,
       
   182     ECoreAppUIsMtvRecStatusOff, 
       
   183     ECoreAppUIsMtvRecStatusOn  
       
   184     };
       
   185 
       
   186 /**
       
   187 * Used for notifying SysAp about Mobile TV DVB-H status.
       
   188 */
       
   189 const TUint32 KCoreAppUIsMtvDvbhStatus = 0x00000115;
       
   190 enum TCoreAppUIsMtvDvbhStatus
       
   191     {
       
   192     ECoreAppUIsMtvDvbhStatusUninitialized = 0,
       
   193     ECoreAppUIsMtvDvbhStatusOff, 
       
   194     ECoreAppUIsMtvDvbhStatusOn  
       
   195     };
       
   196 
       
   197 /**
       
   198 * Used for notifying SysAp of the PoC missed indicator state
       
   199 */
       
   200 const TUint32 KCoreAppUIsPoCMissedIndicator = 0x00000116;
       
   201 enum TCoreAppUIsPocMissedIndicator
       
   202      {
       
   203      ECoreAppUIsPocMissedIndicatorUninitialized = 0,
       
   204      ECoreAppUIsPocMissedIndicatorOff,
       
   205      ECoreAppUIsPocMissedIndicatorOn
       
   206      };
       
   207 
       
   208 /**
       
   209 * Used for notifying SysAp of the video sharing indicator state
       
   210 */
       
   211 const TUint32 KCoreAppUIsVideoSharingIndicator= 0x00000117;
       
   212 enum TCoreAppUIsVideoSharingIndicator
       
   213      {
       
   214      ECoreAppUIsVideoSharingIndicatorUninitialized = 0,
       
   215      ECoreAppUIsVideoSharingIndicatorOff,
       
   216      ECoreAppUIsVideoSharingIndicatorOn
       
   217      };
       
   218 
       
   219 // =============================================================================
       
   220 // Contacts Database Recovery Status API
       
   221 // =============================================================================
       
   222 
       
   223 // Use TUid KPSUidCoreApplicationUIs = { 0x101F8767 } 
       
   224 /**
       
   225 * Used by DbRecovery to notify other applications about the Contacts DB status.
       
   226 * Old Shared Data constant name: KSysDbRecoveryContacts
       
   227 */
       
   228 const TUint32 KCoreAppUIsDbRecoveryContacts = 0x00000105;
       
   229 enum TCoreAppUIs
       
   230     {
       
   231     ECoreAppUIsContactsDbCorrupted = KErrCorrupt, // -20
       
   232     ECoreAppUIsContactsDbOk = KErrNone            // 0
       
   233     };
       
   234 
       
   235 // =============================================================================
       
   236 // Light Control API
       
   237 // =============================================================================
       
   238 
       
   239 // Use TUid KPSUidCoreApplicationUIs = { 0x101F8767 } 
       
   240 
       
   241 /**
       
   242 * Used by Alarm UI to notify SysAp to 1) start/stop blinking lights and 2) change the SW state
       
   243 * into Alarm if current SW state is Charging.
       
   244 * Old Shared Data constant name: KSysApAlarmLightActive
       
   245 */
       
   246 const TUint32 KLightsAlarmLightActive = 0x00000201;
       
   247 enum TLightsAlarm
       
   248     {
       
   249     ELightsBlinkingUninitialized = 0,
       
   250     ELightsNotBlinking,
       
   251     ELightsBlinking
       
   252     };
       
   253 
       
   254 /**
       
   255 * SysAp lights API for Video Telephony. VT can request forced lights on until eternity.
       
   256 * The lights are switched off only when requested explicitely.
       
   257 * Old Shared Data constant names: KSysApForcedLightsOn
       
   258 */
       
   259 const TUint32 KLightsVTForcedLightsOn = 0x00000202;
       
   260 enum TLights
       
   261     {
       
   262     EForcedLightsUninitialized = 0,
       
   263     EForcedLightsOff, // normal state
       
   264     EForcedLightsOn
       
   265     };
       
   266 
       
   267 /**
       
   268 * SysAp lights API for ScreenSaver. SS can request forced lights on for the
       
   269 * maximum of 30 secs. Possible values: an integer > 0 and <= 30 (secs).
       
   270 * Old Shared Data constant name: KSysApForcedSSLightsOn
       
   271 */
       
   272 const TUint32 KLightsSSForcedLightsOn = 0x00000203;
       
   273 
       
   274 /**
       
   275 * SysAp generic Lights API.
       
   276 * Old Shared Data constant name: KSysApLightsControl
       
   277 */
       
   278 const TUint32 KLightsControl = 0x00000204;
       
   279 enum TLightsControl
       
   280     {
       
   281     ELightsUninitialized = 0,
       
   282     ELightsOff, // not supported by SysAp
       
   283     ELightsOn   // lights are switched on in a normal way
       
   284     };
       
   285 /**
       
   286 * SysAp lights API for AT backlight command
       
   287 */
       
   288 const TUint32 KLightsATCForcedLightsOn = 0x00000206;
       
   289 
       
   290 // =============================================================================
       
   291 // Autolock Status API
       
   292 // =============================================================================
       
   293 
       
   294 // Use TUid KPSUidCoreApplicationUIs = { 0x101F8767 } 
       
   295 
       
   296 /**
       
   297 * Indicates the status of Autolock.
       
   298 */
       
   299 #ifdef RD_STARTUP_CHANGE
       
   300 const TUint32 KCoreAppUIsAutolockStatus  = 0x00000501;
       
   301 enum TPSAutolockStatus
       
   302     {
       
   303     EAutolockStatusUninitialized = 0,
       
   304     EAutolockOff,
       
   305 #ifndef RD_REMOTELOCK
       
   306     EAutolockOn
       
   307 #else    
       
   308     ETimerLocked, // Autolock period is user defined and the lock was set on due to user inactivity timeout.
       
   309     EManualLocked, // User set the lock on manually from the power key menu.
       
   310     ERemoteLocked //The lock was set on by a remote lock message.
       
   311 #endif // RD_REMOTELOCK    
       
   312     };
       
   313 #endif //RD_STARTUP_CHANGE
       
   314 
       
   315 // =============================================================================
       
   316 /* When the mode changes, changes would be done in the followings...
       
   317    e.g.  wallpaper, profile, theme and widgets in the homescreen. 
       
   318    All those changes would take time, which is tried to be decreased. 
       
   319    When the mode changes, then is also shown the UI-note, e.g. "Mode activated: Personal" which consume time.  
       
   320 
       
   321    To decrease the used time, the "profile changed"-note is suppressed by using the following P&S key value.
       
   322    Uses TUid KPSUidCoreApplicationUIs = { 0x101F8767 }
       
   323 */
       
   324 // =============================================================================  
       
   325 
       
   326 // Used for deciding, whether to show the Activated Profile note or not.
       
   327 
       
   328 const TUint32 KCoreAppUIsProfileActivatedNote = 0x00000205;
       
   329 enum TCoreAppUIsProfileActivatedNote
       
   330      {
       
   331       ECoreAppUIsProfileActivatedNoteNotShown = 0,
       
   332       ECoreAppUIsProfileActivatedNoteShown = 1 
       
   333      };
       
   334 
       
   335 #endif // COREAPPLICATIONUISDOMAINPSKEYS_H