CAknQueryControl Class Reference

IMPORT_C TInt CAknQueryControl::CancelAnimation

C++ Constructor.

virtual IMPORT_C CAknQueryControl::~CAknQueryControl ( ) [virtual]

C++ Destructor.

Member Function Documentation

void CAknQueryControl::CancelQueryL

stops animation if one present

Returns:: error code

IMPORT_C TBool CAknQueryControl::CheckNumber

This cancels the query.

Used when the query control has to get abandon the query for some reason

CCoeControl* CAknQueryControl::ComponentControl

Checks if the given number in the editor is within the maximum and minimum values.

From CCoeControl Get the components of a compound control.

It returns one of the control's component controls, identified by aIndex.

Parameters:

anIndex

The index of the control to get.

Returns:: The component control with an index of aIndex.

Reimplemented in CAknExtQueryControl.

IMPORT_C void CAknQueryControl::ConstructFromResourceL

Second phase constructor: loads contents of array from resources.

Parameters:

aRea

resource reader pointed to a query resource.

virtual void CAknQueryControl::ConstructQueryL ( TResourceReader & aRes ) [protected, virtual]

After having read the query type from resource.

This method is called in CostructFromResourceL()

See also:: ConstructFromResourceL()

Reimplemented in CAknMultilineQueryControl, CAknExtMultilineQueryControl, and CAknExtQueryControl.

virtual IMPORT_C CCoeControl* CAknQueryControl::ControlByLayoutOrNull ( TInt aLayout ) [virtual]

Get pointer to query controls control (editor).

Parameters:

aLayout

Controls layout (for one line queries use EDataLayout, ECodeLayout... and for multiline queries use EMultiDataFirstEdwin, EMultiDataSecondEdwin...)

Returns:: Pointer to control, NULL if not found

Reimplemented in CAknMultilineQueryControl, CAknExtMultilineQueryControl, and CAknExtQueryControl.

TInt CAknQueryControl::CountComponentControls

The region of the control to be redrawn.

From CCoeControl Count number of controls contained in a compound control.

Returns:: The number of component controls contained by this control.

Reimplemented in CAknExtQueryControl.

CAknQueryControl::DECLARE_TYPE_ID ( 0x10283143 ) [inline]

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

TRect CAknQueryControl::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 CAknQueryControl::DialogSize ( ) const [protected]

Return the size of the dialog.

This equals to the control size plus the margins.

void CAknQueryControl::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 CAknQueryControl::Draw ( const TRect & aRect ) const [protected]

From CCoeControl Draw a control.

Parameters:

aRect

void CAknQueryControl::DrawEditorFrame	(	CWindowGc &	aGc,
		TRect &	aRect
	)	const `[protected]`

Draw editor frame and shadows.

TBool CAknQueryControl::EditorContentIsValidL

void CAknQueryControl::FocusChanged

Returns:: true if the content of the editor is valid, false otherwise

Reimplemented in CAknExtQueryControl.

From CCoeControl Added to pass-through focus-loss warnings.

if not ready, this will leave.

Returns:: Indicates whether or not the key event was used by this control.

Reimplemented in CAknExtQueryControl.

IMPORT_C TTimeIntervalSeconds CAknQueryControl::GetDuration

IMPORT_C TReal CAknQueryControl::GetFloatingPointNumberL

Get duration from duration editor.

Returns:: Return duration from editor.

IMPORT_C void CAknQueryControl::GetLocation

Get number from floating point editor.

Returns:: Returns number from editor

Get location from location editor.

Modifies aLocation in such way that either longitude or latitude will change.

IMPORT_C TInt CAknQueryControl::GetNumber

IMPORT_C void CAknQueryControl::GetText

Get number from number editor.

Returns:: Returns number from editor

Get text from text, secret text, numeric secret text snd phonenumber editor.

Parameters:

aDes

Address of variable where text returned.

IMPORT_C TInt CAknQueryControl::GetTextEntryLength

IMPORT_C TInt CAknQueryControl::GetTextLength

Return the max length of the text in the text editor.

Returns:: max text length

IMPORT_C TTime CAknQueryControl::GetTime

Get text length from editor.

Returns:: Length of text from editor

IMPORT_C void CAknQueryControl::HandlePointerEventL

