CAknSettingPage Class Reference

class CAknSettingPage : public CAknControl

Inherits from

Public Member Functions
CAknSettingPage(TInt)
CAknSettingPage(const TDesC *, TInt, TInt, TInt, TInt)
~CAknSettingPage()
IMPORT_C CEikButtonGroupContainer *Cba()
IMPORT_C CCoeControl *ComponentControl(TInt)
IMPORT_C voidConstructL()
IMPORT_C TIntCountComponentControls()
IMPORT_C CCoeControl *EditorControl()
IMPORT_C TBoolExecuteLD(enum CAknSettingPage::TAknSettingPageUpdateMode)
voidGetCaptionForFep(TDes &)
IMPORT_C voidGetEditorResourceInfoL(TInt, TInt &, TInt &)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C TCoeInputCapabilitiesInputCapabilities()
TBool IsBackgroundDrawingEnabled()
IMPORT_C TBoolIsEditable()
IMPORT_C TBoolIsNumbered()
IMPORT_C voidSetEditState(const TBool)
IMPORT_C voidSetNumbered(TBool)
IMPORT_C voidSetSettingId(TInt)
IMPORT_C voidSetSettingNumberL(const TInt)
IMPORT_C voidSetSettingPageObserver(MAknSettingPageObserver *)
IMPORT_C voidSetSettingTextL(const TDesC &)
IMPORT_C TIntSettingId()
TRect SettingItemContentRect(TBool)
IMPORT_C TIntSettingNumber()
Protected Member Functions
IMPORT_C voidAcceptSettingL()
IMPORT_C voidAttemptExitL(TBool)
IMPORT_C voidBaseConstructL()
voidBaseConstructL(TUint)
IMPORT_C voidBaseDraw(const TRect &)
IMPORT_C voidCheckAndSetDataValidity()
IMPORT_C voidConstructFromResourceL(TInt)
IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C TBoolDataValidity()
IMPORT_C TIntDefaultCbaResourceId()
IMPORT_C voidDismissL(TBool)
IMPORT_C voidDisplayMenuL()
IMPORT_C voidDynInitMenuPaneL(TInt, CEikMenuPane *)
IMPORT_C voidDynamicInitL()
CAknsFrameBackgroundControlContext *EditedItemControlContext()
IMPORT_C voidFocusChanged(TDrawNow)
IMPORT_C voidHandleControlEventL(CCoeControl *, TCoeEvent)
IMPORT_C voidHideMenu()
IMPORT_C TIntInvalidDataCbaResourceId()
IMPORT_C TBoolIsBaseConstructed()
TBool IsSkinsHandlingEditorFrameDrawing()
TBool IsStopActiveSchudlerCalled()
IMPORT_C TBoolMenuShowing()
IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUid)
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C TBoolOkToExitL(TBool)
IMPORT_C TBoolPostDisplayCheckL()
IMPORT_C voidProcessCommandL(TInt)
IMPORT_C voidResetFlags()
IMPORT_C voidRestoreOriginalSettingL()
IMPORT_C voidSelectCurrentItemL()
IMPORT_C voidSetDataValidity(TBool)
voidSetDrawBackground(const TBool)
voidSetEditedItemFrameIID(const TAknsItemID &, const TAknsItemID &)
voidSetEditedItemFrameRects(const TRect &, const TRect &)
voidSetEditorIndicatorRect(const TRect &)
IMPORT_C voidSetEmphasis(CCoeControl *, TBool)
IMPORT_C voidSetFocusToEditor()
voidSetStopActiveSchedulerFlag(const TBool)
IMPORT_C TIntSettingPageResourceId()
IMPORT_C CEikLabel *ShadowText()
IMPORT_C voidSizeChanged()
IMPORT_C voidStandardSettingPageLayout()
voidStopActiveScheduler()
IMPORT_C CEikLabel *TextLabel()
IMPORT_C voidUpdateCbaL()
IMPORT_C voidUpdateSettingL()
IMPORT_C TBoolWaiting()
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
IMPORT_C voidCAknSettingPage_Reserved_1()
IMPORT_C voidCAknSettingPage_Reserved_2()
IMPORT_C voidDraw(const TRect &)
IMPORT_C void *ExtensionInterface(TUid)
voidPopNaviDecoratorIfRequired()
IMPORT_C voidReserved_2()
IMPORT_C voidReserved_MtsmObject()
IMPORT_C voidReserved_MtsmPosition()
voidStartActiveScheduler()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MinimumSize()
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
Public Member Enumerations
enumTAknSettingPageUpdateMode { EUpdateWhenChanged, EUpdateWhenAccepted }
enumTEditedItemSkinClass { ESettingPageSkinEditedItemClassValueItemList, ESettingPageSkinEditedItemClassVolume, ESettingPageSkinEditedItemClassSlider, ESettingPageSkinEditedItemClassTextEntry, ESettingPageSkinEditedItemClassCodeDateTimeEntry }
Private Member Enumerations
enumTFlagIndices { EMenuShowingIndex = 0, ENumberedStyleIndex, EIsBaseConstructedIndex, EHasValidDataIndex }
Inherited Enumerations
CCoeControl:TZoomType
Protected Attributes
MAknSettingPageObserver *iSettingPageObserver
TInt iUpdateMode
Private Attributes
CEikButtonGroupContainer *iCba
TInt iCbaResourceId
TInt iControlType
CCoeControl *iEditorControl
TInt iEditorResourceId
CAknSettingPageExtension *iExtension
TInt iExtensionId
TBitFlags iFlags
TAknLayoutRect iHighlight
HBufC *iHintText
TInt iInvalidDataCbaResourceId
TInt iIsProtected
CEikMenuBar *iMenuBar
TInt iMenuBarId
CAknNavigationDecorator *iNaviDecorator
CAknNavigationControlContainer *iNaviPane
CEikLabel *iNumberLabel
TInt iResourceId
TBool *iReturn
TInt iSettingId
TInt iSettingNumber
HBufC *iSettingText
const TDesC *iSettingTextFromConstructor
TAknLayoutRect iShadow
CAknSettingPageSkinsInfo *iSkinsInfo
CEikLabel *iTextLabel
CActiveSchedulerWait iWait
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknSettingPage(TInt)

