CAknEnumeratedTextPopupSettingItem Class Reference

class CAknEnumeratedTextPopupSettingItem : public CAknEnumeratedTextSettingItem

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.

Inherits from

Public Member Functions
CAknEnumeratedTextPopupSettingItem ( TInt , TInt &)
~CAknEnumeratedTextPopupSettingItem ()
IMPORT_C void EditItemL ( TBool )
IMPORT_C CArrayPtr < CAknEnumeratedText > * EnumeratedTextArray ()
IMPORT_C void LoadL ()
IMPORT_C CArrayPtr < HBufC > * PoppedUpTextArray ()
IMPORT_C const TDesC & SettingTextL ()
IMPORT_C void StoreL ()
Protected Member Functions
IMPORT_C void CompleteConstructionL ()
IMPORT_C void CreateAndExecuteSettingPageL ()
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 )
Private Member Functions
IMPORT_C void CAknSettingItem_Reserved ()
void CreateQueryValueL ()
void CreateTextArrayL ()
TInt FindNextEnumerationValue ()
void SetSettingPageTextL ()
void UpdateInternalValuesL ()
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()
Inherited Enumerations
CAknSettingItem:TFlags
CAknSettingItem:TSettingItemProtection
Private Attributes
TInt & iExternalValue
TInt iInternalValue
TInt iNumberOfItems
CAknQueryValueTextArray * iQueryTextArray
CAknQueryValueText * iQueryValue
TInt iSelectedIndex
TInt iSpare_EnumeratedTextPopup_1

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

Parameters

TInt aResourceId
TInt & aValue

~CAknEnumeratedTextPopupSettingItem()

IMPORT_C ~CAknEnumeratedTextPopupSettingItem ( )

Destructor

Member Functions Documentation

CAknSettingItem_Reserved()

IMPORT_C void CAknSettingItem_Reserved ( ) [private]

CompleteConstructionL()

IMPORT_C void CompleteConstructionL ( ) [protected, virtual]

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

CreateQueryValueL()

void CreateQueryValueL ( ) [private]

CreateSettingPageL()

IMPORT_C CAknSettingPage * CreateSettingPageL ( ) [protected, virtual]

Framework method for constructing the launching setting page

CreateTextArrayL()

void CreateTextArrayL ( ) [private]

EditItemL(TBool)

IMPORT_C void EditItemL ( TBool aCalledFromMenu ) [virtual]

This launches the setting page for popup list setting page

Parameters

TBool aCalledFromMenu - ignored in this class

EnumeratedTextArray()

IMPORT_C CArrayPtr < CAknEnumeratedText > * EnumeratedTextArray ( ) const

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

ExternalValue()

IMPORT_C TInt ExternalValue ( ) const [protected]

Get the external value

FindNextEnumerationValue()

TInt FindNextEnumerationValue ( ) const [private]

This routine looks at the current enumeration values and returns the next integer higher than the highest enumeration. For internal use only, although it is possible that clients or derivers might want to use somthing like it.

IndexFromValue(TInt)

IMPORT_C TInt IndexFromValue ( TInt aInputValue ) const [protected]

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

Parameters

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

InternalValue()

IMPORT_C TInt InternalValue ( ) const [protected]

Access the internal value

LoadL()

IMPORT_C void LoadL ( ) [virtual]

PoppedUpTextArray()

IMPORT_C CArrayPtr < HBufC > * PoppedUpTextArray ( ) const

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

QueryValue()

IMPORT_C MAknQueryValue * QueryValue ( ) const [protected]

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

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.

Parameters

TInt 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

Parameters

TInt aNewValue

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

Parameters

TInt aNewIndex

SetSettingPageTextL()

void SetSettingPageTextL ( ) [private]

Implementors of subclasses can call this non-virtual method to set up the list of texts to be used for the setting page. (Although it is not useful for CAknCheckBoxSettingPage ) The list is constructed from the contents of the two text arrays, EnumeratedTextArray() and PoppedUpTextArray() . This is usually to be done "On the fly" immediately prior to the raising of a setting page.

SettingTextL()

IMPORT_C const TDesC & SettingTextL ( ) [virtual]

StoreL()

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

UpdateInternalValuesL()

void UpdateInternalValuesL ( ) [private]

Member Data Documentation

TInt & iExternalValue

TInt & iExternalValue [private]

TInt iInternalValue

TInt iInternalValue [private]

TInt iNumberOfItems

TInt iNumberOfItems [private]

CAknQueryValueTextArray * iQueryTextArray

CAknQueryValueTextArray * iQueryTextArray [private]

CAknQueryValueText * iQueryValue

CAknQueryValueText * iQueryValue [private]

TInt iSelectedIndex

TInt iSelectedIndex [private]

TInt iSpare_EnumeratedTextPopup_1

TInt iSpare_EnumeratedTextPopup_1 [private]