CAknEnumeratedTextPopupSettingItem Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknsettingitemlist.h>

Inherits CAknEnumeratedTextSettingItem.

Inherited by CAknBinaryPopupSettingItem.

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.


Public Member Functions
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.
IMPORT_C	~CAknEnumeratedTextPopupSettingItem ()
	Destructor.
virtual IMPORT_C void	StoreL ()
	This command externalizes the current setting.
virtual IMPORT_C void	LoadL ()
virtual IMPORT_C const TDesC &	SettingTextL ()
virtual IMPORT_C void	EditItemL (TBool aCalledFromMenu)
	This launches the setting page for popup list setting page.
IMPORT_C CArrayPtr< CAknEnumeratedText > *	EnumeratedTextArray () const
	Access to the enumerated text array.
IMPORT_C CArrayPtr< HBufC > *	PoppedUpTextArray () const
	Access to the "popped up" array of texts.
Protected Member Functions
virtual IMPORT_C CAknSettingPage *	CreateSettingPageL ()
	Framework method for constructing the launching setting page.
virtual IMPORT_C void	CreateAndExecuteSettingPageL ()
	Framework method to create and execute setting page.
virtual IMPORT_C void	CompleteConstructionL ()
	Method called by framework to complete the construction.
IMPORT_C void	SetExternalValue (TInt aNewValue)
	Sets the value of the (unowned) external value using the reference to it held internally.
IMPORT_C void	SetInternalValue (TInt aNewValue)
	Sets the internal value.
IMPORT_C void	SetSelectedIndex (TInt aNewIndex)
	Set the item that is selected in the associated popup.
IMPORT_C TInt	IndexFromValue (TInt aInputValue) const
	Returns the index in the enumerated item array, given the value of the enumeration.
IMPORT_C TInt	ExternalValue () const
	Get the external value.
IMPORT_C TInt	InternalValue () const
	Access the internal value.
IMPORT_C MAknQueryValue *	QueryValue () const
	Return a reference to the MAknQueryValue that is constructed for the CAknPopupListSettingPage.

Constructor & Destructor Documentation

IMPORT_C CAknEnumeratedTextPopupSettingItem::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.

IMPORT_C CAknEnumeratedTextPopupSettingItem::~CAknEnumeratedTextPopupSettingItem

(

)

Destructor.

Member Function Documentation

virtual IMPORT_C void CAknEnumeratedTextPopupSettingItem::CompleteConstructionL ( ) [protected, virtual]

Method called by framework to complete the construction.

Extra allocations of memory or extra resource reading can happen here.

Reimplemented from CAknEnumeratedTextSettingItem.

Reimplemented in CAknBinaryPopupSettingItem.

virtual IMPORT_C void CAknEnumeratedTextPopupSettingItem::CreateAndExecuteSettingPageL ( ) [protected, virtual]

Framework method to create and execute setting page.

virtual IMPORT_C CAknSettingPage* CAknEnumeratedTextPopupSettingItem::CreateSettingPageL ( ) [protected, virtual]

Framework method for constructing the launching setting page.

Returns:: a constructed CAknSettingPage object on the heap

virtual IMPORT_C void CAknEnumeratedTextPopupSettingItem::EditItemL ( TBool aCalledFromMenu ) [virtual]

This launches the setting page for popup list setting page.

Parameters:

aCalledFromMenu

- ignored in this class

Reimplemented from CAknSettingItem.

Reimplemented in CAknBinaryPopupSettingItem.

IMPORT_C CArrayPtr<CAknEnumeratedText>* CAknEnumeratedTextPopupSettingItem::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

Reimplemented from CAknEnumeratedTextSettingItem.

IMPORT_C TInt CAknEnumeratedTextPopupSettingItem::ExternalValue ( ) const [protected]

Get the external value.

Returns:: TInt

IMPORT_C TInt CAknEnumeratedTextPopupSettingItem::IndexFromValue ( TInt aInputValue ) const [protected]

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

Parameters:

aInputValue

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

Reimplemented from CAknEnumeratedTextSettingItem.

IMPORT_C TInt CAknEnumeratedTextPopupSettingItem::InternalValue ( ) const [protected]

Access the internal value.

Returns:: TInt

virtual IMPORT_C void CAknEnumeratedTextPopupSettingItem::LoadL ( ) [virtual]

Reimplemented from CAknSettingItem.

Reimplemented in CAknBinaryPopupSettingItem.

IMPORT_C CArrayPtr<HBufC>* CAknEnumeratedTextPopupSettingItem::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

Reimplemented from CAknEnumeratedTextSettingItem.

IMPORT_C MAknQueryValue* CAknEnumeratedTextPopupSettingItem::QueryValue ( ) const [protected]

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

Returns:: MAknQueryValue

IMPORT_C void CAknEnumeratedTextPopupSettingItem::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.

Parameters:

aNewValue

Value to be copied via the external reference.

IMPORT_C void CAknEnumeratedTextPopupSettingItem::SetInternalValue ( TInt aNewValue ) [protected]

Sets the internal value.

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

Parameters:

aNewValue

IMPORT_C void CAknEnumeratedTextPopupSettingItem::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

Parameters:

aNewIndex

virtual IMPORT_C const TDesC& CAknEnumeratedTextPopupSettingItem::SettingTextL ( ) [virtual]

Reimplemented from CAknSettingItem.

virtual IMPORT_C void CAknEnumeratedTextPopupSettingItem::StoreL ( ) [virtual]

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.

Reimplemented from CAknSettingItem.

Reimplemented in CAknBinaryPopupSettingItem.

The documentation for this class was generated from the following file:

aknsettingitemlist.h

CAknEnumeratedTextPopupSettingItem Class Reference

Capability Information

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation