epoc32/include/sacls.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
     1.1 --- a/epoc32/include/sacls.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/sacls.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,442 @@
     1.4 -sacls.h
     1.5 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// 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
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +//
    1.19 +
    1.20 +#ifndef __SACLS_H__
    1.21 +#define __SACLS_H__
    1.22 +
    1.23 +#include <e32std.h>
    1.24 +
    1.25 +/**
    1.26 +System agent 2 - maintained entries
    1.27 +@publishedAll
    1.28 +@released
    1.29 +*/
    1.30 +const TInt KUidProfileValue		=0x100052D2;
    1.31 +const TUid KUidProfile			={KUidProfileValue};
    1.32 +
    1.33 +/**
    1.34 +@capability WriteDeviceData capability is required for changing KUidPhonePwr property value.
    1.35 +@publishedAll
    1.36 +@released
    1.37 +*/
    1.38 +const TInt KUidPhonePwrValue=0x100052C5;
    1.39 +const TUid KUidPhonePwr={KUidPhonePwrValue};
    1.40 +
    1.41 +/**
    1.42 +@publishedAll
    1.43 +@released
    1.44 +*/
    1.45 +enum TSAPhoneStatus
    1.46 +	{
    1.47 +	ESAPhoneOff,
    1.48 +	ESAPhoneOn
    1.49 +	};
    1.50 +
    1.51 +/**
    1.52 +@capability WriteDeviceData capability is required for changing KUidSIMStatus property value.
    1.53 +@publishedAll
    1.54 +@released
    1.55 +*/
    1.56 +const TInt KUidSIMStatusValue	=0x100052C6;
    1.57 +const TUid KUidSIMStatus		={KUidSIMStatusValue};
    1.58 +
    1.59 +/**
    1.60 +@publishedAll
    1.61 +@released
    1.62 +*/
    1.63 +enum TSASIMStatus
    1.64 +	{
    1.65 +	ESASimOk,
    1.66 +	ESASimNotPresent,
    1.67 +	ESASimRejected
    1.68 +	};
    1.69 +
    1.70 +/**
    1.71 +@capability WriteDeviceData capability is required for changing KUidNetworkStatus property value.
    1.72 +@publishedAll
    1.73 +@released
    1.74 +*/
    1.75 +const TInt KUidNetworkStatusValue=0x100052C7;
    1.76 +const TUid KUidNetworkStatus	={KUidNetworkStatusValue};
    1.77 +
    1.78 +/**
    1.79 +@publishedAll
    1.80 +@released
    1.81 +*/
    1.82 +enum TSANetworkStatus
    1.83 +	{
    1.84 +	ESANetworkAvailable,
    1.85 +	ESANetworkUnAvailable
    1.86 +	};
    1.87 +
    1.88 +/**
    1.89 +@capability WriteDeviceData capability is required for changing KUidNetworkStrength property value.
    1.90 +@publishedAll
    1.91 +@released
    1.92 +*/
    1.93 +const TInt KUidNetworkStrengthValue  =0x100052C8;
    1.94 +const TUid KUidNetworkStrength  ={KUidNetworkStrengthValue};
    1.95 +
    1.96 +/**
    1.97 +@publishedAll
    1.98 +@released
    1.99 +*/
   1.100 +enum TSANetworkStrength
   1.101 +	{
   1.102 +	ESANetworkStrengthNone,
   1.103 +	ESANetworkStrengthLow,
   1.104 +	ESANetworkStrengthMedium,
   1.105 +	ESANetworkStrengthHigh,
   1.106 +	ESANetworkStrengthUnknown
   1.107 +	};
   1.108 +
   1.109 +/**
   1.110 +@capability WriteDeviceData capability is required for changing KUidChargerStatus property value.
   1.111 +@publishedAll
   1.112 +@released
   1.113 +*/
   1.114 +const TInt KUidChargerStatusValue	=0x100052C9;
   1.115 +const TUid KUidChargerStatus	={KUidChargerStatusValue};
   1.116 +
   1.117 +/**
   1.118 +@publishedAll
   1.119 +@released
   1.120 +*/
   1.121 +enum TSAChargerStatus
   1.122 +	{
   1.123 +	ESAChargerConnected,
   1.124 +	ESAChargerDisconnected,
   1.125 +	ESAChargerNotCharging
   1.126 +	};
   1.127 +
   1.128 +/**
   1.129 +@capability WriteDeviceData capability is required for changing KUidBatteryStrength property value.
   1.130 +@publishedAll
   1.131 +@released
   1.132 +*/
   1.133 +const TInt KUidBatteryStrengthValue  =0x100052CA;
   1.134 +const TUid KUidBatteryStrength  ={KUidBatteryStrengthValue};
   1.135 +
   1.136 +/**
   1.137 +@publishedAll
   1.138 +@released
   1.139 +*/
   1.140 +enum TSABatteryStrength
   1.141 +	{
   1.142 +	ESABatteryAlmostEmpty,
   1.143 +	ESABatteryLow,
   1.144 +	ESABatteryFull
   1.145 +	};
   1.146 +
   1.147 +/**
   1.148 +@capability WriteDeviceData capability is required for changing KUidCurrentCall property value.
   1.149 +@publishedAll
   1.150 +@released
   1.151 +*/
   1.152 +const TInt KUidCurrentCallValue	=0x100052CB;
   1.153 +const TUid KUidCurrentCall		={KUidCurrentCallValue};
   1.154 +
   1.155 +/**
   1.156 +@publishedAll
   1.157 +@released
   1.158 +*/
   1.159 +enum TSACurrentCall
   1.160 +	{
   1.161 +	ESACallNone,
   1.162 +	ESACallVoice,
   1.163 +	ESACallFax,
   1.164 +	ESACallData,
   1.165 +	ESACallAlerting,
   1.166 +	ESACallRinging,
   1.167 +	ESACallAlternating,
   1.168 +	ESACallDialling,
   1.169 +	ESACallAnswering,
   1.170 +	ESACallDisconnecting
   1.171 +	};
   1.172 +
   1.173 +/**
   1.174 +@publishedAll
   1.175 +@released
   1.176 +*/
   1.177 +const TInt KUidDataPortValue	=0x100052CC;
   1.178 +const TUid KUidDataPort			={KUidDataPortValue};
   1.179 +
   1.180 +/**
   1.181 +@publishedAll
   1.182 +@released
   1.183 +*/
   1.184 +enum TSAPort
   1.185 +	{
   1.186 +	ESADataPortIdle,
   1.187 +	ESADataPortBusy	
   1.188 +	};
   1.189 +
   1.190 +/**
   1.191 +@publishedAll
   1.192 +@released
   1.193 +*/
   1.194 +const TInt KUidInboxStatusValue	=0x100052CD;
   1.195 +const TUid KUidInboxStatus		={KUidInboxStatusValue};
   1.196 +
   1.197 +/**
   1.198 +@publishedAll
   1.199 +@released
   1.200 +*/
   1.201 +enum TSAInboxStatus
   1.202 +	{
   1.203 +	ESAInboxEmpty,
   1.204 +	ESADocumentsInInbox
   1.205 +	};
   1.206 +
   1.207 +/**
   1.208 +@publishedAll
   1.209 +@released
   1.210 +*/
   1.211 +const TInt KUidOutboxStatusValue=0x100052CE;
   1.212 +const TUid KUidOutboxStatus		={KUidOutboxStatusValue};
   1.213 +
   1.214 +/**
   1.215 +@publishedAll
   1.216 +@released
   1.217 +*/
   1.218 +enum TSAOutboxStatus
   1.219 +	{
   1.220 +	ESAOutboxEmpty,
   1.221 +	ESADocumentsInOutbox
   1.222 +	};
   1.223 +
   1.224 +/**
   1.225 +@publishedAll
   1.226 +@released
   1.227 +*/
   1.228 +const TInt KUidClockValue		=0x100052CF;
   1.229 +const TUid KUidClock			={KUidClockValue};
   1.230 +
   1.231 +/**
   1.232 +@publishedAll
   1.233 +@released
   1.234 +*/
   1.235 +enum TSAClock
   1.236 +	{
   1.237 +	ESAAm,
   1.238 +	ESAPm
   1.239 +	};
   1.240 +
   1.241 +/**
   1.242 +No longer used
   1.243 +@publishedAll
   1.244 +@released
   1.245 +*/
   1.246 +const TInt KUidAlarmValue		=0x100052D0;
   1.247 +const TUid KUidAlarm			={KUidAlarmValue};
   1.248 +
   1.249 +/**
   1.250 +@publishedAll
   1.251 +@released
   1.252 +*/
   1.253 +enum TSAAlarm
   1.254 +	{
   1.255 +	ESAAlarmOff,
   1.256 +	ESAAlarmOn,
   1.257 +	};
   1.258 +
   1.259 +/**
   1.260 +@publishedAll
   1.261 +@released
   1.262 +*/
   1.263 +const TInt KUidIrdaStatusValue	=0x100052D1;
   1.264 +const TUid KUidIrdaStatus		={KUidIrdaStatusValue};
   1.265 +
   1.266 +/**
   1.267 +@publishedAll
   1.268 +@released
   1.269 +*/
   1.270 +enum TSAIrdaStatus
   1.271 +	{
   1.272 +	ESAIrLoaded,		//IRDA Irlap layer loaded
   1.273 +	ESAIrDiscoveredPeer,//Discovery begin
   1.274 +	ESAIrLostPeer,		//Discovery end
   1.275 +	ESAIrConnected,		//IRDA Irlap layer connected
   1.276 +	ESAIrBlocked,		//IRDA Irlap layer blocked
   1.277 +	ESAIrDisConnected,	//IRDA Irlap layer disconnected
   1.278 +	ESAIrUnloaded		//IRDA Irlap layer unloaded
   1.279 +	};
   1.280 +	
   1.281 +//-----------------------------------------------------------------------------
   1.282 +	
   1.283 +/**
   1.284 +This is a duplicate of Swi::KUidSoftwareInstallKey from swi/swispubsubdefs.h
   1.285 +This is the publish and subscribe property used by Secure Software Install to 
   1.286 +publish its current state. The publish and subscribe key is defined by 
   1.287 +SysAgent2 server, but we do not want to have a dependency to the security 
   1.288 +subsystem, so we redefine a constant with the same key value here so it may be used
   1.289 +by this and other Core OS layer components. We also define the property's
   1.290 +values in sacls.h too, see TSASwisOperation & TSASwisOperationStatus.
   1.291 +
   1.292 +@internalTechnology
   1.293 +*/
   1.294 +const TInt KSAUidSoftwareInstallKeyValue = 0x102047B7;
   1.295 +
   1.296 +/**
   1.297 +This is a duplicate of Swi::KSwisOperationMask from swi/swispubsubdefs.h
   1.298 +@see KSAUidSoftwareInstallKeyValue
   1.299 +@internalTechnology
   1.300 +*/
   1.301 +const TUint KSASwisOperationMask = 0xFF;
   1.302 +
   1.303 +/**
   1.304 +This is a duplicate of Swi::TSwisOperation from swi/swispubsubdefs.h
   1.305 +@see KSAUidSoftwareInstallKeyValue
   1.306 +@internalTechnology
   1.307 +*/
   1.308 +enum TSASwisOperation
   1.309 +	{	
   1.310 +	ESASwisNone			= 0x00, ///< No operation
   1.311 +	ESASwisInstall		= 0x01, ///< Swis install operation is in progress
   1.312 +	ESASwisUninstall	= 0x02, ///< Swis uninstall operation is in progress
   1.313 +	ESASwisRestore		= 0x04  ///< Swis restore operation is in progress
   1.314 +	};
   1.315 +
   1.316 +
   1.317 +/**
   1.318 +This is a duplicate of Swi::KSwisOperationStatusMask from swi/swispubsubdefs.h
   1.319 +@see KSAUidSoftwareInstallKeyValue
   1.320 +@internalTechnology
   1.321 +*/
   1.322 +const TUint KSASwisOperationStatusMask = 0xFF00;  
   1.323 +	
   1.324 +/**
   1.325 +This is a duplicate of Swi::TSwisOperationStatus from swi/swispubsubdefs.h
   1.326 +@see KSAUidSoftwareInstallKeyValue
   1.327 +@internalTechnology
   1.328 +*/
   1.329 +enum TSASwisOperationStatus
   1.330 +	{
   1.331 +	ESASwisStatusNone		= 0x0000, ///< The current operation is in progress
   1.332 +	ESASwisStatusSuccess	= 0x0100, ///< The current/last operation succeeded
   1.333 +	ESASwisStatusAborted	= 0x0200  ///< The current/last operation failed		
   1.334 +	};	
   1.335 +
   1.336 +
   1.337 +//-----------------------------------------------------------------------------
   1.338 +		
   1.339 +/**
   1.340 +This is a duplicate of KUidJavaInstallKey from swi/swispubsubdefs.h
   1.341 +This is the Publish and Subscribe property used by Java install to publish its current 
   1.342 +state. The publish and subscribe key is defined by SysAgent2 server, but we
   1.343 +do not want to have a dependency to the security subsystem, so we redefine a constant 
   1.344 +with the same value here.
   1.345 +@internalTechnology
   1.346 +*/
   1.347 +const TInt KSAUidJavaInstallKeyValue = 0x1020806E;
   1.348 +
   1.349 +
   1.350 +/** This is the global definition used by Software Install server (SWIS)
   1.351 +This is the publish and subscribe property used by SWI to publish the most
   1.352 +recently installed or updated application. If the application has 
   1.353 +subsequently been uninstalled the value may refer to an application
   1.354 +that no longer exists. Has value KUidNull if no applications have been 
   1.355 +installed
   1.356 + 
   1.357 +@publishedPartner
   1.358 +@released
   1.359 +@capability ECapabilityTrustedUI capability is required to modify the value of this property
   1.360 +*/
   1.361 +const TUint KUidSwiLatestInstallation = 0x10272C8E;
   1.362 +
   1.363 +/** This is the global definition of KUidJmiLatestInstallation used
   1.364 +by Java Midlet Installer
   1.365 +This is the publish and subscribe property used by JMI to publish the most
   1.366 +recently installed application. If the application has 
   1.367 +subsequently been uninstalled the value may refer to an application
   1.368 +that no longer exists. Has value KUidNull if no applications have been 
   1.369 +installed 
   1.370 +
   1.371 +@publishedPartner
   1.372 +@released
   1.373 +@capability ECapabilityTrustedUI capability is required to modify the value of this property
   1.374 +*/
   1.375 +const TUint KUidJmiLatestInstallation = 0x10272D3D;
   1.376 +
   1.377 +
   1.378 +/** This is the global definitioin of KUidUnifiedCertstoreFlag. This publish
   1.379 +and subscribe property is used to notify users of changes in the unified certstore
   1.380 +
   1.381 +@publishedPartner
   1.382 +@released
   1.383 +*/
   1.384 +const TUint KUidUnifiedCertstoreFlag = 0x10272C83;
   1.385 +
   1.386 +/**
   1.387 +This is a duplicate of KUidBackupRestoreKey from the secure backup engine's sbdefs.h
   1.388 +This is the Publish and Subscribe property used by Secure Backup Engine to publish its current 
   1.389 +state. The publish and subscribe key is defined by SysAgent2 server.
   1.390 +@publishedAll
   1.391 +@released
   1.392 +*/
   1.393 +const TUint KUidBackupRestoreKey = 0x10202792;
   1.394 +
   1.395 +
   1.396 +/** 
   1.397 +This is a duplicate of KPosLastKnownLocationCategory from lbs's epos_lastknownlocationpsykeys.h
   1.398 +It should NOT be used directly.
   1.399 +Defines value UID of Location P&S keys category.
   1.400 +The publish and subscribe key is defined by SysAgent2 server.
   1.401 +@internalTechnology
   1.402 + */
   1.403 +const TInt KSAPosLastKnownLocationCategoryValue	= 0x10009BFA;
   1.404 +const TUid KSAPosLastKnownLocationCategory = { KSAPosLastKnownLocationCategoryValue };
   1.405 +
   1.406 +/**
   1.407 +This is a duplicate of KPosLastKnownLocation from lbs's epos_lastknownlocationpsykeys.h
   1.408 +ID of the Last Known Location key.
   1.409 +It should NOT be used directly.
   1.410 +Contains binary values, a buffer with packaged TPositionInfo.
   1.411 +
   1.412 +If it contains a buffer, which length does not match TPositionInfo,
   1.413 +such value shall be ignored.
   1.414 +
   1.415 +Client must have ReadDeviceData capability in order to read this key.
   1.416 +@internalTechnology
   1.417 +*/
   1.418 +const TInt KSAPosLastKnownLocation = 0x00000001;
   1.419 +
   1.420 +/** 
   1.421 +This is a duplicate of KPosIndicatorCategoryUid from lbs's locationfwdomainpskeys.h
   1.422 +It should NOT be used directly.
   1.423 +Defines UID of Positioning Indicator P&S keys category. 
   1.424 +@internalTechnology
   1.425 +*/
   1.426 +const TInt KSAPosIndicatorCategoryValue = 0x101F7A79 ;
   1.427 +const TUid KSAPosIndicatorCategory = {KSAPosIndicatorCategoryValue};
   1.428 +
   1.429 +/**
   1.430 +This is a duplicate of KPosIntGpsHwStatus from lbs's locationfwdomainpskeys.h
   1.431 +ID of the Integrated GPS HW Status key.
   1.432 +It should NOT be used directly.
   1.433 +May contain values defined by @ref TPosIntGpsHwIndicatorState.
   1.434 +
   1.435 +Default value (i.e. when this key is not found) is EPosIntGpsHwIndicatorOff.
   1.436 +
   1.437 +If it contains any other value than defined in @ref TPosIntGpsHwState,
   1.438 +such value shall be ignored and TPosIndicatorState::EPosIntGpsHwIndicatorOff
   1.439 +shall be assumed.
   1.440 +@internalTechnology
   1.441 +*/
   1.442 +const TInt KSAPosIntGpsHwStatus = 0x00000001;
   1.443 +// Deprecated - redundant method no longer used by system software
   1.444 +IMPORT_C TInt StartSysAgt2();
   1.445 +
   1.446 +#endif //__SACLS_H__