Get time from date or time editors.

Returns:: Returns data from editor.

IMPORT_C void CAknQueryControl::HandleControlEventL	(	CCoeControl *	aControl,
		TCoeEvent	aEventType
	)

From MCoeControlObserver.

Parameters:

	aControl	Control who caused the event
	aEventType	Type of the event

Reimplemented in CAknExtQueryControl.

IMPORT_C void CAknQueryControl::HandleEdwinEventL	(	CEikEdwin *	aEdwin,
		TEdwinEvent	aEventType
	)

From MEikEdwinObserver.

Parameters:

	aEdwin	Editor who sent the event
	aEventType	Type of the event

IMPORT_C TBool CAknQueryControl::HandleEdwinSizeEventL	(	CEikEdwin *	aEdwin,
		TEdwinSizeEvent	aEventType,
		TSize	aDesirableEdwinSize
	)

From MEikEdwinObserver.

Parameters:

	aEdwin	Editor who's size has changed
	aEventType	Type of the size event
	aDesirableEdwinSize	Desirable size of the edwin

const TPointerEvent &

aPointerEvent

IMPORT_C void CAknQueryControl::HandleResourceChange

From CCoeControl.

Handles pointer events

Reimplemented in CAknMultilineQueryControl, CAknExtMultilineQueryControl, and CAknExtQueryControl.

Reimplemented in CAknMultilineQueryControl, and CAknExtMultilineQueryControl.

void CAknQueryControl::Layout ( ) [protected]

Perform layout by calling SizeChanged.

virtual void CAknQueryControl::LayoutEditor ( const TLayoutMethod & aLayoutM ) [protected, virtual]

Layout the text editor.

virtual void CAknQueryControl::LayoutEditorFrame ( const TLayoutMethod & aLayoutM ) [protected, virtual]

Layout the editor frame.

virtual void CAknQueryControl::LayoutEditorIndicator ( const TLayoutMethod & aLayoutM ) [protected, virtual]

Layout the editor state indicator icons.

virtual void CAknQueryControl::LayoutImageOrAnim ( const TLayoutMethod & aLayoutM ) [protected, virtual]

Layout the image or the animation.

virtual void CAknQueryControl::LayoutPrompt ( const TLayoutMethod & aLayoutM ) [protected, virtual]

Layout the query prompt.

virtual TRect CAknQueryControl::LayoutRect ( ) [protected, virtual]

Layout rectangle (shift up and left by margins).

Reimplemented in CAknMultilineQueryControl, and CAknExtMultilineQueryControl.

CAknLocationEditor* CAknQueryControl::LocationEd ( ) const [protected]

CAknLocationEditor*& CAknQueryControl::LocationEd ( ) [protected]

IMPORT_C TSize CAknQueryControl::MinimumSize

IMPORT_C TInt CAknQueryControl::NbrOfEditorLines

From CCoeControl Give the control a mimimum size.

Returns:: The minimum size required by the control.

Reimplemented in CAknMultilineQueryControl, and CAknExtMultilineQueryControl.

TTypeUid::Ptr CAknQueryControl::MopSupplyObject ( TTypeUid aId ) [protected]

From MObjectProvider.

IMPORT_C TInt CAknQueryControl::NbrOfPromptLines

Return number of editor lines.

Returns:: Number lines in the editor

void CAknQueryControl::PrepareForFocusLossL

Return number of prompt lines.

Returns:: Number of lines in the prompt

IMPORT_C TKeyResponse CAknQueryControl::OfferKeyEventL	(	const TKeyEvent &	aKeyEvent,
		TEventCode	aType
	)

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.

Parameters:

	aKeyEvent	The key event.
	aType	The type of the event: EEventKey, EEventKeyUp or EEventKeyDown.

Returns:: Indicates whether or not the key event was used by this control.

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

From CCoeControl Added to pass-through focus-loss warnings.

if not ready, this will leave.

Returns:: Indicates whether or not the key event was used by this control.

Reimplemented in CAknExtQueryControl.

CAknQueryExtension* CAknQueryControl::QueryExtension ( ) const [protected]

Get the extension object instance, if any exists.

TInt CAknQueryControl::QueryType ( ) const [inline]

Returns:: Layout indication

