|
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 |
#ifndef FEATURECLIENT_H
|
|
sl@0
|
22 |
#define FEATURECLIENT_H
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
// INCLUDES
|
|
sl@0
|
25 |
#include <e32base.h>
|
|
sl@0
|
26 |
#include <featmgr/featurecmn.h>
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
// CLASS DECLARATION
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
/**
|
|
sl@0
|
31 |
* Feature manager client interface.
|
|
sl@0
|
32 |
*
|
|
sl@0
|
33 |
*/
|
|
sl@0
|
34 |
class MFeatureClient
|
|
sl@0
|
35 |
{
|
|
sl@0
|
36 |
public: // From MFeatureClient
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
/**
|
|
sl@0
|
39 |
* Checks if specified feature is supported and returns
|
|
sl@0
|
40 |
* its flags and data if requested.
|
|
sl@0
|
41 |
* @param aFeature feature entry
|
|
sl@0
|
42 |
* @return Positive (1) if the feature is supported,
|
|
sl@0
|
43 |
* Zero if feature is not supported.
|
|
sl@0
|
44 |
* KErrNotFound if feature not found.
|
|
sl@0
|
45 |
* Otherwise one of the Symbian error codes.
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
virtual TInt FeatureSupported( TFeatureEntry& aFeature ) const = 0;
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
/**
|
|
sl@0
|
50 |
* Fills feature status array according to status/data in server
|
|
sl@0
|
51 |
*
|
|
sl@0
|
52 |
* @param aFeatures feature entry array
|
|
sl@0
|
53 |
* @return KErrNone if no error fetching feature statuses.
|
|
sl@0
|
54 |
* Otherwise one of the Symbian OS error codes.
|
|
sl@0
|
55 |
*/
|
|
sl@0
|
56 |
virtual TInt FeaturesSupported( RFeatureArray& aFeatures ) = 0;
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
* Enables a certain feature.
|
|
sl@0
|
60 |
*
|
|
sl@0
|
61 |
* @param aFeature Feature ID.
|
|
sl@0
|
62 |
* @return KErrNone if the feature was succesfully enabled.
|
|
sl@0
|
63 |
* KErrAccessDenied if the feature is not modifiable.
|
|
sl@0
|
64 |
* KErrPermissionDenied if a capability check fails.
|
|
sl@0
|
65 |
* Otherwise one of the Symbian error codes.
|
|
sl@0
|
66 |
*/
|
|
sl@0
|
67 |
virtual TInt EnableFeature( TUid aFeature ) const = 0;
|
|
sl@0
|
68 |
|
|
sl@0
|
69 |
/**
|
|
sl@0
|
70 |
* Disable a certain feature.
|
|
sl@0
|
71 |
*
|
|
sl@0
|
72 |
* @param aFeature Feature ID.
|
|
sl@0
|
73 |
* @return KErrNone if the feature was succesfully disabled.
|
|
sl@0
|
74 |
* KErrAccessDenied if the feature is not modifiable.
|
|
sl@0
|
75 |
* KErrPermissionDenied if a capability check fails.
|
|
sl@0
|
76 |
* Otherwise one of the Symbian error codes.
|
|
sl@0
|
77 |
*/
|
|
sl@0
|
78 |
virtual TInt DisableFeature( TUid aFeature ) const = 0;
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
/**
|
|
sl@0
|
81 |
* Enables or disables a certain feature and sets feature data.
|
|
sl@0
|
82 |
*
|
|
sl@0
|
83 |
* @param aFeature Feature ID.
|
|
sl@0
|
84 |
* @param aEnabled Feature enable or disable.
|
|
sl@0
|
85 |
* @param aData Feature data.
|
|
sl@0
|
86 |
* @return KErrNone if the feature was succesfully enabled.
|
|
sl@0
|
87 |
* KErrAccessDenied if the feature is not modifiable.
|
|
sl@0
|
88 |
* KErrPermissionDenied if a capability check fails.
|
|
sl@0
|
89 |
* Otherwise one of the Symbian error codes.
|
|
sl@0
|
90 |
*/
|
|
sl@0
|
91 |
virtual TInt SetFeature( TUid aFeature, TBool aEnabled, TInt aData ) const = 0;
|
|
sl@0
|
92 |
|
|
sl@0
|
93 |
/**
|
|
sl@0
|
94 |
* Sets certain feature's data.
|
|
sl@0
|
95 |
*
|
|
sl@0
|
96 |
* @param aFeature Feature ID.
|
|
sl@0
|
97 |
* @param aData Feature data.
|
|
sl@0
|
98 |
* @return KErrNone if feature data was succesfully set.
|
|
sl@0
|
99 |
* KErrAccessDenied if the feature is not modifiable.
|
|
sl@0
|
100 |
* KErrPermissionDenied if a capability check fails.
|
|
sl@0
|
101 |
* Otherwise one of the Symbian error codes.
|
|
sl@0
|
102 |
*/
|
|
sl@0
|
103 |
virtual TInt SetFeature( TUid aFeature, TInt aData ) const = 0;
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
/**
|
|
sl@0
|
106 |
* Add a new feature.
|
|
sl@0
|
107 |
*
|
|
sl@0
|
108 |
* @param aFeature Feature entry.
|
|
sl@0
|
109 |
* @return KErrNone if the feature was succesfully added.
|
|
sl@0
|
110 |
* KErrAccessDenied if the feature is not modifiable.
|
|
sl@0
|
111 |
* KErrPermissionDenied if a capability check fails.
|
|
sl@0
|
112 |
* KErrAlreadyExists if feature already exists.
|
|
sl@0
|
113 |
* Otherwise one of the Symbian error codes.
|
|
sl@0
|
114 |
*/
|
|
sl@0
|
115 |
virtual TInt AddFeature( TFeatureEntry aEntry ) const = 0;
|
|
sl@0
|
116 |
|
|
sl@0
|
117 |
/**
|
|
sl@0
|
118 |
* Delete a feature.
|
|
sl@0
|
119 |
*
|
|
sl@0
|
120 |
* @param aFeature Feature ID.
|
|
sl@0
|
121 |
* @return KErrNone if the feature was successfully deleted.
|
|
sl@0
|
122 |
* KErrAccessDenied if the feature is not added using AddFeature() method.
|
|
sl@0
|
123 |
* KErrPermissionDenied if a capability check fails.
|
|
sl@0
|
124 |
* KErrNotFound if the feature not found.
|
|
sl@0
|
125 |
* Otherwise one of the Symbian error codes.
|
|
sl@0
|
126 |
*/
|
|
sl@0
|
127 |
virtual TInt DeleteFeature( TUid aFeature ) const = 0;
|
|
sl@0
|
128 |
|
|
sl@0
|
129 |
/**
|
|
sl@0
|
130 |
* Lists all supported features.
|
|
sl@0
|
131 |
*
|
|
sl@0
|
132 |
* @param aSupportedFeatures A reference to a client owned RFeatureUidArray
|
|
sl@0
|
133 |
* array which will be filled with the IDs of supported features.
|
|
sl@0
|
134 |
* @return - One of the Symbian error codes.
|
|
sl@0
|
135 |
*/
|
|
sl@0
|
136 |
virtual void ListSupportedFeaturesL( RFeatureUidArray& aSupportedFeatures ) = 0;
|
|
sl@0
|
137 |
|
|
sl@0
|
138 |
/**
|
|
sl@0
|
139 |
* Requests notification for subset of features changes.
|
|
sl@0
|
140 |
*
|
|
sl@0
|
141 |
* @param aFeatures Features, from which client requests notification.
|
|
sl@0
|
142 |
* @param aFeatUid Feature id, which will be set by server on completion.
|
|
sl@0
|
143 |
* @param aStatus Client request to be signaled.
|
|
sl@0
|
144 |
* @return - One of the Symbian error codes.
|
|
sl@0
|
145 |
*/
|
|
sl@0
|
146 |
virtual TInt RequestNotification( RFeatureUidArray& aFeatures, TUid& aFeatUid,
|
|
sl@0
|
147 |
TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
148 |
|
|
sl@0
|
149 |
/**
|
|
sl@0
|
150 |
* Re-requests notification of a feature change.
|
|
sl@0
|
151 |
*
|
|
sl@0
|
152 |
* @param aFeatUid UId of the feature to be re-requested.
|
|
sl@0
|
153 |
* @param aStatus Client request to be signalled asynchronously.
|
|
sl@0
|
154 |
* @return One of the Symbian OS system-wide error codes.
|
|
sl@0
|
155 |
*/
|
|
sl@0
|
156 |
virtual void ReRequestNotification( TUid& aFeatUid, TRequestStatus& aStatus ) = 0;
|
|
sl@0
|
157 |
|
|
sl@0
|
158 |
/**
|
|
sl@0
|
159 |
* Cancel notification request for single feature's changes.
|
|
sl@0
|
160 |
*
|
|
sl@0
|
161 |
* @param aFeature Feature, for which client notification cancellation.
|
|
sl@0
|
162 |
* @return - One of the Symbian error codes.
|
|
sl@0
|
163 |
*/
|
|
sl@0
|
164 |
virtual TInt RequestNotifyCancel( TUid aFeature ) const = 0;
|
|
sl@0
|
165 |
|
|
sl@0
|
166 |
/**
|
|
sl@0
|
167 |
* Cancel notification request for all features changes.
|
|
sl@0
|
168 |
*
|
|
sl@0
|
169 |
* @return - One of the Symbian error codes.
|
|
sl@0
|
170 |
*/
|
|
sl@0
|
171 |
virtual TInt RequestNotifyCancelAll( ) const = 0;
|
|
sl@0
|
172 |
|
|
sl@0
|
173 |
};
|
|
sl@0
|
174 |
|
|
sl@0
|
175 |
#endif // FEATURECLIENT_H
|
|
sl@0
|
176 |
|
|
sl@0
|
177 |
// End of File
|