IMPORT_CCAknSettingPage(TIntaSettingPageResourceId)

Simple contructor for using a single setting page resource which itself gives all the setup

Parameters

TInt aSettingPageResourceId

CAknSettingPage(const TDesC *, TInt, TInt, TInt, TInt)

IMPORT_CCAknSettingPage(const TDesC *aSettingTitleText,
TIntaSettingNumber,
TIntaControlType,
TIntaEditorResourceId,
TIntaSettingPageResourceId = 0
)

Constructor that allows separate setting page and editor resources

In all cases the number (if supplied i.e. <> 0 ) is used.

Editor Resource Setting Page Resource present present Both are used (but text & number overridden) = 0 present Editor resource is used via SP resource present = 0 Default Avkon SP resource if used = 0 = 0 Not permitted

Note: The first argument is a TDesC* (rather than TDesC&) because the other constructor cannot initialize such a member without allocation or having an internal dummy buffer.

Rules for text and numbers: The rules are the same for both: (non-zero length) text or number other than EAknSettingPageNoOrdinalDisplayed if given in this constructor will not override resource (unless that is zero length or EAknSettingPageNoOrdinalDisplayed). Note, however, that text or number given via the specific API for setting them, WILL override resource. It is assumed that number from resource is very rare. Special text is somewhat more likely.

Parameters

const TDesC * aSettingTitleTextText at top of setting pane (not copied; must be owned externally until ExecuteLD is called)
TInt aSettingNumberNumber at top left (if present)
TInt aControlTypeDetermines the type constructed and how its resource is read
TInt aEditorResourceIdEditor resource to use in the setting page (if present)
TInt aSettingPageResourceId = 0Setting Page to use (if present)

~CAknSettingPage()

IMPORT_C~CAknSettingPage()[virtual]

C++ destructor

Member Functions Documentation