virtual IMPORT_C void CAknQueryControl::ReadPromptL ( TResourceReader & aRes ) [virtual]

Read prompt text from resource and call SetPrompt if there was text for prompt.

Parameters:

aRes

resource reader pointed to a query resource

void CAknQueryControl::SetAndUseFlagsL

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.

Parameters:

flag

pattern to set and then act on.

Reimplemented in CAknExtQueryControl.

IMPORT_C void CAknQueryControl::SetAnimationL

Sets and overrides other animation.

IMPORT_C void CAknQueryControl::SetDuration

TTimeIntervalSeconds &

aDuration

IMPORT_C void CAknQueryControl::SetFloatingPointNumberL

Set duration to duration editor.

Parameters:

aDuration

Duration to editor

Set number to floating point editor.

Parameters:

aNumber

Number to editor

IMPORT_C void CAknQueryControl::SetImageL	(	const TDesC &	aImageFile,
		TInt	aBmpId,
		TInt	aBmpMaskId
	)

Sets and overrides other image or animation.

IMPORT_C void CAknQueryControl::SetImageL

Sets and overrides other image or animation Takes ownership of aImage.

virtual void CAknQueryControl::SetLineWidthsL ( ) [protected, virtual]

Determine the line widths for the prompt, depends on layout.

Reimplemented in CAknMultilineQueryControl, and CAknExtMultilineQueryControl.

IMPORT_C void CAknQueryControl::SetLocation

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.

Parameters:

aLocation

Location to editor

IMPORT_C void CAknQueryControl::SetMinimumAndMaximum	(	const TReal &	aMinimumValue,
		const TReal &	aMaximumValue
	)

Set minimum and maximum number to floating point editor.

Parameters:

	aMinimumValue	Minimum value
	aMaximumValue	Maximum value

IMPORT_C void CAknQueryControl::SetMinimumAndMaximum	(	TInt	aMinimumValue,
		TInt	aMaximumValue
	)

Set minimum and maximum number to editor.

Parameters:

	aMinimumValue	Minimum value
	aMaximumValue	Maximum value

Reimplemented in CAknExtQueryControl.

IMPORT_C void CAknQueryControl::SetMinimumAndMaximum	(	const TTimeIntervalSeconds &	aMinimumDuration,
		const TTimeIntervalSeconds &	aMaximumDuration
	)

Set minimum and maximum duration to editor.

Parameters:

	aMinimumDuration	Minimum value
	aMaximumDuration	Maximum value

IMPORT_C void CAknQueryControl::SetMinimumAndMaximum	(	const TTime &	aMinimum,
		const TTime &	aMaximum
	)

Set minimum and maximum time or date to editor.

Parameters:

	aMinimum	Minimum value
	aMaximum	Maximum value

IMPORT_C void CAknQueryControl::SetNumberL

Set number to number editor.

Parameters:

aNumber

Number to editor

IMPORT_C void CAknQueryControl::SetNumberOfEditorLines

Set the number of lines in the editor.

Parameters:

aNum

Number of lines in the editor

virtual IMPORT_C void CAknQueryControl::SetPromptL ( const TDesC & aDesC ) [virtual]

Set prompt text for query.

This call WrapToStringL.

Parameters:

aDesC

Text for prompt

IMPORT_C void CAknQueryControl::SetQueryControlObserver

MAknQueryControlObserver *

aQueryControlObserver

IMPORT_C void CAknQueryControl::SetTextEntryLength

Set observer for query control.

Parameters:

aQueryControlObserver

Pointer to oberver class

Set max length of text to text editor.

This will override length from resource

Parameters:

aLength

Max length of text in editor

IMPORT_C void CAknQueryControl::SetTextL

Set text to text and phonenumber editor.

Parameters:

aDesC

Text for editor

IMPORT_C void CAknQueryControl::SetTime

Set date of time to editor.

Parameters:

aTime

Time or date to editor.

void CAknQueryControl::SizeChanged ( ) [protected]

From CCoeControl Respond to size changed.

This function is called by CONE whenever SetExtentL(), SetSizeL(), SetRectL(), SetCornerAndSizeL(), or SetExtentToWholeScreenL() are called on the control.

IMPORT_C void CAknQueryControl::StartAnimationL