|
1 /* |
|
2 |
|
3 magickey_chipset_api.h |
|
4 |
|
5 |
|
6 |
|
7 Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
8 |
|
9 All rights reserved. |
|
10 |
|
11 |
|
12 |
|
13 This program and the accompanying materials are made available |
|
14 |
|
15 under the terms of the Eclipse Public License v1.0 which accompanies |
|
16 |
|
17 this distribution, and is available at |
|
18 |
|
19 http://www.eclipse.org/legal/epl-v10.html |
|
20 |
|
21 |
|
22 |
|
23 Initial Contributors: |
|
24 |
|
25 Nokia Corporation - initial contribution. |
|
26 |
|
27 |
|
28 |
|
29 Contributors: |
|
30 |
|
31 */ |
|
32 |
|
33 |
|
34 |
|
35 /** @file |
|
36 |
|
37 @brief Chipset API H Template |
|
38 |
|
39 |
|
40 |
|
41 This is a header template for Chipset API work. This template should not be |
|
42 |
|
43 used as a normal code template because the location of where the API is |
|
44 |
|
45 documented is different in normal coding style! Doxygen commenting style tries |
|
46 |
|
47 to be similar what Symbian is using for their kernel side development. |
|
48 |
|
49 |
|
50 |
|
51 You can define here also the scope of the whole API see below, or you can |
|
52 |
|
53 define the scope separately before the class or even before the function if |
|
54 |
|
55 that is needed. |
|
56 |
|
57 |
|
58 |
|
59 @publishedDeviceAbstraction |
|
60 |
|
61 */ |
|
62 |
|
63 |
|
64 |
|
65 #ifndef __MAGICKEY_CHIPSET_API_H__ |
|
66 |
|
67 #define __MAGICKEY_CHIPSET_API_H__ |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 // Include files |
|
74 |
|
75 // Constants |
|
76 |
|
77 /** |
|
78 |
|
79 * Magic key press handling P&S Uid. |
|
80 |
|
81 */ |
|
82 |
|
83 const TUid KUidMagicKeyPress = {0x10204CE3}; |
|
84 |
|
85 |
|
86 |
|
87 /** |
|
88 |
|
89 * Information was the MagicKey1 pressed when the key driver was started. |
|
90 |
|
91 * The keypad driver that is handling MagicKey1 have to publish the information. |
|
92 |
|
93 * @value one of TMagicKeyState enumerations. |
|
94 |
|
95 * @type RProperty::EInt |
|
96 |
|
97 */ |
|
98 |
|
99 const TUint32 KMagicKey1Info = 0x00000001; |
|
100 |
|
101 |
|
102 |
|
103 /** |
|
104 |
|
105 * Information was the MagicKey2 pressed when the key driver was started. |
|
106 |
|
107 * The keypad driver that is handling MagicKey2 have to publish the information. |
|
108 |
|
109 * @value one of TMagicKeyState enumerations. |
|
110 |
|
111 * @type RProperty::EInt |
|
112 |
|
113 */ |
|
114 |
|
115 const TUint32 KMagicKey2Info = 0x00000002; |
|
116 |
|
117 |
|
118 |
|
119 /** |
|
120 |
|
121 * Information was the MagicKey3 pressed when the key driver was started. |
|
122 |
|
123 * The keypad driver that is handling MagicKey3 have to publish the information. |
|
124 |
|
125 * @value one of TMagicKeyState enumerations. |
|
126 |
|
127 * @type RProperty::EInt |
|
128 |
|
129 */ |
|
130 |
|
131 const TUint32 KMagicKey3Info = 0x00000003; |
|
132 |
|
133 |
|
134 |
|
135 // Macros |
|
136 |
|
137 // Data types |
|
138 |
|
139 |
|
140 |
|
141 |
|
142 |
|
143 /** |
|
144 |
|
145 * Enums for checking the magic keys states |
|
146 |
|
147 */ |
|
148 |
|
149 enum TMagicKeyState |
|
150 |
|
151 { |
|
152 |
|
153 EMagicKeyUp, // The magic key was not pressed when the key driver was started |
|
154 |
|
155 EMagicKeyDown // The magic key was pressed when the key driver was started |
|
156 |
|
157 }; |
|
158 |
|
159 |
|
160 |
|
161 // Function prototypes |
|
162 |
|
163 // Forward declarations |
|
164 |
|
165 // Class declaration |
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 #endif // __MAGICKEY_CHIPSET_API_H__ |
|
172 |