AcceptSettingL()

IMPORT_C voidAcceptSettingL()[protected, virtual]

Called when the user accepts a setting and the setting page is about to be dismissed. The latest value of the setting is written to the client's object

AttemptExitL(TBool)

IMPORT_C voidAttemptExitL(TBoolaAccept)[protected]

Called when the user accepts or cancels the setting. Default implementation sets the return value and exists.

Re-implementations must call DismissL and StopActiveScheduler() if the setting is to leave.

Parameters

TBool aAcceptETrue if the user accepted. EFalse if the user cancelled.

BaseConstructL()

IMPORT_C voidBaseConstructL()[protected]

Protected non-virtual base method for construction. Only thing required to do in this class is call the ConstructFromResourceL routine and set the flag that says construction has occured

BaseConstructL(TUint)

voidBaseConstructL(TUintaFlags)[protected]

Performs base construction and takes possible flags into account.

Since
5.2

Parameters

TUint aFlagsConstruction flags

BaseDraw(const TRect &)

IMPORT_C voidBaseDraw(const TRect &aRect)const [protected]

Perform the drawing of coded within CAknSettingPage

Parameters

const TRect & aRect

CAknSettingPage_Reserved_1()

IMPORT_C voidCAknSettingPage_Reserved_1()[private, virtual]

New reserved methods for CAknSettingPage hierarchy

CAknSettingPage_Reserved_2()

IMPORT_C voidCAknSettingPage_Reserved_2()[private, virtual]

Cba()

IMPORT_C CEikButtonGroupContainer *Cba()const

Access method to the Command button array

Must be called after full construction, or null reference will be returned.

CheckAndSetDataValidity()

IMPORT_C voidCheckAndSetDataValidity()[protected, virtual]

Framework method to set the validity of the data This is called when the data changes.

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntanIndex)const [virtual]

Standard CCoeControl routine to return the control at a given index

Parameters

TInt anIndex

ConstructFromResourceL(TInt)

IMPORT_C voidConstructFromResourceL(TIntaResourceId)[protected]

This constructs the control based upon the id passed

Parameters

TInt aResourceId

ConstructFromResourceL(TResourceReader &)

IMPORT_C voidConstructFromResourceL(TResourceReader &aRes)[protected, virtual]

This constructs the control based upon a constructed and positioned reader

Parameters

TResourceReader & aRes

ConstructL()

IMPORT_C voidConstructL()[virtual]

public method for construction. Only thing required to do in this class is to call the BaseConstructL(). Derived classes may be required to do more

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [virtual]

Standard CCoeControl routine to return the number of componentn controls

DataValidity()

IMPORT_C TBoolDataValidity()const [protected]

Called to access the validity state of the data

DefaultCbaResourceId()

IMPORT_C TIntDefaultCbaResourceId()const [protected]

This is used to access the default resource id for the cba - the one used when data is valid.

DismissL(TBool)

IMPORT_C voidDismissL(TBoolaAccept)[protected]

Called to remove the setting page. Should not be called except from within re-implemented AttemptExitL

Parameters

TBool aAcceptETrue to accept the current value; EFalse otherwise

DisplayMenuL()

IMPORT_C voidDisplayMenuL()[protected, virtual]

Display the menu

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [private, virtual]

Parameters

const TRect & aRect

DynInitMenuPaneL(TInt, CEikMenuPane *)

IMPORT_C voidDynInitMenuPaneL(TIntaResourceId,
CEikMenuPane *aMenuPane
)[protected, virtual]

From MEikMenuObserver This function intializes the items on the menu. It is used to disable and enable menu items and may be over ridden to add new ones. In addition it adds menu items which have been provided in the ConstructL in the form of a Menu Bar resource. Instead of using the Menu Bar directly it extracts the menu panes and adds them to its own menu pane. It must be called in the DynInitMenuPaneL() function of any derived class before anything else.

Parameters

TInt aResourceId
CEikMenuPane * aMenuPane

DynamicInitL()

IMPORT_C voidDynamicInitL()[protected, virtual]

