author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Wed, 13 Oct 2010 14:11:15 +0300 | |
branch | RCL_3 |
changeset 80 | 726fba06891a |
parent 64 | 3533d4323edc |
permissions | -rw-r--r-- |
64 | 1 |
/* |
2 |
* Copyright (c) 2008 - 20010 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: handles interface to CenRep settings |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
||
19 |
#ifndef CMAILCPSSETTINGS_H_ |
|
20 |
#define CMAILCPSSETTINGS_H_ |
|
21 |
||
22 |
#include "PSSubscriber.h" |
|
23 |
#include "PSSubscribeHandler.h" |
|
24 |
||
25 |
class CRepository; |
|
26 |
class CMailExternalAccount; |
|
27 |
||
28 |
/* |
|
29 |
* Callback interface for observer |
|
30 |
* |
|
31 |
* @lib fsmailserver.exe |
|
32 |
* @since S60 v5.1 |
|
33 |
*/ |
|
34 |
class MMailCpsSettingsCallback |
|
35 |
{ |
|
36 |
public: |
|
37 |
/** |
|
38 |
* Callback from CMailCpsSettings class |
|
39 |
* Informs that settings have changed |
|
40 |
* |
|
41 |
* @since S60 v5.1 |
|
42 |
*/ |
|
43 |
virtual void SettingsChangedCallback() = 0; |
|
44 |
}; |
|
45 |
||
46 |
/** |
|
47 |
* CMail ContentPublishingService Settings Handler class |
|
48 |
* Class implementing interface towards cenrep and email widget settings |
|
49 |
* |
|
50 |
* @lib fsmailserver.exe |
|
51 |
* @since S60 v5.1 |
|
52 |
*/ |
|
53 |
NONSHARABLE_CLASS( CMailCpsSettings ) : public CActive, |
|
54 |
public MPSSubscribeHandler |
|
55 |
{ |
|
56 |
public: |
|
57 |
/** |
|
58 |
* Two-phased constructor. |
|
59 |
* @param aMailClient reference to CFSMailClient class. Mailserver offers |
|
60 |
* this for all handlers in order to prevent parallel instantiation |
|
61 |
*/ |
|
62 |
static CMailCpsSettings* NewL( CFSMailClient& aMailClient ); |
|
63 |
||
64 |
/** |
|
65 |
* Destructor. |
|
66 |
*/ |
|
67 |
virtual ~CMailCpsSettings(); |
|
68 |
||
69 |
/** |
|
70 |
* Starts observing CenRep changes |
|
71 |
* @param aObserver will be callbacked once changes occur |
|
72 |
*/ |
|
73 |
void StartObservingL( MMailCpsSettingsCallback* aObserver ); |
|
74 |
||
75 |
/** |
|
76 |
* Stops observing CenRep changes |
|
77 |
*/ |
|
78 |
void StopObserving(); |
|
79 |
||
80 |
/** |
|
81 |
* Gets array of mailboxes that should be published to widget |
|
82 |
* @return array of mailboxes |
|
83 |
*/ |
|
84 |
RArray<TFSMailMsgId>& Mailboxes(); |
|
85 |
||
86 |
/** |
|
87 |
* Gets array of external mailboxes from widget settings |
|
88 |
* @param aAccounts on completion, contains the necessary information of |
|
89 |
* external mailboxes that currently should have a widget |
|
90 |
* transfers ownership of accounts to caller |
|
91 |
*/ |
|
92 |
void GetExtMailboxesL( RPointerArray<CMailExternalAccount>& aAccounts ); |
|
93 |
||
94 |
/** |
|
95 |
* Adds mailbox to widget settings |
|
96 |
* Method ensures that same mailbox is not added again, if it happens |
|
97 |
* to exist already in the settings. If already exists, method simply returns without |
|
98 |
* doing nothing. |
|
99 |
* @param aMailbox Id of the mailbox to add to settings |
|
100 |
*/ |
|
101 |
void AddMailboxL( const TFSMailMsgId aMailbox ); |
|
102 |
||
103 |
/** |
|
104 |
* Removes mailbox from widget settings |
|
105 |
* @param aMailbox Id of the mailbox to remove from settings |
|
106 |
*/ |
|
107 |
void RemoveMailboxL( const TFSMailMsgId aMailbox ); |
|
108 |
||
109 |
/** |
|
110 |
* Gets maximum row count |
|
111 |
* @return maximum row count |
|
112 |
*/ |
|
113 |
TInt MaxRowCount(); |
|
114 |
||
115 |
/** |
|
116 |
* Gets maximum mailbox count |
|
117 |
* @return maximum mailbox count |
|
118 |
*/ |
|
119 |
TInt MaxMailboxCount(); |
|
120 |
||
121 |
/** |
|
122 |
* |
|
123 |
* @return |
|
124 |
*/ |
|
125 |
void AssociateWidgetToSetting( const TDesC& aContentId, |
|
126 |
const TFSMailMsgId aMailbox ); |
|
127 |
||
128 |
/** |
|
129 |
* |
|
130 |
*/ |
|
131 |
void DissociateWidgetFromSettingL( const TDesC& aContentId ); |
|
132 |
||
133 |
/** |
|
134 |
* |
|
135 |
*/ |
|
136 |
void GetContentId( TInt aMailboxId, TInt aNext, TDes16& aValue ); |
|
137 |
||
138 |
/** |
|
139 |
* |
|
140 |
*/ |
|
141 |
TInt WidgetCountByMailbox( TInt aMailboxId ); |
|
142 |
||
143 |
/** |
|
144 |
* |
|
145 |
*/ |
|
146 |
TBool IsSelected( TInt aId ); |
|
147 |
||
148 |
/** |
|
149 |
* |
|
150 |
*/ |
|
151 |
TUint GetMailboxUidByContentId( const TDesC& aContentId ); |
|
152 |
||
153 |
/** |
|
154 |
* |
|
155 |
*/ |
|
156 |
TUint GetPluginUidByContentId( const TDesC& aContentId ); |
|
157 |
||
158 |
/** |
|
159 |
* Gets a bitmasked configuration value (see cmailwidgetcenrepkeysinternal.h) |
|
160 |
* @return bitmasked configuration value |
|
161 |
*/ |
|
162 |
TInt32 Configuration(); |
|
163 |
||
164 |
/** |
|
165 |
* Return total number of all native mailboxes in the system |
|
166 |
*/ |
|
167 |
TInt TotalIntMailboxCount(); |
|
168 |
||
169 |
||
170 |
/** |
|
171 |
* |
|
172 |
*/ |
|
173 |
TBool FindFromContentIdListL( const TDesC& aContentId ); |
|
174 |
||
175 |
/** |
|
176 |
* |
|
177 |
*/ |
|
178 |
void AddToContentIdListL( const TDesC& aContentId ); |
|
179 |
||
180 |
/** |
|
181 |
* |
|
182 |
*/ |
|
183 |
void RemoveFromContentIdListL( const TDesC& aContentId ); |
|
184 |
||
185 |
/** |
|
186 |
* |
|
187 |
*/ |
|
188 |
void ToggleWidgetNewMailIconL( TBool aIconOn, const TFSMailMsgId& aMailBox ); |
|
189 |
||
190 |
/** |
|
191 |
* |
|
192 |
*/ |
|
193 |
TBool GetNewMailStateL( const TFSMailMsgId& aMailBox, TInt aUnreadCount ); |
|
194 |
||
195 |
/** |
|
196 |
* Find next free CenRep key to store setting. |
|
197 |
* @param aContentId Id of widget instance |
|
198 |
* @return true if account is associated to content id, false if not |
|
199 |
*/ |
|
200 |
TBool Associated( const TDesC& aContentId ); |
|
201 |
||
202 |
/** |
|
203 |
* Callback from PSSubscriber about a PS key event |
|
204 |
* @param aCategory defines the key category |
|
205 |
* @param aKey defines the changed key |
|
206 |
*/ |
|
207 |
void HandlePropertyChangedL( const TUid& aCategory, TInt aKey ); |
|
208 |
||
209 |
/** |
|
210 |
* |
|
211 |
*/ |
|
212 |
TBool BackupOrRestoreMode(); |
|
80
726fba06891a
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
64
diff
changeset
|
213 |
|
726fba06891a
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
64
diff
changeset
|
214 |
/** |
726fba06891a
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
64
diff
changeset
|
215 |
* |
726fba06891a
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
64
diff
changeset
|
216 |
*/ |
726fba06891a
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
64
diff
changeset
|
217 |
TInt GetWidgetSetupBrandIconVariant(); |
726fba06891a
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
64
diff
changeset
|
218 |
|
64 | 219 |
protected: |
220 |
/** |
|
221 |
* From CActive |
|
222 |
* Cancellation logic for the asynchronous request |
|
223 |
* |
|
224 |
* @since S60 v5.0 |
|
225 |
*/ |
|
226 |
virtual void DoCancel(); |
|
227 |
||
228 |
/** |
|
229 |
* From CActive |
|
230 |
* |
|
231 |
* @since S60 v5.0 |
|
232 |
*/ |
|
233 |
virtual void RunL(); |
|
234 |
||
235 |
private: |
|
236 |
/** |
|
237 |
* Constructor |
|
238 |
* @param aMailClient reference to CFSMailClient class. Mailserver offers |
|
239 |
* this for all handlers in order to prevent parallel instantiation |
|
240 |
*/ |
|
241 |
CMailCpsSettings( CFSMailClient& aMailClient ); |
|
242 |
||
243 |
void ConstructL(); |
|
244 |
||
245 |
/** |
|
246 |
* Restarts observing after previous notification request was triggered |
|
247 |
*/ |
|
248 |
void StartObservingL(); |
|
249 |
||
250 |
/** |
|
251 |
* Loads settings from CenRep |
|
252 |
*/ |
|
253 |
void LoadSettingsL(); |
|
254 |
||
255 |
/** |
|
256 |
* Loads configuration data from CenRep |
|
257 |
* (This data contains internal configuration data for publishing logic |
|
258 |
* and should not be mixed with user modifiable settings) |
|
259 |
*/ |
|
260 |
void LoadConfigurationL(); |
|
261 |
||
262 |
/** |
|
263 |
* Resolves mailbox based on mailbox id |
|
264 |
* (mailbox id is stored in CenRep as integer) |
|
265 |
* |
|
266 |
* @param aMailboxId mailboxId from CenRep |
|
267 |
* @param aMsg on completion, contains the mailbox Id in TFSMailMsgId format |
|
268 |
* @return KErrNone if mailbox exists |
|
269 |
* @return KErrNotFound if aValue points to non-existent mailbox |
|
270 |
*/ |
|
271 |
TInt ResolveMailbox( const TInt aMailboxId, TFSMailMsgId& aMsg ); |
|
272 |
||
273 |
/** |
|
274 |
* Finds mailbox if plugin id is set - more efficient than Resolve mailbox |
|
275 |
* |
|
276 |
* @param aMsg mailbox both PluginId and Id is checked |
|
277 |
* @return KErrNone if mailbox exists |
|
278 |
* @return KErrNotFound aMsg.Id() points to non-existent mailbox |
|
279 |
**/ |
|
280 |
TInt CheckMailboxExistence( TFSMailMsgId& aMsg ); |
|
281 |
||
282 |
/** |
|
283 |
* Gets array of CenRep keys representing mailboxes configured to widget |
|
284 |
* @param aKeys array of keys |
|
285 |
*/ |
|
286 |
void GetMailboxNonZeroKeysL( RArray<TUint32>& aKeys ); |
|
287 |
||
288 |
/** |
|
289 |
* Gets all the external mailbox identifiers |
|
290 |
* @param on completion, contains an array of cenrep keys that have an external |
|
291 |
* account specified (i.e. not empty) |
|
292 |
*/ |
|
293 |
void GetExtMailboxNonZeroKeysL( RArray<TUint32>& aKeys ); |
|
294 |
||
295 |
/** |
|
296 |
* Find next free CenRep key to store setting. |
|
297 |
* @param aContentId Id of widget instance |
|
298 |
*/ |
|
299 |
TInt GetSettingToAssociate( const TDesC& aContentId ); |
|
300 |
||
301 |
/** |
|
302 |
* Returns CMailExternalAccount::NewL() according to cenrep key aKey |
|
303 |
* @param aKey |
|
304 |
*/ |
|
305 |
CMailExternalAccount* GetExtMailboxL( TInt aKey ); |
|
306 |
||
307 |
private: // data |
|
308 |
// reference to mailclient |
|
309 |
CFSMailClient& iMailClient; |
|
310 |
// pointer to central repository |
|
311 |
CRepository* iCenRep; |
|
312 |
// callback interface |
|
313 |
MMailCpsSettingsCallback* iObserver; |
|
314 |
// array of mailboxes |
|
315 |
RArray<TFSMailMsgId> iMailboxArray; |
|
316 |
// Internal configuration data |
|
317 |
TInt32 iConfigData; |
|
318 |
// large buffer for reading cenrep data |
|
319 |
TBuf<KMaxFileName> iCenrepText; |
|
320 |
// PubSub subsriber for notifying restore operation |
|
321 |
CPSSubscriber* iBackupRestoreSubscriber; |
|
322 |
// Indicates if restore operation is started |
|
323 |
TBool iRestoreStarted; |
|
324 |
// Indicates if backup operation is ongoing |
|
325 |
TBool iBackupOngoing; |
|
326 |
}; |
|
327 |
||
328 |
#endif /*CMAILCPSSETTINGS_H_*/ |