CAknSettingPage Class Reference

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

Enumerator:

EUpdateWhenChanged
EUpdateWhenAccepted

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

Enumerator:

ESettingPageSkinEditedItemClassValueItemList
ESettingPageSkinEditedItemClassVolume
ESettingPageSkinEditedItemClassSlider
ESettingPageSkinEditedItemClassTextEntry
ESettingPageSkinEditedItemClassCodeDateTimeEntry

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

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:

	aSettingTitleText	Text at top of setting pane (not copied; must be owned externally until ExecuteLD is called)
	aSettingNumber	Number at top left (if present)
	aControlType	Determines the type constructed and how its resource is read
	aEditorResourceId	Editor resource to use in the setting page (if present)
	aSettingPageResourceId	Setting Page to use (if present)

C++ destructor.

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

Reimplemented in CAknDateSettingPage, CAknTimeSettingPage, CAknDurationSettingPage, CAknTimeOffsetSettingPage, CAknIpFieldSettingPage, CAknPasswordSettingPage, CAknSliderSettingPage, CAknTextSettingPage, and CAknVolumeSettingPage.

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:

aAccept

ETrue if the user accepted. EFalse if the user cancelled.

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

Perform the drawing of coded within CAknSettingPage.

Access method to the Command button array.

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

Returns:

CEikButtonGroupContainer* a pointer to the cba owned by the setting page

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

Reimplemented in CAknListBoxSettingPage, CAknMfneSettingPage, CAknTextSettingPage, and CAknIntegerSettingPage.

Standard CCoeControl routine to return the control at a given index.

Parameters:

aIndex

index at which to return control

Reimplemented in CAknMfneSettingPage.

This constructs the control based upon a constructed and positioned reader.

This constructs the control based upon the id passed.

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

Reimplemented in CAknCheckBoxSettingPage, CAknMfneSettingPage, CAknDateSettingPage, CAknTimeSettingPage, CAknDurationSettingPage, CAknTimeOffsetSettingPage, CAknIpFieldSettingPage, CAknAlphaPasswordSettingPage, CAknNumericPasswordSettingPage, CAknPopupSettingPage, CAknRadioButtonSettingPage, CAknSliderSettingPage, CAknTextSettingPage, CAknIntegerSettingPage, and CAknVolumeSettingPage.

Standard CCoeControl routine to return the number of componentn controls.

Parameters:

aIndex

index at which to return control

Reimplemented in CAknMfneSettingPage.

Method to cause this class to construct a control context or type and IID, selected according to the value of enumeration TEditedItemSkinClass, set its coordinate system.

This must be called after a call to SetEditedItemLayoutRect has been made on CAknSettingPage. This is becasue this routine must set the control context's origin to the top left of the value given to SetEditedItemLayoutRect. Since SetEditeItemLayoutRect is to be called in a SizeChanged method, this means that the this should be called after the SizeChanged in the child class.

Parameters:

	aClass	enumeration specifying which class of editor (according to LAF spec) is being constructed.
	aParentAbsolute	ETrue if there is an intervening Window between CAknSettingPage's window and any control that is to draw skin items with this component.

Called to access the validity state of the data.

Returns:

TBool ETRrue if the data is valid

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

Returns:

TInt the default resource Id

Called to remove the setting page.

Should not be called except from within re-implemented AttemptExitL

Parameters:

aAccept

ETrue to accept the current value; EFalse otherwise

Display the menu.

Called immediately prior to activation of the dialog.

Framework routine for derived classes.

Reimplemented in CAknCheckBoxSettingPage, CAknRadioButtonSettingPage, CAknTextSettingPage, and CAknIntegerSettingPage.

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.

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

Returns:

A valid control context for frame drawing for a hosted editor or NULL

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

Returns:

CCoeControl* pointer to the hosted editor control

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:

aMode

The update mode of the class

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.

Reads the passed-in setting page resource in order to read the contained editor control resource information.

