CTextListBoxModel Class Reference

class CTextListBoxModel : public CBase

Text list box model.

Inherits from

Constructor & Destructor Documentation

CTextListBoxModel()

IMPORT_CCTextListBoxModel()

Default constructor.

~CTextListBoxModel()

IMPORT_C~CTextListBoxModel()[virtual]

destructor

Member Functions Documentation

ConstructL(MDesCArray *, TListBoxModelItemArrayOwnership)

IMPORT_C voidConstructL(MDesCArray *aItemTextArray = NULL,
TListBoxModelItemArrayOwnershipaOwnershipType = ELbmOwnsItemArray
)[virtual]

Second-phase constructor.

This function completes construction of a default-constructed CTextListBoxModel, initialising any members which are stored on the heap. Whether ownership of the array is taken depends on the value of the TListBoxModelItemArrayOwnership enum.

Parameters

MDesCArray * aItemTextArray = NULLThe item array.
TListBoxModelItemArrayOwnership aOwnershipType = ELbmOwnsItemArrayWhether or not to take ownership of the array.

ItemArrayOwnershipType()

IMPORT_C TListBoxModelItemArrayOwnershipItemArrayOwnershipType()const [protected]

Gets the item array ownership type.

Item array ownership.

ItemText(TInt)

IMPORT_C TPtrCItemText(TIntaItemIndex)const [virtual]

Gets the text to be displayed in the list box control for the specified item.

Text string to be displayed.

Parameters

TInt aItemIndexIndex of an item.

ItemTextArray()

IMPORT_C MDesCArray *ItemTextArray()const

The array of text items modelled by this text list box model.

A pointer to the array.

MListBoxModel_Reserved()

IMPORT_C TAny *MListBoxModel_Reserved()[private, virtual]

MatchableTextArray()

IMPORT_C const MDesCArray *MatchableTextArray()const [virtual]

Gets an array of strings for incremental matching of typed characters. For the text list box model, these strings are those that are displayed (see ItemText()).

A text array for matching.

NumberOfItems()

IMPORT_C TIntNumberOfItems()const [virtual]

Gets the number of text items in this list box model. The number of text items.

SetItemTextArray(MDesCArray *)

IMPORT_C voidSetItemTextArray(MDesCArray *aItemTextArray)

Sets a new text item array. Panics if aItemTextArray is NULL.

Parameters

MDesCArray * aItemTextArrayNew item text array.

SetOwnershipType(TListBoxModelItemArrayOwnership)

IMPORT_C voidSetOwnershipType(TListBoxModelItemArrayOwnershipaOwnershipType)

Sets the item array ownership type.

Parameters

TListBoxModelItemArrayOwnership aOwnershipTypeItem array ownership.

Member Data Documentation

TListBoxModelItemArrayOwnership iItemArrayOwnershipType

TListBoxModelItemArrayOwnership iItemArrayOwnershipType[private]

MDesCArray * iItemTextArray

MDesCArray *iItemTextArray[protected]

The array of text items modelled by this text list box model.