CAknMultiLineIpQueryDialog Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None


#include <aknquerydialog.h>

Inherits CAknMultiLineDataQueryDialog.


Detailed Description

Query Dialog with data input on more than one line (2 lines at the moment).

Create using NewL methods and passing parameters as appropriate.

Attention: When deriving from this class, you must call SetDataL during second phase construction.


Public Member Functions

virtual IMPORT_C  ~CAknMultiLineIpQueryDialog ()
IMPORT_C void  SetPromptL (const TDesC &aFirstPrompt, const TDesC &aSecondPrompt)
  Set prompt text for query.
IMPORT_C void  SetMaxLengthOfFirstEditor (TInt aFirstTextEditorMaxLength)
  Sets max length for the first editor in a query.
IMPORT_C void  SetMaxLengthOfSecondEditor (TInt aSecondTextEditorMaxLength)
  Sets max length for the second editor in a query.

Static Public Member Functions

static IMPORT_C CAknMultiLineIpQueryDialog NewL (TInetAddr &aAddress1, TInetAddr &aAddress2, TTone aTone=ENoTone)
  Second phase construction.

Protected Member Functions

template<class T1, class T2>
void  SetDataL (T1 &aData1, T2 &aData2)
  Set the query data for first and second line Must be called by derived classes during second phase construction (NewL method).
virtual IMPORT_C TBool  OkToExitL (TInt aButtonId)
  From CEikdialog.
IMPORT_C void  PreLayoutDynInitL ()
  From CEikdialog.
IMPORT_C void  HandleResourceChange (TInt aType)
  From CCoeControl.
IMPORT_C void  UpdateLeftSoftKeyL ()
  If the query text is ok (retrieved form query controls) then display the left soft key, otherwise hide it.
IMPORT_C void  DoSetPromptL ()
  Set the prompt inside the query control.
IMPORT_C TBool  NeedToDismissQueryL (const TKeyEvent &aKeyEvent)
  Called by OfferkeyEventL(), gives a change to dismiss the query even with keys different than Enter of Ok.
IMPORT_C CAknExtMultilineQueryControl FirstControl () const
  Access to 1st query control.
IMPORT_C CAknExtMultilineQueryControl SecondControl () const
  Access to 2nd query control.
IMPORT_C CAknQueryControl QueryControl () const
  Not implemented.
IMPORT_C TPtrC  SecondPrompt () const
  Prompt access for derived classes.

Static Protected Member Functions

template<class T1, class T2>
static CAknMultiLineIpQueryDialog DoNewL (T1 &aData1, T2 &aData2, const TTone &aTone)
  Utility function called by NewL methods - should really be private but it is left here to show to people extending this class what their NewL method should do.

Constructor & Destructor Documentation

virtual IMPORT_C CAknMultiLineIpQueryDialog::~CAknMultiLineIpQueryDialog  )  [virtual]
 

Member Function Documentation

template<class T1, class T2>
static CAknMultiLineIpQueryDialog* CAknMultiLineIpQueryDialog::DoNewL T1 &  aData1,
T2 &  aData2,
const TTone aTone
[inline, static, protected]
 

Utility function called by NewL methods - should really be private but it is left here to show to people extending this class what their NewL method should do.

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C void CAknMultiLineIpQueryDialog::DoSetPromptL  )  [protected, virtual]
 

Set the prompt inside the query control.

If dialog is active redo layout and draw.

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C CAknExtMultilineQueryControl* CAknMultiLineIpQueryDialog::FirstControl  )  const [protected]
 

Access to 1st query control.

Returns:
Pointer to the control of the first line.

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C void CAknMultiLineIpQueryDialog::HandleResourceChange TInt  aType  )  [protected, virtual]
 

From CCoeControl.

Handles a change to the control's resources. The types of resources handled are those which are shared across the environment, e.g. colours or fonts.

Parameters:
aType  A message UID value. The most common is KEikMessageColorSchemeChange which controls get when the colour scheme is changed. Other examples include: KEikMessageFadeAllWindows, KEikMessageUnfadeWindows, KEikMessageZoomChange, KEikMessageVirtualCursorStateChange, KEikMessageCapsLock, KEikMessagePrepareForSave.

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C TBool CAknMultiLineIpQueryDialog::NeedToDismissQueryL const TKeyEvent &  aKeyEvent  )  [protected, virtual]
 

Called by OfferkeyEventL(), gives a change to dismiss the query even with keys different than Enter of Ok.

Parameters:
aKeyEvent  Key event which will be checked
Returns:
Should the query be dismissed

Reimplemented from CAknMultiLineDataQueryDialog.

static IMPORT_C CAknMultiLineIpQueryDialog* CAknMultiLineIpQueryDialog::NewL TInetAddr &  aAddress1,
TInetAddr &  aAddress2,
TTone  aTone = ENoTone
[static]
 

Second phase construction.

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

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

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C CAknQueryControl* CAknMultiLineIpQueryDialog::QueryControl  )  const [protected, virtual]
 

Not implemented.

Returns:
NULL.

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C CAknExtMultilineQueryControl* CAknMultiLineIpQueryDialog::SecondControl  )  const [protected]
 

Access to 2nd query control.

Returns:
Pointer to the control of the second line.

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C TPtrC CAknMultiLineIpQueryDialog::SecondPrompt  )  const [protected]
 

Prompt access for derived classes.

Reimplemented from CAknMultiLineDataQueryDialog.

template<class T1, class T2>
void CAknMultiLineIpQueryDialog::SetDataL T1 &  aData1,
T2 &  aData2
[inline, protected]
 

Set the query data for first and second line Must be called by derived classes during second phase construction (NewL method).

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C void CAknMultiLineIpQueryDialog::SetMaxLengthOfFirstEditor TInt  aFirstTextEditorMaxLength  ) 
 

Sets max length for the first editor in a query.

Parameters:
aFirstTextEditorMaxLength  Max length for editor

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C void CAknMultiLineIpQueryDialog::SetMaxLengthOfSecondEditor TInt  aSecondTextEditorMaxLength  ) 
 

Sets max length for the second editor in a query.

Parameters:
aSecondTextEditorMaxLength  Max length for editor

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C void CAknMultiLineIpQueryDialog::SetPromptL const TDesC &  aFirstPrompt,
const TDesC &  aSecondPrompt
 

Set prompt text for query.

This this will override text given in constructor.

Parameters:
aFirstPrompt  Text for prompt on the first query line
aSecondPrompt  Text for prompt on the second query line

Reimplemented from CAknMultiLineDataQueryDialog.

IMPORT_C void CAknMultiLineIpQueryDialog::UpdateLeftSoftKeyL  )  [protected, virtual]
 

If the query text is ok (retrieved form query controls) then display the left soft key, otherwise hide it.

Reimplemented from CAknMultiLineDataQueryDialog.


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top