Collapse all Symbian^3 Application Developer Library

CGSItemTextArray Class Reference

class CGSItemTextArray : public CBase

Inherits from

CGSItemTextArray
- CBase

Public Member Functions
	~CGSItemTextArray ()
IMPORT_C TInt	CurrentFeature ()
IMPORT_C const CGSListboxEntry *	FeatureByIdL ( TInt )
IMPORT_C TInt	FeatureIdByIndex ( TInt )
IMPORT_C HBufC *	GetItemCaptionFromFeatureIdLC ( TUint32 , TInt , CCoeEnv &)
IMPORT_C TInt	IndexForFeatureIdL ( TInt )
IMPORT_C TInt	MdcaCount ()
IMPORT_C TPtrC	MdcaPoint ( TInt )
IMPORT_C CGSItemTextArray *	NewL ( TUint32 , CCoeEnv &)
IMPORT_C void	SetDynamicTextDoublePaneL ( TInt , const TDesC &)
IMPORT_C void	SetDynamicTextL ( TInt , const TDesC &)
IMPORT_C void	SetItemVisibilityL ( TInt , TVisibility )

Protected Member Functions
	CGSItemTextArray ()
void	ConstructL ( TUint32 , CCoeEnv &)
void	ConstructL ( TUint32 , CCoeEnv &, TInt )

Private Member Functions
TBool	CompareEntries (const CGSListboxEntry &, const CGSListboxEntry &)

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

Public Member Enumerations
enum	TVisibility { EInvisible = 0, EVisible = 1 }

Protected Attributes
RPointerArray < CGSListboxEntry >	iAllEntries
RPointerArray < CGSListboxEntry >	iCurrentlyDisplayedEntries

Constructor & Destructor Documentation

CGSItemTextArray()

CGSItemTextArray

(

)

[protected]

~CGSItemTextArray()

~CGSItemTextArray

(

)

Member Functions Documentation

CompareEntries(const CGSListboxEntry &, const CGSListboxEntry &)

TBool	CompareEntries	(	const CGSListboxEntry &	aLeft,
			const CGSListboxEntry &	aRight
		)	[private, static]

Parameters

const CGSListboxEntry & aLeft
const CGSListboxEntry & aRight

ConstructL(TUint32, CCoeEnv &)

void	ConstructL	(	TUint32	aResId,
			CCoeEnv &	aEnv
		)	[protected]

Parameters

TUint32 aResId
CCoeEnv & aEnv

ConstructL(TUint32, CCoeEnv &, TInt)

void	ConstructL	(	TUint32	aResId,
			CCoeEnv &	aEnv,
			TInt	aCount
		)	[protected]

Parameters

TUint32 aResId
CCoeEnv & aEnv
TInt aCount

CurrentFeature()

IMPORT_C TInt

CurrentFeature

(

)

const [virtual]

Access the id of the currently selected feature

FeatureByIdL(TInt)

IMPORT_C const CGSListboxEntry *

FeatureByIdL

(

TInt

aFeatureId

)

const

Parameters

TInt aFeatureId

FeatureIdByIndex(TInt)

IMPORT_C TInt

FeatureIdByIndex

(

TInt

aIndex

)

const

Returns the feature id corresponding to an index

Parameters

TInt aIndex

GetItemCaptionFromFeatureIdLC(TUint32, TInt, CCoeEnv &)

IMPORT_C HBufC *	GetItemCaptionFromFeatureIdLC	(	TUint32	aResourceId,
			TInt	aFeatureId,
			CCoeEnv &	aCone
		)	[static]

Parameters

TUint32 aResourceId
TInt aFeatureId
CCoeEnv & aCone

IndexForFeatureIdL(TInt)

IMPORT_C TInt

IndexForFeatureIdL

(

TInt

aFeatureId

)

const

Set the currently selected feature id

Parameters

TInt aFeatureId

MdcaCount()

IMPORT_C TInt

MdcaCount

(

)

const

MdcaPoint(TInt)

IMPORT_C TPtrC

MdcaPoint

(

TInt

aIndex

)

const

Parameters

TInt aIndex

NewL(TUint32, CCoeEnv &)

IMPORT_C CGSItemTextArray *	NewL	(	TUint32	aResId,
			CCoeEnv &	aEnv
		)	[static]

Parameters

TUint32 aResId
CCoeEnv & aEnv

SetDynamicTextDoublePaneL(TInt, const TDesC &)

IMPORT_C void	SetDynamicTextDoublePaneL	(	TInt	aFeatureId,
			const TDesC &	aAdditionalText
		)

Used to add dynamic text to the end of an existing model item When Double Pane List box is used CAknDoubleStyleListBox

Parameters

TInt aFeatureId
const TDesC & aAdditionalText

SetDynamicTextL(TInt, const TDesC &)

IMPORT_C void	SetDynamicTextL	(	TInt	aFeatureId,
			const TDesC &	aAdditionalText
		)

Used to add dynamic text to the end of an existing model item

Parameters

TInt aFeatureId
const TDesC & aAdditionalText

SetItemVisibilityL(TInt, TVisibility)

IMPORT_C void	SetItemVisibilityL	(	TInt	aFeatureId,
			TVisibility	aVisibility
		)

Specify that this item should be visible / invisible in the iCurrentlyDisplayedEntries array

Parameters

TInt aFeatureId
TVisibility aVisibility

Member Enumerations Documentation

Enum TVisibility

Enumerators

EInvisible = 0
EVisible = 1

Member Data Documentation

RPointerArray< CGSListboxEntry > iAllEntries

RPointerArray < CGSListboxEntry >

iAllEntries

[protected]

All the entries which may potentially be contained within the listbox model. This array is owned and destroyed by this class.

RPointerArray< CGSListboxEntry > iCurrentlyDisplayedEntries

RPointerArray < CGSListboxEntry >

iCurrentlyDisplayedEntries

[protected]

The entries which are currently displayed within the listbox. These pointers are actually owned in the iAllEntries array and therefore this array must not be 'ResetAndDestroyed()' (but rather just Reset()) from within this class' destructor.