|
1 /* |
|
2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Homescreen content control server API definitions |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef HSCCAPI_H |
|
19 #define HSCCAPI_H |
|
20 |
|
21 // System includes |
|
22 #include <e32base.h> |
|
23 #include <ccsrvapi.h> |
|
24 // Forward declarations |
|
25 |
|
26 // Constants |
|
27 |
|
28 // ---------------------------------------------------------------------------- |
|
29 // Home screen cotent control server messages |
|
30 // ---------------------------------------------------------------------------- |
|
31 enum THsCcSrvMessages |
|
32 { |
|
33 // ---------------------------------------------------------------------------- |
|
34 // WidgetListChangedNtf |
|
35 // ---------------------------------------------------------------------------- |
|
36 // Purpose: |
|
37 // This notification is used to inform api observer of changed widget list |
|
38 // |
|
39 // Message parameters: |
|
40 // - Message id: EHsCcWidgetListChangedNtf |
|
41 // - Transaction id: None |
|
42 // - Message data: None |
|
43 EHsCcWidgetListChangedNtf = ECcProviderMessageBase, |
|
44 // ---------------------------------------------------------------------------- |
|
45 // ViewListChangedNtf |
|
46 // ---------------------------------------------------------------------------- |
|
47 // Purpose: |
|
48 // This notification is used to inform api observer of changed view list |
|
49 // |
|
50 // Message parameters: |
|
51 // - Message id: EHsCcViewListChangedNtf |
|
52 // - Transaction id: None |
|
53 // - Message data: None |
|
54 EHsCcViewListChangedNtf, |
|
55 // ---------------------------------------------------------------------------- |
|
56 // AppListChangedNtf |
|
57 // ---------------------------------------------------------------------------- |
|
58 // Purpose: |
|
59 // This notification is used to inform api observer of changed application list |
|
60 // |
|
61 // Message parameters: |
|
62 // - Message id: EHsCcAppListChangedNtf |
|
63 // - Transaction id: None |
|
64 // - Message data: None |
|
65 EHsCcAppListChangedNtf, |
|
66 // ---------------------------------------------------------------------------- |
|
67 // WidgetListReq |
|
68 // ---------------------------------------------------------------------------- |
|
69 // Purpose: |
|
70 // This request is used to get a list of installed Home screen widgets |
|
71 // |
|
72 // Message parameters: |
|
73 // - Message id: EHsCcWidgetListReq |
|
74 // - Transaction id: Unique transaction id |
|
75 // - Message data: None |
|
76 EHsCcWidgetListReq, |
|
77 // ---------------------------------------------------------------------------- |
|
78 // WidgetListResp |
|
79 // ---------------------------------------------------------------------------- |
|
80 // Purpose: |
|
81 // This response contains the list of installed widgets |
|
82 // |
|
83 // Message parameters: |
|
84 // - Message id: EHsCcWidgetListResp |
|
85 // - Transaction id: Transaction id from corresponding WidgetListReq |
|
86 // - Status: Operation status (Symbian error code) |
|
87 // - Message data: Successful operation: CHsContentInfoArray instance |
|
88 // containing installed widgets |
|
89 // Failed operation: None |
|
90 EHsCcWidgetListResp, |
|
91 // ---------------------------------------------------------------------------- |
|
92 // AddWidgetReq |
|
93 // ---------------------------------------------------------------------------- |
|
94 // Purpose: |
|
95 // This request is used to add a widget to Home screen |
|
96 // |
|
97 // Message parameters: |
|
98 // - Message id: EHsCcAddWidgetReq |
|
99 // - Transaction id: Unique transaction id |
|
100 // - Message data: CHsContentInfo instance defining the added widget |
|
101 EHsCcAddWidgetReq, |
|
102 // ---------------------------------------------------------------------------- |
|
103 // AddWidgetResp |
|
104 // ---------------------------------------------------------------------------- |
|
105 // Purpose: |
|
106 // This response contains the status of adding widget |
|
107 // |
|
108 // Message parameters: |
|
109 // - Message id: EHsCcAddWidgetResp |
|
110 // - Transaction id: Transaction id from corresponding AddWidgetReq |
|
111 // - Status: Operation status (Symbian error code) |
|
112 // - Message data: None |
|
113 EHsCcAddWidgetResp, |
|
114 // ---------------------------------------------------------------------------- |
|
115 // RemoveWidgetReq |
|
116 // ---------------------------------------------------------------------------- |
|
117 // Purpose: |
|
118 // This request is used to remove a widget from Home screen |
|
119 // |
|
120 // Message parameters: |
|
121 // - Message id: EHsCcRemoveWidgetReq |
|
122 // - Transaction id: Unique transaction id |
|
123 // - Message data: CHsContentInfo instance defining the removed widget |
|
124 EHsCcRemoveWidgetReq, |
|
125 // ---------------------------------------------------------------------------- |
|
126 // RemoveWidgetResp |
|
127 // ---------------------------------------------------------------------------- |
|
128 // Purpose: |
|
129 // This response contains the status of removing widget |
|
130 // |
|
131 // Message parameters: |
|
132 // - Message id: EHsCcRemoveWidgetResp |
|
133 // - Transaction id: Transaction id from corresponding RemoveWidgetReq |
|
134 // - Status: Operation status (Symbian error code) |
|
135 // - Message data: None |
|
136 EHsCcRemoveWidgetResp, |
|
137 // ---------------------------------------------------------------------------- |
|
138 // ViewListReq |
|
139 // ---------------------------------------------------------------------------- |
|
140 // Purpose: |
|
141 // This request is used to get a list of installed Home screen views |
|
142 // |
|
143 // Message parameters: |
|
144 // - Message id: EHsCcViewListReq |
|
145 // - Transaction id: Unique transaction id |
|
146 // - Message data: None |
|
147 EHsCcViewListReq, |
|
148 // ---------------------------------------------------------------------------- |
|
149 // ViewListResp |
|
150 // ---------------------------------------------------------------------------- |
|
151 // Purpose: |
|
152 // This response contains the list of installed views |
|
153 // |
|
154 // Message parameters: |
|
155 // - Message id: EHsCcViewListResp |
|
156 // - Transaction id: Transaction id from corresponding ViewListReq |
|
157 // - Status: Operation status (Symbian error code) |
|
158 // - Message data: Successful operation: CHsContentInfoArray instance |
|
159 // containing installed views |
|
160 // Failed operation: None |
|
161 EHsCcViewListResp, |
|
162 // ---------------------------------------------------------------------------- |
|
163 // AddViewReq |
|
164 // ---------------------------------------------------------------------------- |
|
165 // Purpose: |
|
166 // This request is used to add a view to Home screen |
|
167 // |
|
168 // Message parameters: |
|
169 // - Message id: EHsCcAddViewReq |
|
170 // - Transaction id: Unique transaction id |
|
171 // - Message data: CHsContentInfo instance defining the added view |
|
172 EHsCcAddViewReq, |
|
173 // ---------------------------------------------------------------------------- |
|
174 // AddViewResp |
|
175 // ---------------------------------------------------------------------------- |
|
176 // Purpose: |
|
177 // This response contains the status of adding view |
|
178 // |
|
179 // Message parameters: |
|
180 // - Message id: EHsCcAddViewResp |
|
181 // - Transaction id: Transaction id from corresponding AddViewReq |
|
182 // - Status: Operation status (Symbian error code) |
|
183 // - Message data: None |
|
184 EHsCcAddViewResp, |
|
185 // ---------------------------------------------------------------------------- |
|
186 // RemoveViewReq |
|
187 // ---------------------------------------------------------------------------- |
|
188 // Purpose: |
|
189 // This request is used to remove a view from Home screen |
|
190 // |
|
191 // Message parameters: |
|
192 // - Message id: EHsCcRemoveViewReq |
|
193 // - Transaction id: Unique transaction id |
|
194 // - Message data: CHsContentInfo instance defining the removed view |
|
195 EHsCcRemoveViewReq, |
|
196 // ---------------------------------------------------------------------------- |
|
197 // RemoveViewResp |
|
198 // ---------------------------------------------------------------------------- |
|
199 // Purpose: |
|
200 // This response contains the status of removing view |
|
201 // |
|
202 // Message parameters: |
|
203 // - Message id: EHsCcRemoveViewResp |
|
204 // - Transaction id: Transaction id from corresponding RemoveViewReq |
|
205 // - Status: Operation status (Symbian error code) |
|
206 // - Message data: None |
|
207 EHsCcRemoveViewResp, |
|
208 // ---------------------------------------------------------------------------- |
|
209 // ActivateViewReq |
|
210 // ---------------------------------------------------------------------------- |
|
211 // Purpose: |
|
212 // This request is used to activate a Home screen view |
|
213 // |
|
214 // Message parameters: |
|
215 // - Message id: EHsCcActivateViewReq |
|
216 // - Transaction id: Unique transaction id |
|
217 // - Message data: CHsContentInfo instance defining the activated view |
|
218 EHsCcActivateViewReq, |
|
219 // ---------------------------------------------------------------------------- |
|
220 // ActivateViewResp |
|
221 // ---------------------------------------------------------------------------- |
|
222 // Purpose: |
|
223 // This response contains the status of activating view |
|
224 // |
|
225 // Message parameters: |
|
226 // - Message id: EHsCcActivateViewResp |
|
227 // - Transaction id: Transaction id from corresponding ActivateViewReq |
|
228 // - Status: Operation status (Symbian error code) |
|
229 // - Message data: None |
|
230 EHsCcActivateViewResp, |
|
231 // ---------------------------------------------------------------------------- |
|
232 // AppListReq |
|
233 // ---------------------------------------------------------------------------- |
|
234 // Purpose: |
|
235 // This request is used to get a list of installed Home screen application |
|
236 // configurations |
|
237 // |
|
238 // Message parameters: |
|
239 // - Message id: EHsCcAppListReq |
|
240 // - Transaction id: Unique transaction id |
|
241 // - Message data: None |
|
242 EHsCcAppListReq, |
|
243 // ---------------------------------------------------------------------------- |
|
244 // AppListResp |
|
245 // ---------------------------------------------------------------------------- |
|
246 // Purpose: |
|
247 // This response contains the list of installed application configurations |
|
248 // |
|
249 // Message parameters: |
|
250 // - Message id: EHsCcAppListResp |
|
251 // - Transaction id: Transaction id from corresponding AppListReq |
|
252 // - Status: Operation status (Symbian error code) |
|
253 // - Message data: Successful operation: CHsContentInfoArray instance |
|
254 // containing installed application configurations |
|
255 // Failed operation: None |
|
256 EHsCcAppListResp, |
|
257 // ---------------------------------------------------------------------------- |
|
258 // ActivateAppReq |
|
259 // ---------------------------------------------------------------------------- |
|
260 // Purpose: |
|
261 // This request is used to activate a Home screen application configuration |
|
262 // |
|
263 // Message parameters: |
|
264 // - Message id: EHsCcActivateAppReq |
|
265 // - Transaction id: Unique transaction id |
|
266 // - Message data: CHsContentInfo instance defining the activated application |
|
267 // configuration |
|
268 EHsCcActivateAppReq, |
|
269 // ---------------------------------------------------------------------------- |
|
270 // ActivateAppResp |
|
271 // ---------------------------------------------------------------------------- |
|
272 // Purpose: |
|
273 // This response contains the status of activating application configuration |
|
274 // |
|
275 // Message parameters: |
|
276 // - Message id: EHsCcActivateAppResp |
|
277 // - Transaction id: Transaction id from corresponding ActivateAppReq |
|
278 // - Status: Operation status (Symbian error code) |
|
279 // - Message data: None |
|
280 EHsCcActivateAppResp, |
|
281 // ---------------------------------------------------------------------------- |
|
282 // NotSupportedResp |
|
283 // ---------------------------------------------------------------------------- |
|
284 // Purpose: |
|
285 // This request is used to get a list of installed Home screen widgets |
|
286 // |
|
287 // Message parameters: |
|
288 // - Message id: EHsCcNotSupportedResp |
|
289 // - Transaction id: Transaction id from corresponding not supported request |
|
290 // - Status: Operation status KErrNotSupported |
|
291 // - Message data: None |
|
292 EHsCcNotSupportedResp |
|
293 }; |
|
294 |
|
295 #endif // HSCCAPI_H |
|
296 |
|
297 // End of file |