Parameters:

	aSettingPageResoruceId	This is used to specifiy what resource to read
	aControlType	Returns the control type (MAY return 0 - that's a valid control type!
	aEditorResourceId	Returns the setting page's LLINK editor resource, but returns 0 if not present

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:

	aControl	The control changing its state (not used)
	aEventType	The type of control event

Reimplemented in CAknMfneSettingPage, CAknPasswordSettingPage, CAknTextSettingPage, and CAknIntegerSettingPage.

Handles pointer events.

Reimplemented in CAknCheckBoxSettingPage, CAknMfneSettingPage, CAknDateSettingPage, CAknTimeSettingPage, CAknDurationSettingPage, CAknTimeOffsetSettingPage, CAknIpFieldSettingPage, CAknPasswordSettingPage, CAknAlphaPasswordSettingPage, CAknNumericPasswordSettingPage, CAknPopupSettingPage, CAknRadioButtonSettingPage, CAknSliderSettingPage, CAknEdwinSettingPage, CAknTextSettingPage, CAknIntegerSettingPage, and CAknVolumeSettingPage.

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

colors or fonts.

Parameters:

aType

Reason for the "resource" change, usually an system event UID

Reimplemented in CAknCheckBoxSettingPage, and CAknRadioButtonSettingPage.

Hide the menu.

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

Returns:

TInt The resource Id of the softkey bindings.

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

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

Returns:

TBool ETrue if BaseContructL has been called (and not left)

Is the setting page possible to edit by the user.

Returns:

Can user modify the setting page. True if can, false if cannot.

Access method for whether the setting page is numbered or not.

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

Returns:

TBool ETrue iff the drawing of the edited item frame is going to be handled by the base CAknSettingPage class itself using Skins

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

Returns:

TBool ETrue if the menu is currently showing

This routine routes the keys to the editor.

However, if the menu is showing, then events are sent to the menu.

Parameters:

	aKeyEvent	event information
	aType	type of event being handled

Reimplemented in CAknTextSettingPage.

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:

aAccept

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

Returns:

TBool a value indicating whether the setting page should be dismissed

Reimplemented in CAknPasswordSettingPage, and CAknTextSettingPage.

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

Returns:

TBool ETrue if the setting page is to continue

Reimplemented in CAknPasswordSettingPage.

From MEikCommandObserver Processes events from the softkeys.

Responds to EAknSoftkeyOk and EAknSoftkeyBack to accept or cancel the pop-up.

Parameters:

aCommandId

Event Id from the soft-key

Reimplemented in CAknCheckBoxSettingPage.

Set default construction values of internal state.

Called when the user rejects the setting.

A backup copy may need to be restored if UpdateWhenChanged flag was set

Reimplemented in CAknDateSettingPage, CAknTimeSettingPage, CAknDurationSettingPage, CAknTimeOffsetSettingPage, CAknIpFieldSettingPage, CAknSliderSettingPage, CAknTextSettingPage, CAknIntegerSettingPage, and CAknVolumeSettingPage.

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.

Reimplemented in CAknCheckBoxSettingPage, CAknPopupSettingPage, and CAknRadioButtonSettingPage.

used to set the validity of the data

Parameters:

TBool

aValid Sets the validity true or false

Enables / disables transparency effect, i.e.

does the setting page draw its own background or not.

Parameters:

aDrawBackground

EFalse enables transparency

Method to be called by CAknSettingPage descendents when they have laid themselves out.

This tells the base class how big the layout spec rectangle hosting the editor is. The second rectangle is the size of the area that the base class does not have to draw to for skins. Usually, this is the area actually inhabited by the editor control.

Coordinates are to be given in pixels relative to the main_pane.

Parameters:

	aFrameRect	Layout rectangle in which to host the editor.
	aRealEditorRect	Layout rectangle actually occupied by the editor control

Set the edit-state of the setting page.

The setting page can be edited or it can be only viewed by the user.

Parameters:

aEditable

If false, the setting page cannot be modified by the user

From MEikMenuObserver Called when menu is cancelled.

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.

Set method for whether the setting page is numbered or not.

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:

aSettingId

An id to provide to the observer in the callback

Substitutes the new setting number.

Parameters:

aSettingNumber

The new setting number to display

Sets the observer for the setting page.

Parameters:

aObserver

The observer for changes to the setting

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:

aSettingText

The new setting text to display

Returns the setting Id.

Returns:

TInt the setting Id

Access method for the number of the setting page.

Access method for the internally held resource Id.

From CCoeControl This routine is called as part of the set-up of the control.

It is the place to put layout code.

Reimplemented in CAknListBoxSettingPage, CAknMfneSettingPage, CAknPasswordSettingPage, CAknSliderSettingPage, CAknEdwinSettingPage, CAknTextSettingPage, CAknIntegerSettingPage, and CAknVolumeSettingPage.

This routine is the base layout for CAknSettingPage.

It lays out the labels and configures the drawing in general.

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.

Reimplemented in CAknListBoxSettingPage, CAknTextSettingPage, and CAknIntegerSettingPage.

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

Reimplemented in CAknCheckBoxSettingPage, CAknDateSettingPage, CAknTimeSettingPage, CAknDurationSettingPage, CAknTimeOffsetSettingPage, CAknIpFieldSettingPage, CAknPasswordSettingPage, CAknRadioButtonSettingPage, CAknSliderSettingPage, CAknTextSettingPage, CAknIntegerSettingPage, and CAknVolumeSettingPage.

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

Returns:

EFalse only if the CActiveSheduler level is not running

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:

aWriteSteam

A connected write stream

Reimplemented in CAknCheckBoxSettingPage, CAknDateSettingPage, CAknTimeSettingPage, CAknDurationSettingPage, CAknTimeOffsetSettingPage, CAknIpFieldSettingPage, CAknPasswordSettingPage, CAknAlphaPasswordSettingPage, CAknNumericPasswordSettingPage, CAknPopupSettingPage, CAknRadioButtonSettingPage, CAknSliderSettingPage, CAknTextSettingPage, CAknIntegerSettingPage, and CAknVolumeSettingPage.

Pointer to setting page observer; may be NULL.

Hold the update mode passed in the constructor.