Collapse all Symbian^3 Application Developer Library

CTextListBoxModel Class Reference

class CTextListBoxModel : public CBase

Text list box model.

Inherits from

CTextListBoxModel
- CBase

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

Protected Member Functions
IMPORT_C TListBoxModelItemArrayOwnership	ItemArrayOwnershipType ()

Private Member Functions
IMPORT_C TAny *	MListBoxModel_Reserved ()

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

Protected Attributes
MDesCArray *	iItemTextArray

Private Attributes
TListBoxModelItemArrayOwnership	iItemArrayOwnershipType

Constructor & Destructor Documentation

CTextListBoxModel()

IMPORT_C

CTextListBoxModel

(

)

Default constructor.

~CTextListBoxModel()

IMPORT_C

~CTextListBoxModel

(

)

[virtual]

destructor

Member Functions 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.

Parameters

MDesCArray * aItemTextArray = NULL	The item array.
TListBoxModelItemArrayOwnership aOwnershipType = ELbmOwnsItemArray	Whether or not to take ownership of the array.

ItemArrayOwnershipType()

IMPORT_C TListBoxModelItemArrayOwnership

ItemArrayOwnershipType

(

)

const [protected]

Gets the item array ownership type.

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.

Parameters

TInt aItemIndex

Index of an item.

ItemTextArray()

IMPORT_C MDesCArray *

ItemTextArray

(

)

const

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

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

NumberOfItems()

IMPORT_C TInt

NumberOfItems

(

)

const [virtual]

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

SetItemTextArray(MDesCArray *)

IMPORT_C void

SetItemTextArray

(

MDesCArray *

aItemTextArray

)

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

Parameters

MDesCArray * aItemTextArray

New item text array.

SetOwnershipType(TListBoxModelItemArrayOwnership)

IMPORT_C void

SetOwnershipType

(

TListBoxModelItemArrayOwnership

aOwnershipType

)

Sets the item array ownership type.

Parameters

TListBoxModelItemArrayOwnership aOwnershipType

Item 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.