author | Fionntina Carville <fionntinac@symbian.org> |
Mon, 15 Nov 2010 11:25:21 +0000 | |
branch | RCL_3 |
changeset 105 | a533a8e36da8 |
parent 102 | ba63c83f4716 |
permissions | -rw-r--r-- |
83 | 1 |
/* |
2 |
* Copyright (c) 2007 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: CMmListBox |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
15 |
* Version : %version: MM_22.1.17 % << Don't touch! Updated by Synergy at check-out. |
83 | 16 |
* |
17 |
*/ |
|
18 |
||
19 |
||
20 |
#ifndef C_MMLISTBOX_H |
|
21 |
#define C_MMLISTBOX_H |
|
22 |
||
23 |
#include <e32std.h> |
|
24 |
#include <e32base.h> |
|
25 |
#include <aknlists.h> |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
26 |
#include <e32cmn.h> |
83 | 27 |
|
28 |
class CMmListBoxModel; |
|
29 |
class CMmListBoxItemDrawer; |
|
30 |
class CMmMarqueeAdapter; |
|
31 |
class CMmWidgetContainer; |
|
32 |
class CMmTemplateLibrary; |
|
33 |
||
34 |
/** |
|
35 |
* CMmListBox |
|
36 |
* |
|
37 |
* @code |
|
38 |
* @endcode |
|
39 |
* @lib mmwidgets |
|
40 |
* @since S60 v3.0 |
|
41 |
* @ingroup group_mmwidgets |
|
42 |
*/ |
|
43 |
NONSHARABLE_CLASS( CMmListBox ) : public CEikFormattedCellListBoxTypedef |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
44 |
{ |
83 | 45 |
public: |
46 |
/** |
|
47 |
* Two-phased constructor. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
48 |
* |
83 | 49 |
* @since S60 v3.0 |
50 |
* @param aParent Parent control. |
|
51 |
* @param aFlags Flags. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
52 |
* @param aTemplateLibrary Template library for drawer. |
83 | 53 |
* @return List box. |
54 |
*/ |
|
55 |
static CMmListBox* NewL( const CCoeControl* aParent, TInt aFlags, |
|
56 |
CMmTemplateLibrary* aTemplateLibrary ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
57 |
|
83 | 58 |
/** |
59 |
* Two-phased constructor. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
60 |
* |
83 | 61 |
* @since S60 v3.0 |
62 |
* @param aParent Parent control. |
|
63 |
* @param aFlags Flags. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
64 |
* @param aTemplateLibrary Template library for drawer. |
83 | 65 |
* @return List box. |
66 |
*/ |
|
67 |
static CMmListBox* NewLC( const CCoeControl* aParent, TInt aFlags, |
|
68 |
CMmTemplateLibrary* aTemplateLibrary ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
69 |
|
83 | 70 |
/** |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
71 |
* Destructor. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
72 |
* |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
73 |
* @since S60 v3.0 |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
74 |
*/ |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
75 |
virtual ~CMmListBox(); |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
76 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
77 |
/** |
83 | 78 |
* Gets the listbox model. |
79 |
* |
|
80 |
* @since S60 v3.0 |
|
81 |
* @return Listbox model. |
|
82 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
83 |
CMmListBoxModel * MmModel(); |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
84 |
|
83 | 85 |
/** |
86 |
* Sets the listbox model. |
|
87 |
* |
|
88 |
* @since S60 v3.0 |
|
89 |
* @param aMmModel The model to be set. |
|
90 |
*/ |
|
91 |
void SetMmModel( CMmListBoxModel* aMmModel ); |
|
92 |
||
93 |
/** |
|
94 |
* Creates the view class instance. |
|
95 |
* |
|
96 |
* @since S60 v3.0 |
|
97 |
* @return Listbox view. |
|
98 |
*/ |
|
99 |
CListBoxView* MakeViewClassInstanceL(); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
100 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
101 |
/** |
83 | 102 |
* Creates the item drawer for listbox. |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
103 |
* |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
104 |
* @param aTemplateLibrary Template library for drawer. |
83 | 105 |
* @since S60 v3.0 |
106 |
*/ |
|
107 |
void CreateItemDrawerL( CMmTemplateLibrary* aTemplateLibrary ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
108 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
109 |
/** |
83 | 110 |
* Sets the flag. |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
111 |
* |
83 | 112 |
* @since S60 v3.0 |
113 |
* @param aFlag Avkon list flag |
|
114 |
*/ |
|
115 |
void SetListFlag( TInt aFlag ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
116 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
117 |
/** |
83 | 118 |
* Clears the flag. |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
119 |
* |
83 | 120 |
* @since S60 v3.0 |
121 |
* @param aFlag Avkon list flag |
|
122 |
*/ |
|
123 |
void ClearListFlag( TInt aFlag ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
124 |
|
83 | 125 |
|
126 |
public: // from base class CCoeControl. |
|
127 |
||
128 |
/** |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
129 |
* From CCoeControl. |
83 | 130 |
* Handles pointer events. |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
131 |
* |
83 | 132 |
* @since S60 v3.0 |
133 |
* @param aPointerEvent Pointer event. |
|
134 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
135 |
void HandlePointerEventL( const TPointerEvent& aPointerEvent ); |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
136 |
|
83 | 137 |
/** |
138 |
* From base class. |
|
139 |
* |
|
140 |
* @since S60 v3.0 |
|
141 |
* @param aKeyEvent Key event. |
|
142 |
* @param aType Event code. |
|
143 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
144 |
TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent, |
83 | 145 |
TEventCode aType ); |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
146 |
|
83 | 147 |
/** |
148 |
* Adjusts the given rectangle. |
|
149 |
* |
|
150 |
* @since S60 v3.0 |
|
151 |
* @param aRect Rectangle to be adjusted. |
|
152 |
* @return Error code. |
|
153 |
*/ |
|
154 |
TInt AdjustRectHeightToWholeNumberOfItems( TRect& aRect ) const; |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
155 |
|
83 | 156 |
/** |
157 |
* Sets item drawer and view background context. |
|
158 |
* |
|
159 |
* @since S60 v3.0 |
|
160 |
* @param aBgContext Background context. |
|
161 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
162 |
void SetItemDrawerAndViewBgContext( |
83 | 163 |
CAknsBasicBackgroundControlContext * aBgContext ); |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
164 |
|
83 | 165 |
/** |
166 |
* Updates scrollbar. |
|
167 |
* |
|
168 |
* @since S60 v3.0 |
|
169 |
*/ |
|
170 |
void UpdateScrollBarsL(); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
171 |
|
83 | 172 |
/** |
173 |
* Special version of Update scrollbar that never calls DrawNow() |
|
174 |
*/ |
|
175 |
void UpdateScrollBarsNoRedrawL(); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
176 |
|
83 | 177 |
/** |
178 |
* Checks if all items fit in view rectangle. |
|
179 |
* |
|
180 |
* @since S60 v3.0 |
|
181 |
* @return Do all items fit in view rectangle. |
|
182 |
*/ |
|
183 |
TBool AllItemsFitInViewRect(); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
184 |
|
83 | 185 |
/** |
186 |
* Handles scrollbar visibility change. |
|
187 |
* |
|
188 |
* @since S60 v3.0 |
|
189 |
* @return Is redraw needed. |
|
190 |
*/ |
|
191 |
TBool HandleScrollbarVisibilityChangeL(); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
192 |
|
83 | 193 |
/** |
194 |
* Sets marquee adapter. |
|
195 |
* |
|
196 |
* @since S60 v3.0 |
|
197 |
* @param aAdapter Marquee adapter. |
|
198 |
*/ |
|
199 |
void SetMarqueeAdapter( CMmMarqueeAdapter* aAdapter ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
200 |
|
83 | 201 |
/** |
202 |
* Notifies that marquee is being drawn. |
|
203 |
* |
|
204 |
* @since S60 v3.0 |
|
205 |
* @param aIsMarqueeBeingDrawn Is marquee being drawn. |
|
206 |
*/ |
|
207 |
void SetMarqueeDrawing( TBool aIsMarqueeBeingDrawn ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
208 |
|
83 | 209 |
/** |
210 |
* Handles item removal. redraws view, updates scrollbar. |
|
211 |
* |
|
212 |
* @since S60 v3.0 |
|
213 |
*/ |
|
214 |
void HandleItemRemovalL(); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
215 |
|
83 | 216 |
/** |
217 |
* Redraws items in view if it is necessary. |
|
218 |
* |
|
219 |
* @since S60 v3.0 |
|
220 |
* @param aPreviousCurrent Previously current item index. |
|
221 |
* @param aCurrent Current item index. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
222 |
* |
83 | 223 |
* @return true if anything was drawn. |
224 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
225 |
TBool RedrawIfNecessary( TInt aPreviousCurrent, TInt aCurrent ); |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
226 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
227 |
/** |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
228 |
* Overridden from base class to allow for drawing scrollbar |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
229 |
* background in mirrored layout. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
230 |
* |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
231 |
* @param aRect clipping rect |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
232 |
*/ |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
233 |
void Draw(const TRect& aRect) const; |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
234 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
235 |
/** |
83 | 236 |
* Draws the listbox view. |
237 |
* |
|
238 |
* @since S60 v5.0 |
|
239 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
240 |
void DrawView(); |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
241 |
|
83 | 242 |
/** |
243 |
* Set the vertical item offset; |
|
244 |
* @param aOffset The offset to set to the widget. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
245 |
* |
83 | 246 |
* @since S60 v5.0 |
247 |
*/ |
|
248 |
void SetVerticalItemOffset( TInt aOffset ); |
|
249 |
||
250 |
/** |
|
251 |
* Gets the current widget vertical item offset. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
252 |
* |
83 | 253 |
* @since S60 v5.0 |
254 |
* @return The current widget vertical item offset. |
|
255 |
*/ |
|
256 |
TInt VerticalItemOffset() const; |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
257 |
|
83 | 258 |
/** |
259 |
* Simply sets the item height members in widget and view. |
|
260 |
*/ |
|
261 |
void SetItemHeight( TInt aItemHeight ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
262 |
|
83 | 263 |
/** |
264 |
* Updates scrollbar thumbs. |
|
265 |
*/ |
|
266 |
void UpdateScrollBarThumbs(); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
267 |
|
83 | 268 |
/** |
269 |
* Counts the number of component controls which this component owns. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
270 |
*/ |
83 | 271 |
TInt CountComponentControls() const; |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
272 |
|
83 | 273 |
/** |
274 |
* Disables/enables child component (scrollbar) drawing. |
|
275 |
*/ |
|
276 |
void SetDisableChildComponentDrawing( TBool aDisable ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
277 |
|
83 | 278 |
/** |
279 |
* Handles scrolling event. |
|
280 |
* |
|
281 |
* @since S60 v3.0 |
|
282 |
* @param aScrollBar Scrollbar being scrolled. |
|
283 |
* @param aEventType Type of scrollbar event. |
|
284 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
285 |
void HandleScrollEventL( CEikScrollBar* aScrollBar, |
83 | 286 |
TEikScrollEvent aEventType ); |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
287 |
|
83 | 288 |
private: |
289 |
/** |
|
290 |
* Default constructor. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
291 |
* |
83 | 292 |
* @since S60 v3.0 |
293 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
294 |
CMmListBox(); |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
295 |
|
83 | 296 |
/** |
297 |
* 2nd phase constructor. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
298 |
* |
83 | 299 |
* @since S60 v3.0 |
300 |
* @param aParent Parent control. |
|
301 |
* @param aFlags Flags. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
302 |
* @param aTemplateLibrary Template library for drawer. |
83 | 303 |
*/ |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
304 |
void ConstructL( const CCoeControl* aParent, TInt aFlags, |
83 | 305 |
CMmTemplateLibrary* aTemplateLibrary ); |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
306 |
|
83 | 307 |
/** |
308 |
* Handles pointer events when edit mode is enabled. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
309 |
* |
83 | 310 |
* This method is only called during edit mode. It selectively passes |
311 |
* only some of the pointer events to CAknGrid::HandlePointerEventL |
|
312 |
* in order to disable flicking and panning. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
313 |
* |
83 | 314 |
* @param aPointerEvent pointer event |
315 |
*/ |
|
316 |
void HandlePointerEventInEditModeL( const TPointerEvent& aPointerEvent ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
317 |
|
83 | 318 |
/** |
319 |
* Scrolls the view if pointer is close to the top/bottom edge. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
320 |
* |
83 | 321 |
* This method is used only when edit mode is active. In a way it |
322 |
* brings back the focus based scrolling behavior that was present |
|
323 |
* in CAknGrid before ODE scrolling was introduced. |
|
324 |
*/ |
|
325 |
void HandleScrollingInEditMode( const TPointerEvent& aPointerEvent ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
326 |
|
83 | 327 |
/** |
328 |
* Checks if pointer position is within the scroll-triggering area. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
329 |
* |
83 | 330 |
* @param aPointerEvent pointer event |
331 |
* @return true if pointer above the top scrolling threshold. |
|
332 |
*/ |
|
333 |
TBool IsPointerInTopScrollingThreshold( |
|
334 |
const TPointerEvent& aPointerEvent ) const; |
|
335 |
||
336 |
/** |
|
337 |
* Checks if pointer position is within the scroll-triggering area. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
338 |
* |
83 | 339 |
* @param aPointerEvent pointer event |
340 |
* @return true if pointer below the bottom scrolling threshold. |
|
341 |
*/ |
|
342 |
TBool IsPointerInBottomScrollingThreshold( |
|
343 |
const TPointerEvent& aPointerEvent ) const; |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
344 |
|
83 | 345 |
/** |
346 |
* Scrolls the view if the pointer is near top/bottom edge of the screen. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
347 |
* |
83 | 348 |
* Assumes that current item index is the index of the item under the |
349 |
* pointer. The time value returned is based on the distance of the pointer |
|
350 |
* from the top/bottom edge of the grid view (this makes the scrolling speed |
|
351 |
* dependent of how close the pointer is to the edge). |
|
352 |
* If there is no need to continue scrolling because the beginning/end of |
|
353 |
* the list has already been reached, 0 is returned. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
354 |
* |
83 | 355 |
* @param aPointerEvent pointer event |
356 |
* @return time to wait before calling this method again (in microseconds) |
|
357 |
* or 0 if already at the beginning/end of the list |
|
358 |
*/ |
|
359 |
TInt ScrollIfNeeded( const TPointerEvent& aPointerEvent ); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
360 |
|
83 | 361 |
/** |
362 |
* Ensures that elements are drawn correctly when mirrored layout is |
|
363 |
* used and scrollbar is visible by shifting ViewRect to the right. |
|
364 |
*/ |
|
365 |
void FixViewForMirroredLayout(); |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
366 |
|
83 | 367 |
/** |
368 |
* Redraws the background under the vertical scrollbar in mirrored layout. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
369 |
* |
83 | 370 |
* The reason such method is needed is that view rectangle is shifted |
371 |
* to the right in mirrored layout and does not cover the scrollbar |
|
372 |
* area. In normal (non-mirrored) mode this method does nothing. |
|
373 |
*/ |
|
374 |
void RedrawScrollbarBackground() const; |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
375 |
|
83 | 376 |
/** |
377 |
* Does actual handling of scroll events. |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
378 |
* |
83 | 379 |
* @param aScrollBar Scrollbar being scrolled. |
380 |
* @param aEventType Type of scrollbar event. |
|
381 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
382 |
void ProcessScrollEventL( CEikScrollBar* aScrollBar, |
83 | 383 |
TEikScrollEvent aEventType ); |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
384 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
385 |
/** |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
386 |
* Handles periodic events from @c iRedrawTimer. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
387 |
* Such events are generated at equal time intervals while |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
388 |
* the view is being scrolled using the scrollbar. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
389 |
* This function typically calls @c ProcessScrollEventL, |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
390 |
* which actually scrolls the view and causes a redraw. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
391 |
*/ |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
392 |
void HandleRedrawTimerEventL(); |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
393 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
394 |
private: |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
395 |
/** |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
396 |
* Callback function for @c iRedrawTimer. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
397 |
* It simply calls @c HandleRedrawTimerEventL and returns 0. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
398 |
* |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
399 |
* @param aPtr A pointer to CMmListBox object. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
400 |
* @return 0 (always). |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
401 |
*/ |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
402 |
static TInt RedrawTimerCallback( TAny* aPtr ); |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
403 |
|
83 | 404 |
private: // Data |
405 |
/** |
|
406 |
* Item drawer. |
|
407 |
*/ |
|
408 |
CMmListBoxItemDrawer* iMmDrawer; |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
409 |
|
83 | 410 |
/** |
411 |
* Multimedia Menu model. |
|
412 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
413 |
CMmListBoxModel* iMmModel; |
83 | 414 |
|
415 |
/** |
|
416 |
* marquee adapter. |
|
417 |
*/ |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
418 |
CMmMarqueeAdapter* iMarqueeAdapter; |
83 | 419 |
|
420 |
/** |
|
421 |
* Blocks scrollbar drawing. When this flag is set scrollbars components |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
422 |
* are blocked in the CountComponentControls() method; |
83 | 423 |
*/ |
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
424 |
TBool iDisableChildComponentDrawing; |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
425 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
426 |
/** |
83 | 427 |
* This member is only used in edit mode to store the position of the pointer |
428 |
* during EButton1Down event. |
|
429 |
*/ |
|
430 |
TPoint iButton1DownPos; |
|
102
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
431 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
432 |
/** |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
433 |
* ETrue if the view is being scrolled with the scrollbar. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
434 |
*/ |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
435 |
TBool iScrollbarThumbIsBeingDragged; |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
436 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
437 |
/** |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
438 |
* Stores the number of scrollbar events that were ignored. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
439 |
* It is only used while scrolling the view using scrollbar, |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
440 |
* in such situation the scroll events that this object receives |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
441 |
* are ignored, and actual scrolling is done only when |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
442 |
* iRedrawTimer completes. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
443 |
*/ |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
444 |
TInt iSkippedScrollbarEventsCount; |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
445 |
|
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
446 |
/** |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
447 |
* A timer that initiates redraws at certain time intervals. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
448 |
* It is used to refresh the view while scrolling with |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
449 |
* the scrollbar. |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
450 |
*/ |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
451 |
CPeriodic* iRedrawTimer; |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
452 |
}; |
ba63c83f4716
Revision: 201039
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
88
diff
changeset
|
453 |
|
83 | 454 |
#endif // MMLISTBOX_H |