author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Tue, 14 Sep 2010 20:58:58 +0300 | |
branch | RCL_3 |
changeset 88 | 3321d3e205b6 |
parent 83 | 5456b4e8b3a8 |
child 102 | ba63c83f4716 |
permissions | -rw-r--r-- |
83 | 1 |
/* |
2 |
* Copyright (c) 2002-2004 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: |
|
15 |
* Avkon adapter for Xuikon |
|
16 |
* |
|
17 |
*/ |
|
18 |
||
19 |
#ifndef XNAPPUIADAPTER_H |
|
20 |
#define XNAPPUIADAPTER_H |
|
21 |
||
22 |
// System includes |
|
23 |
#include <aknViewAppUi.h> |
|
24 |
||
25 |
// User includes |
|
26 |
||
27 |
// Forward declarations |
|
28 |
class TAiFwPublisherInfo; |
|
29 |
class THsPublisherInfo; |
|
30 |
class TXnUiEngineAppIf; |
|
31 |
class CXnNodeAppIf; |
|
32 |
class CXnNode; |
|
33 |
class CXnDomNode; |
|
34 |
class CXnAppUiAdapterImpl; |
|
35 |
class CXnUiEngine; |
|
36 |
class CXnUiStateListener; |
|
37 |
class CXnViewManager; |
|
38 |
class CXnViewAdapter; |
|
39 |
class MHsContentControlUi; |
|
40 |
class CXnEffectManager; |
|
41 |
class MHsContentControl; |
|
42 |
class CXnItemActivator; |
|
88
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
43 |
class CXnViewSwitcher; |
83 | 44 |
|
45 |
// Class declaration |
|
46 |
/** |
|
47 |
* Avkon adapter for Xuikon. |
|
48 |
* |
|
49 |
* @ingroup group_xnlayoutengine |
|
50 |
* @lib xnlayoutengine.lib |
|
51 |
* @since Series 60 3.1 |
|
52 |
*/ |
|
53 |
class CXnAppUiAdapter : public CAknViewAppUi |
|
54 |
{ |
|
55 |
public: |
|
56 |
/** |
|
57 |
* C++ default constructor. |
|
58 |
* |
|
59 |
* @param aApplicationUid Application UID |
|
60 |
*/ |
|
61 |
IMPORT_C CXnAppUiAdapter( TUid aApplicationUid ); |
|
62 |
||
63 |
/** |
|
64 |
* Destructor. |
|
65 |
*/ |
|
66 |
IMPORT_C virtual ~CXnAppUiAdapter(); |
|
67 |
||
68 |
public: |
|
69 |
// New functions |
|
70 |
||
71 |
/** |
|
72 |
* Removes and deregisters view from AppUi |
|
73 |
* |
|
74 |
* @since S60 5.2 |
|
75 |
* @param aView view to deregister |
|
76 |
*/ |
|
77 |
IMPORT_C void RemoveViewL( CAknView& aView ); |
|
78 |
||
79 |
/** |
|
80 |
* Get the UI engine |
|
81 |
* |
|
82 |
* @since Series 60 3.1 |
|
83 |
* @return UI engine |
|
84 |
*/ |
|
85 |
IMPORT_C TXnUiEngineAppIf* UiEngineL(); |
|
86 |
||
87 |
/** |
|
88 |
* Handle interaction notification from the engine |
|
89 |
* |
|
90 |
* @since Series 60 3.1 |
|
91 |
* @param aOrigin Node that originated the event |
|
92 |
* @param aTrigger Trigger information of the event, as created by event |
|
93 |
* originator |
|
94 |
* @param aTriggerDefinition Trigger information as it exists in the action |
|
95 |
* definition in xml |
|
96 |
* @param aEvent Event information of the event |
|
97 |
*/ |
|
98 |
IMPORT_C virtual void HandleXuikonEventL( |
|
99 |
CXnNodeAppIf& aOrigin, |
|
100 |
CXnNodeAppIf& aTrigger, |
|
101 |
CXnDomNode& aTriggerDefinition, |
|
102 |
CXnDomNode& aEvent ); |
|
103 |
||
104 |
/** |
|
105 |
* Handles data plugin loading. |
|
106 |
* To be overriden by subclass. |
|
107 |
* |
|
108 |
* @since S60 5.0 |
|
109 |
* @param aPublisher Publisher to load |
|
110 |
*/ |
|
111 |
IMPORT_C virtual void LoadPublisher( |
|
112 |
const TAiFwPublisherInfo& aPublisher ); |
|
113 |
||
114 |
/** |
|
115 |
* Handles data plugin destroying. |
|
116 |
* To be overriden by subclass. |
|
117 |
* |
|
118 |
* @since S60 5.0 |
|
119 |
* @param aPublisher Publisher to destroy |
|
120 |
*/ |
|
121 |
IMPORT_C virtual void DestroyPublisher( |
|
122 |
const TAiFwPublisherInfo& aPublisher ); |
|
123 |
||
124 |
/** |
|
125 |
* Handles dynamic menuitem element initialisation. |
|
126 |
* To be overriden by subclass. |
|
127 |
* |
|
128 |
* @since S60 5.0 |
|
129 |
* @param aItemType Menuitem type |
|
130 |
* @param aList List of data plugins |
|
131 |
* @return ETrue if menuitem should be shown, EFalse otherwise |
|
132 |
*/ |
|
133 |
IMPORT_C virtual TBool DynInitMenuItemL( |
|
134 |
const TDesC& aItemType, |
|
135 |
RPointerArray< CXnNodeAppIf >* aList = NULL ); |
|
136 |
||
137 |
/* |
|
138 |
* Returns the Xml Ui view as CAknView reference. |
|
139 |
* |
|
140 |
* @since S60 5.0 |
|
141 |
* @return Xml Ui View |
|
142 |
*/ |
|
143 |
IMPORT_C CAknView& CXnAppUiAdapter::View() const; |
|
144 |
||
145 |
/** |
|
146 |
* Handles changes when entering or exiting edit mode |
|
147 |
* To be overriden by subclass. |
|
148 |
* |
|
149 |
* @since S60 5.0 |
|
150 |
* @param aEnter enter or exit edit mode |
|
151 |
*/ |
|
152 |
IMPORT_C virtual void HandleEnterEditModeL( TBool aEnter ); |
|
153 |
||
154 |
/** |
|
155 |
* Routes the events from external rendering plug-ins to content plug-ins. |
|
156 |
* To be overriden by subclass. |
|
157 |
* |
|
158 |
* @since S60 5.2 |
|
159 |
* @param aEvent Event string |
|
160 |
* @param aDestination Destination node for the event |
|
161 |
*/ |
|
162 |
IMPORT_C virtual void HandleEventL( const TDesC& aEvent, |
|
163 |
CXnNodeAppIf& aDestination ); |
|
164 |
||
165 |
/** |
|
166 |
* Constructs THsPublisherInfo from aNode |
|
167 |
* To be overriden by subclass. |
|
168 |
* |
|
169 |
* @since S60 5.2 |
|
170 |
* @param aNode <contentsource> elements |
|
171 |
* @param aInfo Publisher info which is constructed from aNode |
|
172 |
* @return KErrNone if aInfo is succesfully build |
|
173 |
*/ |
|
174 |
EXPORT_C virtual TInt PublisherInfo( CXnNodeAppIf& aNode, |
|
175 |
THsPublisherInfo& aInfo ); |
|
176 |
||
177 |
/** |
|
178 |
* Constructs THsPublisherInfo from aNode |
|
179 |
* |
|
180 |
* @since S60 5.2 |
|
181 |
* @param aNode <contentsource> elements |
|
182 |
* @param aInfo Publisher info which is constructed from aNode |
|
183 |
* @return KErrNone if aInfo is succesfully build |
|
184 |
*/ |
|
185 |
TInt PublisherInfo( CXnNode& aNode, THsPublisherInfo& aInfo ); |
|
186 |
||
187 |
/** |
|
188 |
* This is called when (initial) view is ready |
|
189 |
* To be overriden by subclass. |
|
190 |
* |
|
191 |
* @since S60 5.2 |
|
192 |
*/ |
|
193 |
IMPORT_C virtual void HandleUiReadyEventL(); |
|
194 |
||
195 |
/** |
|
196 |
* Second-phase constructor |
|
197 |
* |
|
198 |
* @since Series 60 3.1 |
|
199 |
*/ |
|
200 |
IMPORT_C void ConstructL(); |
|
201 |
||
202 |
/** |
|
203 |
* From CEikAppUi. |
|
204 |
* |
|
205 |
* @since Series 60 3.1 |
|
206 |
*/ |
|
207 |
IMPORT_C void ProcessMessageL( TUid aUid, const TDesC8& aParams ); |
|
208 |
||
209 |
protected: |
|
210 |
// from CAknViewAppUi |
|
211 |
||
212 |
/** |
|
213 |
* @see CAknViewAppUi |
|
214 |
* |
|
215 |
* @since Series 60 3.1 |
|
216 |
*/ |
|
217 |
IMPORT_C void HandleResourceChangeL( TInt aType ); |
|
218 |
||
219 |
/** |
|
220 |
* @see CAknViewAppUi |
|
221 |
* |
|
222 |
* @since S60 5.2 |
|
223 |
*/ |
|
224 |
IMPORT_C void PrepareToExit(); |
|
225 |
||
226 |
public: |
|
227 |
// new functions |
|
228 |
||
229 |
/** |
|
230 |
* Reloads the UI |
|
231 |
*/ |
|
232 |
void ReloadUiL(); |
|
233 |
||
234 |
/** |
|
235 |
* Gets UiEngine |
|
236 |
* |
|
237 |
* @since S60 5.0 |
|
238 |
* @return UiEngine |
|
239 |
*/ |
|
240 |
CXnUiEngine& UiEngine() const; |
|
241 |
||
242 |
/** |
|
243 |
* Gets ViewManager |
|
244 |
* |
|
245 |
* @since S60 5.0 |
|
246 |
* @return ViewManager |
|
247 |
*/ |
|
248 |
CXnViewManager& ViewManager() const; |
|
249 |
||
250 |
/** |
|
251 |
* Gets ViewAdapter |
|
252 |
* |
|
253 |
* @since S60 5.0 |
|
254 |
* @return ViewAdapter |
|
255 |
*/ |
|
256 |
CXnViewAdapter& ViewAdapter() const; |
|
257 |
||
258 |
/** |
|
259 |
* Gets UiStateListener |
|
260 |
* |
|
261 |
* @since S60 5.0 |
|
262 |
* @return UiStateListener |
|
263 |
*/ |
|
264 |
CXnUiStateListener& UiStateListener() const; |
|
265 |
||
266 |
/** |
|
267 |
* Gets a Content Control UI |
|
268 |
* |
|
269 |
* @since S60 5.0 |
|
270 |
* @param aType Content control UI type |
|
271 |
* @return Interface to content control UI, NULL if not present |
|
272 |
*/ |
|
273 |
MHsContentControlUi* HsContentController( const TDesC8& aType ) const; |
|
274 |
||
275 |
/** |
|
276 |
* Get effect manager |
|
277 |
* |
|
278 |
* @since S60 5.0 |
|
279 |
* @return effect manager |
|
280 |
*/ |
|
281 |
CXnEffectManager* EffectManager() const; |
|
282 |
||
283 |
/** |
|
284 |
* Gets a Content Control server interface |
|
285 |
* |
|
286 |
* @since S60 5.0 |
|
287 |
* @return Interface to content control server, NULL if not present |
|
288 |
*/ |
|
289 |
MHsContentControl* HsContentControlSrv() const; |
|
290 |
||
291 |
/** |
|
292 |
* Gets a Item activator |
|
293 |
* |
|
294 |
* @since S60 5.0 |
|
295 |
* @return Item activator |
|
296 |
*/ |
|
297 |
CXnItemActivator& ItemActivator() const; |
|
298 |
||
299 |
/** |
|
300 |
* Queries whether the focus control is visible |
|
301 |
* |
|
302 |
* @since S60 5.0 |
|
303 |
* @return ETrue focus is shown, EFalse otherwise |
|
304 |
*/ |
|
305 |
TBool FocusShown() const; |
|
306 |
||
307 |
/** |
|
308 |
* Makes focus control invisible |
|
309 |
* |
|
310 |
* @since S60 5.0 |
|
311 |
*/ |
|
312 |
void HideFocus(); |
|
313 |
||
314 |
/** |
|
315 |
* Makes focus control visible |
|
316 |
* |
|
317 |
* @since S60 5.0 |
|
318 |
*/ |
|
319 |
void ShowFocus(); |
|
320 |
||
88
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
321 |
/** |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
322 |
* View switcher helper. |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
323 |
* |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
324 |
* @since S60 5.0 |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
325 |
*/ |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
326 |
CXnViewSwitcher* ViewSwitcher(); |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
327 |
|
83 | 328 |
private: |
329 |
// Data |
|
330 |
||
331 |
/** |
|
332 |
* flag for application exit |
|
333 |
*/ |
|
334 |
TBool iExitingApp; |
|
335 |
||
336 |
/** |
|
337 |
* application uid |
|
338 |
*/ |
|
339 |
TUid iApplicationUid; |
|
340 |
||
341 |
/** |
|
342 |
* appui adapter impl. |
|
343 |
* Own. |
|
344 |
*/ |
|
345 |
CXnAppUiAdapterImpl* iImpl; |
|
346 |
||
347 |
/** |
|
348 |
* Proxy to UiEngine. |
|
349 |
* Own. |
|
350 |
*/ |
|
351 |
TXnUiEngineAppIf* iUiEngineAppIf; |
|
88
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
352 |
|
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
353 |
/** |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
354 |
* View switcher scrolls view when finger follow is used. |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
355 |
* Own. |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
356 |
*/ |
3321d3e205b6
Revision: 201033
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
357 |
CXnViewSwitcher* iViewSwitcher; |
83 | 358 |
}; |
359 |
||
360 |
#endif |
|
361 |
||
362 |
// End of file |