CAknTextQueryDialog Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknquerydialog.h>

Inherits CAknQueryDialog.

Detailed Description

This class should be used when user is reguest to enter plain text, secret text, phonenumber or PIN-code.

Public Member Functions
IMPORT_C  CAknTextQueryDialog (TDes &aDataText, const TTone &aTone=ENoTone)
  C++ Constructor.
virtual IMPORT_C  ~CAknTextQueryDialog ()
  C++ Destructor.
IMPORT_C void  SetMaxLength (TInt aLength)
  Set max lenght for editor.
virtual IMPORT_C TBool  CheckIfEntryTextOk () const
  Return true if the length of the text is bigger than zero and if there is at least a character which is not a space.
IMPORT_C void  SetDefaultInputMode (TInt aInputMode)
  Changes default input mode of a secret editor.
IMPORT_C TBool  HandleQueryEditorSizeEventL (CAknQueryControl *aQueryControl, TQueryControlEvent aEventType)
  From MAknQueryControlObserver.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  Handles pointer events.
IMPORT_C  CAknTextQueryDialog (TDes &aDataText, TDesC &aPrompt, const TTone &aTone=ENoTone)
  deprecated do not use

Static Public Member Functions
static IMPORT_C CAknTextQueryDialog *  NewL (TDes &aDataText, const TTone &aTone=ENoTone)
  Second phase construction required to align API with multiline queries and because in future MAknQueryData will be used.

Protected Member Functions
IMPORT_C void  PreLayoutDynInitL ()
  From CEikdialog.
virtual IMPORT_C TBool  OkToExitL (TInt aButtonId)
  From CEikdialog.
void  SetControlTextL ()
  Called by PreLayoutDynInit(), set the control observer, the text and the maximum length of the text.
TDes &  Text ()
const TDesC &  Text () const

Protected Attributes
TInt  iTextMaxLength
  Max length for text.
TDes &  iDataText
  Text for editor.
TBool  iEditorTextOk

Constructor & Destructor Documentation

IMPORT_C CAknTextQueryDialog::CAknTextQueryDialog (  TDes &  aDataText,
const TTone &  aTone = ENoTone
) 
 

C++ Constructor.

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

C++ Destructor.

IMPORT_C CAknTextQueryDialog::CAknTextQueryDialog (  TDes &  aDataText,
TDesC &  aPrompt,
const TTone &  aTone = ENoTone
) 
 

deprecated do not use

Member Function Documentation

virtual IMPORT_C TBool CAknTextQueryDialog::CheckIfEntryTextOk (   )  const [virtual]
 

Return true if the length of the text is bigger than zero and if there is at least a character which is not a space.

IMPORT_C void CAknTextQueryDialog::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  ) 
 

Handles pointer events.

Reimplemented from CAknQueryDialog.

IMPORT_C TBool CAknTextQueryDialog::HandleQueryEditorSizeEventL (  CAknQueryControl *  aQueryControl,
TQueryControlEvent  aEventType
) 
 

From MAknQueryControlObserver.

Gets called when editor sends size event

Parameters:
aQueryControl  Pointer to query control which sent the event
aEventType  Type of the event

Reimplemented from CAknQueryDialog.

static IMPORT_C CAknTextQueryDialog* CAknTextQueryDialog::NewL (  TDes &  aDataText,
const TTone &  aTone = ENoTone
)  [static]
 

Second phase construction required to align API with multiline queries and because in future MAknQueryData will be used.

virtual IMPORT_C TBool CAknTextQueryDialog::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.

Parameters:
aButtonId  The ID of the button that was activated
Returns:
Should return ETrue if the dialog should exit, and EFalse if it should not.

Reimplemented from CAknQueryDialog.

IMPORT_C void CAknTextQueryDialog::PreLayoutDynInitL (   )  [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.

Reimplemented from CAknQueryDialog.

void CAknTextQueryDialog::SetControlTextL (   )  [protected]
 

Called by PreLayoutDynInit(), set the control observer, the text and the maximum length of the text.

IMPORT_C void CAknTextQueryDialog::SetDefaultInputMode (  TInt  aInputMode  ) 
 

Changes default input mode of a secret editor.

By default input mode in secret editor is alpha input mode (EAknEditorSecretAlphaInputMode from uikon.hrh). By using this method the default input mode can be changed to numeric input mode (EAknEditorNumericInputMode).

Parameters:
aInputMode  Default input mode in the secret editor. Only EAknEditorNumericInputMode and EAknEditorSecretAlphaInputMode are supported.
IMPORT_C void CAknTextQueryDialog::SetMaxLength (  TInt  aLength  ) 
 

Set max lenght for editor.

This overrides the max lenght given in resource.

Parameters:
aLength  Max lenght.
const TDesC& CAknTextQueryDialog::Text (   )  const [inline, protected]
 
Returns:
data
TDes& CAknTextQueryDialog::Text (   )  [inline, protected]
 
Returns:
data

Field Documentation

TDes& CAknTextQueryDialog::iDataText [protected]
 

Text for editor.

When query is approved text from editor is stored here

TBool CAknTextQueryDialog::iEditorTextOk [protected]
 
Deprecated:
  • not used anymore
TInt CAknTextQueryDialog::iTextMaxLength [protected]
 

Max length for text.

Deprecated:
This data will become private Use Text() and MaxTextLength() instead
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top