epoc32/include/sacls.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __SACLS_H__
williamr@2
    17
#define __SACLS_H__
williamr@2
    18
williamr@4
    19
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    20
#include <saclsdefines.h>
williamr@4
    21
#include <saclscommon.h>
williamr@4
    22
#endif
williamr@4
    23
williamr@2
    24
#include <e32std.h>
williamr@2
    25
williamr@2
    26
/**
williamr@2
    27
System agent 2 - maintained entries
williamr@2
    28
@publishedAll
williamr@2
    29
@released
williamr@2
    30
*/
williamr@2
    31
const TInt KUidProfileValue		=0x100052D2;
williamr@2
    32
const TUid KUidProfile			={KUidProfileValue};
williamr@2
    33
williamr@2
    34
/**
williamr@2
    35
@capability WriteDeviceData capability is required for changing KUidPhonePwr property value.
williamr@2
    36
@publishedAll
williamr@2
    37
@released
williamr@2
    38
*/
williamr@2
    39
const TInt KUidPhonePwrValue=0x100052C5;
williamr@2
    40
const TUid KUidPhonePwr={KUidPhonePwrValue};
williamr@2
    41
williamr@2
    42
/**
williamr@2
    43
@publishedAll
williamr@2
    44
@released
williamr@2
    45
*/
williamr@2
    46
enum TSAPhoneStatus
williamr@2
    47
	{
williamr@2
    48
	ESAPhoneOff,
williamr@2
    49
	ESAPhoneOn
williamr@2
    50
	};
williamr@2
    51
williamr@2
    52
/**
williamr@2
    53
@capability WriteDeviceData capability is required for changing KUidSIMStatus property value.
williamr@2
    54
@publishedAll
williamr@2
    55
@released
williamr@2
    56
*/
williamr@2
    57
const TInt KUidSIMStatusValue	=0x100052C6;
williamr@2
    58
const TUid KUidSIMStatus		={KUidSIMStatusValue};
williamr@2
    59
williamr@2
    60
/**
williamr@2
    61
@publishedAll
williamr@2
    62
@released
williamr@2
    63
*/
williamr@2
    64
enum TSASIMStatus
williamr@2
    65
	{
williamr@2
    66
	ESASimOk,
williamr@2
    67
	ESASimNotPresent,
williamr@2
    68
	ESASimRejected
williamr@2
    69
	};
williamr@2
    70
williamr@2
    71
/**
williamr@2
    72
@capability WriteDeviceData capability is required for changing KUidNetworkStatus property value.
williamr@2
    73
@publishedAll
williamr@2
    74
@released
williamr@2
    75
*/
williamr@2
    76
const TInt KUidNetworkStatusValue=0x100052C7;
williamr@2
    77
const TUid KUidNetworkStatus	={KUidNetworkStatusValue};
williamr@2
    78
williamr@2
    79
/**
williamr@2
    80
@publishedAll
williamr@2
    81
@released
williamr@2
    82
*/
williamr@2
    83
enum TSANetworkStatus
williamr@2
    84
	{
williamr@2
    85
	ESANetworkAvailable,
williamr@2
    86
	ESANetworkUnAvailable
williamr@2
    87
	};
williamr@2
    88
williamr@2
    89
/**
williamr@2
    90
@capability WriteDeviceData capability is required for changing KUidNetworkStrength property value.
williamr@2
    91
@publishedAll
williamr@2
    92
@released
williamr@2
    93
*/
williamr@2
    94
const TInt KUidNetworkStrengthValue  =0x100052C8;
williamr@2
    95
const TUid KUidNetworkStrength  ={KUidNetworkStrengthValue};
williamr@2
    96
williamr@2
    97
/**
williamr@2
    98
@publishedAll
williamr@2
    99
@released
williamr@2
   100
*/
williamr@2
   101
enum TSANetworkStrength
williamr@2
   102
	{
williamr@2
   103
	ESANetworkStrengthNone,
williamr@2
   104
	ESANetworkStrengthLow,
williamr@2
   105
	ESANetworkStrengthMedium,
williamr@2
   106
	ESANetworkStrengthHigh,
williamr@2
   107
	ESANetworkStrengthUnknown
williamr@2
   108
	};
williamr@2
   109
williamr@2
   110
