|
85
|
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: ?Description
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
|
17 |
|
|
|
18 |
#ifndef __CAINNERENTRY_H__
|
|
|
19 |
#define __CAINNERENTRY_H__
|
|
|
20 |
|
|
|
21 |
#include <e32base.h>
|
|
|
22 |
|
|
|
23 |
#include "caentryattribute.h"
|
|
92
|
24 |
#include "cainnericondescription.h"
|
|
85
|
25 |
|
|
|
26 |
/**
|
|
|
27 |
* Class represents Content Arsenal entry
|
|
|
28 |
*/
|
|
|
29 |
NONSHARABLE_CLASS( CCaInnerEntry ): public CBase
|
|
|
30 |
{
|
|
|
31 |
public:
|
|
|
32 |
|
|
|
33 |
/**
|
|
|
34 |
* Destructor.
|
|
|
35 |
*/
|
|
|
36 |
virtual ~CCaInnerEntry();
|
|
|
37 |
|
|
|
38 |
/**
|
|
|
39 |
* Two-phased constructor.
|
|
|
40 |
* @return The created object.
|
|
|
41 |
*/
|
|
|
42 |
IMPORT_C static CCaInnerEntry* NewL();
|
|
|
43 |
|
|
|
44 |
/**
|
|
|
45 |
* Two-phased constructor.
|
|
|
46 |
* @return The created object.
|
|
|
47 |
*/
|
|
|
48 |
IMPORT_C static CCaInnerEntry* NewLC();
|
|
|
49 |
|
|
|
50 |
// GETTERS
|
|
|
51 |
/**
|
|
|
52 |
* Gets entry id.
|
|
|
53 |
* @return Entry id.
|
|
|
54 |
*/
|
|
|
55 |
IMPORT_C TInt GetId() const;
|
|
|
56 |
|
|
|
57 |
/**
|
|
|
58 |
* Gets entry text.
|
|
|
59 |
* @return Entry text.
|
|
|
60 |
*/
|
|
|
61 |
IMPORT_C const RBuf& GetText() const;
|
|
|
62 |
|
|
|
63 |
/**
|
|
|
64 |
* Gets entry description.
|
|
|
65 |
* @return Entry description.
|
|
|
66 |
*/
|
|
|
67 |
IMPORT_C const RBuf& GetDescription() const;
|
|
92
|
68 |
|
|
85
|
69 |
/**
|
|
|
70 |
* Gets entry typename.
|
|
|
71 |
* @return Entry typename.
|
|
|
72 |
*/
|
|
|
73 |
IMPORT_C const RBuf& GetEntryTypeName() const;
|
|
|
74 |
|
|
|
75 |
/**
|
|
92
|
76 |
* Gets icon description.
|
|
|
77 |
* @return Icon description.
|
|
85
|
78 |
*/
|
|
92
|
79 |
IMPORT_C const CCaInnerIconDescription* Icon() const;
|
|
85
|
80 |
|
|
|
81 |
/**
|
|
|
82 |
* Gets entry flags.
|
|
|
83 |
* @return Entry flags.
|
|
|
84 |
*/
|
|
|
85 |
IMPORT_C TUint GetFlags() const;
|
|
|
86 |
|
|
|
87 |
/**
|
|
|
88 |
* Gets entry attributes.
|
|
|
89 |
* @return Entry attributes table.
|
|
|
90 |
*/
|
|
|
91 |
IMPORT_C const RCaEntryAttrArray& GetAttributes() const;
|
|
|
92 |
|
|
|
93 |
/**
|
|
|
94 |
* Gets entry role.
|
|
|
95 |
* @return Entry role.
|
|
|
96 |
*/
|
|
|
97 |
IMPORT_C TUint GetRole() const;
|
|
|
98 |
|
|
|
99 |
/**
|
|
|
100 |
* Gets entry uid.
|
|
|
101 |
* @return Entry uid.
|
|
|
102 |
*/
|
|
|
103 |
IMPORT_C TInt32 GetUid() const;
|
|
|
104 |
|
|
|
105 |
/**
|
|
|
106 |
* Gets icon id.
|
|
|
107 |
* @return Icon id.
|
|
|
108 |
*/
|
|
|
109 |
IMPORT_C TInt GetIconId() const;
|
|
|
110 |
|
|
|
111 |
// SETTERS
|
|
|
112 |
/**
|
|
|
113 |
* Sets entry id.
|
|
|
114 |
* @param aId Entry id.
|
|
|
115 |
*/
|
|
|
116 |
IMPORT_C void SetId( TUint aId );
|
|
|
117 |
|
|
|
118 |
/**
|
|
|
119 |
* Sets the entry text.
|
|
|
120 |
* @param aText Entry text.
|
|
|
121 |
*/
|
|
|
122 |
IMPORT_C void SetTextL( const TDesC& aText );
|
|
|
123 |
|
|
|
124 |
/**
|
|
|
125 |
* Sets the entry description.
|
|
|
126 |
* @param aText Entry description.
|
|
|
127 |
*/
|
|
|
128 |
IMPORT_C void SetDescriptionL( const TDesC& aText );
|
|
92
|
129 |
|
|
85
|
130 |
/**
|
|
|
131 |
* Sets the entry typename.
|
|
|
132 |
* @param aTypeName Entry typename.
|
|
|
133 |
*/
|
|
|
134 |
IMPORT_C void SetEntryTypeNameL( const TDesC& aTypeName );
|
|
|
135 |
|
|
|
136 |
/**
|
|
|
137 |
* Sets icon data.
|
|
|
138 |
* @param aFilename Filename.
|
|
88
|
139 |
* @param aSkinId Skin id.
|
|
|
140 |
* @param aApplicationId application id.
|
|
85
|
141 |
*/
|
|
92
|
142 |
IMPORT_C void SetIconDataL(
|
|
|
143 |
const TDesC& aFilename, const TDesC& aSkinId, const TDesC& aApplicationId );
|
|
85
|
144 |
|
|
|
145 |
/**
|
|
|
146 |
* Adds attribute to entry.
|
|
|
147 |
* @param aKey Attribute key.
|
|
|
148 |
* @param aValue Attribute value.
|
|
|
149 |
*/
|
|
|
150 |
IMPORT_C void AddAttributeL( const TDesC& aKey, const TDesC& aValue );
|
|
|
151 |
|
|
|
152 |
/**
|
|
|
153 |
* Sets flags for the entry
|
|
|
154 |
* @param aFlags Flags.
|
|
|
155 |
*/
|
|
|
156 |
IMPORT_C void SetFlags( TUint aFlags );
|
|
|
157 |
|
|
|
158 |
/**
|
|
|
159 |
* Sets the entry's role.
|
|
|
160 |
* @param aRole Entry role.
|
|
|
161 |
*/
|
|
|
162 |
IMPORT_C void SetRole( TUint aRole );
|
|
|
163 |
|
|
|
164 |
/**
|
|
|
165 |
* Remove attribute with given key.
|
|
|
166 |
* @param aKey Key of attribute to be removed.
|
|
|
167 |
*/
|
|
|
168 |
IMPORT_C void RemoveAttributeL( const TDesC& aKey );
|
|
|
169 |
|
|
|
170 |
/**
|
|
|
171 |
* Verifies if attribute exists, and returns its value for the given key.
|
|
|
172 |
* @param aKey Attribute key.
|
|
|
173 |
* @param aAttrVal Attribute value.
|
|
|
174 |
* @return ETrue if attribute exists.
|
|
|
175 |
*/
|
|
|
176 |
IMPORT_C TBool FindAttribute( const TDesC& aKey, TDes& aAttrVal );
|
|
92
|
177 |
|
|
|
178 |
/**
|
|
|
179 |
* Verifies if attribute exists, and returns its value for the given key.
|
|
|
180 |
* @param aKey Attribute key.
|
|
|
181 |
* @param aAttrVal Attribute value.
|
|
|
182 |
* @return ETrue if attribute exists.
|
|
|
183 |
*/
|
|
|
184 |
IMPORT_C TBool FindAttribute( const TDesC& aKey, TPtrC& aAttrVal );
|
|
|
185 |
|
|
85
|
186 |
/**
|
|
|
187 |
* Sets the entry uid.
|
|
|
188 |
* @param aUid Entry uid.
|
|
|
189 |
*/
|
|
|
190 |
IMPORT_C void SetUid( TInt32 aUid );
|
|
|
191 |
|
|
|
192 |
/**
|
|
|
193 |
* Sets the entry icon id (id from storage).
|
|
|
194 |
* @param aIconId Icon id.
|
|
|
195 |
*/
|
|
|
196 |
IMPORT_C void SetIconId( TInt aIconId );
|
|
|
197 |
|
|
|
198 |
/**
|
|
|
199 |
* Externalizes object to the stream
|
|
|
200 |
* @param aStream a write stream
|
|
|
201 |
*/
|
|
|
202 |
IMPORT_C void ExternalizeL( RWriteStream& aStream ) const;
|
|
|
203 |
|
|
|
204 |
/**
|
|
|
205 |
* Internalizes stream to the object
|
|
|
206 |
* @param aStream a read stream
|
|
|
207 |
*/
|
|
|
208 |
IMPORT_C void InternalizeL( RReadStream& aStream );
|
|
|
209 |
|
|
|
210 |
private:
|
|
|
211 |
|
|
|
212 |
/**
|
|
|
213 |
* Second phased constructor.
|
|
|
214 |
*/
|
|
|
215 |
void ConstructL();
|
|
|
216 |
|
|
|
217 |
/**
|
|
|
218 |
* Constructor
|
|
|
219 |
*/
|
|
|
220 |
CCaInnerEntry();
|
|
|
221 |
|
|
|
222 |
private:
|
|
|
223 |
// data
|
|
|
224 |
|
|
|
225 |
/*
|
|
|
226 |
* Unique identifier of the entry.
|
|
|
227 |
*/
|
|
|
228 |
TInt iId;
|
|
|
229 |
|
|
|
230 |
/*
|
|
|
231 |
* Name.
|
|
|
232 |
* Own.
|
|
|
233 |
*/
|
|
|
234 |
RBuf iText;
|
|
|
235 |
|
|
|
236 |
/*
|
|
|
237 |
* Description.
|
|
|
238 |
* Own.
|
|
|
239 |
*/
|
|
|
240 |
RBuf iDescription;
|
|
92
|
241 |
|
|
85
|
242 |
/*
|
|
|
243 |
* Entry type.
|
|
|
244 |
* Own.
|
|
|
245 |
*/
|
|
|
246 |
RBuf iEntryTypeName;
|
|
|
247 |
|
|
|
248 |
/*
|
|
92
|
249 |
* Icon.
|
|
85
|
250 |
* Own.
|
|
|
251 |
*/
|
|
92
|
252 |
CCaInnerIconDescription* iIcon;
|
|
85
|
253 |
|
|
|
254 |
/*
|
|
|
255 |
* Flags.
|
|
|
256 |
*/
|
|
|
257 |
TUint iFlags;
|
|
|
258 |
|
|
|
259 |
/*
|
|
|
260 |
* Attributes array. Own
|
|
|
261 |
*/
|
|
|
262 |
RCaEntryAttrArray iAttributes;
|
|
|
263 |
|
|
|
264 |
/*
|
|
|
265 |
* Entry role ( group, item )
|
|
|
266 |
*/
|
|
|
267 |
TUint iRole;
|
|
|
268 |
|
|
|
269 |
/*
|
|
|
270 |
* Uid
|
|
|
271 |
*/
|
|
|
272 |
TInt32 iUid;
|
|
|
273 |
|
|
|
274 |
};
|
|
|
275 |
|
|
|
276 |
#endif // __CAINNERENTRY_H__
|