class CAknQueryDialog : public CAknDialog |
General query dialog
Use for confirmation queries
Protected Member Functions | |
---|---|
IMPORT_C void | DoSetPromptL() |
CCoeControl * | FindControlOnAnyPageWithControlType(TInt, TInt *, TInt *) |
TBitFlags16 & | Flags() |
const TBitFlags16 & | Flags() |
TInt | GetLeftCBAShortKeyPress() |
TInt | GetRightCBAShortKeyPress() |
TBool | IsLeftSoftkeyVisible() |
void | LayoutAndDraw() |
IMPORT_C TBool | OkToExitL(TInt) |
void | PlayTone() |
IMPORT_C void | PostLayoutDynInitL() |
IMPORT_C void | PreLayoutDynInitL(void) |
IMPORT_C TPtrC | Prompt() |
IMPORT_C CAknQueryControl * | QueryControl() |
void | ReportUserActivity() |
IMPORT_C void | SetSizeAndPosition(const TSize &) |
CAknKeySoundSystem * | SoundSystem() |
TTone & | Tone() |
const TTone & | Tone() |
IMPORT_C void | UpdateLeftSoftKeyL() |
Private Member Functions | |
---|---|
IMPORT_C void | CAknDialog_Reserved() |
IMPORT_C void | CAknQueryDialog_Reserved() |
IMPORT_C void | CEikDialog_Reserved_1() |
IMPORT_C void | CEikDialog_Reserved_2() |
IMPORT_C void * | ExtensionInterface(TUid) |
Public Member Enumerations | |
---|---|
enum | TTone { ENoTone = 0, EConfirmationTone = EAvkonSIDConfirmationTone, EWarningTone = EAvkonSIDWarningTone, EErrorTone = EAvkonSIDErrorTone } |
Inherited Enumerations | |
---|---|
CCoeControl:TZoomType | |
CEikDialog:@169 |
Protected Attributes | |
---|---|
CAknQueryDialogExtension * | iExtension |
TBitFlags16 | iFlags |
TDesC * | iPrompt |
CAknKeySoundSystem * | iSoundSystem |
TInt | iSpare_1 |
TTone | iTone |
Inherited Attributes | |
---|---|
CAknDialog::iMenuBar | |
CCoeControl::iCoeEnv | |
CCoeControl::iContext | |
CCoeControl::iPosition | |
CCoeControl::iSize | |
CEikBorderedControl::iBorder |
IMPORT_C | CAknQueryDialog | ( | const TTone & | aTone | ) |
Construction
: will be made protected - use NewL
const TTone & aTone |
IMPORT_C | CAknQueryDialog | ( | TDesC & | aPrompt, |
const TTone & | aTone = ENoTone | |||
) |
do not use
IMPORT_C void | DismissQueryL | ( | ) | [virtual] |
Called by NeedToDismissQueryL(), gives a change to either accept or reject the query. Default implementation is to accept the query if the Left soft key is displayed and reject it otherwise. Left softkey is only displayed if the query has valid data into it.
IMPORT_C void | DoSetPromptL | ( | ) | [protected, virtual] |
Set the prompt inside the query control. If dialog is active redo layout and draw.
IMPORT_C TInt | ExecuteLD | ( | TInt | aResourceId | ) | [virtual] |
Call PrepareLC and display dialog.
Identical to version in CEikDialog but need to override this because of version with prompt, compiler will complain if this is not implemented in derived class as well
TInt aResourceId | resource for query |
IMPORT_C TInt | ExecuteLD | ( | TInt | aResourceId, |
const TDesC & | aPrompt | |||
) |
Call PrepareLC and display dialog.
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
TUid aInterface |
CCoeControl * | FindControlOnAnyPageWithControlType | ( | TInt | aControlType, |
TInt * | aLineIndex = 0, | |||
TInt * | aPageIndex = 0 | |||
) | const [protected] |
To be used to go through every control in the dialog, on every page, in Dialog-internal storage order, until a control with that type is found. If such a control is not found, a null pointer will be returned.
TInt aControlType | - Enum used to identify the control type on that CEikCaptionedControl Line |
TInt * aLineIndex = 0 | - Optional argument, if used contains reference to an int which holds the initial line to start searching on, and on finding a control of that type, is assigned the next position to start searching. |
TInt * aPageIndex = 0 | - Optional argument, if used contains reference to an int which holds the initial dialog page to start searching on, and on finding a control of that type, is assigned the page that the control was found on. |
TInt | GetLeftCBAShortKeyPress | ( | ) | [protected] |
Returns left CBA short key press Id of the left CBA
TInt | GetRightCBAShortKeyPress | ( | ) | [protected] |
Returns right CBA short key press Id of the right CBA
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Handles pointer events
const TPointerEvent & aPointerEvent |
IMPORT_C TBool | HandleQueryEditorSizeEventL | ( | CAknQueryControl * | aQueryControl, |
TQueryControlEvent | aEventType | |||
) |
Gets called when editor sends size event.
CAknQueryControl * aQueryControl | Pointer to query control which sent the event |
TQueryControlEvent aEventType | Type of the event |
IMPORT_C TBool | HandleQueryEditorStateEventL | ( | CAknQueryControl * | aQueryControl, |
TQueryControlEvent | aEventType, | |||
TQueryValidationStatus | aStatus | |||
) |
Gets called when editor sends state event
CAknQueryControl * aQueryControl | Pointer to query control which sent the event |
TQueryControlEvent aEventType | Type of the event |
TQueryValidationStatus aStatus | Editor validation status |
IMPORT_C CAknPopupHeadingPane * | Heading | ( | ) | const |
Deprecated method to return pointer to query heading or NULL (use QueryHeading())
will be removed (use QueryHeading() method instead)
IMPORT_C TCoeInputCapabilities | InputCapabilities | ( | ) | const [virtual] |
From CCoeControl. Gets the control's input capabilities.
The control's input capabilities.
TBool | IsLeftSoftkeyVisible | ( | ) | [protected] |
Returns whether the left softkey is visible ETrue is the left softkey is visible
IMPORT_C void | MakeLeftSoftkeyVisible | ( | TBool | aVisible | ) |
Set visibility of the left softkey. Softkey is hidden when data in the query is not acceptable.
TBool aVisible | EFalse hides softkey label, ETrue shows it. |
IMPORT_C TInt | MaxTextLength | ( | const CAknQueryControl * | aControl, |
const TDes & | aDataText, | |||
TInt | aApiValue | |||
) | [static] |
Return the maximum possible length of the query text This is (in order of precedence, and assuming they are valid i.e. less than or equal to the length of the descriptor passed to return the value) dependent on:
1) aApiValue
2) Resource set value held in aControl
3) The MaxLength of the descriptor maximum text length
const CAknQueryControl * aControl | |
const TDes & aDataText | |
TInt aApiValue |
IMPORT_C TInt | MaxTextLength | ( | const CAknQueryControl * | aControl, |
const TDes * | aDataText, | |||
TInt | aApiValue | |||
) | [static] |
use other version of MaxTextLength
const CAknQueryControl * aControl | |
const TDes * aDataText | |
TInt aApiValue |
IMPORT_C TBool | NeedToDismissQueryL | ( | const TKeyEvent & | aKeyEvent | ) | [virtual] |
Called by OfferkeyEventL(), gives a change to dismiss the query even with keys different than Enter of Ok.
const TKeyEvent & aKeyEvent |
IMPORT_C CAknQueryDialog * | NewL | ( | const TTone & | aTone = ENoTone | ) | [static] |
Second phase construction required to align with multiline queries API In future might use MAknQueryData mixin in the base class, hence requiring second phase construction.
pointer to CAknQueryDialog
const TTone & aTone = ENoTone |
IMPORT_C CAknQueryDialog * | NewL | ( | TDes & | aText, |
const TTone & | aTone = ENoTone | |||
) | [static] |
pointer to CAknTextQueryDialog
IMPORT_C CAknQueryDialog * | NewL | ( | TInt & | aNumber, |
const TTone & | aTone = ENoTone | |||
) | [static] |
pointer to CAknNumberQueryDialog
IMPORT_C CAknQueryDialog * | NewL | ( | TTime & | aTime, |
const TTone & | aTone = ENoTone | |||
) | [static] |
pointer to CAknTimeQueryDialog
IMPORT_C CAknQueryDialog * | NewL | ( | TTimeIntervalSeconds & | aTime, |
const TTone & | aTone = ENoTone | |||
) | [static] |
pointer to CAknDurationQueryDialog
TTimeIntervalSeconds & aTime | |
const TTone & aTone = ENoTone |
IMPORT_C CAknQueryDialog * | NewL | ( | TReal & | aNumber, |
const TTone & | aTone = ENoTone | |||
) | [static] |
pointer to CAknFloatQueryDialog
IMPORT_C CAknQueryDialog * | NewL | ( | TInetAddr & | aInetAddr, |
const TTone & | aTone = ENoTone | |||
) | [static] |
pointer to CAknIpQueryDialog
IMPORT_C CAknQueryDialog * | NewL | ( | TPosition & | aValue, |
const TTone & | aTone = ENoTone | |||
) | [static] |
Not yet totally implemented!
pointer to CAknLocationQueryDialog
IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [virtual] |
From CCoeControl
Handle key events. When a key event occurs, until one of them returns EKeyWasConsumed to indicate that it processed the key event. CONE calls this function for each control on the control stack, Indicates whether or not the key event was used by this control.
const TKeyEvent & aKeyEvent | The key event. |
TEventCode aType | The type of the event: EEventKey, EEventKeyUp or EEventKeyDown. |
IMPORT_C TBool | OkToExitL | ( | TInt | aButtonId | ) | [protected, virtual] |
From CEikdialog
This function is called by the EIKON framework if the user activates a button in the button panel. It is not called if the Cancel button is activated, unless the EEikDialogFlagNotifyEsc flag is set. Should return ETrue if the dialog should exit, and EFalse if it should not.
TInt aButtonId | The ID of the button that was activated |
IMPORT_C void | PostLayoutDynInitL | ( | ) | [protected, virtual] |
From CEikdialog
This function is called by the EIKON dialog framework just before the dialog is activated, after it has called PreLayoutDynInitL() and the dialog has been sized.
IMPORT_C void | PreLayoutDynInitL | ( | void | ) | [protected, virtual] |
From CEikdialog
This function is called by the EIKON dialog framework just before the dialog is activated, but before it is sized, and before PostLayoutDynInitL() is called.
void |
IMPORT_C CAknQueryControl * | QueryControl | ( | ) | const [protected, virtual] |
Return pointer to query control or NULL
IMPORT_C CAknPopupHeadingPane * | QueryHeading | ( | ) | const [virtual] |
Return pointer to query heading or NULL
IMPORT_C void | RemoveEditorIndicator | ( | ) |
Removes the editor indicators for this dialog. Used to ensure this dialog does not own any editor indicators. before opening another dialog which outlasts this one.
IMPORT_C TInt | RunDlgLD | ( | TInt | aResourceId | ) |
use RunLD or ExecuteLD instead
TInt aResourceId |
IMPORT_C TInt | RunLD | ( | ) | [virtual] |
Runs the querydialog and returns the ID of the button used to dismiss it. The dialog is destroyed on exit.
IMPORT_C void | SetEmergencyCallSupport | ( | TBool | aOnOff | ) |
Enable or disable emergency call support. This method is only valid in numeric queries (secret or normal).
Default is Off for both.
TBool aOnOff | Sets emergency call support active or inactive, if feature is available in current type of control |
IMPORT_C void | SetEmergencyCallSupportForCBA | ( | TBool | aOnOff | ) |
Enable or disable support to change the CBA labels of the query according to the current ECS state. It's necessary to enable this alongside with ECS for touch and full screen queries.
Note that if enabling this, then it's not necessary to call SetEmergencyCallSupport( ETrue ) additionally, as when enabling this, CAknQueryControl::EEmergencyCallsEnabledByAPI will also be set. To enable the ECS via this method, it must be called prior to PreLayoutDynamicInitL.
If this is enabled for CAknQueryDialog-derived classes, then the OkToExitL implementation of those should forward the EAknSoftkeyEmergencyCall events to the base class' OkToExitL for the emergency call event to be handled.
This method is only valid in numeric queries (secret or normal), default is Off for both.
TBool aOnOff | ETrue to enable the ECS CBA support, EFalse otherwise. |
IMPORT_C void | SetHeaderImageL | ( | CEikImage * | aImage | ) |
use QueryHeading() method instead
CEikImage * aImage |
IMPORT_C void | SetHeaderTextL | ( | const TDesC & | aHeader | ) |
use QueryHeading() method instead
const TDesC & aHeader |
IMPORT_C void | SetPredictiveTextInputPermitted | ( | TBool | aPermitted | ) |
This method can be used to set predictive text entry permitted. The default Query behaviour is to supress predictive entry (over-riding editor resource flags that may indicate otherwise.
This may be called at any time prior to activation of the query.
TBool aPermitted | ETrue - allow predictive text entry |
IMPORT_C void | SetPromptL | ( | const TDesC & | aPrompt | ) |
Set prompt text for query. This this will override text given in constructor.
const TDesC & aPrompt | Text for prompt |
IMPORT_C void | SetSizeAndPosition | ( | const TSize & | aSize | ) | [protected, virtual] |
From CEikdialog
EIKON provides an implementation of this function, which positions the dialog in the centre of the screen. However, it can be overridden by derived classes.
const TSize & aSize | The size for the dialog. |
IMPORT_C void | UpdateLeftSoftKeyL | ( | ) | [protected, virtual] |
If the query text is ok (retrieved form query control) then display the left soft key, otherwise hide it.
Enumeration for tones.
The tone played before the dialog is shown. Application specific tones may be played by casting the application defined Sound ID (SID), to TTone
ENoTone = 0 |
No tone is played |
EConfirmationTone = EAvkonSIDConfirmationTone |
A confirmation tone is played. |
EWarningTone = EAvkonSIDWarningTone |
A warning tone is played. |
EErrorTone = EAvkonSIDErrorTone |
An error tone is played. |
CAknQueryDialogExtension * | iExtension | [protected] |
Caption Retriever
TBitFlags16 | iFlags | [protected] |
Flags for emergency call support Need these at least to store the ECS state until the control exists
TTone | iTone | [protected] |
Tone which is played when the query is executed These will be made private, use protected methods