homescreensrv_plat/ai_plugin_information_api/inc/activeidle2domainpskeys.h
changeset 0 79c6a41cd166
child 15 a0713522ab97
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     1 /*
       
     2 * Copyright (c) 2005-2006 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:  Active Idle 2 domain P&S key definitions
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef ACTIVEIDLE2_DOMAIN_PS_KEYS_H
       
    20 #define ACTIVEIDLE2_DOMAIN_PS_KEYS_H
       
    21 
       
    22 /**
       
    23 * PubSub Category AI information API
       
    24 */
       
    25 const TUid KPSUidAiInformation = {0x101FD657};
       
    26 
       
    27 /**
       
    28 * PubSub keys
       
    29 */
       
    30 const TUint KActiveIdleUid = 0x00000001; // Contains UID of StandbyUI (Active Idle) application
       
    31 
       
    32 const TUint KActiveIdleState = 0x00000002; // Contains one value from following emuneration
       
    33 
       
    34 enum EPSActiveIdleState
       
    35 {
       
    36     // Indicates that Active Idle goes to background
       
    37     // Value is triggered by KAknFullOrPartialForegroundLost event
       
    38     //
       
    39     // Corresponds to value EPSTelephonyNotIdle writtern to former  KTelephonyIdleStatus
       
    40     EPSAiBackground = 0,
       
    41 
       
    42     // Indicates that Active Idle goes to foreground
       
    43     // Value is triggered by KAknFullOrPartialForegroundGained event
       
    44     //
       
    45     // Corresponds to value EPSTelephonyIdle writtern to former  KTelephonyIdleStatus
       
    46     EPSAiForeground,
       
    47 
       
    48     // Indicates that Active Idle goes to background and keyboard focus goes to Phone app for Tel number entry
       
    49     // The key is managed by windows server plug-in depends on the key pressed by end-user (See Chapter "Key event handling" from Active Idle SWAD)
       
    50     //
       
    51     // Corresponds to value EPSTelephonyIncomingKeyEvents written to former KTelephonyFocusInfo
       
    52     EPSAiNumberEntry
       
    53 };
       
    54 
       
    55 const TUint KActiveIdlePopupState = 0x00000003; // Contains one value from following emuneration
       
    56 
       
    57 enum EPSActiveIdlePopupState
       
    58 {
       
    59     // Indicates that Active Idle is displaying dialog or menu
       
    60     // The key is managed by windows server plug-in to determine whether to enable keylock handling
       
    61     EPSAiDisplayingMenuOrDialog,
       
    62 
       
    63     // Indicates that Active Idle is not displaying dialog or menu
       
    64     // The key is managed by windows server plug-in to determine whether to enable keylock handling
       
    65     EPSAiNotDisplayingMenuOrDialog
       
    66 };
       
    67 
       
    68 
       
    69 const TUint KActiveIdleActOnSendKey = 0x00000004; // Contains 0 if we are to ignore the send or > 0 if we need to react to it
       
    70 
       
    71 const TUint KActiveIdleTouchToolbarWidth = 0x00000005;
       
    72 
       
    73 const TUint KActiveIdleTouchToolbarHeight = 0x00000006;
       
    74 
       
    75 const TUint KActiveIdleSimRegFailedReceived = 0x00000007; // Contains 1 if we have received sim reg failed message, 0 if not.
       
    76 
       
    77 enum EPSActiveIdleSimRegReceiveStatus
       
    78 {
       
    79     // Indicates that Active Idle is displaying dialog or menu
       
    80     // The key is managed by windows server plug-in to determine whether to enable keylock handling
       
    81     EPSSimRegFailedMessageNotReceived = 0,
       
    82 
       
    83     // Indicates that Active Idle is not displaying dialog or menu
       
    84     // The key is managed by windows server plug-in to determine whether to enable keylock handling
       
    85     EPSSimRegFailedMessageReceived
       
    86 };
       
    87 
       
    88 const TUint KActiveIdleThemeSupportsXsp = 0x00000008;   // Contains one value from following enumeration
       
    89 
       
    90 enum EPSActiveIdleThemeSupportsXsp
       
    91 {
       
    92     // Value indicates that xSP feature is not supported in currently active theme
       
    93     EPSAiXspNotSupported,
       
    94 
       
    95     // Value indicates that the current theme supports the xSP feature
       
    96     EPSAiXspIsSupported
       
    97 };
       
    98 
       
    99 const TUint KActiveIdleLaunch = 0x00000009; // Contains information if shortcut launching is ongoing or not
       
   100 
       
   101 enum EPSActiveIdleIdleLaunch
       
   102 {
       
   103 
       
   104 	// Value indicates that no shortcut is in launching state and new launch tapping can be handled
       
   105 	EPSAiLaunchNotActive = 0,
       
   106 	
       
   107 	// Value indicates that active idle shortcut is launching
       
   108 	EPSAiLaunchIsActive	
       
   109 };
       
   110 
       
   111 
       
   112 // Indicates that Active Idle 2 should be restarted.
       
   113 const TUint KActiveIdleRestartAI2 = 0x0000000B;
       
   114 
       
   115 // Indicates that all the CPS Harvester plugins have been updated
       
   116 const TUint KActiveIdleCpsPluginsUpdated = 0x0000000C;
       
   117 
       
   118 enum EPSActiveIdleCpsPluginsUpdated
       
   119     {
       
   120     EPSAiPluginsNotUpdated = 0,
       
   121     EPSAiPluginsUpdated
       
   122     };
       
   123 
       
   124 // Key to indicate wether the WS plug-in forwards all the numeric keypad 
       
   125 // events to telephone or not.
       
   126 const TUint KActiveIdleForwardNumericKeysToPhone = 0x0000000D;
       
   127 
       
   128 enum EActiveIdleForwardNumericKeysToPhone
       
   129     {
       
   130     // Forward events to phone
       
   131     EPSAiForwardNumericKeysToPhone,
       
   132     
       
   133     // Don't forward events to phone
       
   134     EPSAiDontForwardNumericKeysToPhone
       
   135     };
       
   136 
       
   137 // Indicates that in ExtHS mode the LSK should have a locked shortcut.
       
   138 // Contains the full shortcut definition string.
       
   139 const TUint KActiveIdleExtHS_LSKLocked = 0x00000501;
       
   140 
       
   141 // Indicates that in ExtHS mode the RSK should have a locked shortcut.
       
   142 // Contains the full shortcut definition string.
       
   143 const TUint KActiveIdleExtHS_RSKLocked = 0x00000502;
       
   144 
       
   145 // Indicates that in ExtHS mode the plugin configuration has changed.
       
   146 const TUint KActiveIdleExtHS_PluginConfChange = 0x00000503;
       
   147 
       
   148 /**
       
   149 * PubSub Category AI plug-in registry API
       
   150 */
       
   151 const TUid KPSUidActiveIdle2 =  {0x102750F0}; // ActiveIdle2 SID
       
   152 
       
   153 /**
       
   154 *
       
   155 * First iterate Active plugin UID range to find all
       
   156 * active plugin UID's. Use that UID as a key to find the plugins name
       
   157 * from the name range.
       
   158 *
       
   159 */
       
   160 
       
   161 /**
       
   162 * Active plugin count
       
   163 *
       
   164 * Possible integer values:
       
   165 * 0x000000000 - 0xFFFFFFFF : Active plugin count
       
   166 */
       
   167 const TUint KAIActivePluginCount = 0x00000000;
       
   168 
       
   169 /**
       
   170 * Active plugin UID range
       
   171 *
       
   172 * Possible integer values:
       
   173 * 0x100000000 - 0xFFFFFFFF : Active plugins UID
       
   174 */
       
   175 const TUint KAIActivePluginRangeStart = 0x00000001;
       
   176 const TUint KAIActivePluginRangeEnd   = 0x0FFFFFFF;
       
   177 
       
   178 /**
       
   179 * Active plugin name range
       
   180 *
       
   181 * Possible string values:
       
   182 * Plugin name
       
   183 */
       
   184 const TUint KAIPluginNameRangeStart = 0x10000000;
       
   185 const TUint KAIPluginNameRangeEnd   = 0xFFFFFFFF;
       
   186 
       
   187 #endif // ACTIVEIDLE2_DOMAIN_PS_KEYS_H