CAknFilteredTextListBoxModel Class Reference

#include <mw/AknUtils.h>

class CAknFilteredTextListBoxModel : public CTextListBoxModel

Inherits from

Public Member Functions
~CAknFilteredTextListBoxModel()
IMPORT_C voidCreateFilterL(CEikListBox *, CAknSearchField *)
IMPORT_C CAknListBoxFilterItems *Filter()
virtual IMPORT_C TPtrCItemText(TInt)
virtual IMPORT_C const MDesCArray *MatchableTextArray()
virtual IMPORT_C TIntNumberOfItems()
IMPORT_C voidRemoveFilter()
Inherited Attributes
CTextListBoxModel::iItemTextArray
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CTextListBoxModel::CTextListBoxModel()
CTextListBoxModel::ConstructL(MDesCArray *,TListBoxModelItemArrayOwnership)
CTextListBoxModel::ItemArrayOwnershipType()const
CTextListBoxModel::ItemTextArray()const
CTextListBoxModel::SetItemTextArray(MDesCArray *)
CTextListBoxModel::SetOwnershipType(TListBoxModelItemArrayOwnership)
CTextListBoxModel::~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.
Since
S60 0.9

Constructor & Destructor Documentation

~CAknFilteredTextListBoxModel ( )

IMPORT_C~CAknFilteredTextListBoxModel()

Destructor.

Member Function Documentation

CreateFilterL ( CEikListBox *, CAknSearchField * )

IMPORT_C voidCreateFilterL(CEikListBox *aListBox,
CAknSearchField *aSearchField
)

Creates a CAknListBoxFilterItems and thus enables filtering of list items.

ParameterDescription
aListBoxList box from which one or more items can be selected.
aSearchFieldSearch field control.

Filter ( )

IMPORT_C CAknListBoxFilterItems *Filter()const

Access function for the filter.

Returns: Pointer to the listbox filter.

ItemText ( TInt )

IMPORT_C TPtrCItemText(TIntaItemIndex)const [virtual]

Reimplemented from CTextListBoxModel::ItemText(TInt)const

Returns the text of the specified item.

ParameterDescription
aItemIndexIndex to the item.

Returns: The text of item in given index.

MatchableTextArray ( )

IMPORT_C const MDesCArray *MatchableTextArray()const [virtual]

Reimplemented from CTextListBoxModel::MatchableTextArray()const

Implementation of CTextListBoxModel::MatchableTextArray()

Returns: Pointer to the text array.

NumberOfItems ( )

IMPORT_C TIntNumberOfItems()const [virtual]

Reimplemented from CTextListBoxModel::NumberOfItems()const

Implementation of CTextListBoxModel::NumberOfItems()

Returns: The number of items the list box has.

RemoveFilter ( )

IMPORT_C voidRemoveFilter()

removes previously added filter from model

© Nokia 2011.