CAknEnumeratedTextPopupSettingItem Class Reference

#include <mw/aknsettingitemlist.h>

class CAknEnumeratedTextPopupSettingItem : public CAknEnumeratedTextSettingItem

Inherits from

CAknEnumeratedTextPopupSettingItem
- CAknEnumeratedTextSettingItem
  - CAknSettingItem

Public Member Functions
	CAknEnumeratedTextPopupSettingItem(TInt, TInt &)
	~CAknEnumeratedTextPopupSettingItem()
virtual IMPORT_C void	EditItemL(TBool)
IMPORT_C CArrayPtr< CAknEnumeratedText > *	EnumeratedTextArray()
virtual IMPORT_C void	LoadL()
IMPORT_C CArrayPtr< HBufC > *	PoppedUpTextArray()
virtual IMPORT_C const TDesC &	SettingTextL()
virtual IMPORT_C void	StoreL()

Protected Member Functions
virtual IMPORT_C void	CompleteConstructionL()
virtual IMPORT_C void	CreateAndExecuteSettingPageL()
virtual IMPORT_C CAknSettingPage *	CreateSettingPageL()
IMPORT_C TInt	ExternalValue()
IMPORT_C TInt	IndexFromValue(TInt)
IMPORT_C TInt	InternalValue()
IMPORT_C MAknQueryValue *	QueryValue()
IMPORT_C void	SetExternalValue(TInt)
IMPORT_C void	SetInternalValue(TInt)
IMPORT_C void	SetSelectedIndex(TInt)

Inherited Enumerations
	CAknSettingItem:TFlags
	CAknSettingItem:TSettingItemProtection

Inherited Functions
	CAknEnumeratedTextSettingItem::CAknEnumeratedTextSettingItem(TInt)
	CAknEnumeratedTextSettingItem::HandleTextArrayUpdateL()
	CAknEnumeratedTextSettingItem::NumberOfItems()const
	CAknEnumeratedTextSettingItem::SetEnumeratedTextArrays(CArrayPtr< CAknEnumeratedText > ,CArrayPtr< HBufC > )
	CAknEnumeratedTextSettingItem::SettingPageTextArray()const
	CAknEnumeratedTextSettingItem::~CAknEnumeratedTextSettingItem()
	CAknSettingItem::AssociatedResourceId()const
	CAknSettingItem::CAknSettingItem(TInt)
	CAknSettingItem::ConstructL(const TBool,const TInt,const TDesC &,CArrayPtr< CGulIcon > *,const TInt,const TInt,const TInt,const TInt)
	CAknSettingItem::CreateBitmapL()
	CAknSettingItem::EditorControlType()const
	CAknSettingItem::EmptyItemText()const
	CAknSettingItem::HandleSettingPageEventL(CAknSettingPage *,TAknSettingPageEvent)
	CAknSettingItem::HasIcon()const
	CAknSettingItem::Identifier()const
	CAknSettingItem::IsHidden()const
	CAknSettingItem::IsNumberedStyle()const
	CAknSettingItem::ListBoxText()
	CAknSettingItem::ProtectionState()
	CAknSettingItem::SetCompulsoryIndTextL(const TDesC &)
	CAknSettingItem::SetEmptyItemTextL(const TDesC &)
	CAknSettingItem::SetHidden(TBool)
	CAknSettingItem::SetIconMask(CFbsBitmap *)
	CAknSettingItem::SetIconMaskAndReturnBitmap(CGulIcon *)
	CAknSettingItem::SetParentListBox(const CEikFormattedCellListBox *)
	CAknSettingItem::SetProtectionState(CAknSettingItem::TSettingItemProtection)
	CAknSettingItem::SetSettingPage(CAknSettingPage *)
	CAknSettingItem::SetSettingPageFlags(TInt)
	CAknSettingItem::SetUpStandardSettingPageL()
	CAknSettingItem::SettingEditorResourceId()const
	CAknSettingItem::SettingName()
	CAknSettingItem::SettingNumber()const
	CAknSettingItem::SettingPage()const
	CAknSettingItem::SettingPageFlags()const
	CAknSettingItem::SettingPageResourceId()const
	CAknSettingItem::UpdateListBoxTextL()
	CAknSettingItem::VisibleIndex()
	CAknSettingItem::~CAknSettingItem()
	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

Setting item type for CAknEnumeratedItems.

The main use case for this is for list of texts that are being manipulated in the client source code as a set of enumerations, while the texts, read from resource, are not strongly exposed to the client.

They are exposed to the user, and appear in two versions, if desired - the text shown in the setting list when not being edited, and the "popped-up" version of the texts.

