CAknListBoxFilterItems Class Reference
| class CAknListBoxFilterItems : public CBase |
Detailed Description
Listbox item filtering. This class is designed to be stored inside a listbox model and the model should call this in its NumberOfItems() and ItemText() implementation. The model must be given to this class and it must have MatchableTextArray() implemented correctly. HandleOfferKeyEvent() should be called from the same offer key event implementation which forwards the keys to listbox and search field
If you have both markable list and find at the same time, you should call ResetFiltering() before executing the command for marked items. This ensures that the ListBox's SelectionIndexes() returns all items instead of only those items that are visible. Selected *items can be found under CAknListBoxFilterItems::SelectionIndexes().
Constructor & Destructor Documentation
CAknListBoxFilterItems ( CEikListBox *, CAknSearchField *, MListBoxModel *, CListBoxView * )
Base class default constructor.
| Parameter | Description | | aListBox | Listbox to be filtered, |
| aSearchField | Listbox search field. |
| aModel | Listbox model, |
| aView | A list box view that displays the list items which are currently visible in a list box. |
~CAknListBoxFilterItems ( )
| IMPORT_C | ~CAknListBoxFilterItems | ( | ) | |
Destructor. Frees all resources owned by the object prior to its destruction.
Member Function Documentation
ConstructL ( )
| IMPORT_C void | ConstructL | ( | ) | |
This is for setting empty list text.
DefaultMatchableItemFromItem ( TPtrC )
| IMPORT_C TPtrC | DefaultMatchableItemFromItem | ( | TPtrC | aText | ) | |
For building MdcaPoint() of the model's MatchableTextArray. This method builds the default value for MatchableTextArray.
| Parameter | Description | | aText | Pointer descriptor. |
DeferredSendFullKeyEventToFepL ( const TKeyEvent & )
| void | DeferredSendFullKeyEventToFepL | ( | const TKeyEvent & | aEvent | ) | |
An improved version of DeferredSendKeyEventToFepL. It sends a
TKeyEvent rather than just key code. Thus the correct key event can be send to FEP on QWERTY keyboard.
- Since
- S60 5.0
| Parameter | Description | | aEvent | Event send to FEP. |
DeferredSendKeyEventToFepL ( TUint )
| IMPORT_C void | DeferredSendKeyEventToFepL | ( | TUint | aValue | ) | |
Sends key events to FEP. This is used to resend key event to FEP if AknFind's HandleOfferKeyEventL() gets the key while search field has no focus. If search field has a focus, the key events go directly to the editor and this is not called.
| Parameter | Description | | aValue | The character code for an EEventKey. |
FilteredItemIndex ( TInt )
| IMPORT_C TInt | FilteredItemIndex | ( | TInt | aVisibleItemIndex | ) | const |
This is used to fetch the content of a list item after filter has been used.
| Parameter | Description | | aVisibleItemIndex | The index of visible item. |
Returns: Index to the original item array.
FilteredNumberOfItems ( )
| IMPORT_C TInt | FilteredNumberOfItems | ( | ) | const |
This is used to ask how many list items are available after filter has been used. Counts visible list items.
Returns: Number of items visible.
FindBox ( )
This function just returns pointer to the search field.
Returns: Pointer to the search field.
HandleControlEventL ( CCoeControl *, TCoeEvent )
| IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| | TCoeEvent | aEventType |
| | ) | |
Editor sends messages to this object as control events.
| Parameter | Description | | aControl | The control that sent the event. |
| aEventType | The event type. |
HandleItemArrayChangeL ( )
| IMPORT_C void | HandleItemArrayChangeL | ( | ) | |
When you change the list item array you should call this method.
HandleOfferkeyEventL ( )
| IMPORT_C void | HandleOfferkeyEventL | ( | ) | |
Applications should call this in OfferKeyEventL() which gives keys to listbox and search field.
IdleCallBack ( TAny * )
|
TInt
| IdleCallBack | ( | TAny * | aFilterItems | ) | [static] |
This gets called from DeferredSendKeyEventToFepL(). This does the actual sending of a key event. Does not support more than one event at the time.
| Parameter | Description | | aFilterItems | Pointer to the CAknListBoxFilterItems object. |
Returns: Always returns 0.
NonFilteredNumberOfItems ( )
| IMPORT_C TInt | NonFilteredNumberOfItems | ( | ) | const |
Returns number of original list items.
Returns: Number of all items.
ResetFilteringL ( )
| IMPORT_C void | ResetFilteringL | ( | ) | |
This function is to be called when filter is cleared.
SelectionIndexes ( )
This one gives all indices, not just the ones that are visible.
Returns: Pointer to the array that has all indices.
SetListBox ( CEikListBox * )
Attaches or detaches list used by the filtering.
- Since
- S60 2.0
| Parameter | Description | | aListBox | Pointer to listbox or NULL. |
SetModel ( MListBoxModel * )
Attaches or detaches list model used by the filtering.
- Since
- S60 2.0
| Parameter | Description | | aModel | a pointer to list model or NULL. |
SetObserver ( MCoeControlObserver * )
| Parameter | Description | | aObserver | Pointer to the observer. |
SetParentControl ( CCoeControl * )
AknFind
uses this to inform us who is the parent control owning the listbox and search field. This control should be window-owning control and it will be used to resize the listbox when changes to the filtering happens.
| Parameter | Description | | aControl | Pointer to the control. |
SetPopup ( )
AknFind
uses this to inform us that we have popup find. Applications shouldn't call this.
SetSearchField ( CAknSearchField * )
| IMPORT_C void | SetSearchField | ( | CAknSearchField * | aSearchField | ) | |
Attaches or detaches find pane used by the filtering.
- Since
- S60 2.0
| Parameter | Description | | aSearchField | Pointer to findbox or NULL. |
SetView ( CListBoxView * )
Attaches or detaches list view used by the filtering.
- Since
- S60 2.0
| Parameter | Description | | aView | a pointer to list view or NULL. |
UpdateCachedDataL ( )
| IMPORT_C void | UpdateCachedDataL | ( | ) | |
This function will update filter items state from the search field and listbox. Also updates selection indexes.
UpdateSelectionIndexL ( TInt )
| IMPORT_C void | UpdateSelectionIndexL | ( | TInt | aVisibleIndex | ) | |
This will synchronise the selected index from the listbox. If you use SelectionIndexes(), call this before it. This is heavy operation and goes through all list items.
| Parameter | Description | | aVisibleIndex | Index to be updated. |
UpdateSelectionIndexesL ( )
| IMPORT_C void | UpdateSelectionIndexesL | ( | ) | |
This will synchronise the selection indices from the listbox. If you use SelectionIndexes(), call this before it. This is heavy operation and goes through all list items.
VisibleItemIndex ( TInt )
| IMPORT_C TInt | VisibleItemIndex | ( | TInt | aOriginalIndex | ) | const |
Finds the list item on the screen when the item array index is given.
| Parameter | Description | | aOriginalIndex | Item index. |
Returns: Matching index from original array. Returns -1 if the Index is not visible.