/**
williamr@2
   111
@capability WriteDeviceData capability is required for changing KUidChargerStatus property value.
williamr@2
   112
@publishedAll
williamr@2
   113
@released
williamr@2
   114
*/
williamr@2
   115
const TInt KUidChargerStatusValue	=0x100052C9;
williamr@2
   116
const TUid KUidChargerStatus	={KUidChargerStatusValue};
williamr@2
   117
williamr@2
   118
/**
williamr@2
   119
@publishedAll
williamr@2
   120
@released
williamr@2
   121
*/
williamr@2
   122
enum TSAChargerStatus
williamr@2
   123
	{
williamr@2
   124
	ESAChargerConnected,
williamr@2
   125
	ESAChargerDisconnected,
williamr@2
   126
	ESAChargerNotCharging
williamr@2
   127
	};
williamr@2
   128
williamr@2
   129
/**
williamr@2
   130
@capability WriteDeviceData capability is required for changing KUidBatteryStrength property value.
williamr@2
   131
@publishedAll
williamr@2
   132
@released
williamr@2
   133
*/
williamr@2
   134
const TInt KUidBatteryStrengthValue  =0x100052CA;
williamr@2
   135
const TUid KUidBatteryStrength  ={KUidBatteryStrengthValue};
williamr@2
   136
williamr@2
   137
/**
williamr@2
   138
@publishedAll
williamr@2
   139
@released
williamr@2
   140
*/
williamr@2
   141
enum TSABatteryStrength
williamr@2
   142
	{
williamr@2
   143
	ESABatteryAlmostEmpty,
williamr@2
   144
	ESABatteryLow,
williamr@2
   145
	ESABatteryFull
williamr@2
   146
	};
williamr@2
   147
williamr@2
   148
/**
williamr@2
   149
@capability WriteDeviceData capability is required for changing KUidCurrentCall property value.
williamr@2
   150
@publishedAll
williamr@2
   151
@released
williamr@2
   152
*/
williamr@2
   153
const TInt KUidCurrentCallValue	=0x100052CB;
williamr@2
   154
const TUid KUidCurrentCall		={KUidCurrentCallValue};
williamr@2
   155
williamr@2
   156
/**
williamr@2
   157
@publishedAll
williamr@2
   158
@released
williamr@2
   159
*/
williamr@2
   160
enum TSACurrentCall
williamr@2
   161
	{
williamr@2
   162
	ESACallNone,
williamr@2
   163
	ESACallVoice,
williamr@2
   164
	ESACallFax,
williamr@2
   165
	ESACallData,
williamr@2
   166
	ESACallAlerting,
williamr@2
   167
	ESACallRinging,
williamr@2
   168
	ESACallAlternating,
williamr@2
   169
	ESACallDialling,
williamr@2
   170
	ESACallAnswering,
williamr@2
   171
	ESACallDisconnecting
williamr@2
   172
	};
williamr@2
   173
williamr@2
   174
/**
williamr@2
   175
@publishedAll
williamr@2
   176
@released
williamr@2
   177
*/
williamr@2
   178
const TInt KUidDataPortValue	=0x100052CC;
williamr@2
   179
const TUid KUidDataPort			={KUidDataPortValue};
williamr@2
   180
williamr@2
   181
/**
williamr@2
   182
@publishedAll
williamr@2
   183
@released
williamr@2
   184
*/
williamr@2
   185
enum TSAPort
williamr@2
   186
	{
williamr@2
   187
	ESADataPortIdle,
williamr@2
   188
	ESADataPortBusy	
williamr@2
   189
	};
williamr@2
   190
williamr@2
   191
/**
williamr@2
   192
@publishedAll
williamr@2
   193
@released
williamr@2
   194
*/
williamr@2
   195
const TInt KUidInboxStatusValue	=0x100052CD;
williamr@2
   196
const TUid KUidInboxStatus		={KUidInboxStatusValue};
williamr@2
   197
williamr@2
   198
/**
williamr@2
   199
@publishedAll
williamr@2
   200
@released
williamr@2
   201
*/
williamr@2
   202
enum TSAInboxStatus
williamr@2
   203
	{
williamr@2
   204
	ESAInboxEmpty,
williamr@2
   205
	ESADocumentsInInbox
williamr@2
   206
	};