Called immediately prior to activation of the dialog. Framework routine for derived classes.

EditedItemControlContext()

CAknsFrameBackgroundControlContext *EditedItemControlContext()const [protected]

Control context for providing to the skinning for the hosted editor and its framing

Since
2.0

EditorControl()

IMPORT_C CCoeControl *EditorControl()const

Returns reference to the hosted "editor" control as a CCoeControl. This routine is used in derived classes, which may then cast to the specific run-time type Note also that derived classes may provide type-specific access that performs these casts already

ExecuteLD(enum CAknSettingPage::TAknSettingPageUpdateMode)

IMPORT_C TBoolExecuteLD(enum CAknSettingPage::TAknSettingPageUpdateModeaMode = EUpdateWhenAccepted)

Executes a waiting dialog-like setting page

The passed mode determines if the editor's value is updated continuously, or just when it is accepted.

Parameters

enum CAknSettingPage::TAknSettingPageUpdateMode aMode = EUpdateWhenAcceptedThe update mode of the class

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

FocusChanged(TDrawNow)

IMPORT_C voidFocusChanged(TDrawNowaDrawNow)[protected, virtual]

From CCoeControl Takes any action required when the control gains or loses focus e.g. to change its appearance. The control should be redrawn depending on the value of aDrawNow. Empty by default.

Parameters

TDrawNow aDrawNow

GetCaptionForFep(TDes &)

voidGetCaptionForFep(TDes &aCaption)const

Used for aknsettingpage's extenstion corresponding function

Since
5.0

Parameters

TDes & aCaptionOn return, this should be set to the caption of the target control.

GetEditorResourceInfoL(TInt, TInt &, TInt &)

IMPORT_C voidGetEditorResourceInfoL(TIntaSettingPageResourceId,
TInt &aControlType,
TInt &aEditorResourceId
)[static]

Reads the passed-in setting page resource in order to read the contained editor control resource information This will leave if an invalid resource ID is passed

Parameters

TInt aSettingPageResourceId
TInt & aControlTypeReturns the control type (MAY return 0 - that's a valid control type!
TInt & aEditorResourceIdReturns the setting page's LLINK editor resource, but returns 0 if not present

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C voidHandleControlEventL(CCoeControl *aControl,
TCoeEventaEventType
)[protected, virtual]

From MCoeControlObserver: Acts upon changes in the hosted control's state.

This class's implementation is trivial and should be able to be safely re-implemented in directly client-derived classes. For non-base setting page classes, a call to the base class should be made

Parameters

CCoeControl * aControlThe control changing its state (not used)
TCoeEvent aEventTypeThe type of control event

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

Handles pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Since
2.0

Parameters

TInt aTypeReason for the "resource" change, usually an system event UID

HideMenu()

IMPORT_C voidHideMenu()[protected, virtual]

Hide the menu

InputCapabilities()

IMPORT_C TCoeInputCapabilitiesInputCapabilities()const [virtual]

From CCoeControl. Gets the control's input capabilities.

InvalidDataCbaResourceId()

IMPORT_C TIntInvalidDataCbaResourceId()const [protected]

Access method for the softkey resource used when there is invalid data

IsBackgroundDrawingEnabled()

TBool IsBackgroundDrawingEnabled()const

Is the setting page drawing the background itself or not (= "transparency")

IsBaseConstructed()

IMPORT_C TBoolIsBaseConstructed()[protected]

This method can be used to test if BaseConstructL() has been called yet successfully

IsEditable()

IMPORT_C TBoolIsEditable()const

Is the setting page possible to edit by the user.

Since
3.1

IsNumbered()

IMPORT_C TBoolIsNumbered()const

Access method for whether the setting page is numbered or not

IsSkinsHandlingEditorFrameDrawing()

TBool IsSkinsHandlingEditorFrameDrawing()const [protected]

Indicates whether skin system will be able to draw the editor frame and background

Since
2.0

IsStopActiveSchudlerCalled()

TBool IsStopActiveSchudlerCalled()const [protected]

Is the setting page call the StopActiveScheduler or not

MenuShowing()

IMPORT_C TBoolMenuShowing()const [protected]

This is used as a protected access function for the state of the menu bar

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUidaId)[protected]

