class CAknTextSettingPage : public CAknEdwinSettingPage |
Public Member Functions | |
---|---|
CAknTextSettingPage ( TInt , TDes &, TInt ) | |
CAknTextSettingPage (const TDesC *, TInt , TInt , TInt , TInt , TDes &, TInt ) | |
IMPORT_C void | ConstructL () |
IMPORT_C void | HandlePointerEventL (const TPointerEvent &) |
void | ProcessPopupStateChangesL () |
Protected Member Functions | |
---|---|
~CAknTextSettingPage () | |
IMPORT_C void | AcceptSettingL () |
IMPORT_C void | CheckAndSetDataValidity () |
IMPORT_C void | DynamicInitL () |
IMPORT_C void | HandleControlEventL ( CCoeControl *, TCoeEvent) |
IMPORT_C TKeyResponse | OfferKeyEventL (const TKeyEvent &, TEventCode ) |
IMPORT_C TBool | OkToExitL ( TBool ) |
IMPORT_C void | RestoreOriginalSettingL () |
IMPORT_C void | SizeChanged () |
IMPORT_C void | UpdateCbaL () |
IMPORT_C void | UpdateSettingL () |
IMPORT_C void | UpdateTextL () |
IMPORT_C void | WriteInternalStateL ( RWriteStream &) |
Private Member Functions | |
---|---|
IMPORT_C void | CAknEdwinSettingPage_Reserved_1 () |
IMPORT_C void | CAknSettingPage_Reserved_1 () |
IMPORT_C void | CAknSettingPage_Reserved_2 () |
IMPORT_C void * | ExtensionInterface ( TUid ) |
IMPORT_C void | Reserved_2 () |
void | RestartMultitapWaitTimer () |
Public Member Enumerations | |
---|---|
enum |
TAknTextSettingPageFlags
{
EZeroLengthNotOffered = 0x0, EPutCursorAtEnd = 0x0, EZeroLengthAllowed = 0x0000001, ENoInitialSelection = 0x0000004, EPutCursorAtBeginning = 0x0000008, EUseEdwinCursorAndSelectionFlags = 0x0000010, EPredictiveTextEntryPermitted = 0x0020 } |
Inherited Enumerations | |
---|---|
CAknSettingPage:TAknSettingPageUpdateMode | |
CAknSettingPage:TEditedItemSkinClass | |
CCoeControl:TZoomType |
Private Attributes | |
---|---|
HBufC * | iBackupText |
CAknTextSettingPageExtension * | iExtension |
TDes & | iText |
TInt | iTextSettingPageFlags |
IMPORT_C | CAknTextSettingPage | ( | TInt | aResourceID, |
TDes & | aText, | |||
TInt | aTextSettingPageFlags = 0 | |||
) |
Simple constructor depending only on a single resource Id. Editor resource is given via the link in the setting page resource.
IMPORT_C | CAknTextSettingPage | ( | const TDesC * | aSettingTitleText, |
TInt | aSettingNumber, | |||
TInt | aControlType, | |||
TInt | aEditorResourceId, | |||
TInt | aSettingPageResourceId, | |||
TDes & | aText, | |||
TInt | aTextSettingPageFlags = 0 | |||
) |
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.
const TDesC * aSettingTitleText | Text at top of setting pane; OWNED EXTERNALLY |
TInt aSettingNumber | Number at top left (if present) |
TInt aControlType | Determines the type constructed and how its resource is read |
TInt aEditorResourceId | Editor resource to use in the setting page (if present) |
TInt aSettingPageResourceId | Setting Page to use (if present) |
TDes & aText | Reference to text for editing |
TInt aTextSettingPageFlags = 0 | option flags for miscellaneous things |
IMPORT_C void | AcceptSettingL | ( | ) | [protected, virtual] |
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
IMPORT_C void | CAknEdwinSettingPage_Reserved_1 | ( | ) | [private, virtual] |
Reserved method from CAknEdwinSettingPage
IMPORT_C void | CAknSettingPage_Reserved_1 | ( | ) | [private, virtual] |
Reserved methods for CAknSettingPage hierarchy
IMPORT_C void | CheckAndSetDataValidity | ( | ) | [protected, virtual] |
Framework method to set the validity of the data This is called when the data changes.
IMPORT_C void | ConstructL | ( | ) | [virtual] |
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.
IMPORT_C void | DynamicInitL | ( | ) | [protected, virtual] |
Called immediately prior to activation of the dialog. Framework routine for derived classes.
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
TUid aInterface |
IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
TCoeEvent | aEventType | |||
) | [protected, virtual] |
From MCoeControlObserver : Acts upon changes in the hosted control's state. If the EUpdateWhenChanged flag is set, this updates the setting text.
CCoeControl * aControl | The control changing its state (not used) |
TCoeEvent aEventType | The type of control event |
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl . Handles pointer events
const TPointerEvent & aPointerEvent |
IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [protected, virtual] |
This routine routes the keys to the editor. However, if the menu is showing, then events are sent to the menu.
const TKeyEvent & aKeyEvent | event information |
TEventCode aType | type of event being handled |
IMPORT_C TBool | OkToExitL | ( | TBool | aAccept | ) | [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.
TBool aAccept | ETrue if the user has indicated to accept the setting page; EFalse otherwise |
void | ProcessPopupStateChangesL | ( | ) |
add for CAknTextSettingPageExtension to access the api fo CAknTextSettingPage
IMPORT_C void | Reserved_2 | ( | ) | [private, virtual] |
Reserved method derived from CCoeControl
IMPORT_C void | RestoreOriginalSettingL | ( | ) | [protected, virtual] |
Called when the user rejects the setting. A backed up copy is used to restore the initial value
IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
From CCoeControl This routine is called as part of the set-up of the control. It is the place to put the layout code.
IMPORT_C void | UpdateCbaL | ( | ) | [protected, virtual] |
Update the CBA. This should be called after a control state change in case there has been a change in data validity.
IMPORT_C void | UpdateSettingL | ( | ) | [protected, virtual] |
Called when something has changed and the client's object needs to have its text updated
IMPORT_C void | UpdateTextL | ( | ) | [protected, virtual] |
This method copies out the text from the editor into the client's descriptor
IMPORT_C void | WriteInternalStateL | ( | 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.
RWriteStream & aWriteStream |
EZeroLengthNotOffered = 0x0 | |
EPutCursorAtEnd = 0x0 | |
EZeroLengthAllowed = 0x0000001 | |
ENoInitialSelection = 0x0000004 | |
EPutCursorAtBeginning = 0x0000008 | |
EUseEdwinCursorAndSelectionFlags = 0x0000010 | |
EPredictiveTextEntryPermitted = 0x0020 |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.