author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Wed, 15 Sep 2010 12:00:00 +0300 | |
branch | RCL_3 |
changeset 93 | b01126ce0bec |
parent 83 | 5456b4e8b3a8 |
child 102 | ba63c83f4716 |
permissions | -rw-r--r-- |
83 | 1 |
/* |
2 |
* Copyright (c) 2009 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 |
* widget manager plugin declaration |
|
16 |
* |
|
17 |
*/ |
|
18 |
||
19 |
#ifndef __WMPLUGIN_ |
|
20 |
#define __WMPLUGIN_ |
|
21 |
||
22 |
// INCLUDES |
|
23 |
#include <e32base.h> |
|
24 |
#include <vwsdef.h> |
|
25 |
||
26 |
#include <hscontentcontrolui.h> |
|
27 |
#include <hscontentcontroller.h> |
|
28 |
#include <hscontentinfo.h> |
|
29 |
||
30 |
class CAknViewAppUi; |
|
31 |
class CWmResourceLoader; |
|
32 |
class CWmMainContainer; |
|
33 |
class CWmEffectManager; |
|
34 |
class CWmWidgetData; |
|
35 |
class CWmInstaller; |
|
93
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
36 |
class CWmConfiguration; |
83 | 37 |
|
38 |
/** |
|
39 |
* CWmPlugin |
|
40 |
*/ |
|
41 |
NONSHARABLE_CLASS( CWmPlugin ) : public CHsContentControlUi |
|
42 |
{ |
|
43 |
public: |
|
44 |
||
45 |
/** |
|
46 |
* Two-phased constructor. |
|
47 |
*/ |
|
48 |
static CWmPlugin* NewL(); |
|
49 |
||
50 |
/** Destructor */ |
|
51 |
~CWmPlugin(); |
|
52 |
||
53 |
public: // From MHsContentControlUi |
|
54 |
||
55 |
/** |
|
56 |
* shows the widget manager UI |
|
57 |
* |
|
58 |
* @see MHsContentControlUi::Activate |
|
59 |
*/ |
|
60 |
void Activate(); |
|
61 |
||
62 |
/** |
|
63 |
* notification for widget manager UI that its |
|
64 |
* deactivated and plugin is about to be destroyed. |
|
65 |
* |
|
66 |
* @see MHsContentControlUi::DeActivate |
|
67 |
*/ |
|
68 |
void DeActivate(); |
|
69 |
||
70 |
/** |
|
71 |
* returns array of AknViews which were added to |
|
72 |
* AknViewAppUi by this plugin. |
|
73 |
* |
|
74 |
* @see MHsContentControlUi::Views |
|
75 |
*/ |
|
76 |
void Views( RPointerArray<CAknView>& aViews ); |
|
77 |
||
78 |
/** |
|
79 |
* Notifies widget list changes |
|
80 |
* |
|
81 |
* @see MHsContentControlUi::NotifyWidgetListChanged |
|
82 |
*/ |
|
83 |
void NotifyWidgetListChanged(); |
|
84 |
||
85 |
public: // plugin services |
|
86 |
||
87 |
/** |
|
88 |
* whether widget manager UI is showing |
|
89 |
* |
|
90 |
* @return return ETrue if wm UI is showed |
|
91 |
*/ |
|
92 |
TBool IsActive(); |
|
93 |
||
94 |
/** |
|
95 |
* hides widget manager UI |
|
96 |
*/ |
|
97 |
void CloseView(); |
|
98 |
||
99 |
/** |
|
100 |
* main view activated. Sets the previous view ID and main container |
|
101 |
* |
|
102 |
* @param aPreviousViewId |
|
103 |
* @param aWmMainContainer |
|
104 |
*/ |
|
105 |
void MainViewActivated( |
|
106 |
const TVwsViewId& aPreviousViewId, |
|
107 |
CWmMainContainer* aWmMainContainer ); |
|
108 |
||
109 |
/** |
|
110 |
* main view was deactivated |
|
111 |
*/ |
|
112 |
void MainViewDeactivated(); |
|
113 |
||
114 |
/** Postponed command to execute when widgetmanager has deactivated */ |
|
115 |
enum TCommand |
|
116 |
{ |
|
117 |
/** no command */ |
|
118 |
ENone, |
|
119 |
/** add content to home screen */ |
|
120 |
EAddToHomescreen |
|
121 |
}; |
|
122 |
||
123 |
/** |
|
124 |
* Sets a postponed command. The postponed command will be executed after |
|
125 |
* widget manager has been deactivated. |
|
126 |
* |
|
127 |
* @param aCommand the command to be executed |
|
128 |
* @param aContent content parameter related to the command |
|
129 |
*/ |
|
130 |
void SetPostponedCommandL( |
|
131 |
TCommand aCommand, CHsContentInfo& aContent ); |
|
132 |
||
133 |
/** |
|
134 |
* the CAknViewAppUi reference |
|
135 |
* |
|
136 |
* @return returns CAknViewAppUi |
|
137 |
*/ |
|
138 |
CAknViewAppUi& ViewAppUi(); |
|
139 |
||
140 |
/** |
|
141 |
* the resource loader |
|
142 |
* |
|
143 |
* @return returns CWmResourceLoader |
|
144 |
*/ |
|
145 |
CWmResourceLoader& ResourceLoader(); |
|
146 |
||
147 |
/** |
|
148 |
* the content controller ref |
|
149 |
* |
|
150 |
* @return returns MHsContentController |
|
151 |
*/ |
|
152 |
MHsContentController& ContentController(); |
|
153 |
||
154 |
/** |
|
155 |
* the shared file server reference |
|
156 |
*/ |
|
157 |
RFs& FileServer(); |
|
158 |
||
159 |
/** prestored action to be executed. */ |
|
160 |
void DoExecuteCommand(); |
|
161 |
||
162 |
/** callback function for launcher */ |
|
163 |
static TInt ExecuteCommand( TAny* aSelf ); |
|
164 |
||
165 |
/** |
|
166 |
* reference to iWmInstaller |
|
167 |
*/ |
|
168 |
CWmInstaller& WmInstaller(); |
|
169 |
||
170 |
/** |
|
93
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
171 |
* reference to iWmConfiguration |
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
172 |
*/ |
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
173 |
CWmConfiguration& Configuration(); |
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
174 |
|
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
175 |
/** |
83 | 176 |
* Get widget by Uid. Used for getting widget details |
177 |
* when error has occured during uninstallation. |
|
178 |
* @param aUid Uid of widget |
|
179 |
*/ |
|
180 |
CWmWidgetData* GetUninstalledWidgetByUid( TUid aUid ); |
|
181 |
||
182 |
private: |
|
183 |
/** constructor */ |
|
184 |
CWmPlugin(); |
|
185 |
/** 2nd phase constructor */ |
|
186 |
void ConstructL(); |
|
187 |
||
188 |
/** |
|
189 |
* Sets forwarding numeric keys to phone. |
|
190 |
* |
|
191 |
* @param aEnabled ETrue if numeric keys are forwarded to phone |
|
192 |
*/ |
|
193 |
void ForwardNumericKeysToPhone( TBool aEnabled ); |
|
194 |
||
195 |
/** |
|
196 |
* Shows error note. |
|
197 |
* |
|
198 |
* @parama aError Error to be shown. |
|
199 |
*/ |
|
200 |
void ShowErrorNoteL( TInt aError ); |
|
201 |
||
202 |
private: // data members |
|
203 |
||
204 |
/** |
|
205 |
* the host application view app UI (not owned) |
|
206 |
*/ |
|
207 |
CAknViewAppUi* iViewAppUi; |
|
208 |
||
209 |
/** |
|
210 |
* main container (not owned) |
|
211 |
*/ |
|
212 |
CWmMainContainer* iWmMainContainer; |
|
213 |
||
214 |
/** |
|
215 |
* resource loader |
|
216 |
*/ |
|
217 |
CWmResourceLoader* iResourceLoader; |
|
218 |
||
219 |
/** |
|
220 |
* previous view ID (shown when main view closed) |
|
221 |
*/ |
|
222 |
TVwsViewId iPreviousViewUid; |
|
223 |
||
224 |
/** |
|
225 |
* Takes care of fancy UI effects |
|
226 |
*/ |
|
227 |
CWmEffectManager* iEffectManager; |
|
228 |
||
229 |
/** |
|
230 |
* The file server session |
|
231 |
*/ |
|
232 |
RFs* iFs; |
|
233 |
||
234 |
/** |
|
235 |
* command to be executed when widgetmanager has |
|
236 |
* been deactivated |
|
237 |
*/ |
|
238 |
TCommand iPostponedCommand; |
|
239 |
||
240 |
/** |
|
241 |
* content info as parameter to iPostponedCommand |
|
242 |
*/ |
|
243 |
CHsContentInfo* iPostponedContent; |
|
244 |
||
245 |
/* |
|
246 |
* Handles installation |
|
247 |
*/ |
|
248 |
CWmInstaller* iWmInstaller; |
|
249 |
||
250 |
/** |
|
251 |
* Used for adding widgets to homescreen. |
|
252 |
*/ |
|
253 |
CPeriodic* iLauncher; |
|
254 |
||
255 |
/** |
|
256 |
* Counter for execute command delay. |
|
257 |
*/ |
|
258 |
TInt iExecutionCount; |
|
259 |
||
93
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
260 |
/** |
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
261 |
* The configuration |
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
262 |
*/ |
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
263 |
CWmConfiguration* iConfiguration; |
b01126ce0bec
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
83
diff
changeset
|
264 |
|
83 | 265 |
#ifdef _WM_UNIT_TEST |
266 |
friend class CWmUnitTest; |
|
267 |
#endif |
|
268 |
}; |
|
269 |
||
270 |
#endif // __WMPLUGIN_ |
|
271 |