|
85
|
1 |
/*
|
|
98
|
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:
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
85
|
17 |
#ifndef C_WIDGETDESCRIPTION_H
|
|
|
18 |
#define C_WIDGETDESCRIPTION_H
|
|
|
19 |
|
|
|
20 |
// INCLUDES
|
|
|
21 |
#include <e32base.h>
|
|
|
22 |
// CONSTANTS
|
|
|
23 |
|
|
|
24 |
// FORWARD DECLARATIONS
|
|
|
25 |
class CCaInnerEntry;
|
|
|
26 |
|
|
|
27 |
/**
|
|
|
28 |
* Widget Parser
|
|
|
29 |
*
|
|
|
30 |
* @since Series Series60 5.x
|
|
|
31 |
*/
|
|
|
32 |
class CCaWidgetDescription : public CBase
|
|
|
33 |
{
|
|
|
34 |
|
|
|
35 |
public:
|
|
|
36 |
// Constructors and destructor
|
|
|
37 |
|
|
|
38 |
/**
|
|
|
39 |
* Two-phased constructor.
|
|
|
40 |
*/
|
|
|
41 |
static CCaWidgetDescription* NewL( );
|
|
|
42 |
static CCaWidgetDescription* NewLC( );
|
|
|
43 |
static CCaWidgetDescription* NewLC( CCaInnerEntry* aEntry );
|
|
|
44 |
|
|
|
45 |
/**
|
|
|
46 |
* Destructor.
|
|
|
47 |
*/
|
|
|
48 |
virtual ~CCaWidgetDescription();
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Static method to compare two CCaWidgetDescription objects
|
|
98
|
52 |
* used in Find() method
|
|
85
|
53 |
* @param aFirst first item to compare
|
|
|
54 |
* @param aSecond second item to compare
|
|
98
|
55 |
* @return ETrue if widget uri value is the same in both objects,
|
|
85
|
56 |
* otherwise returns EFalse
|
|
|
57 |
*/
|
|
|
58 |
static TBool Compare( const CCaWidgetDescription& aFirst,
|
|
98
|
59 |
const CCaWidgetDescription& aSecond );
|
|
85
|
60 |
|
|
|
61 |
/**
|
|
|
62 |
* Method to compare two CCaWidgetDescription objects
|
|
|
63 |
* @param aToCompare first item to compare
|
|
|
64 |
* @return ETrue if all value is the same in both objects,
|
|
|
65 |
* otherwise returns EFalse
|
|
|
66 |
*/
|
|
|
67 |
TBool Compare( const CCaWidgetDescription& aToCompare );
|
|
|
68 |
|
|
|
69 |
/*
|
|
|
70 |
* MMC id setter
|
|
|
71 |
* @param aMmcId MMC id
|
|
|
72 |
*/
|
|
93
|
73 |
void SetMmcIdL( const TDesC& aMmcId );
|
|
85
|
74 |
|
|
|
75 |
/*
|
|
|
76 |
* PackageUid setter
|
|
|
77 |
* @param aPackageUid package UID
|
|
|
78 |
*/
|
|
|
79 |
void SetPackageUidL( const TDesC& aPackageUid );
|
|
|
80 |
|
|
|
81 |
/*
|
|
98
|
82 |
* PackageUid getter
|
|
|
83 |
* @return iPackageUid - package UID
|
|
|
84 |
*/
|
|
|
85 |
TUint GetPackageUidL();
|
|
|
86 |
|
|
|
87 |
/*
|
|
85
|
88 |
* Title setter
|
|
|
89 |
* @param aTitle widget title
|
|
|
90 |
*/
|
|
|
91 |
void SetTitleL( const TDesC& aTitle );
|
|
|
92 |
|
|
|
93 |
/*
|
|
|
94 |
* Description setter
|
|
|
95 |
* @param aTitle widget title
|
|
|
96 |
*/
|
|
|
97 |
void SetDescriptionL( const TDesC& aDescription );
|
|
|
98 |
|
|
|
99 |
/*
|
|
|
100 |
* Uri setter
|
|
|
101 |
* @param aUri widget uri
|
|
|
102 |
*/
|
|
|
103 |
void SetUriL( const TDesC& aUri );
|
|
|
104 |
|
|
|
105 |
/*
|
|
|
106 |
* Icon Uri setter
|
|
|
107 |
* @param aIconUri widget icon uri
|
|
|
108 |
*/
|
|
|
109 |
void SetIconUriL( const TDesC& aIconUri );
|
|
|
110 |
|
|
|
111 |
/*
|
|
98
|
112 |
* Preview image name setter.
|
|
|
113 |
* @param aPreview preview image name identifier.
|
|
|
114 |
*/
|
|
|
115 |
void SetPreviewImageNameL( const TDesC& aPreviewName );
|
|
|
116 |
|
|
|
117 |
/*
|
|
85
|
118 |
* Library setter
|
|
|
119 |
* @param aLibrary widget library
|
|
|
120 |
*/
|
|
|
121 |
void SetLibraryL( const TDesC& aLibrary );
|
|
|
122 |
|
|
|
123 |
/*
|
|
98
|
124 |
* Content storage entry id getter
|
|
|
125 |
* @return CS entry id
|
|
85
|
126 |
*/
|
|
98
|
127 |
TInt GetEntryId() const;
|
|
85
|
128 |
|
|
|
129 |
/*
|
|
|
130 |
* MMC id getter
|
|
|
131 |
* @return CA entry id
|
|
|
132 |
*/
|
|
98
|
133 |
TPtrC GetMmcId() const;
|
|
|
134 |
|
|
85
|
135 |
/*
|
|
|
136 |
* Library getter
|
|
|
137 |
* @return widget library
|
|
|
138 |
*/
|
|
98
|
139 |
TPtrC GetLibrary() const;
|
|
85
|
140 |
|
|
|
141 |
/*
|
|
|
142 |
* Description getter
|
|
|
143 |
* @return widget Description
|
|
|
144 |
*/
|
|
98
|
145 |
TPtrC GetDescription() const;
|
|
85
|
146 |
|
|
|
147 |
/*
|
|
|
148 |
* Uri getter
|
|
|
149 |
* @return widget Uri
|
|
|
150 |
*/
|
|
98
|
151 |
TPtrC GetUri() const;
|
|
85
|
152 |
|
|
|
153 |
/*
|
|
|
154 |
* IconUri getter
|
|
|
155 |
* @return widget IconUri
|
|
|
156 |
*/
|
|
98
|
157 |
TPtrC GetIconUri() const;
|
|
85
|
158 |
|
|
|
159 |
/*
|
|
98
|
160 |
* Preview image name getter
|
|
|
161 |
* @return widget preview image name
|
|
|
162 |
*/
|
|
|
163 |
TPtrC GetPreviewImageName( ) const;
|
|
|
164 |
|
|
|
165 |
/*
|
|
85
|
166 |
* Title getter
|
|
98
|
167 |
* @return widget title
|
|
85
|
168 |
*/
|
|
98
|
169 |
TPtrC GetTitle() const;
|
|
85
|
170 |
|
|
|
171 |
/*
|
|
|
172 |
* Missing flag
|
|
|
173 |
* @return ETrue if flag missing is set
|
|
|
174 |
*/
|
|
98
|
175 |
TBool IsMissing() const;
|
|
85
|
176 |
|
|
|
177 |
/*
|
|
87
|
178 |
* Used flag
|
|
|
179 |
* @return ETrue if flag used is set
|
|
|
180 |
*/
|
|
98
|
181 |
TBool IsUsed() const;
|
|
93
|
182 |
|
|
|
183 |
/*
|
|
|
184 |
* Used flag
|
|
|
185 |
* @return ETrue if flag visible is set
|
|
|
186 |
*/
|
|
98
|
187 |
TBool IsVisible() const;
|
|
93
|
188 |
|
|
87
|
189 |
/*
|
|
85
|
190 |
* Entry getter
|
|
|
191 |
* @return entry representing widget
|
|
|
192 |
*/
|
|
98
|
193 |
CCaInnerEntry* GetEntryLC() const;
|
|
93
|
194 |
|
|
87
|
195 |
/*
|
|
|
196 |
* Modification time setter
|
|
|
197 |
* @param aModificationTime
|
|
|
198 |
*/
|
|
|
199 |
void SetModificationTimeL( const TDesC& aModificationTime );
|
|
|
200 |
|
|
|
201 |
/*
|
|
|
202 |
* Modification time getter
|
|
|
203 |
* @return widget Modification time
|
|
|
204 |
*/
|
|
93
|
205 |
TPtrC GetModificationTime() const;
|
|
|
206 |
|
|
|
207 |
/*
|
|
|
208 |
* Remove MMC id.
|
|
|
209 |
*/
|
|
|
210 |
void RemoveMmcId();
|
|
|
211 |
/*
|
|
|
212 |
* Set service fw xml filename
|
|
|
213 |
* @param aServiceXml Service xml filename
|
|
|
214 |
*/
|
|
98
|
215 |
void SetServiceXmlL( const TDesC& aServiceXml );
|
|
93
|
216 |
/*
|
|
|
217 |
* Get service fw xml filename
|
|
|
218 |
* @return Service xml filename
|
|
|
219 |
*/
|
|
|
220 |
TPtrC GetServiceXml() const;
|
|
98
|
221 |
|
|
96
|
222 |
/*
|
|
98
|
223 |
/*
|
|
|
224 |
* Localizes title and description, fill string id fields
|
|
|
225 |
*/
|
|
96
|
226 |
void LocalizeTextsL();
|
|
98
|
227 |
|
|
96
|
228 |
/*
|
|
|
229 |
* StringIdDescription time getter
|
|
|
230 |
* @return StringIdDescription
|
|
|
231 |
*/
|
|
|
232 |
TPtrC GetStringIdDescription() const;
|
|
98
|
233 |
|
|
96
|
234 |
/*
|
|
|
235 |
* StringIdTitle time getter
|
|
|
236 |
* @return widget StringIdTitle
|
|
|
237 |
*/
|
|
|
238 |
TPtrC GetStringIdTitle() const;
|
|
98
|
239 |
|
|
|
240 |
/*
|
|
94
|
241 |
* Set manifest file path name.
|
|
|
242 |
* @param aServiceXml Manifest file path name.
|
|
|
243 |
*/
|
|
98
|
244 |
void SetManifestFilePathNameL( const TDesC& aManifestFilePathName );
|
|
|
245 |
|
|
94
|
246 |
/*
|
|
|
247 |
* Get manifest file path name.
|
|
|
248 |
* @return Manifest file path name.
|
|
|
249 |
*/
|
|
|
250 |
TPtrC GetManifestFilePathName() const;
|
|
96
|
251 |
|
|
98
|
252 |
/*
|
|
|
253 |
* Set logical string for description.
|
|
|
254 |
* @param aStringIdDescription logical string for description.
|
|
|
255 |
*/
|
|
96
|
256 |
void SetStringIdDescriptionL( const TDesC& aStringIdDescription );
|
|
|
257 |
|
|
98
|
258 |
/*
|
|
|
259 |
* Set logical string for title.
|
|
|
260 |
* @param aStringIdTitle logical string for title.
|
|
|
261 |
*/
|
|
96
|
262 |
void SetStringidTitleL( const TDesC& aStringIdTitle );
|
|
|
263 |
|
|
85
|
264 |
/*
|
|
|
265 |
* Flag setter
|
|
|
266 |
* @param aFlag flag
|
|
|
267 |
* @param aValue flag value
|
|
|
268 |
*/
|
|
|
269 |
void SetFlag( TInt aFlag, TBool aValue );
|
|
|
270 |
|
|
98
|
271 |
/*
|
|
|
272 |
* Valid setter
|
|
|
273 |
* @param aVal value
|
|
|
274 |
*/
|
|
|
275 |
void SetValid(TBool aVal);
|
|
|
276 |
|
|
|
277 |
/*
|
|
|
278 |
* Valid getter
|
|
|
279 |
* @return valid value
|
|
|
280 |
*/
|
|
|
281 |
TBool CCaWidgetDescription::IsValid();
|
|
|
282 |
|
|
|
283 |
/*
|
|
|
284 |
* Library name getter
|
|
|
285 |
* @return libraru name
|
|
|
286 |
*/
|
|
|
287 |
TPtrC GetLibraryName() const;
|
|
|
288 |
|
|
85
|
289 |
|
|
|
290 |
/**
|
|
|
291 |
* C++ default constructor.
|
|
|
292 |
*/
|
|
|
293 |
CCaWidgetDescription();
|
|
|
294 |
|
|
|
295 |
/**
|
|
|
296 |
* By default Symbian 2nd phase constructor is private.
|
|
|
297 |
*/
|
|
98
|
298 |
void ConstructL();
|
|
85
|
299 |
void ConstructL( CCaInnerEntry* aEntry );
|
|
|
300 |
|
|
|
301 |
// Data
|
|
|
302 |
|
|
|
303 |
/*
|
|
|
304 |
* Content Storage entry id
|
|
|
305 |
*/
|
|
|
306 |
TInt iEntryId;
|
|
98
|
307 |
|
|
|
308 |
/*
|
|
|
309 |
* Marks vidget as valid, used to remove widgets
|
|
|
310 |
*/
|
|
|
311 |
TBool iValid;
|
|
85
|
312 |
|
|
|
313 |
/*
|
|
|
314 |
* Package UID
|
|
|
315 |
*/
|
|
|
316 |
TUint iPackageUid;
|
|
|
317 |
|
|
|
318 |
/*
|
|
|
319 |
* MMC id
|
|
|
320 |
*/
|
|
93
|
321 |
RBuf iMmcId;
|
|
85
|
322 |
|
|
|
323 |
/*
|
|
|
324 |
* Widget title. Own
|
|
|
325 |
*/
|
|
|
326 |
RBuf iTitle;
|
|
|
327 |
|
|
|
328 |
/*
|
|
|
329 |
* Widget description. Own
|
|
|
330 |
*/
|
|
|
331 |
RBuf iDescription;
|
|
|
332 |
|
|
|
333 |
/*
|
|
|
334 |
* Widget uri. Own
|
|
|
335 |
*/
|
|
|
336 |
RBuf iUri;
|
|
|
337 |
|
|
|
338 |
/*
|
|
|
339 |
* Widget icon uri. Own
|
|
|
340 |
*/
|
|
|
341 |
RBuf iIconUri;
|
|
98
|
342 |
|
|
89
|
343 |
/*
|
|
98
|
344 |
* Preview name. Own
|
|
89
|
345 |
*/
|
|
98
|
346 |
RBuf iPreviewImageName;
|
|
85
|
347 |
/*
|
|
|
348 |
* Widget library. Own
|
|
|
349 |
*/
|
|
|
350 |
RBuf iLibrary;
|
|
|
351 |
|
|
|
352 |
/*
|
|
|
353 |
* Widgets flags.
|
|
|
354 |
*/
|
|
|
355 |
TInt iFlags;
|
|
93
|
356 |
|
|
87
|
357 |
/*
|
|
|
358 |
* Modification time.
|
|
|
359 |
*/
|
|
|
360 |
RBuf iModificationTime;
|
|
93
|
361 |
/*
|
|
|
362 |
* Service fw xml file
|
|
|
363 |
*/
|
|
|
364 |
RBuf iServiceXml;
|
|
94
|
365 |
/*
|
|
|
366 |
* Manifest file path name.
|
|
|
367 |
*/
|
|
|
368 |
RBuf iManifestFilePathName;
|
|
96
|
369 |
/*
|
|
|
370 |
* Strign id of title
|
|
|
371 |
*/
|
|
|
372 |
RBuf iStringIdTitle;
|
|
|
373 |
/*
|
|
|
374 |
* Strign id of description
|
|
|
375 |
*/
|
|
|
376 |
RBuf iStringIdDescription;
|
|
85
|
377 |
};
|
|
|
378 |
|
|
|
379 |
typedef RPointerArray<CCaWidgetDescription> RWidgetArray;
|
|
|
380 |
|
|
|
381 |
#endif // C_WIDGETDESCRIPTION_H
|
|
|
382 |
// End of File
|