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 |
* Version : 2 << Don't touch! Updated by Synergy at check-out.
|
|
16 |
*
|
|
17 |
*/
|
|
18 |
|
|
19 |
#ifndef MMCACHEFORITEM_H
|
|
20 |
#define MMCACHEFORITEM_H
|
|
21 |
|
|
22 |
#include <e32base.h>
|
|
23 |
#include <e32cmn.h>
|
|
24 |
#include "mmsubcellssetupcode.h"
|
|
25 |
|
|
26 |
class CGulIcon;
|
|
27 |
class CHnIconHolder;
|
|
28 |
class CMmItemsDataCache;
|
|
29 |
|
|
30 |
/**
|
|
31 |
* Stores cached information needed to draw a single item.
|
|
32 |
*/
|
|
33 |
NONSHARABLE_CLASS( CMmCacheForItem ): public CBase
|
|
34 |
{
|
|
35 |
public:
|
|
36 |
/**
|
|
37 |
* Creates a new instance of CMmCacheForItem object.
|
|
38 |
* The newly created object will be left on the cleanup stack.
|
|
39 |
*
|
|
40 |
* @param aParent The owner of the newly created object.
|
|
41 |
*/
|
|
42 |
static CMmCacheForItem* NewLC( CMmItemsDataCache& aParent );
|
|
43 |
|
|
44 |
/**
|
|
45 |
* Creates a new instance of CMmCacheForItem object.
|
|
46 |
* The newly created object will be left on the cleanup stack.
|
|
47 |
*
|
|
48 |
* @param aParent The owner of the newly created object.
|
|
49 |
*/
|
|
50 |
static CMmCacheForItem* NewL( CMmItemsDataCache& aParent );
|
|
51 |
|
|
52 |
/**
|
|
53 |
* Standard C++ virtual destructor.
|
|
54 |
*/
|
|
55 |
~CMmCacheForItem();
|
|
56 |
|
|
57 |
/**
|
|
58 |
* Sets the subcell setup code that denoted valid subcell setup for this
|
|
59 |
* item.
|
|
60 |
*
|
|
61 |
* @param aSubcellsSetupCode Subcells setup code for this item.
|
|
62 |
*/
|
|
63 |
inline void SetSubcellsSetupCode( TMmSubcellsSetupCode aSubcellsSetupCode );
|
|
64 |
|
|
65 |
/**
|
|
66 |
* Returns the code of the subcells setup required by this item to be
|
|
67 |
* properly drawn using cached data.
|
|
68 |
*/
|
|
69 |
inline TMmSubcellsSetupCode GetSubcellsSetupCode() const;
|
|
70 |
|
|
71 |
/**
|
|
72 |
* Returns information whether the data in this cache is valid.
|
|
73 |
* Invalid cache should never be used.
|
|
74 |
*
|
|
75 |
* @return ETrue if valid, EFalse otherwise.
|
|
76 |
*/
|
|
77 |
inline TBool IsValid() const;
|
|
78 |
|
|
79 |
/**
|
|
80 |
* Marks this cache object as valid.
|
|
81 |
*/
|
|
82 |
inline void MarkAsValidL();
|
|
83 |
|
|
84 |
/**
|
|
85 |
* Marks this cache object as invalid.
|
|
86 |
*/
|
|
87 |
inline void MarkAsInvalid();
|
|
88 |
|
|
89 |
/**
|
|
90 |
* Returns information whether at the moment of updating this cache object
|
|
91 |
* the item was current (highlighted).
|
|
92 |
*
|
|
93 |
* @return ETrue if current, EFalse otherwise.
|
|
94 |
*/
|
|
95 |
inline TBool IsCurrent();
|
|
96 |
|
|
97 |
/**
|
|
98 |
* Sets the information whether the item was current (highlighted).
|
|
99 |
*/
|
|
100 |
inline void SetCurrent( TBool aCurrent );
|
|
101 |
|
|
102 |
/**
|
|
103 |
* Retrieves the cached item text.
|
|
104 |
* This is the complete string needed by AVKON methods to draw the item
|
|
105 |
* including tab characters and icon indices.
|
|
106 |
*
|
|
107 |
* @return Cached item text.
|
|
108 |
*/
|
|
109 |
inline const TDesC& GetItemText() const;
|
|
110 |
|
|
111 |
/**
|
|
112 |
* Returns reference to the text buffer owned by this cache.
|
|
113 |
* This methods allows for updating the cached text.
|
|
114 |
*
|
|
115 |
* @return Reference to the text buffer owned by this cache.
|
|
116 |
*/
|
|
117 |
inline RBuf& GetItemTextForModifications();
|
|
118 |
|
|
119 |
/**
|
|
120 |
* Retrives cached template name.
|
|
121 |
*
|
|
122 |
* @return Cached template name.
|
|
123 |
*/
|
|
124 |
const TDesC8& GetTemplate() const;
|
|
125 |
|
|
126 |
/**
|
|
127 |
* Sets template name for the item.
|
|
128 |
*
|
|
129 |
* @param aItemTemplate Template name.
|
|
130 |
*/
|
|
131 |
void SetTemplateL( const TDesC8& aItemTemplate );
|
|
132 |
|
|
133 |
/**
|
|
134 |
* Returns cached item size.
|
|
135 |
*
|
|
136 |
* @return Cached item size.
|
|
137 |
*/
|
|
138 |
inline TSize GetSize() const;
|
|
139 |
|
|
140 |
/**
|
|
141 |
* Updates item size stored in the cache.
|
|
142 |
*
|
|
143 |
* @param aItemSize Item size.
|
|
144 |
*/
|
|
145 |
inline void SetSize( TSize aItemSize );
|
|
146 |
|
|
147 |
/**
|
|
148 |
* Produces icon list, which can be then passed as parameter to
|
|
149 |
* CEikFormattedCellListBoxData::SetIconArray.
|
|
150 |
* It is up to the caller to delete the returned array. However,
|
|
151 |
* the icons stored in the array must not be deleted.
|
|
152 |
*/
|
|
153 |
CArrayPtr<CGulIcon>* GetIconListL();
|
|
154 |
|
|
155 |
/**
|
|
156 |
* Appends an icon (specifically an icon holder) to the cached array of icon holders.
|
|
157 |
* The icon holder is then co-owned by this CMmCacheForItem object so that the
|
|
158 |
* icon contained in the icon holder can be safely stored.
|
|
159 |
*
|
|
160 |
* @param aIconHolder An icon holder (NULL value not allowed).
|
|
161 |
* @return Index of the just appended icon holder.
|
|
162 |
*/
|
|
163 |
TInt AppendIconL( CHnIconHolder* aIconHolder );
|
|
164 |
|
|
165 |
/**
|
|
166 |
* Clears the array of icon holders stored in this item cache.
|
|
167 |
* It ceases co-owning the icon holders and resets the array
|
|
168 |
* that stores them.
|
|
169 |
*/
|
|
170 |
void ClearIconArray();
|
|
171 |
|
|
172 |
/**
|
|
173 |
* Based on the information about how the item must be drawn (with
|
|
174 |
* hightlight or not) and what currect subcells setup it, this methods
|
|
175 |
* invalidates the cache for this item to prevent problems such as:
|
|
176 |
* * cache information for highlighted item being used for to draw
|
|
177 |
* the item without highlight or vice versa.
|
|
178 |
* * relying on cache and not performing the full subcells setup while
|
|
179 |
* the current subcells setup does not fit this particular item.
|
|
180 |
*/
|
|
181 |
void InvalidateIfCacheMayNotBeUsed( TBool aIsItemCurrent,
|
|
182 |
TMmSubcellsSetupCode aSubcellsSetupCode );
|
|
183 |
|
|
184 |
protected:
|
|
185 |
/**
|
|
186 |
* Stardard C++ constructor.
|
|
187 |
*
|
|
188 |
* @param aParent CMmItemsDataCache object owning this object.
|
|
189 |
*/
|
|
190 |
CMmCacheForItem( CMmItemsDataCache& aParent );
|
|
191 |
|
|
192 |
/**
|
|
193 |
* 2nd phase constructor.
|
|
194 |
*/
|
|
195 |
void ConstructL();
|
|
196 |
|
|
197 |
/**
|
|
198 |
* Updates the iIconList so that it reflects the contents of
|
|
199 |
* iIconHolderList.
|
|
200 |
*/
|
|
201 |
void UpdateIconListL();
|
|
202 |
|
|
203 |
protected:
|
|
204 |
/**
|
|
205 |
* Stores information whether this cache object is valid.
|
|
206 |
*/
|
|
207 |
TBool iIsValid;
|
|
208 |
|
|
209 |
/**
|
|
210 |
* Stores information the item was highlighted at the moment
|
|
211 |
* of last cache update.
|
|
212 |
*/
|
|
213 |
TBool iIsCurrent;
|
|
214 |
|
|
215 |
/**
|
|
216 |
* Stores subcells setup code that denotes the subcells setup
|
|
217 |
* needed to draw the item using the cached data.
|
|
218 |
*/
|
|
219 |
TMmSubcellsSetupCode iSubcellsSetupCode;
|
|
220 |
|
|
221 |
/**
|
|
222 |
* Own.
|
|
223 |
* Stores the item text in the format that
|
|
224 |
* CFormattedCellListBoxData::Draw accepts.
|
|
225 |
* This text includes icon indices separated with tab characters.
|
|
226 |
*/
|
|
227 |
RBuf iItemText;
|
|
228 |
|
|
229 |
/**
|
|
230 |
* Stores the item size.
|
|
231 |
*/
|
|
232 |
TSize iItemSize;
|
|
233 |
|
|
234 |
/**
|
|
235 |
* Template identifier obtained from @c aParent using
|
|
236 |
* @c CMmItemsDataCache::GetTemplateIdentifierL.
|
|
237 |
*/
|
|
238 |
TInt iTemplateIdentifier;
|
|
239 |
|
|
240 |
/**
|
|
241 |
* Own.
|
|
242 |
* The icon holders in the array are co-owned.
|
|
243 |
*/
|
|
244 |
RArray<CHnIconHolder*> iIconHolderList;
|
|
245 |
|
|
246 |
/**
|
|
247 |
* Object that represents the whole data cache as opposed
|
|
248 |
* to single item cache represented by this object.
|
|
249 |
*/
|
|
250 |
CMmItemsDataCache& iParent;
|
|
251 |
|
|
252 |
/**
|
|
253 |
* Array of icons stored in the icon holders which are in iIconHolderList.
|
|
254 |
* This member is only valid when this cache object is marked as valid
|
|
255 |
* using the MarkAsValidL method.
|
|
256 |
* Own.
|
|
257 |
*/
|
|
258 |
CArrayPtr<CGulIcon>* iIconList;
|
|
259 |
|
|
260 |
};
|
|
261 |
|
|
262 |
#include "mmcacheforitem.inl"
|
|
263 |
|
|
264 |
#endif // MMCACHEFORITEM_H
|