Parameters

TTypeUid aId

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[protected, virtual]

This routine routes the keys to the editor. However, if the menu is showing, then events are sent to the menu.

Parameters

const TKeyEvent & aKeyEventevent information
TEventCode aTypetype of event being handled

OkToExitL(TBool)

IMPORT_C TBoolOkToExitL(TBoolaAccept)[protected, virtual]

Framework method to determine if it is OK to exit the setting page. Derived classes may check for valid data before allowing the dismissal of the setting page.

Parameters

TBool aAcceptETrue if the user has indicated to accept the setting page; EFalse otherwise

PopNaviDecoratorIfRequired()

voidPopNaviDecoratorIfRequired()[private]

Pop the navidecorator. The iNaviPane is used as a flag to show if popping is required to be done or not. It is zeroed by this method.

PostDisplayCheckL()

IMPORT_C TBoolPostDisplayCheckL()[protected, virtual]

Framework method called as soon as the setting page is displayed, but before the new active sheduler level is started. Returning EFalse will dismiss the setting page right away

ProcessCommandL(TInt)

IMPORT_C voidProcessCommandL(TIntaCommandId)[protected, virtual]

From MEikCommandObserver Processes events from the softkeys. Responds to EAknSoftkeyOk and EAknSoftkeyBack to accept or cancel the pop-up.

Parameters

TInt aCommandIdEvent Id from the soft-key

Reserved_2()

IMPORT_C voidReserved_2()[private, virtual]

Reserved method derived from CCoeControl

Reserved_MtsmObject()

IMPORT_C voidReserved_MtsmObject()[private, virtual]

Reserved_MtsmPosition()

IMPORT_C voidReserved_MtsmPosition()[private, virtual]

ResetFlags()

IMPORT_C voidResetFlags()[protected]

Set default construction values of internal state

RestoreOriginalSettingL()

IMPORT_C voidRestoreOriginalSettingL()[protected, virtual]

Called when the user rejects the setting. A backup copy may need to be restored if UpdateWhenChanged flag was set

SelectCurrentItemL()

IMPORT_C voidSelectCurrentItemL()[protected, virtual]

This method should be implemented in listbox classes to move the selection in listbox editors prior to exiting from the setting page. It is called on a CAknSettingPage* reference, and is therefore declared here.

SetDataValidity(TBool)

IMPORT_C voidSetDataValidity(TBoolaValid)[protected]

used to set the validity of the data

Parameters

TBool aValid

SetDrawBackground(const TBool)

voidSetDrawBackground(const TBoolaDrawBackground)[protected]

Enables / disables transparency effect, i.e. does the setting page draw its own background or not.

Parameters

const TBool aDrawBackgroundEFalse enables transparency

SetEditState(const TBool)

IMPORT_C voidSetEditState(const TBoolaEditable)

Set the edit-state of the setting page. The setting page can be edited or it can be only viewed by the user.

Since
3.1

Parameters

const TBool aEditableIf false, the setting page cannot be modified by the user

SetEditedItemFrameIID(const TAknsItemID &, const TAknsItemID &)

voidSetEditedItemFrameIID(const TAknsItemID &aFrameIID,
const TAknsItemID &aFrameCenterIID
)[protected]

Sets the skin item ID for the frame graphics that is drawn around the setting item.

Since
5.2

Parameters

const TAknsItemID & aFrameIIDSkin item ID of the frame graphics.
const TAknsItemID & aFrameCenterIIDSkin item ID of the center piece of the frame graphics

SetEditedItemFrameRects(const TRect &, const TRect &)

voidSetEditedItemFrameRects(const TRect &aOuterRect,
const TRect &aInnerRect
)[protected]

Sets the outer and inner rectangle for the frame graphics that is drawn around the setting item.

Since
5.2

Parameters

const TRect & aOuterRectFrame outer rectangle.
const TRect & aInnerRectFrame inner rectangle.

SetEditorIndicatorRect(const TRect &)

