CTextListBoxModel Class Reference

#include <mw/eiktxlbm.h>

class CTextListBoxModel : public CBase

Inherits from

CTextListBoxModel

Protected Attributes
MDesCArray *	iItemTextArray

Public Member Functions
	CTextListBoxModel()
virtual	~CTextListBoxModel()
virtual IMPORT_C void	ConstructL(MDesCArray *, TListBoxModelItemArrayOwnership)
virtual IMPORT_C TPtrC	ItemText(TInt)
IMPORT_C MDesCArray *	ItemTextArray()
virtual IMPORT_C const MDesCArray *	MatchableTextArray()
virtual IMPORT_C TInt	NumberOfItems()
IMPORT_C void	SetItemTextArray(MDesCArray *)
IMPORT_C void	SetOwnershipType(TListBoxModelItemArrayOwnership)

Protected Member Functions
IMPORT_C TListBoxModelItemArrayOwnership	ItemArrayOwnershipType()

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()

Detailed Description

Text list box model.

Member Attribute Documentation

iItemTextArray

MDesCArray *

iItemTextArray

[protected]

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

Constructor & Destructor Documentation

CTextListBoxModel ( )

IMPORT_C

CTextListBoxModel

(

)

Default constructor.

~CTextListBoxModel ( )

IMPORT_C

~CTextListBoxModel

(

)

[virtual]

destructor

Member Function Documentation

ConstructL ( MDesCArray *, TListBoxModelItemArrayOwnership )

IMPORT_C void	ConstructL	(	MDesCArray *	aItemTextArray = NULL,
			TListBoxModelItemArrayOwnership	aOwnershipType = 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.

Parameter	Description
aItemTextArray	The item array.
aOwnershipType	Whether or not to take ownership of the array.

ItemArrayOwnershipType ( )

IMPORT_C TListBoxModelItemArrayOwnership

ItemArrayOwnershipType

(

)

const [protected]

Gets the item array ownership type.

Returns: Item array ownership.

ItemText ( TInt )

IMPORT_C TPtrC

ItemText

(

TInt

aItemIndex

)

const [virtual]

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

Parameter	Description
aItemIndex	Index of an item.

Returns: Text string to be displayed.

ItemTextArray ( )

IMPORT_C MDesCArray *

ItemTextArray

(

)

const

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

Returns: A pointer to the array.

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()).

Returns: A text array for matching.

NumberOfItems ( )

IMPORT_C TInt

NumberOfItems

(

)

const [virtual]

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

Returns: The number of text items.

SetItemTextArray ( MDesCArray * )

IMPORT_C void

SetItemTextArray

(

MDesCArray *

aItemTextArray

)

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

Parameter	Description
aItemTextArray	New item text array.

SetOwnershipType ( TListBoxModelItemArrayOwnership )

IMPORT_C void

SetOwnershipType

(

TListBoxModelItemArrayOwnership

aOwnershipType

)

Sets the item array ownership type.

Parameter	Description
aOwnershipType	Item array ownership.