| class CAknQueryControl : public CAknControl |
The control for a query dialog.
Manage layout of elements in a query dialog:- the text, the image and the editors.
CAknQueryDialog, CAknText
| Protected Member Functions | |
|---|---|
| void | ConstructQueryL(TResourceReader &) |
| TRect | DialogRect() |
| TSize | DialogSize() |
| void | DialogSizeChanged() |
| void | Draw(const TRect &) |
| void | DrawEditorFrame(CWindowGc &, TRect &) |
| void | Layout() |
| void | LayoutEditor(const TLayoutMethod &) |
| void | LayoutEditorFrame(const TLayoutMethod &) |
| void | LayoutEditorIndicator(const TLayoutMethod &) |
| void | LayoutImageOrAnim(const TLayoutMethod &) |
| void | LayoutPrompt(const TLayoutMethod &) |
| TRect | LayoutRect() |
| CAknLocationEditor *& | LocationEd() |
| CAknLocationEditor * | LocationEd() |
| TTypeUid::Ptr | MopSupplyObject(TTypeUid) |
| CAknQueryExtension * | QueryExtension() |
| void | SetLineWidthsL() |
| void | SizeChanged() |
| Private Member Functions | |
|---|---|
| void | CreateBackspaceButtonL() |
| void | CreateIncAndDecButtonsL() |
| void | DeployFlagsL() |
| CEikDialog * | Dialog() |
| void | DoSetPromptL() |
| TBool | EmbeddedVirtualInput() |
| IMPORT_C void * | ExtensionInterface(TUid) |
| void | LayoutEditorForFullScreen(const TLayoutMethod &) |
| void | LayoutPromptForFullScreen() |
| void | PictographCallBack() |
| TInt | PinCodeTimeoutCallback(TAny *) |
| void | PlayPinCodeTacticon() |
| void | ResetPinCodeTacticonTimer() |
| void | SetFlags(TBitFlags16) |
| TInt | StaticPictographCallBack(TAny *) |
| void | StopPinCodeTacticonTimer() |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| Protected Attributes | |
|---|---|
| CAknBitmapAnimation * | iAnimation |
| TInt | iControl |
| CEikDateEditor * | iDateEdwin |
| CAknButton * | iDecreaseValueButton |
| TSize | iDialogSize |
| CEikDurationEditor * | iDurationEdwin |
| CAknEcsDetector * | iEcsDetector |
| TAknQueryEcsObserver * | iEcsObserver |
| CAknQueryEditIndicator * | iEditIndicator |
| TAknLayoutRect | iEditorFrame |
| TAknLayoutRect | iEditorHorShadow |
| TAknLayoutRect | iEditorVerShadow |
| CEikEdwin * | iEdwin |
| TBitFlags16 | iFlags |
| CEikFloatingPointEditor * | iFloatingPointEditor |
| TBool | iHasEditor |
| CEikImage * | iImage |
| CAknButton * | iIncreaseValueButton |
| TAknLayoutRect | iLayoutMfne |
| CArrayFixFlat< TInt > * | iLineWidths |
| CAknIntegerEdwin * | iNumberEdwin |
| TInt | iNumberOfEditorLines |
| CAknNumericSecretEditor * | iPinEdwin |
| CAknTextControl * | iPrompt |
| MAknQueryControlObserver * | iQueryControlObserver |
| TInt | iQueryType |
| CEikSecretEditor * | iSecretEd |
| TUint16 | iSpare_1 |
| CEikTimeEditor * | iTimeEdwin |
| Private Attributes | |
|---|---|
| CAknQueryControlExtension * | iExtension |
| TInt | iSpare |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| void | AttemptEmergencyCallL | ( | ) |
Attempts to make an emergency call if a valid emergency number has been entered to the query.
| void | CancelQueryL | ( | ) |
This cancels the query. Used when the query control has to get abandon the query for some reason
| IMPORT_C TBool | CheckNumber | ( | ) |
Checks if the given number in the editor is within the maximum and minimum values.
| CCoeControl * | ComponentControl | ( | TInt | anIndex | ) | const [virtual] |
From CCoeControl Get the components of a compound control. It returns one of the control's component controls, identified by aIndex. The component control with an index of aIndex.
| TInt anIndex | The index of the control to get. |
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aRes | ) | [virtual] |
Second phase constructor: loads contents of array from resources.
| TResourceReader & aRes |
| void | ConstructQueryL | ( | TResourceReader & | aRes | ) | [protected, virtual] |
After having read the query type from resource. This method is called in CostructFromResourceL()
| TResourceReader & aRes |
| IMPORT_C CCoeControl * | ControlByLayoutOrNull | ( | TInt | aLayout | ) | [virtual] |
Get pointer to query controls control (editor)
Pointer to control, NULL if not found
| TInt aLayout | Controls layout (for one line queries use EDataLayout, ECodeLayout... and for multiline queries use EMultiDataFirstEdwin, EMultiDataSecondEdwin...) |
| TInt | CountComponentControls | ( | ) | const [virtual] |
From CCoeControl Count number of controls contained in a compound control.
The number of component controls contained by this control.
| void | CreateIncAndDecButtonsL | ( | ) | [private] |
Creates increment and decrement buttons.
| void | DeployFlagsL | ( | ) | [private] |
This acts on the Query control flags that are set from CAknQueryDialog
| CEikDialog * | Dialog | ( | ) | const [private] |
Returns pointer to dialog.
Pointer to dialog if it exists.
| TRect | DialogRect | ( | ) | const [protected] |
Return the rect that is used by the dialog for layout This can be determined using LAF values and is equal to TPoint(0,0) plus the control size plus the margins
| TSize | DialogSize | ( | ) | const [protected] |
Return the size of the dialog. This equals to the control size plus the margins.
| void | DialogSizeChanged | ( | ) | [protected] |
Calculates the size of the dialog. This can be determined using LAF values and is equal to the control size plus the margins.
| void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
From CCoeControl Draw a control.
| const TRect & aRect | The region of the control to be redrawn. |
| void | DrawEditorFrame | ( | CWindowGc & | aGc, |
| TRect & | aRect | |||
| ) | const [protected] | |||
Draw editor frame and shadows
| TBool | EditorContentIsValidL | ( | ) | const |
true if the content of the editor is valid, false otherwise
| TBool | EmbeddedVirtualInput | ( | ) | const [private] |
Checks if this query control should contain embedded virtual keypad.
ETrue if embedded virtual keypad should be used.
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
| TUid aInterface |
| void | FocusChanged | ( | TDrawNow | aDrawNow | ) | [virtual] |
From CCoeControl Added to pass-through focus-loss warnings. if not ready, this will leave. Indicates whether or not the key event was used by this control.
| TDrawNow aDrawNow |
| void | GetCaption | ( | TDes & | aCaption | ) | const |
Return prompt needed by FEP to query dialog
| TDes & aCaption |
| IMPORT_C TTimeIntervalSeconds | GetDuration | ( | ) | const |
Get duration from duration editor
Return duration from editor.
| IMPORT_C TReal | GetFloatingPointNumberL | ( | ) | const |
Get number from floating point editor.
Returns number from editor
| IMPORT_C void | GetLocation | ( | TPosition & | aLocation | ) | const |
Get location from location editor
Modifies aLocation in such way that either longitude or latitude will change.
| TPosition & aLocation |
| IMPORT_C void | GetText | ( | TDes & | aDes | ) | const |
Get text from text, secret text, numeric secret text snd phonenumber editor.
| TDes & aDes | Address of variable where text returned. |
| IMPORT_C TInt | GetTextEntryLength | ( | ) | const |
Return the max length of the text in the text editor max text length
| IMPORT_C TInt | GetTextLength | ( | ) | const |
Get text length from editor.
Length of text from editor
| IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| TCoeEvent | aEventType | |||
| ) | ||||
From MCoeControlObserver
| CCoeControl * aControl | Control who caused the event |
| TCoeEvent aEventType | Type of the event |
| IMPORT_C void | HandleEdwinEventL | ( | CEikEdwin * | aEdwin, |
| TEdwinEvent | aEventType | |||
| ) | ||||
From MEikEdwinObserver
| CEikEdwin * aEdwin | Editor who sent the event |
| TEdwinEvent aEventType | Type of the event |
| IMPORT_C TBool | HandleEdwinSizeEventL | ( | CEikEdwin * | aEdwin, |
| TEdwinSizeEvent | aEventType, | |||
| TSize | aDesirableEdwinSize | |||
| ) | ||||
From MEikEdwinObserver
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl. Handles pointer events
| const TPointerEvent & aPointerEvent |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
| TInt aType |
| void | LayoutEditor | ( | const TLayoutMethod & | aLayoutM | ) | [protected, virtual] |
Layout the text editor
| const TLayoutMethod & aLayoutM |
| void | LayoutEditorForFullScreen | ( | const TLayoutMethod & | ) | [private] |
Layouts the query prompt in case of Full Screen Query.
| const TLayoutMethod & |
| void | LayoutEditorFrame | ( | const TLayoutMethod & | aLayoutM | ) | [protected, virtual] |
Layout the editor frame
| const TLayoutMethod & aLayoutM |
| void | LayoutEditorIndicator | ( | const TLayoutMethod & | aLayoutM | ) | [protected, virtual] |
Layout the editor state indicator icons
| const TLayoutMethod & aLayoutM |
| void | LayoutImageOrAnim | ( | const TLayoutMethod & | aLayoutM | ) | [protected, virtual] |
Layout the image or the animation
| const TLayoutMethod & aLayoutM |
| void | LayoutPrompt | ( | const TLayoutMethod & | aLayoutM | ) | [protected, virtual] |
Layout the query prompt
| const TLayoutMethod & aLayoutM |
| void | LayoutPromptForFullScreen | ( | ) | [private] |
Layout the text editor in case of Full Screen Query.
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
From CCoeControl Give the control a mimimum size.
The minimum size required by the control.
| TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected] |
From MObjectProvider
| TTypeUid aId |
| IMPORT_C TInt | NbrOfEditorLines | ( | ) | const |
Return number of editor lines
Number lines in the editor
| IMPORT_C TInt | NbrOfPromptLines | ( | ) | const |
Return number of prompt lines
Number of lines in the prompt
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
From CCoeControl Handle key events. When a key event occurs, CONE calls this function for each control on the control stack, until one of them returns EKeyWasConsumed to indicate that it processed the key event. 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. |
| TInt | PinCodeTimeoutCallback | ( | TAny * | aThis | ) | [private, static] |
Callback for pin code timeouts for producing a tacticons.
| TAny * aThis | Pointer to this object, which is used to play tacticon. |
| void | PlayPinCodeTacticon | ( | ) | [private] |
Plays a tacticon. Used by the timeout callback.
| void | PrepareForFocusLossL | ( | ) | [virtual] |
From CCoeControl Added to pass-through focus-loss warnings. if not ready, this will leave. Indicates whether or not the key event was used by this control.
| CAknQueryExtension * | QueryExtension | ( | ) | const [protected] |
Get the extension object instance, if any exists.
| TInt | QueryType | ( | ) | const [inline] |
Layout indication
At the moment the layout is a good indication of the query type (PIN,number,etc) The query dialog uses this information to determine query type in order to process key events in a way dependent on the query type. These key events can't be processes by the control directly because they involve actions only the dialog can perform
| IMPORT_C void | ReadPromptL | ( | TResourceReader & | aRes | ) | [virtual] |
Read prompt text from resource and call SetPrompt if there was text for prompt.
| TResourceReader & aRes | resource reader pointed to a query resource |
| void | ResetPinCodeTacticonTimer | ( | ) | [private] |
Resets the timer for pincode query tacticon playback.
| void | SetAndUseFlagsL | ( | TBitFlags16 | aFlags | ) |
This transfers CAknQueryControl's flags set by the dialog and then uses them. The method must be called after all the contained controls are constructed; Inside PreLayoutDynamicInitL is recommended.
| TBitFlags16 aFlags |
| IMPORT_C void | SetAnimationL | ( | TInt | aResource | ) |
Sets and overrides other animation
| TInt aResource |
| IMPORT_C void | SetDuration | ( | TTimeIntervalSeconds & | aDuration | ) |
Set duration to duration editor
| TTimeIntervalSeconds & aDuration | Duration to editor |
| void | SetEcsCbaVisibleL | ( | TBool | aVisible | ) |
Sets the ECS CBA visibility in the query.
TBool aVisible ETrue if an ECS number is entered to the query, EFalse otherwise.
| TBool aVisible |
| void | SetFlags | ( | TBitFlags16 | aFlags | ) | [private] |
This transfers CAknQueryControl's flags set by the dialog
| TBitFlags16 aFlags |
| IMPORT_C void | SetFloatingPointNumberL | ( | const TReal * | aNumber | ) |
Set number to floating point editor
| const TReal * aNumber | Number to editor |
| IMPORT_C void | SetImageL | ( | CEikImage * | aImage | ) |
Sets and overrides other image or animation Takes ownership of aImage
| CEikImage * aImage |
| IMPORT_C void | SetImageL | ( | const TDesC & | aImageFile, |
| TInt | aBmpId, | |||
| TInt | aBmpMaskId | |||
| ) | ||||
Sets and overrides other image or animation
| void | SetLineWidthsL | ( | ) | [protected, virtual] |
Determine the line widths for the prompt, depends on layout
| IMPORT_C void | SetLocation | ( | const TPosition & | aLocation | ) |
Set location to location editor
Modifies editor in such way that it'll start showing either longitude or latitude from the given location. It depends on resource file flags of the location editor which is used.
| const TPosition & aLocation | Location to editor |
| IMPORT_C void | SetMinimumAndMaximum | ( | const TTime & | aMinimum, |
| const TTime & | aMaximum | |||
| ) | ||||
Set minimum and maximum time or date to editor
| IMPORT_C void | SetMinimumAndMaximum | ( | const TTimeIntervalSeconds & | aMinimumDuration, |
| const TTimeIntervalSeconds & | aMaximumDuration | |||
| ) | ||||
Set minimum and maximum duration to editor
| const TTimeIntervalSeconds & aMinimumDuration | Minimum value |
| const TTimeIntervalSeconds & aMaximumDuration | Maximum value |
| IMPORT_C void | SetMinimumAndMaximum | ( | TInt | aMinimumValue, |
| TInt | aMaximumValue | |||
| ) | ||||
Set minimum and maximum number to editor
| IMPORT_C void | SetMinimumAndMaximum | ( | const TReal & | aMinimumValue, |
| const TReal & | aMaximumValue | |||
| ) | ||||
Set minimum and maximum number to floating point editor
| IMPORT_C void | SetNumberL | ( | TInt | aNumber | ) |
Set number to number editor
| TInt aNumber | Number to editor |
| IMPORT_C void | SetNumberOfEditorLines | ( | TInt | aNum | ) |
Set the number of lines in the editor.
| TInt aNum | Number of lines in the editor |
| IMPORT_C void | SetPromptL | ( | const TDesC & | aDesC | ) | [virtual] |
Set prompt text for query. This call WrapToStringL.
| const TDesC & aDesC | Text for prompt |
| IMPORT_C void | SetQueryControlObserver | ( | MAknQueryControlObserver * | aQueryControlObserver | ) |
Set observer for query control.
| MAknQueryControlObserver * aQueryControlObserver | Pointer to oberver class |
| IMPORT_C void | SetTextEntryLength | ( | TInt | aLength | ) |
Set max length of text to text editor. This will override length from resource
| TInt aLength | Max length of text in editor |
| IMPORT_C void | SetTextL | ( | const TDesC & | aDesC | ) |
Set text to text and phonenumber editor.
| const TDesC & aDesC | Text for editor |
| IMPORT_C void | SetTime | ( | TTime & | aTime | ) |
Set date of time to editor
| TTime & aTime | Time or date to editor. |
| void | SizeChanged | ( | ) | [protected, virtual] |
From CCoeControl Respond to size changed. This function is called by CONE whenever SetExtentL(), SetSizeL(), SetRectL(), SetCornerAndSizeL(), or SetExtentToWholeScreenL() are called on the control.
| TInt | StaticPictographCallBack | ( | TAny * | aPtr | ) | [private, static] |
| TAny * aPtr |
| void | StopPinCodeTacticonTimer | ( | ) | [private] |
Stops/removes the timer for pincode query tacticon playback.
| void | WindowLayout | ( | TAknWindowLineLayout & | aLayout | ) | const [virtual] |
Return window layout depending on Layout Window layout is done by the dialog
| TAknWindowLineLayout & aLayout |
Layout for queries can be done using the following methods. Each method is specified in a LAF section
| EConfQueryLayoutM | |
| EDataQueryLayoutM | |
| ECodeQueryLayoutM | |
| ETimeQueryLayoutM | |
| EDateQueryLayoutM | |
| ECombinedCodeDataQueryLayoutM |
LAYOUT according to LAF specs for combined code and data queries |
Enumeration for indexing into control flags, which determine the control behaviour relative to a number of things, e.g. emergency control handling, displaying of edit indicator, enabling of predictive text, etc
| EEmergencyCallsEnabledByAPI |
Query supports emergency calls. |
| EEmergencyCallsDisabledByAPI |
Query doesn't support emergency calls. |
| EPredictiveTextEntryPermitted |
Predictive text input is allowed in the query. |
| EEditorIndicatorOff |
Editor indicators are not shown in the query. |
| EEmergencyCallsCBASupport |
Additional support to ECS for CBA label change. Must be enabled for touch full screen query for the ECS to function properly. |
| CEikFloatingPointEditor * | iFloatingPointEditor | [protected] |
| MAknQueryControlObserver * | iQueryControlObserver | [protected] |