williamr@2
   207
williamr@2
   208
/**
williamr@2
   209
@publishedAll
williamr@2
   210
@released
williamr@2
   211
*/
williamr@2
   212
const TInt KUidOutboxStatusValue=0x100052CE;
williamr@2
   213
const TUid KUidOutboxStatus		={KUidOutboxStatusValue};
williamr@2
   214
williamr@2
   215
/**
williamr@2
   216
@publishedAll
williamr@2
   217
@released
williamr@2
   218
*/
williamr@2
   219
enum TSAOutboxStatus
williamr@2
   220
	{
williamr@2
   221
	ESAOutboxEmpty,
williamr@2
   222
	ESADocumentsInOutbox
williamr@2
   223
	};
williamr@2
   224
williamr@2
   225
/**
williamr@2
   226
@publishedAll
williamr@2
   227
@released
williamr@2
   228
*/
williamr@2
   229
const TInt KUidClockValue		=0x100052CF;
williamr@2
   230
const TUid KUidClock			={KUidClockValue};
williamr@2
   231
williamr@2
   232
/**
williamr@2
   233
@publishedAll
williamr@2
   234
@released
williamr@2
   235
*/
williamr@2
   236
enum TSAClock
williamr@2
   237
	{
williamr@2
   238
	ESAAm,
williamr@2
   239
	ESAPm
williamr@2
   240
	};
williamr@2
   241
williamr@2
   242
/**
williamr@2
   243
No longer used
williamr@2
   244
@publishedAll
williamr@2
   245
@released
williamr@2
   246
*/
williamr@2
   247
const TInt KUidAlarmValue		=0x100052D0;
williamr@2
   248
const TUid KUidAlarm			={KUidAlarmValue};
williamr@2
   249
williamr@2
   250
/**
williamr@2
   251
@publishedAll
williamr@2
   252
@released
williamr@2
   253
*/
williamr@2
   254
enum TSAAlarm
williamr@2
   255
	{
williamr@2
   256
	ESAAlarmOff,
williamr@2
   257
	ESAAlarmOn,
williamr@2
   258
	};
williamr@2
   259
williamr@2
   260
/**
williamr@2
   261
@publishedAll
williamr@2
   262
@released
williamr@2
   263
*/
williamr@2
   264
const TInt KUidIrdaStatusValue	=0x100052D1;
williamr@2
   265
const TUid KUidIrdaStatus		={KUidIrdaStatusValue};
williamr@2
   266
williamr@2
   267
/**
williamr@2
   268
@publishedAll
williamr@2
   269
@released
williamr@2
   270
*/
williamr@2
   271
enum TSAIrdaStatus
williamr@2
   272
	{
williamr@2
   273
	ESAIrLoaded,		//IRDA Irlap layer loaded
williamr@2
   274
	ESAIrDiscoveredPeer,//Discovery begin
williamr@2
   275
	ESAIrLostPeer,		//Discovery end
williamr@2
   276
	ESAIrConnected,		//IRDA Irlap layer connected
williamr@2
   277
	ESAIrBlocked,		//IRDA Irlap layer blocked
williamr@2
   278
	ESAIrDisConnected,	//IRDA Irlap layer disconnected
williamr@2
   279
	ESAIrUnloaded		//IRDA Irlap layer unloaded
williamr@2
   280
	};
williamr@2
   281
	
williamr@2
   282
//-----------------------------------------------------------------------------
williamr@2
   283
	
williamr@2
   284
/**
williamr@2
   285
This is a duplicate of Swi::KUidSoftwareInstallKey from swi/swispubsubdefs.h
williamr@2
   286
This is the publish and subscribe property used by Secure Software Install to 
williamr@2
   287
publish its current state. The publish and subscribe key is defined by 
williamr@2
   288
SysAgent2 server, but we do not want to have a dependency to the security 
williamr@2
   289
subsystem, so we redefine a constant with the same key value here so it may be used
williamr@2
   290
by this and other Core OS layer components. We also define the property's
williamr@2
   291
values in sacls.h too, see TSASwisOperation & TSASwisOperationStatus.
williamr@2
   292
williamr@4
   293
@publishedAll
williamr@4
   294
@released
williamr@2
   295
*/
williamr@2
   296
