CAknFilteredTextListBoxModel Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikcore.lib

Capability Information

Required Capabilities

None

#include <aknutils.h>

Inherits CTextListBoxModel.

Detailed Description

This class shows how application should build its model for filtered items.

Application should not use this directly, if it has it's own model or if there's any special things needed for MatchableTextArray. Application can derive from this though. All listboxes use CAknFilteredTextListBoxModel by default. CreateFilter() call enables it.


Public Member Functions
IMPORT_C void�	CreateFilterL (CEikListBox aListBox, CAknSearchField aSearchField)
�	Creates a `CAknListBoxFilterItems` and thus enables filtering of list items.
IMPORT_C void�	RemoveFilter ()
�	removes previously added filter from model
IMPORT_C CAknListBoxFilterItems *�	Filter () const
�	Access function for the filter.
IMPORT_C�	~CAknFilteredTextListBoxModel ()
�	Destructor.
virtual IMPORT_C TInt�	NumberOfItems () const
�	Implementation of `CTextListBoxModel::NumberOfItems()`.
virtual IMPORT_C TPtrC�	ItemText (TInt aItemIndex) const
�	Returns the text of the specified item.
IMPORT_C const MDesCArray *�	MatchableTextArray () const
�	Implementation of `CTextListBoxModel::MatchableTextArray()`.

Constructor & Destructor Documentation

IMPORT_C CAknFilteredTextListBoxModel::~CAknFilteredTextListBoxModel

(�

�)�

�	Destructor.

Member Function Documentation

IMPORT_C void CAknFilteredTextListBoxModel::CreateFilterL	(�	CEikListBox *�	aListBox,
		CAknSearchField *�	aSearchField
	)�

�

Creates a CAknListBoxFilterItems and thus enables filtering of list items.

Parameters:

	aListBox�	List box from which one or more items can be selected.
	aSearchField�	Search field control.

IMPORT_C CAknListBoxFilterItems* CAknFilteredTextListBoxModel::Filter

(�

�)�

const

�	Access function for the filter. Returns: Pointer to the listbox filter.

virtual IMPORT_C TPtrC CAknFilteredTextListBoxModel::ItemText (� TInt� aItemIndex �)� const [virtual]

�

Returns the text of the specified item.

Parameters:

aItemIndex�

Index to the item.

Returns:: The text of item in given index.

Reimplemented from CTextListBoxModel.

IMPORT_C const MDesCArray* CAknFilteredTextListBoxModel::MatchableTextArray (� �)� const [virtual]

�	Implementation of `CTextListBoxModel::MatchableTextArray()`. Returns: Pointer to the text array. Reimplemented from CTextListBoxModel.

virtual IMPORT_C TInt CAknFilteredTextListBoxModel::NumberOfItems (� �)� const [virtual]

�	Implementation of `CTextListBoxModel::NumberOfItems()`. Returns: The number of items the list box has. Reimplemented from CTextListBoxModel.

IMPORT_C void CAknFilteredTextListBoxModel::RemoveFilter

(�

�)�

�	removes previously added filter from model

The documentation for this class was generated from the following file: