CAknTextSettingPage Class Reference

Public Types

Public Member Functions

Protected Member Functions

Enumerator:

EZeroLengthNotOffered
EPutCursorAtEnd
EZeroLengthAllowed
ENoInitialSelection
EPutCursorAtBeginning
EUseEdwinCursorAndSelectionFlags
EPredictiveTextEntryPermitted

Simple constructor depending only on a single resource Id.

Editor resource is given via the link in the setting page resource.

Parameters:

	aSettingPageResourceId	Setting Page to use (if present)
	aText	Reference to text for editing
	aTextSettingPageFlags	option flags for miscellaneous things

Constructor that allows separate setting page and editor resources.

This constructor allows the use of setting page using only the editor resource. Other combinations are also possible

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 (Effectively like the other constructor) present = 0 Default Avkon SP resource if used + this editor resource = 0 = 0 uses default resource for both SP and editor. This is OK if: i) control type is present, ii) a default resource exists ( OK for text, integer, date, time, duration )

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. Note that this buffer must be owned by the client until ExecuteLD has been called.

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; OWNED EXTERNALLY
	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)
	aText	Reference to text for editing
	aTextSettingPageFlags	option flags for miscellaneous things

C++ destructor.

Called when the user accepts the text and the setting page is about to be dismissed.

The latest value of the text is written to the client's object

Reimplemented from CAknSettingPage.

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

Reimplemented from CAknSettingPage.

2nd stage construction for this specific type.

Calls BaseConstructL in CAknSettingPage, where the object is constructed from resource.

After calling this method, the contained editor is fully constructed and has its text set, copied from the aText parameter of the constructor.

This constructor can be called prior to a call to ExecuteLD in order to ensure construction of the editor if API needs to be called on it prior to setting page launch. ExecuteLD will not attempt itself to do the construction a 2nd time.

Reimplemented from CAknSettingPage.

Called immediately prior to activation of the dialog.

Framework routine for derived classes.

Reimplemented from CAknSettingPage.

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

If the EUpdateWhenChanged flag is set, this updates the setting text.

Parameters:

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

Reimplemented from CAknSettingPage.

From CCoeControl.

Handles pointer events

Reimplemented from CAknEdwinSettingPage.

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 from CAknSettingPage.

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 from CAknSettingPage.

Called when the user rejects the setting.

A backed up copy is used to restore the initial value

Reimplemented from CAknSettingPage.

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

It is the place to put the layout code.

Implements CAknEdwinSettingPage.

Update the CBA.

This should be called after a control state change in case there has been a change in data validity.

Reimplemented from CAknSettingPage.

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

Reimplemented from CAknSettingPage.

This method copies out the text from the editor into the client's descriptor.

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 from CAknSettingPage.