const TInt KSAUidSoftwareInstallKeyValue = 0x102047B7;
williamr@2
   297
williamr@2
   298
/**
williamr@2
   299
This is a duplicate of Swi::TSwisOperation from swi/swispubsubdefs.h
williamr@2
   300
@see KSAUidSoftwareInstallKeyValue
williamr@4
   301
@publishedAll
williamr@4
   302
@released
williamr@2
   303
*/
williamr@2
   304
enum TSASwisOperation
williamr@2
   305
	{	
williamr@4
   306
	ESASwisNone			= 0x00, //< No operation
williamr@4
   307
	ESASwisInstall		= 0x01, //< Swis install operation is in progress
williamr@4
   308
	ESASwisUninstall	= 0x02, //< Swis uninstall operation is in progress
williamr@4
   309
	ESASwisRestore		= 0x04  //< Swis restore operation is in progress
williamr@2
   310
	};
williamr@2
   311
williamr@2
   312
williamr@2
   313
/**
williamr@2
   314
This is a duplicate of Swi::KSwisOperationStatusMask from swi/swispubsubdefs.h
williamr@2
   315
@see KSAUidSoftwareInstallKeyValue
williamr@4
   316
@publishedAll
williamr@4
   317
@released
williamr@2
   318
*/
williamr@2
   319
const TUint KSASwisOperationStatusMask = 0xFF00;  
williamr@2
   320
	
williamr@2
   321
/**
williamr@2
   322
This is a duplicate of Swi::TSwisOperationStatus from swi/swispubsubdefs.h
williamr@2
   323
@see KSAUidSoftwareInstallKeyValue
williamr@4
   324
@publishedAll
williamr@4
   325
@released
williamr@2
   326
*/
williamr@2
   327
enum TSASwisOperationStatus
williamr@2
   328
	{
williamr@4
   329
	ESASwisStatusNone		= 0x0000, //< The current operation is in progress
williamr@4
   330
	ESASwisStatusSuccess	= 0x0100, //< The current/last operation succeeded
williamr@4
   331
	ESASwisStatusAborted	= 0x0200  //< The current/last operation failed		
williamr@2
   332
	};	
williamr@2
   333
williamr@2
   334
williamr@2
   335
//-----------------------------------------------------------------------------
williamr@2
   336
		
williamr@2
   337
williamr@2
   338
/** This is the global definition used by Software Install server (SWIS)
williamr@2
   339
This is the publish and subscribe property used by SWI to publish the most
williamr@2
   340
recently installed or updated application. If the application has 
williamr@2
   341
subsequently been uninstalled the value may refer to an application
williamr@2
   342
that no longer exists. Has value KUidNull if no applications have been 
williamr@2
   343
installed
williamr@2
   344
 
williamr@4
   345
@publishedAll
williamr@2
   346
@released
williamr@2
   347
@capability ECapabilityTrustedUI capability is required to modify the value of this property
williamr@2
   348
*/
williamr@2
   349
const TUint KUidSwiLatestInstallation = 0x10272C8E;
williamr@2
   350
williamr@4
   351
/** This is the global definition of KUidUnifiedCertstoreFlag. This publish
williamr@2
   352
and subscribe property is used to notify users of changes in the unified certstore
williamr@2
   353
williamr@4
   354
@publishedAll
williamr@2
   355
@released
williamr@2
   356
*/
williamr@2
   357
const TUint KUidUnifiedCertstoreFlag = 0x10272C83;
williamr@2
   358
williamr@2
   359
/**
williamr@2
   360
This is a duplicate of KUidBackupRestoreKey from the secure backup engine's sbdefs.h
williamr@2
   361
This is the Publish and Subscribe property used by Secure Backup Engine to publish its current 
williamr@2
   362
state. The publish and subscribe key is defined by SysAgent2 server.
williamr@2
   363
@publishedAll
williamr@2
   364
@released
williamr@2
   365
*/
williamr@2
   366
const TUint KUidBackupRestoreKey = 0x10202792;
williamr@2
   367
williamr@2
   368
williamr@2
   369
// Deprecated - redundant method no longer used by system software
williamr@2
   370
IMPORT_C TInt StartSysAgt2();
williamr@2
   371
williamr@2
   372
#endif //__SACLS_H__