voidSetEditorIndicatorRect(const TRect &aRect)[protected]

Sets the rectangle for the editing state indicators. Should only be called by setting pages that have an editor which displays the editor indicators as the editor control.

Since
5.2

Parameters

const TRect & aRectEditor indicator rectangle.

SetEmphasis(CCoeControl *, TBool)

IMPORT_C voidSetEmphasis(CCoeControl *,
TBoolaEmphasis
)[protected, virtual]

From MEikMenuObserver Called when menu is cancelled.

Parameters

CCoeControl *
TBool aEmphasis

SetFocusToEditor()

IMPORT_C voidSetFocusToEditor()[protected, virtual]

Puts the focus back on the editor. For complicated setting pages that have focus removed from them at some point, then a re-implementation may have to do some work here.

SetNumbered(TBool)

IMPORT_C voidSetNumbered(TBoolaNumbered)

Set method for whether the setting page is numbered or not

Parameters

TBool aNumbered

SetSettingId(TInt)

IMPORT_C voidSetSettingId(TIntaSettingId)

Sets the setting Id. The Id may be used to unabiguously number a setting in some context. It would be useful to call SettingId() on aSettingPageControl in handling an observer callback. The Id is not used internally.

Parameters

TInt aSettingIdAn id to provide to the observer in the callback

SetSettingNumberL(const TInt)

IMPORT_C voidSetSettingNumberL(const TIntaSettingNumber)

Substitutes the new setting number.

Parameters

const TInt aSettingNumberThe new setting number to display

SetSettingPageObserver(MAknSettingPageObserver *)

IMPORT_C voidSetSettingPageObserver(MAknSettingPageObserver *aObserver)

Sets the observer for the setting page.

Parameters

MAknSettingPageObserver * aObserverThe observer for changes to the setting

SetSettingTextL(const TDesC &)

IMPORT_C voidSetSettingTextL(const TDesC &aSettingText)

Substitutes the new setting text. Memory is allocated for a copy. If already constructed, the label is reformatted.

Note that calling this will over-ride text in Setting Page resource

Parameters

const TDesC & aSettingTextThe new setting text to display

SetStopActiveSchedulerFlag(const TBool)

voidSetStopActiveSchedulerFlag(const TBoolaStopCalled)[protected]

Set the flag to indicate that if the function CAknSettingPage::StopActiveScheduler called or not

Parameters

const TBool aStopCalledETrue means the StopActiveScheduler is called.

SettingId()

IMPORT_C TIntSettingId()const

Returns the setting Id.

SettingItemContentRect(TBool)

TRect SettingItemContentRect(TBoolaScrollBarUsed)

Calculates and returns setting item content rect.

Parameters

TBool aScrollBarUsedETrue if the setting page content should have scrollbar, EFalse otherwise.

SettingNumber()

IMPORT_C TIntSettingNumber()const

Access method for the number of the setting page

SettingPageResourceId()

IMPORT_C TIntSettingPageResourceId()[protected]

Access method for the internally held resource Id

ShadowText()

IMPORT_C CEikLabel *ShadowText()const [protected]
Pointer to shadow text label
Since
5.0

SizeChanged()

IMPORT_C voidSizeChanged()[protected, virtual]

From CCoeControl This routine is called as part of the set-up of the control. It is the place to put layout code.

StandardSettingPageLayout()

IMPORT_C voidStandardSettingPageLayout()[protected]

This routine is the base layout for CAknSettingPage. It lays out the labels and configures the drawing in general.

StartActiveScheduler()

voidStartActiveScheduler()[private]

Activate another level on the active scheduler

StopActiveScheduler()

voidStopActiveScheduler()[protected]

Stop current (additional) level on the active scheduler.

TextLabel()

IMPORT_C CEikLabel *TextLabel()const [protected]
Pointer to setting text label
Since
5.0

UpdateCbaL()

IMPORT_C voidUpdateCbaL()[protected, virtual]

This framework method is used to update the contents of the CBA in a custom way. Some setting page classes implement a degree of validation and will implement this. Derived classes should ensure that this is being called frequently enough for their purposes.

