author | Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> |
Wed, 15 Sep 2010 11:56:55 +0300 | |
branch | RCL_3 |
changeset 74 | 6b5524b4f673 |
parent 63 | f4a778e096c2 |
child 85 | 38bb213f60ba |
permissions | -rw-r--r-- |
63 | 1 |
/* |
2 |
* Copyright (c) 2005-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: Phonebook 2 contact view list box. |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
||
19 |
#ifndef CPBK2CONTACTVIEWLISTBOX_H |
|
20 |
#define CPBK2CONTACTVIEWLISTBOX_H |
|
21 |
||
22 |
// INCLUDES |
|
23 |
#include <aknlists.h> |
|
24 |
#include <TPbk2IconId.h> |
|
25 |
#include "MPbk2ClipListBoxText.h" |
|
26 |
#include <MPbk2PointerEventInspector.h> |
|
27 |
#include <MPbk2UiControlCmdItem.h> |
|
28 |
#include <coemain.h> |
|
29 |
#include "CPbk2ContactViewListBoxModel.h" |
|
30 |
||
31 |
||
32 |
// FORWARD DECLARATIONS |
|
33 |
class CPbk2ContactViewListBoxModel; |
|
34 |
class CVPbkContactManager; |
|
35 |
class MVPbkContactViewBase; |
|
36 |
class MPbk2ContactNameFormatter; |
|
37 |
class CPbk2StorePropertyArray; |
|
38 |
class MPbk2ContactUiControlExtension; |
|
39 |
class CPbk2ListboxModelCmdDecorator; |
|
40 |
class CPbk2ContactViewCustomListBoxData; |
|
41 |
class CPbk2PredictiveSearchFilter; |
|
42 |
class CCoeControl; |
|
43 |
||
44 |
/** |
|
45 |
* Phonebook 2 contact view list box. |
|
46 |
*/ |
|
47 |
NONSHARABLE_CLASS(CPbk2ContactViewListBox) : |
|
48 |
public CAknSingleGraphicStyleListBox, |
|
49 |
public MPbk2ClipListBoxText, |
|
50 |
public MPbk2PointerEventInspector, |
|
51 |
private MCoeForegroundObserver |
|
52 |
{ |
|
53 |
||
54 |
public: |
|
55 |
/** CreateItemDrawerL() |
|
56 |
* |
|
57 |
* Chooses which itemdrawer to use. |
|
58 |
*/ |
|
59 |
void CreateItemDrawerL(); |
|
60 |
||
61 |
public: // Constructors and destructor |
|
62 |
||
63 |
/** |
|
64 |
* Creates a new instance of this class. |
|
65 |
* |
|
66 |
* @param aContainer The control container for this control. |
|
67 |
* @param aResourceReader Resource reader used to construct |
|
68 |
* this object. |
|
69 |
* @param aManager Reference to contact manager. |
|
70 |
* @param aView Reference to contact view. |
|
71 |
* @param aNameFormatter Reference to the name formatter. |
|
72 |
* @param aStoreProperties Store property array. |
|
73 |
* @param aUiExtension UI extension. |
|
74 |
* @param aSearchFilter PBk2 Search Filter |
|
75 |
* @return A new instance of this class. |
|
76 |
*/ |
|
77 |
static CPbk2ContactViewListBox* NewL( |
|
78 |
CCoeControl& aContainer, |
|
79 |
TResourceReader& aResourceReader, |
|
80 |
const CVPbkContactManager& aManager, |
|
81 |
MVPbkContactViewBase& aView, |
|
82 |
MPbk2ContactNameFormatter& aNameFormatter, |
|
83 |
CPbk2StorePropertyArray& aStoreProperties, |
|
84 |
MPbk2ContactUiControlExtension* aUiExtension, |
|
85 |
CPbk2PredictiveSearchFilter &aSearchFilter ); |
|
86 |
||
87 |
/** |
|
88 |
* Destructor. |
|
89 |
*/ |
|
90 |
~CPbk2ContactViewListBox(); |
|
91 |
||
92 |
public: // Interface |
|
93 |
||
94 |
/** |
|
95 |
* Returns the number of items in the list box currently. |
|
96 |
* |
|
97 |
* @return Number of items in the listbox. |
|
98 |
*/ |
|
99 |
TInt NumberOfItems() const; |
|
100 |
||
101 |
/** |
|
102 |
* Returns list box selection status. |
|
103 |
* |
|
104 |
* @return ETrue if there are items marked, EFalse otherwise. |
|
105 |
*/ |
|
106 |
TBool ContactsMarked() const; |
|
107 |
||
108 |
/** |
|
109 |
* Handles item addition / deletion etc |
|
110 |
* events by updating list box data and the focus. |
|
111 |
* |
|
112 |
* @param aEvent contact view event |
|
113 |
* @see MPbk2NamesListState::HandleContactViewEventL |
|
114 |
* @param aIndex listbox index |
|
115 |
*/ |
|
116 |
void HandleEventL( |
|
117 |
TInt aEvent, |
|
118 |
TInt aIndex ); |
|
119 |
||
120 |
/** |
|
121 |
* Fixes the top item index of the list box. |
|
122 |
*/ |
|
123 |
void FixTopItemIndex(); |
|
124 |
||
125 |
/** |
|
126 |
* Checks that there is focus in the list. |
|
127 |
*/ |
|
128 |
void CheckFocusIndex(); |
|
129 |
||
130 |
/** |
|
131 |
* Handles pointer event. |
|
132 |
* |
|
133 |
* @see CAknSingleGraphicStyleListBox::HandlePointerEventL |
|
134 |
*/ |
|
135 |
void HandlePointerEventL( |
|
136 |
const TPointerEvent& aPointerEvent ); |
|
137 |
||
138 |
/** |
|
139 |
* Draws the listbox. |
|
140 |
* |
|
141 |
* @see CAknSingleGraphicStyleListBox::Draw |
|
142 |
*/ |
|
143 |
void Draw( const TRect& aRect ) const; |
|
144 |
||
145 |
/** |
|
146 |
* Returns Phonebook 2 control flags defined in Pbk2UIControls.hrh. |
|
147 |
* |
|
148 |
* @return Control flags. |
|
149 |
*/ |
|
150 |
TUint Flags() const; |
|
151 |
||
152 |
/** |
|
153 |
* Returns ETrue if the list supports selection. |
|
154 |
* |
|
155 |
* @return ETrue if the list supports selection. |
|
156 |
*/ |
|
157 |
TBool IsSelectionListBox(); |
|
158 |
||
159 |
/** |
|
160 |
* Sets the scroll event observer. |
|
161 |
*/ |
|
162 |
void SetScrollEventObserver(MEikScrollBarObserver* aObserver); |
|
163 |
||
164 |
/** |
|
165 |
* Sets the commands that should appear at the top of the list. |
|
166 |
* @param aCommands An array of commands. NULL may be given to |
|
167 |
* indicate that no commands are to be shown. |
|
168 |
*/ |
|
169 |
void SetListCommands( const RPointerArray<MPbk2UiControlCmdItem>* aCommands ); |
|
170 |
||
171 |
/** |
|
172 |
* Handle showing of popupcharacter when user scrolls name list |
|
173 |
* using scroll bar. |
|
174 |
* |
|
175 |
* @param CWindowGc. |
|
176 |
* @param TRect. |
|
177 |
*/ |
|
178 |
void HandlePopupCharacter( CWindowGc* aGc, |
|
179 |
const TRect& aRectOfListBoxItem ) const; |
|
180 |
||
181 |
/** |
|
182 |
* Set the state of the Marking mode |
|
183 |
*/ |
|
184 |
inline void SetMarkingModeState( TBool aActived ) |
|
185 |
{ |
|
186 |
iMarkingModeOn = aActived; |
|
187 |
} |
|
188 |
||
74
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
189 |
/** |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
190 |
* Reset the value of iShowPopupChar, i.e. set its value to EFalse. |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
191 |
* As for iShowPopupChar, ETrue indicates showing the scrollbar popup char; |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
192 |
* EFalse indicates the opposite. |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
193 |
*/ |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
194 |
inline void ResetShowPopupChar() |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
195 |
{ |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
196 |
iShowPopupChar = EFalse; |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
197 |
} |
6b5524b4f673
Revision: 201035
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
63
diff
changeset
|
198 |
|
63 | 199 |
public: // From MPbk2ClipListBoxText |
200 |
TBool ClipFromBeginning( |
|
201 |
TDes& aBuffer, |
|
202 |
TInt aItemIndex, |
|
203 |
TInt aSubCellNumber ); |
|
204 |
||
205 |
public: // From MPbk2PointerEventInspector |
|
206 |
TBool FocusedItemPointed(); |
|
207 |
TBool FocusableItemPointed(); |
|
208 |
TBool SearchFieldPointed(); |
|
209 |
||
210 |
public: // From CEikListBox |
|
211 |
void HandleScrollEventL( CEikScrollBar* aScrollBar, |
|
212 |
TEikScrollEvent aEventType ); |
|
213 |
||
214 |
private: // MCoeForegroundObserver |
|
215 |
void HandleGainingForeground(); |
|
216 |
void HandleLosingForeground(); |
|
217 |
||
218 |
protected: // Implementation |
|
219 |
CPbk2ContactViewListBox( |
|
220 |
CCoeControl& aContainer, |
|
221 |
MPbk2ContactUiControlExtension* aUiExtension, |
|
222 |
CPbk2PredictiveSearchFilter &aSearchFilter ); |
|
223 |
void ConstructL( |
|
224 |
CCoeControl& aContainer, |
|
225 |
TResourceReader& aResourceReader, |
|
226 |
const CVPbkContactManager& aManager, |
|
227 |
MVPbkContactViewBase& aView, |
|
228 |
MPbk2ContactNameFormatter& aNameFormatter, |
|
229 |
CPbk2StorePropertyArray& aStoreProperties ); |
|
230 |
void CreateListBoxModelL( |
|
231 |
const CVPbkContactManager& aManager, |
|
232 |
MVPbkContactViewBase& aView, |
|
233 |
MPbk2ContactNameFormatter& aNameFormatter, |
|
234 |
CPbk2StorePropertyArray& aStoreProperties ); |
|
235 |
||
236 |
||
237 |
virtual CPbk2ContactViewListBoxModel* DoCreateModelL( |
|
238 |
CPbk2ContactViewListBoxModel::TParams params ); |
|
239 |
||
240 |
virtual CPbk2ListboxModelCmdDecorator* DoCreateDecoratorL( |
|
241 |
const CPbk2IconArray& aIconArray, |
|
242 |
TPbk2IconId aEmptyIconId, |
|
243 |
TPbk2IconId aDefaultIconId ); |
|
244 |
||
245 |
TBool IsContact( TInt aIndex ) const; |
|
246 |
||
247 |
private: |
|
248 |
void RecalcWidthInMarkingMode( TInt& aWidth, const CFont& aFont, TChar aChar ); |
|
249 |
||
250 |
private: // Data structures |
|
251 |
/// Data loaded from resources |
|
252 |
struct TResourceData |
|
253 |
{ |
|
254 |
/// Own: Flags |
|
255 |
TUint iFlags; |
|
256 |
/// Own: Text to use for unnamed entries |
|
257 |
HBufC* iUnnamedText; |
|
258 |
/// Own: Empty icon id |
|
259 |
TPbk2IconId iEmptyIconId; |
|
260 |
/// Own: Default icon id |
|
261 |
TPbk2IconId iDefaultIconId; |
|
262 |
}; |
|
263 |
||
264 |
protected: //data |
|
265 |
/// Own: List box model |
|
266 |
CPbk2ContactViewListBoxModel* iModel; |
|
267 |
/// Own: Data loaded from resources |
|
268 |
TResourceData iResourceData; |
|
269 |
/// Own: Indexes of the changed list items |
|
270 |
CArrayFixFlat<TInt> iChangedIndexes; |
|
271 |
||
272 |
/// Ref: UI extension |
|
273 |
MPbk2ContactUiControlExtension* iUiExtension; |
|
274 |
/// Own: Pointer movement indicator |
|
275 |
TBool iFocusedContactPointed; |
|
276 |
/// Own: Pointer movement indicator |
|
277 |
TBool iFocusableContactPointed; |
|
278 |
/// Ref: scroll event observer |
|
279 |
MEikScrollBarObserver* iScrollEventObserver; |
|
280 |
/// Own: Wraps the listbox model |
|
281 |
CPbk2ListboxModelCmdDecorator* iListboxModelDecorator; |
|
282 |
/// For handling of scroll bar popupcharacter |
|
283 |
TBool iShowPopupChar; |
|
284 |
/// Doesnt Own - Ownership Transferred to CPbk2ContactViewCustomListBoxItemDrawer |
|
285 |
CPbk2ContactViewCustomListBoxData* iColumnData; |
|
286 |
///Ref : Search Pane Filter |
|
287 |
CPbk2PredictiveSearchFilter &iSearchFilter; |
|
288 |
// ref: used fro checking command item count |
|
289 |
CCoeControl& iContainer; |
|
290 |
// Flag to indicate whether Marking mode is active |
|
291 |
TBool iMarkingModeOn; |
|
292 |
||
293 |
}; |
|
294 |
||
295 |
#endif // CPBK2CONTACTVIEWLISTBOX_H |
|
296 |
||
297 |
// End of File |