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.

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

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.

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

Performs base construction and takes possible flags into account.

Perform the drawing of coded within CAknSettingPage

New reserved methods for CAknSettingPage hierarchy

Access method to the Command button array

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

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

Standard CCoeControl routine to return the control at a given index

This constructs the control based upon the id passed

This constructs the control based upon a constructed and positioned reader

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

Standard CCoeControl routine to return the number of componentn controls

Called to access the validity state of the data

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

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

Display the menu

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.

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

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

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

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.

From CAknControl

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.

Used for aknsettingpage's extenstion corresponding function

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

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

Handles pointer events

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

Hide the menu

From CCoeControl . Gets the control's input capabilities.

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

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

Is the setting page possible to edit by the user.

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

Is the setting page call the StopActiveScheduler or not

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

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

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.

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.

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

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

Reserved method derived from CCoeControl

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

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.

used to set the validity of the data

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

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

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

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

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.

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.

Substitutes the new setting number.

Sets the observer for the setting page.

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

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

Returns the setting Id.

Calculates and returns setting item content rect.

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.

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

Activate another level on the active scheduler

Stop current (additional) level on the active scheduler.

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.

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

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

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.

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

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

Pointer to setting page observer; may be NULL

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.

Hold the update mode passed in the constructor