Constructor & Destructor Documentation

CAknEnumeratedTextPopupSettingItem ( TInt, TInt & )

IMPORT_C	CAknEnumeratedTextPopupSettingItem	(	TInt	aResourceId,
			TInt &	aValue
		)

Construct a list, storing in it a resource (to be read at 2nd stage construction) and a reference to na externally owned integer - the value to be manipulated

~CAknEnumeratedTextPopupSettingItem ( )

IMPORT_C

~CAknEnumeratedTextPopupSettingItem

(

)

Destructor

Member Function Documentation

CompleteConstructionL ( )

IMPORT_C void

CompleteConstructionL

(

)

[protected, virtual]

Reimplemented from CAknEnumeratedTextSettingItem::CompleteConstructionL()

Method called by framework to complete the construction. Extra allocations of memory or extra resource reading can happen here.

CreateAndExecuteSettingPageL ( )

IMPORT_C void

CreateAndExecuteSettingPageL

(

)

[protected, virtual]

Framework method to create and execute setting page

CreateSettingPageL ( )

IMPORT_C CAknSettingPage *

CreateSettingPageL

(

)

[protected, virtual]

Framework method for constructing the launching setting page

Returns: a constructed CAknSettingPage object on the heap

EditItemL ( TBool )

IMPORT_C void

EditItemL

(

TBool

aCalledFromMenu

)

[virtual]

Reimplemented from CAknSettingItem::EditItemL(TBool)

This launches the setting page for popup list setting page

Parameter	Description
aCalledFromMenu	- ignored in this class

EnumeratedTextArray ( )

IMPORT_C CArrayPtr< CAknEnumeratedText > *

EnumeratedTextArray

(

)

const

Reimplemented from CAknEnumeratedTextSettingItem::EnumeratedTextArray()const

Access to the enumerated text array. Texts here are used in the setting item list display.

Returns: a pointer to an array of HBufC*s

ExternalValue ( )

IMPORT_C TInt

ExternalValue

(

)

const [protected]

Get the external value

Returns: TInt

IndexFromValue ( TInt )

IMPORT_C TInt

IndexFromValue

(

TInt

aInputValue

)

const [protected]

Reimplemented from CAknEnumeratedTextSettingItem::IndexFromValue(TInt)const

Returns the index in the enumerated item array, given the value of the enumeration

Parameter	Description
aInputValue	Value to look up; Returns -1 if value is not found

InternalValue ( )

IMPORT_C TInt

InternalValue

(

)

const [protected]

Access the internal value

Returns: TInt

LoadL ( )

IMPORT_C void

LoadL

(

)

[virtual]

Reimplemented from CAknSettingItem::LoadL()

PoppedUpTextArray ( )

IMPORT_C CArrayPtr< HBufC > *

PoppedUpTextArray

(

)

const

Reimplemented from CAknEnumeratedTextSettingItem::PoppedUpTextArray()const

Access to the "popped up" array of texts. They may be defined differently from those in the enumerated text arry

Returns: a pointer to an array of HBufC*s

QueryValue ( )

IMPORT_C MAknQueryValue *

QueryValue

(

)

const [protected]

Return a reference to the MAknQueryValue that is constructed for the CAknPopupListSettingPage

Returns: MAknQueryValue

SetExternalValue ( TInt )

IMPORT_C void

SetExternalValue

(

TInt

aNewValue

)

[protected]

Sets the value of the (unowned) external value using the reference to it held internally. Note that this does not change the value of the reference itself. That is, aNewValue's address is not copied in to be used as the external reference.

Parameter	Description
aNewValue	Value to be copied via the external reference.

SetInternalValue ( TInt )

IMPORT_C void

SetInternalValue

(

TInt

aNewValue

)

[protected]

Sets the internal value. The value of aNewValue is copied into the internal storage holding the internal value

SetSelectedIndex ( TInt )

IMPORT_C void

SetSelectedIndex

(

TInt

aNewIndex

)

[protected]

Set the item that is selected in the associated popup. This should be done so as to keep the selected index consistent with the internal value

SettingTextL ( )

IMPORT_C const TDesC &

SettingTextL

(

)

[virtual]

Reimplemented from CAknSettingItem::SettingTextL()

StoreL ( )

IMPORT_C void

StoreL

(

)

[virtual]

Reimplemented from CAknSettingItem::StoreL()

This command externalizes the current setting. The displayed (internal) copy is transferred to the external copy (the one referenced in the constructor).

This must be called by the client if he wants this to happen. Note that StoreAllL() on the setting item list will call this for each setting item.