epoc32/include/sacls.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     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
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __SACLS_H__
    17 #define __SACLS_H__
    18 
    19 #include <e32std.h>
    20 
    21 /**
    22 System agent 2 - maintained entries
    23 @publishedAll
    24 @released
    25 */
    26 const TInt KUidProfileValue		=0x100052D2;
    27 const TUid KUidProfile			={KUidProfileValue};
    28 
    29 /**
    30 @capability WriteDeviceData capability is required for changing KUidPhonePwr property value.
    31 @publishedAll
    32 @released
    33 */
    34 const TInt KUidPhonePwrValue=0x100052C5;
    35 const TUid KUidPhonePwr={KUidPhonePwrValue};
    36 
    37 /**
    38 @publishedAll
    39 @released
    40 */
    41 enum TSAPhoneStatus
    42 	{
    43 	ESAPhoneOff,
    44 	ESAPhoneOn
    45 	};
    46 
    47 /**
    48 @capability WriteDeviceData capability is required for changing KUidSIMStatus property value.
    49 @publishedAll
    50 @released
    51 */
    52 const TInt KUidSIMStatusValue	=0x100052C6;
    53 const TUid KUidSIMStatus		={KUidSIMStatusValue};
    54 
    55 /**
    56 @publishedAll
    57 @released
    58 */
    59 enum TSASIMStatus
    60 	{
    61 	ESASimOk,
    62 	ESASimNotPresent,
    63 	ESASimRejected
    64 	};
    65 
    66 /**
    67 @capability WriteDeviceData capability is required for changing KUidNetworkStatus property value.
    68 @publishedAll
    69 @released
    70 */
    71 const TInt KUidNetworkStatusValue=0x100052C7;
    72 const TUid KUidNetworkStatus	={KUidNetworkStatusValue};
    73 
    74 /**
    75 @publishedAll
    76 @released
    77 */
    78 enum TSANetworkStatus
    79 	{
    80 	ESANetworkAvailable,
    81 	ESANetworkUnAvailable
    82 	};
    83 
    84 /**
    85 @capability WriteDeviceData capability is required for changing KUidNetworkStrength property value.
    86 @publishedAll
    87 @released
    88 */
    89 const TInt KUidNetworkStrengthValue  =0x100052C8;
    90 const TUid KUidNetworkStrength  ={KUidNetworkStrengthValue};
    91 
    92 /**
    93 @publishedAll
    94 @released
    95 */
    96 enum TSANetworkStrength
    97 	{
    98 	ESANetworkStrengthNone,
    99 	ESANetworkStrengthLow,
   100 	ESANetworkStrengthMedium,
   101 	ESANetworkStrengthHigh,
   102 	ESANetworkStrengthUnknown
   103 	};
   104 
   105 /**
   106 @capability WriteDeviceData capability is required for changing KUidChargerStatus property value.
   107 @publishedAll
   108 @released
   109 */
   110 const TInt KUidChargerStatusValue	=0x100052C9;
   111 const TUid KUidChargerStatus	={KUidChargerStatusValue};
   112 
   113 /**
   114 @publishedAll
   115 @released
   116 */
   117 enum TSAChargerStatus
   118 	{
   119 	ESAChargerConnected,
   120 	ESAChargerDisconnected,
   121 	ESAChargerNotCharging
   122 	};
   123 
   124 /**
   125 @capability WriteDeviceData capability is required for changing KUidBatteryStrength property value.
   126 @publishedAll
   127 @released
   128 */
   129 const TInt KUidBatteryStrengthValue  =0x100052CA;
   130 const TUid KUidBatteryStrength  ={KUidBatteryStrengthValue};
   131 
   132 /**
   133 @publishedAll
   134 @released
   135 */
   136 enum TSABatteryStrength
   137 	{
   138 	ESABatteryAlmostEmpty,
   139 	ESABatteryLow,
   140 	ESABatteryFull
   141 	};
   142 
   143 /**
   144 @capability WriteDeviceData capability is required for changing KUidCurrentCall property value.
   145 @publishedAll
   146 @released
   147 */
   148 const TInt KUidCurrentCallValue	=0x100052CB;
   149 const TUid KUidCurrentCall		={KUidCurrentCallValue};
   150 
   151 /**
   152 @publishedAll
   153 @released
   154 */
   155 enum TSACurrentCall
   156 	{
   157 	ESACallNone,
   158 	ESACallVoice,
   159 	ESACallFax,
   160 	ESACallData,
   161 	ESACallAlerting,
   162 	ESACallRinging,
   163 	ESACallAlternating,
   164 	ESACallDialling,
   165 	ESACallAnswering,
   166 	ESACallDisconnecting
   167 	};
   168 
   169 /**
   170 @publishedAll
   171 @released
   172 */
   173 const TInt KUidDataPortValue	=0x100052CC;
   174 const TUid KUidDataPort			={KUidDataPortValue};
   175 
   176 /**
   177 @publishedAll
   178 @released
   179 */
   180 enum TSAPort
   181 	{
   182 	ESADataPortIdle,
   183 	ESADataPortBusy	
   184 	};
   185 
   186 /**
   187 @publishedAll
   188 @released
   189 */
   190 const TInt KUidInboxStatusValue	=0x100052CD;
   191 const TUid KUidInboxStatus		={KUidInboxStatusValue};
   192 
   193 /**
   194 @publishedAll
   195 @released
   196 */
   197 enum TSAInboxStatus
   198 	{
   199 	ESAInboxEmpty,
   200 	ESADocumentsInInbox
   201 	};
   202 
   203 /**
   204 @publishedAll
   205 @released
   206 */
   207 const TInt KUidOutboxStatusValue=0x100052CE;
   208 const TUid KUidOutboxStatus		={KUidOutboxStatusValue};
   209 
   210 /**
   211 @publishedAll
   212 @released
   213 */
   214 enum TSAOutboxStatus
   215 	{
   216 	ESAOutboxEmpty,
   217 	ESADocumentsInOutbox
   218 	};
   219 
   220 /**
   221 @publishedAll
   222 @released
   223 */
   224 const TInt KUidClockValue		=0x100052CF;
   225 const TUid KUidClock			={KUidClockValue};
   226 
   227 /**
   228 @publishedAll
   229 @released
   230 */
   231 enum TSAClock
   232 	{
   233 	ESAAm,
   234 	ESAPm
   235 	};
   236 
   237 /**
   238 No longer used
   239 @publishedAll
   240 @released
   241 */
   242 const TInt KUidAlarmValue		=0x100052D0;
   243 const TUid KUidAlarm			={KUidAlarmValue};
   244 
   245 /**
   246 @publishedAll
   247 @released
   248 */
   249 enum TSAAlarm
   250 	{
   251 	ESAAlarmOff,
   252 	ESAAlarmOn,
   253 	};
   254 
   255 /**
   256 @publishedAll
   257 @released
   258 */
   259 const TInt KUidIrdaStatusValue	=0x100052D1;
   260 const TUid KUidIrdaStatus		={KUidIrdaStatusValue};
   261 
   262 /**
   263 @publishedAll
   264 @released
   265 */
   266 enum TSAIrdaStatus
   267 	{
   268 	ESAIrLoaded,		//IRDA Irlap layer loaded
   269 	ESAIrDiscoveredPeer,//Discovery begin
   270 	ESAIrLostPeer,		//Discovery end
   271 	ESAIrConnected,		//IRDA Irlap layer connected
   272 	ESAIrBlocked,		//IRDA Irlap layer blocked
   273 	ESAIrDisConnected,	//IRDA Irlap layer disconnected
   274 	ESAIrUnloaded		//IRDA Irlap layer unloaded
   275 	};
   276 	
   277 //-----------------------------------------------------------------------------
   278 	
   279 /**
   280 This is a duplicate of Swi::KUidSoftwareInstallKey from swi/swispubsubdefs.h
   281 This is the publish and subscribe property used by Secure Software Install to 
   282 publish its current state. The publish and subscribe key is defined by 
   283 SysAgent2 server, but we do not want to have a dependency to the security 
   284 subsystem, so we redefine a constant with the same key value here so it may be used
   285 by this and other Core OS layer components. We also define the property's
   286 values in sacls.h too, see TSASwisOperation & TSASwisOperationStatus.
   287 
   288 @internalTechnology
   289 */
   290 const TInt KSAUidSoftwareInstallKeyValue = 0x102047B7;
   291 
   292 /**
   293 This is a duplicate of Swi::KSwisOperationMask from swi/swispubsubdefs.h
   294 @see KSAUidSoftwareInstallKeyValue
   295 @internalTechnology
   296 */
   297 const TUint KSASwisOperationMask = 0xFF;
   298 
   299 /**
   300 This is a duplicate of Swi::TSwisOperation from swi/swispubsubdefs.h
   301 @see KSAUidSoftwareInstallKeyValue
   302 @internalTechnology
   303 */
   304 enum TSASwisOperation
   305 	{	
   306 	ESASwisNone			= 0x00, ///< No operation
   307 	ESASwisInstall		= 0x01, ///< Swis install operation is in progress
   308 	ESASwisUninstall	= 0x02, ///< Swis uninstall operation is in progress
   309 	ESASwisRestore		= 0x04  ///< Swis restore operation is in progress
   310 	};
   311 
   312 
   313 /**
   314 This is a duplicate of Swi::KSwisOperationStatusMask from swi/swispubsubdefs.h
   315 @see KSAUidSoftwareInstallKeyValue
   316 @internalTechnology
   317 */
   318 const TUint KSASwisOperationStatusMask = 0xFF00;  
   319 	
   320 /**
   321 This is a duplicate of Swi::TSwisOperationStatus from swi/swispubsubdefs.h
   322 @see KSAUidSoftwareInstallKeyValue
   323 @internalTechnology
   324 */
   325 enum TSASwisOperationStatus
   326 	{
   327 	ESASwisStatusNone		= 0x0000, ///< The current operation is in progress
   328 	ESASwisStatusSuccess	= 0x0100, ///< The current/last operation succeeded
   329 	ESASwisStatusAborted	= 0x0200  ///< The current/last operation failed		
   330 	};	
   331 
   332 
   333 //-----------------------------------------------------------------------------
   334 		
   335 /**
   336 This is a duplicate of KUidJavaInstallKey from swi/swispubsubdefs.h
   337 This is the Publish and Subscribe property used by Java install to publish its current 
   338 state. The publish and subscribe key is defined by SysAgent2 server, but we
   339 do not want to have a dependency to the security subsystem, so we redefine a constant 
   340 with the same value here.
   341 @internalTechnology
   342 */
   343 const TInt KSAUidJavaInstallKeyValue = 0x1020806E;
   344 
   345 
   346 /** This is the global definition used by Software Install server (SWIS)
   347 This is the publish and subscribe property used by SWI to publish the most
   348 recently installed or updated application. If the application has 
   349 subsequently been uninstalled the value may refer to an application
   350 that no longer exists. Has value KUidNull if no applications have been 
   351 installed
   352  
   353 @publishedPartner
   354 @released
   355 @capability ECapabilityTrustedUI capability is required to modify the value of this property
   356 */
   357 const TUint KUidSwiLatestInstallation = 0x10272C8E;
   358 
   359 /** This is the global definition of KUidJmiLatestInstallation used
   360 by Java Midlet Installer
   361 This is the publish and subscribe property used by JMI to publish the most
   362 recently installed application. If the application has 
   363 subsequently been uninstalled the value may refer to an application
   364 that no longer exists. Has value KUidNull if no applications have been 
   365 installed 
   366 
   367 @publishedPartner
   368 @released
   369 @capability ECapabilityTrustedUI capability is required to modify the value of this property
   370 */
   371 const TUint KUidJmiLatestInstallation = 0x10272D3D;
   372 
   373 
   374 /** This is the global definitioin of KUidUnifiedCertstoreFlag. This publish
   375 and subscribe property is used to notify users of changes in the unified certstore
   376 
   377 @publishedPartner
   378 @released
   379 */
   380 const TUint KUidUnifiedCertstoreFlag = 0x10272C83;
   381 
   382 /**
   383 This is a duplicate of KUidBackupRestoreKey from the secure backup engine's sbdefs.h
   384 This is the Publish and Subscribe property used by Secure Backup Engine to publish its current 
   385 state. The publish and subscribe key is defined by SysAgent2 server.
   386 @publishedAll
   387 @released
   388 */
   389 const TUint KUidBackupRestoreKey = 0x10202792;
   390 
   391 
   392 /** 
   393 This is a duplicate of KPosLastKnownLocationCategory from lbs's epos_lastknownlocationpsykeys.h
   394 It should NOT be used directly.
   395 Defines value UID of Location P&S keys category.
   396 The publish and subscribe key is defined by SysAgent2 server.
   397 @internalTechnology
   398  */
   399 const TInt KSAPosLastKnownLocationCategoryValue	= 0x10009BFA;
   400 const TUid KSAPosLastKnownLocationCategory = { KSAPosLastKnownLocationCategoryValue };
   401 
   402 /**
   403 This is a duplicate of KPosLastKnownLocation from lbs's epos_lastknownlocationpsykeys.h
   404 ID of the Last Known Location key.
   405 It should NOT be used directly.
   406 Contains binary values, a buffer with packaged TPositionInfo.
   407 
   408 If it contains a buffer, which length does not match TPositionInfo,
   409 such value shall be ignored.
   410 
   411 Client must have ReadDeviceData capability in order to read this key.
   412 @internalTechnology
   413 */
   414 const TInt KSAPosLastKnownLocation = 0x00000001;
   415 
   416 /** 
   417 This is a duplicate of KPosIndicatorCategoryUid from lbs's locationfwdomainpskeys.h
   418 It should NOT be used directly.
   419 Defines UID of Positioning Indicator P&S keys category. 
   420 @internalTechnology
   421 */
   422 const TInt KSAPosIndicatorCategoryValue = 0x101F7A79 ;
   423 const TUid KSAPosIndicatorCategory = {KSAPosIndicatorCategoryValue};
   424 
   425 /**
   426 This is a duplicate of KPosIntGpsHwStatus from lbs's locationfwdomainpskeys.h
   427 ID of the Integrated GPS HW Status key.
   428 It should NOT be used directly.
   429 May contain values defined by @ref TPosIntGpsHwIndicatorState.
   430 
   431 Default value (i.e. when this key is not found) is EPosIntGpsHwIndicatorOff.
   432 
   433 If it contains any other value than defined in @ref TPosIntGpsHwState,
   434 such value shall be ignored and TPosIndicatorState::EPosIntGpsHwIndicatorOff
   435 shall be assumed.
   436 @internalTechnology
   437 */
   438 const TInt KSAPosIntGpsHwStatus = 0x00000001;
   439 // Deprecated - redundant method no longer used by system software
   440 IMPORT_C TInt StartSysAgt2();
   441 
   442 #endif //__SACLS_H__