|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
/**
|
|
sl@0
|
22 |
@file
|
|
sl@0
|
23 |
@publishedPartner
|
|
sl@0
|
24 |
@released
|
|
sl@0
|
25 |
*/
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#ifndef FEATURECMN_H
|
|
sl@0
|
28 |
#define FEATURECMN_H
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
#include <e32cmn.h>
|
|
sl@0
|
31 |
#include <babitflags.h>
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
const TInt KFeatureUnsupported( 0 );
|
|
sl@0
|
34 |
const TInt KFeatureSupported( 1 );
|
|
sl@0
|
35 |
|
|
sl@0
|
36 |
/** An enumeration for accessing feature status flags.
|
|
sl@0
|
37 |
@see TBitFlagsT
|
|
sl@0
|
38 |
*/
|
|
sl@0
|
39 |
enum TFeatureFlags
|
|
sl@0
|
40 |
{
|
|
sl@0
|
41 |
/** If set, feature is supported and available for use;
|
|
sl@0
|
42 |
if not, feature is not supported.
|
|
sl@0
|
43 |
*/
|
|
sl@0
|
44 |
EFeatureSupported = 0,
|
|
sl@0
|
45 |
/** If set, feature is upgradeable. The feature is known to the device
|
|
sl@0
|
46 |
but it must be upgraded to enable it. If a feature s blacklisted,
|
|
sl@0
|
47 |
its upgradeable flag is unset.
|
|
sl@0
|
48 |
*/
|
|
sl@0
|
49 |
EFeatureUpgradeable = 1,
|
|
sl@0
|
50 |
/** If set, the feature is modifiable and may be enabled/disabled
|
|
sl@0
|
51 |
at run-time. The initial flag values for such a feature flag are
|
|
sl@0
|
52 |
defined in a ROM image obey file.
|
|
sl@0
|
53 |
*/
|
|
sl@0
|
54 |
EFeatureModifiable = 2,
|
|
sl@0
|
55 |
/** If set, the feature has been blacklisted, and may not be changed at
|
|
sl@0
|
56 |
run-time. This also prevents a feature from being upgraded.
|
|
sl@0
|
57 |
*/
|
|
sl@0
|
58 |
EFeatureBlackListed = 3,
|
|
sl@0
|
59 |
/** If set, this flag Supported state is unknown at build-time and is
|
|
sl@0
|
60 |
initialised at run-time by system software. The Feature Manager will
|
|
sl@0
|
61 |
ignore the Supported flag in the file. A run-time call to RFeatureControl
|
|
sl@0
|
62 |
will be needed to set the feature's supported flag. Look ups of
|
|
sl@0
|
63 |
uninitialised features result in a KErrNotReady error code.
|
|
sl@0
|
64 |
*/
|
|
sl@0
|
65 |
EFeatureUninitialized = 4,
|
|
sl@0
|
66 |
/** If set, this flag is saved to the system drive when modified
|
|
sl@0
|
67 |
preserving its value across reboots/power downs.
|
|
sl@0
|
68 |
*/
|
|
sl@0
|
69 |
EFeaturePersisted = 5,
|
|
sl@0
|
70 |
|
|
sl@0
|
71 |
// Bits 6..23 Reserved for Symbian to define for future use, always zero.
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
// High byte bits are undefined, reserved for internal use
|
|
sl@0
|
74 |
EFeatureReserved24 = 24,
|
|
sl@0
|
75 |
EFeatureReserved25 = 25,
|
|
sl@0
|
76 |
EFeatureReserved26 = 26,
|
|
sl@0
|
77 |
EFeatureReserved27 = 27,
|
|
sl@0
|
78 |
EFeatureReserved28 = 28,
|
|
sl@0
|
79 |
EFeatureReserved29 = 29,
|
|
sl@0
|
80 |
EFeatureReserved30 = 30,
|
|
sl@0
|
81 |
EFeatureReserved31 = 31
|
|
sl@0
|
82 |
|
|
sl@0
|
83 |
};
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
/** An enumeration for checking feature change type.
|
|
sl@0
|
86 |
*/
|
|
sl@0
|
87 |
enum TFeatureChangeType
|
|
sl@0
|
88 |
{
|
|
sl@0
|
89 |
/** Feature status not changed.
|
|
sl@0
|
90 |
*/
|
|
sl@0
|
91 |
EFeatureNoChange = 0,
|
|
sl@0
|
92 |
/** Feature status changed to enabled or disabled.
|
|
sl@0
|
93 |
*/
|
|
sl@0
|
94 |
EFeatureStatusUpdated = 1,
|
|
sl@0
|
95 |
/** Feature data changed.
|
|
sl@0
|
96 |
*/
|
|
sl@0
|
97 |
EFeatureDataUpdated = 2,
|
|
sl@0
|
98 |
/** Feature status and data changed.
|
|
sl@0
|
99 |
*/
|
|
sl@0
|
100 |
EFeatureStatusDataUpdated = 3,
|
|
sl@0
|
101 |
/** Not used, future: complex change occurred, reload all features.
|
|
sl@0
|
102 |
*/
|
|
sl@0
|
103 |
EFeatureRediscover = 4,
|
|
sl@0
|
104 |
/** Not used, future: new feature has been added to system.
|
|
sl@0
|
105 |
*/
|
|
sl@0
|
106 |
EFeatureFeatureCreated = 5,
|
|
sl@0
|
107 |
/** Feature has been deleted.
|
|
sl@0
|
108 |
*/
|
|
sl@0
|
109 |
EFeatureFeatureDeleted = 6
|
|
sl@0
|
110 |
};
|
|
sl@0
|
111 |
|
|
sl@0
|
112 |
/**
|
|
sl@0
|
113 |
Feature entry class.
|
|
sl@0
|
114 |
Used by Feature Manager and its clients.
|
|
sl@0
|
115 |
|
|
sl@0
|
116 |
*/
|
|
sl@0
|
117 |
|
|
sl@0
|
118 |
class TFeatureEntry
|
|
sl@0
|
119 |
{
|
|
sl@0
|
120 |
public:
|
|
sl@0
|
121 |
|
|
sl@0
|
122 |
/**
|
|
sl@0
|
123 |
Default constructor.
|
|
sl@0
|
124 |
Needed by clients using the method
|
|
sl@0
|
125 |
FeatureSupported( TFeatureEntry& aFeature ) of Feature Control API.
|
|
sl@0
|
126 |
|
|
sl@0
|
127 |
@param aFeature Feature UID.
|
|
sl@0
|
128 |
*/
|
|
sl@0
|
129 |
IMPORT_C TFeatureEntry( TUid aFeature );
|
|
sl@0
|
130 |
|
|
sl@0
|
131 |
/**
|
|
sl@0
|
132 |
Default constructor.
|
|
sl@0
|
133 |
Needed by clients using the method
|
|
sl@0
|
134 |
AddFeature( TFeatureEntry& aFeature ) of Feature Control API.
|
|
sl@0
|
135 |
|
|
sl@0
|
136 |
@param aFeature Feature UID.
|
|
sl@0
|
137 |
@param aFlags Feature status flags.
|
|
sl@0
|
138 |
@param aData Feature data.
|
|
sl@0
|
139 |
*/
|
|
sl@0
|
140 |
IMPORT_C TFeatureEntry( TUid aFeature, TBitFlags32 aFlags, TUint32 aData );
|
|
sl@0
|
141 |
|
|
sl@0
|
142 |
/**
|
|
sl@0
|
143 |
Returns feature UID.
|
|
sl@0
|
144 |
*/
|
|
sl@0
|
145 |
IMPORT_C TUid FeatureUid() const;
|
|
sl@0
|
146 |
|
|
sl@0
|
147 |
/**
|
|
sl@0
|
148 |
Returns feature status flags.
|
|
sl@0
|
149 |
*/
|
|
sl@0
|
150 |
IMPORT_C TBitFlags32 FeatureFlags() const;
|
|
sl@0
|
151 |
|
|
sl@0
|
152 |
/**
|
|
sl@0
|
153 |
Returns feature data.
|
|
sl@0
|
154 |
*/
|
|
sl@0
|
155 |
IMPORT_C TUint32 FeatureData() const;
|
|
sl@0
|
156 |
|
|
sl@0
|
157 |
public:
|
|
sl@0
|
158 |
/**
|
|
sl@0
|
159 |
Default constructor.
|
|
sl@0
|
160 |
Used by Feature Manager.
|
|
sl@0
|
161 |
*/
|
|
sl@0
|
162 |
IMPORT_C TFeatureEntry();
|
|
sl@0
|
163 |
|
|
sl@0
|
164 |
private:
|
|
sl@0
|
165 |
|
|
sl@0
|
166 |
/** UID of the feature. */
|
|
sl@0
|
167 |
TUid iFeatureID;
|
|
sl@0
|
168 |
/**
|
|
sl@0
|
169 |
Value of the feature status flags.
|
|
sl@0
|
170 |
@see TFeatureFlags
|
|
sl@0
|
171 |
*/
|
|
sl@0
|
172 |
TBitFlags32 iFlags;
|
|
sl@0
|
173 |
/** Data associated with feature. */
|
|
sl@0
|
174 |
TUint32 iData;
|
|
sl@0
|
175 |
/**
|
|
sl@0
|
176 |
Reserved for future use.
|
|
sl@0
|
177 |
Initialised to 0 on construction.
|
|
sl@0
|
178 |
*/
|
|
sl@0
|
179 |
TUint32 iReserved;
|
|
sl@0
|
180 |
};
|
|
sl@0
|
181 |
|
|
sl@0
|
182 |
|
|
sl@0
|
183 |
/**
|
|
sl@0
|
184 |
Defines the feature UID array.
|
|
sl@0
|
185 |
*/
|
|
sl@0
|
186 |
typedef RArray<TUid> RFeatureUidArray;
|
|
sl@0
|
187 |
|
|
sl@0
|
188 |
/**
|
|
sl@0
|
189 |
Defines the feature entry array.
|
|
sl@0
|
190 |
*/
|
|
sl@0
|
191 |
typedef RArray<TFeatureEntry> RFeatureArray;
|
|
sl@0
|
192 |
|
|
sl@0
|
193 |
#endif // FEATURECMN_H
|
|
sl@0
|
194 |
|
|
sl@0
|
195 |
// End of File
|