|
sl@0
|
1 |
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// Public interface for querying support for features on a device, and
|
|
sl@0
|
15 |
// subscribing for notification if any features are added or removed.
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
//
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#ifndef FEATREG_H
|
|
sl@0
|
20 |
#define FEATREG_H
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
/**
|
|
sl@0
|
23 |
* Interface for inquiring whether features are supported on the device.
|
|
sl@0
|
24 |
*
|
|
sl@0
|
25 |
* The code segment below shows an example of how the QuerySupport() API
|
|
sl@0
|
26 |
* should be used in client code that checks feature status.
|
|
sl@0
|
27 |
*
|
|
sl@0
|
28 |
* @code
|
|
sl@0
|
29 |
*
|
|
sl@0
|
30 |
* // Single query
|
|
sl@0
|
31 |
* //
|
|
sl@0
|
32 |
* TBool haveUsb = RFeatureRegistry::QuerySupportS(NFeature::KUsb) > 0;
|
|
sl@0
|
33 |
* if (haveUsb)
|
|
sl@0
|
34 |
* { // ... connect to USB service ...
|
|
sl@0
|
35 |
* }
|
|
sl@0
|
36 |
*
|
|
sl@0
|
37 |
* // or Multiple queries
|
|
sl@0
|
38 |
* //
|
|
sl@0
|
39 |
* RFeatureRegistry featReg;
|
|
sl@0
|
40 |
* const TBool opened = (featReg.Open() == KErrNone);
|
|
sl@0
|
41 |
* iHaveUsb = opened && (featReg.QuerySupport(NFeature::KUsb) > 0);
|
|
sl@0
|
42 |
* iHaveBluetooth = opened && (featReg.QuerySupport(NFeature::KBluetooth) > 0);
|
|
sl@0
|
43 |
* featReg.Close(); // can always call Close(), even if Open() failed:
|
|
sl@0
|
44 |
* // ... proceed to update application menus based on these featue flags
|
|
sl@0
|
45 |
*
|
|
sl@0
|
46 |
* @endcode
|
|
sl@0
|
47 |
*
|
|
sl@0
|
48 |
* Note the QuerySupport() API can return a negative error code. Clients
|
|
sl@0
|
49 |
* calling this API need to decide if this should result in specific error
|
|
sl@0
|
50 |
* handling or whether ignoring the error and assuming the feature is not
|
|
sl@0
|
51 |
* supported is the best policy.
|
|
sl@0
|
52 |
*
|
|
sl@0
|
53 |
* @see RFeatureRegistry::QuerySupportS
|
|
sl@0
|
54 |
* @publishedPartner
|
|
sl@0
|
55 |
* @deprecated
|
|
sl@0
|
56 |
*/
|
|
sl@0
|
57 |
NONSHARABLE_CLASS(RFeatureRegistry)
|
|
sl@0
|
58 |
{
|
|
sl@0
|
59 |
public:
|
|
sl@0
|
60 |
/**
|
|
sl@0
|
61 |
* Bit assignments in status word for listed features
|
|
sl@0
|
62 |
*
|
|
sl@0
|
63 |
* @internalComponent
|
|
sl@0
|
64 |
*/
|
|
sl@0
|
65 |
enum
|
|
sl@0
|
66 |
{
|
|
sl@0
|
67 |
EStatusSupportBit = 1,
|
|
sl@0
|
68 |
EStatusUpgradableBit = 2
|
|
sl@0
|
69 |
};
|
|
sl@0
|
70 |
inline RFeatureRegistry();
|
|
sl@0
|
71 |
IMPORT_C TInt Open();
|
|
sl@0
|
72 |
IMPORT_C TInt QuerySupport(TUid aFeatureUid);
|
|
sl@0
|
73 |
IMPORT_C TInt QuerySupport(TUid aFeatureUid, TUint32& aInfo);
|
|
sl@0
|
74 |
IMPORT_C void Close();
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
IMPORT_C static TInt QuerySupportS(TUid aFeatureUid);
|
|
sl@0
|
77 |
IMPORT_C static TInt QuerySupportS(TUid aFeatureUid, TUint32& aInfo);
|
|
sl@0
|
78 |
|
|
sl@0
|
79 |
private:
|
|
sl@0
|
80 |
class TImpl;
|
|
sl@0
|
81 |
TImpl* iImpl;
|
|
sl@0
|
82 |
};
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
#ifndef SYMBIAN_FEATURE_MANAGER
|
|
sl@0
|
85 |
/**
|
|
sl@0
|
86 |
* Interface for obtaining notification of changes in the Feature Registry.
|
|
sl@0
|
87 |
*
|
|
sl@0
|
88 |
* @internalComponent
|
|
sl@0
|
89 |
*/
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
NONSHARABLE_CLASS(RFeatureRegistryNotify)
|
|
sl@0
|
92 |
{
|
|
sl@0
|
93 |
public:
|
|
sl@0
|
94 |
inline RFeatureRegistryNotify();
|
|
sl@0
|
95 |
IMPORT_C TInt Open();
|
|
sl@0
|
96 |
IMPORT_C void Subscribe(TRequestStatus &aNotifyStatus);
|
|
sl@0
|
97 |
IMPORT_C void Cancel();
|
|
sl@0
|
98 |
IMPORT_C void Close();
|
|
sl@0
|
99 |
|
|
sl@0
|
100 |
private:
|
|
sl@0
|
101 |
class TImpl;
|
|
sl@0
|
102 |
TImpl* iImpl;
|
|
sl@0
|
103 |
};
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
#endif
|
|
sl@0
|
106 |
|
|
sl@0
|
107 |
#include <featreg.inl>
|
|
sl@0
|
108 |
|
|
sl@0
|
109 |
#endif
|