UpdateSettingL()

IMPORT_C voidUpdateSettingL()[protected, virtual]

Called when something has changed and the client's object needs to have its value updated

Waiting()

IMPORT_C TBoolWaiting()[protected]

Method to determine the current running state of the setting page's ActiveScheduler level.

WriteInternalStateL(RWriteStream &)

IMPORT_C voidWriteInternalStateL(RWriteStream &aWriteStream)const [protected, virtual]

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters

RWriteStream & aWriteStream

Member Enumerations Documentation

Enum TAknSettingPageUpdateMode

This enumeration is passed in the ExecuteLD() method to control how often the setting page updates the externally held client object

Enumerators

EUpdateWhenChanged
EUpdateWhenAccepted

Enum TEditedItemSkinClass

This enumeration is used to select the type and IIDs for the various classes defined in the Skins LAF spec for "Opened Setting Items"

Enumerators

ESettingPageSkinEditedItemClassValueItemList
ESettingPageSkinEditedItemClassVolume
ESettingPageSkinEditedItemClassSlider
ESettingPageSkinEditedItemClassTextEntry
ESettingPageSkinEditedItemClassCodeDateTimeEntry

Enum TFlagIndices

Enumerators

EMenuShowingIndex = 0
ENumberedStyleIndex
EIsBaseConstructedIndex
EHasValidDataIndex

Member Data Documentation

CEikButtonGroupContainer * iCba

CEikButtonGroupContainer *iCba[private]

TInt iCbaResourceId

TInt iCbaResourceId[private]

TInt iControlType

TInt iControlType[private]

CCoeControl * iEditorControl

CCoeControl *iEditorControl[private]

TInt iEditorResourceId

TInt iEditorResourceId[private]

CAknSettingPageExtension * iExtension

CAknSettingPageExtension *iExtension[private]

TInt iExtensionId

TInt iExtensionId[private]

TBitFlags iFlags

TBitFlags iFlags[private]

TAknLayoutRect iHighlight

TAknLayoutRect iHighlight[private]

HBufC * iHintText

HBufC *iHintText[private]

TInt iInvalidDataCbaResourceId

TInt iInvalidDataCbaResourceId[private]

TInt iIsProtected

TInt iIsProtected[private]

CEikMenuBar * iMenuBar

CEikMenuBar *iMenuBar[private]

TInt iMenuBarId

TInt iMenuBarId[private]

CAknNavigationDecorator * iNaviDecorator

CAknNavigationDecorator *iNaviDecorator[private]

CAknNavigationControlContainer * iNaviPane

CAknNavigationControlContainer *iNaviPane[private]

CEikLabel * iNumberLabel

CEikLabel *iNumberLabel[private]

TInt iResourceId

TInt iResourceId[private]

TBool * iReturn

TBool *iReturn[private]

TInt iSettingId

TInt iSettingId[private]

TInt iSettingNumber

TInt iSettingNumber[private]

MAknSettingPageObserver * iSettingPageObserver

MAknSettingPageObserver *iSettingPageObserver[protected]

Pointer to setting page observer; may be NULL

HBufC * iSettingText

HBufC *iSettingText[private]

const TDesC * iSettingTextFromConstructor

const TDesC *iSettingTextFromConstructor[private]

This member points to the setting title text that is passed as part of its more complicated constructor. The descriptor pointed to is not owned, and therefor must be preserved in the client, at least until the 2nd stage construction is performed (inside ExecuteLD).

Since, however, setting pages are all waiting, the descriptor can usually be on the stack in the client.

TAknLayoutRect iShadow

TAknLayoutRect iShadow[private]

CAknSettingPageSkinsInfo * iSkinsInfo

CAknSettingPageSkinsInfo *iSkinsInfo[private]

CEikLabel * iTextLabel

CEikLabel *iTextLabel[private]

TInt iUpdateMode

TInt iUpdateMode[protected]

Hold the update mode passed in the constructor

CActiveSchedulerWait iWait

CActiveSchedulerWait iWait[private]