CAknQueryDialog Class Reference

class CAknQueryDialog : public CAknDialog

General query dialog

Use for confirmation queries

Public Member Functions
CAknQueryDialog(const TTone &)
CAknQueryDialog()
CAknQueryDialog(TDesC &, const TTone &)
~CAknQueryDialog()
IMPORT_C voidDismissQueryL()
IMPORT_C TIntExecuteLD(TInt)
IMPORT_C TIntExecuteLD(TInt, const TDesC &)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C TBoolHandleQueryEditorSizeEventL(CAknQueryControl *, TQueryControlEvent)
IMPORT_C TBoolHandleQueryEditorStateEventL(CAknQueryControl *, TQueryControlEvent, TQueryValidationStatus)
IMPORT_C CAknPopupHeadingPane *Heading()
IMPORT_C TCoeInputCapabilitiesInputCapabilities()
IMPORT_C voidMakeLeftSoftkeyVisible(TBool)
IMPORT_C TIntMaxTextLength(const CAknQueryControl *, const TDes &, TInt)
IMPORT_C TIntMaxTextLength(const CAknQueryControl *, const TDes *, TInt)
IMPORT_C TBoolNeedToDismissQueryL(const TKeyEvent &)
IMPORT_C CAknQueryDialog *NewL(const TTone &)
IMPORT_C CAknQueryDialog *NewL(TDes &, const TTone &)
IMPORT_C CAknQueryDialog *NewL(TInt &, const TTone &)
IMPORT_C CAknQueryDialog *NewL(TTime &, const TTone &)
IMPORT_C CAknQueryDialog *NewL(TTimeIntervalSeconds &, const TTone &)
IMPORT_C CAknQueryDialog *NewL(TReal &, const TTone &)
IMPORT_C CAknQueryDialog *NewL(TInetAddr &, const TTone &)
IMPORT_C CAknQueryDialog *NewL(TPosition &, const TTone &)
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C CAknPopupHeadingPane *QueryHeading()
IMPORT_C voidRemoveEditorIndicator()
IMPORT_C TIntRunDlgLD(TInt)
IMPORT_C TIntRunLD()
IMPORT_C voidSetEmergencyCallSupport(TBool)
IMPORT_C voidSetEmergencyCallSupportForCBA(TBool)
IMPORT_C voidSetHeaderImageL(CEikImage *)
IMPORT_C voidSetHeaderTextL(const TDesC &)
IMPORT_C voidSetPredictiveTextInputPermitted(TBool)
IMPORT_C voidSetPromptL(const TDesC &)
Protected Member Functions
IMPORT_C voidDoSetPromptL()
CCoeControl *FindControlOnAnyPageWithControlType(TInt, TInt *, TInt *)
TBitFlags16 &Flags()
const TBitFlags16 &Flags()
TInt GetLeftCBAShortKeyPress()
TInt GetRightCBAShortKeyPress()
TBool IsLeftSoftkeyVisible()
voidLayoutAndDraw()
IMPORT_C TBoolOkToExitL(TInt)
voidPlayTone()
IMPORT_C voidPostLayoutDynInitL()
IMPORT_C voidPreLayoutDynInitL(void)
IMPORT_C TPtrCPrompt()
IMPORT_C CAknQueryControl *QueryControl()
voidReportUserActivity()
IMPORT_C voidSetSizeAndPosition(const TSize &)
CAknKeySoundSystem *SoundSystem()
TTone &Tone()
const TTone &Tone()
IMPORT_C voidUpdateLeftSoftKeyL()
Private Member Functions
IMPORT_C voidCAknDialog_Reserved()
IMPORT_C voidCAknQueryDialog_Reserved()
IMPORT_C voidCEikDialog_Reserved_1()
IMPORT_C voidCEikDialog_Reserved_2()
IMPORT_C void *ExtensionInterface(TUid)
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CAknDialog::CAknDialog()
CAknDialog::ConstructL(TInt)
CAknDialog::CreateMenuBarL(TInt)
CAknDialog::DisplayMenuL()
CAknDialog::Draw(const TRect &)const
CAknDialog::DynInitMenuPaneL(TInt,CEikMenuPane *)
CAknDialog::FocusChanged(TDrawNow)
CAknDialog::HideMenu()
CAknDialog::MenuShowing()const
CAknDialog::MopSupplyObject(TTypeUid)
CAknDialog::PrepareLC(TInt)
CAknDialog::ProcessCommandL(TInt)
CAknDialog::SetEmphasis(CCoeControl *,TBool)
CAknDialog::SizeChanged()
CAknDialog::~CAknDialog()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MaximumWidth()const
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
CEikBorderedControl::Border()const
CEikBorderedControl::CEikBorderedControl()
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
CEikDialog::ActivateFirstPageL()const
CEikDialog::ActivePageId()const
CEikDialog::ActivePageIndex()const
CEikDialog::AddAutoDateEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TTime *)
CEikDialog::AddAutoDurationEditorL(const TDesC &,TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &,TBool,TTimeIntervalSeconds *)
CEikDialog::AddAutoFixedPointEditorL(const TDesC &,TInt,TInt,TInt,TInt *,TInt)
CEikDialog::AddAutoFloatEditorL(const TDesC &,TInt,const TReal &,const TReal &,TReal *)
CEikDialog::AddAutoGlobalTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TInt,CGlobalText *,TInt,TInt)
CEikDialog::AddAutoNumberEditorL(const TDesC &,TInt,TInt,TInt,TInt *)
CEikDialog::AddAutoRangeEditorL(const TDesC &,TInt,TInt,TInt,HBufC *,SEikRange *)
CEikDialog::AddAutoRichTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TInt,CGlobalText *,TInt,TInt)
CEikDialog::AddAutoSecretEditorL(const TDesC &,TInt,TDes *)
CEikDialog::AddAutoTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TDes *)
CEikDialog::AddAutoTimeAndDateEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TBool,HBufC *,TTime *)
CEikDialog::AddAutoTimeEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TTime *)
CEikDialog::AddAutoTimeOffsetEditorL(const TDesC &,TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &,TBool,TTimeIntervalSeconds *)
CEikDialog::AdjustAllIdsOnPage(TInt,TInt)
CEikDialog::BorderStyle()
CEikDialog::ButtonCommandObserver()const
CEikDialog::ButtonGroupContainer()const
CEikDialog::CEikDialog()
CEikDialog::ComponentControl(TInt)const
CEikDialog::ConstructAutoDialogLC(TInt,TInt)
CEikDialog::ConstructSleepingAlertDialogL(TInt)
CEikDialog::ConstructSleepingDialogL(TInt)
CEikDialog::Control(TInt)const
CEikDialog::ControlCaption(TInt)const
CEikDialog::ControlOrNull(TInt)const
CEikDialog::ControlsOnPage(RArray< CEikCaptionedControl * > &,TInt)const
CEikDialog::ConvertCustomControlTypeToBaseControlType(TInt)const
CEikDialog::CountComponentControls()const
CEikDialog::CreateCustomControlL(TInt)
CEikDialog::CreateLineByTypeL(const TDesC &,TInt,TInt,TAny *)
CEikDialog::CreateLineByTypeL(const TDesC &,TInt,TInt,TInt,TAny *)
CEikDialog::CurrentLine()const
CEikDialog::DeclareAutoDateEditor(TInt,TTime *)
CEikDialog::DeclareAutoDurationEditor(TInt,TTimeIntervalSeconds *)
CEikDialog::DeclareAutoFixedPointEditor(TInt,TInt *)
CEikDialog::DeclareAutoNumberEditor(TInt,TInt *)
CEikDialog::DeclareAutoRangeEditor(TInt,SEikRange *)
CEikDialog::DeclareAutoSecretEditor(TInt,TDes *)
CEikDialog::DeclareAutoTextEditorL(TInt,TDes *)
CEikDialog::DeclareAutoTimeAndDateEditor(TInt,TTime *)
CEikDialog::DeclareAutoTimeEditor(TInt,TTime *)
CEikDialog::DeclareAutoTimeOffsetEditor(TInt,TTimeIntervalSeconds *)
CEikDialog::DeclareItemAuto(TInt,TInt,TAny *)
CEikDialog::DeleteLine(TInt,TBool)
CEikDialog::DialogFlags()
CEikDialog::DurationEditorValue(TInt)const
CEikDialog::ExitSleepingDialog()
CEikDialog::Extension()const
CEikDialog::FindLineIndex(const CCoeControl &)const
CEikDialog::FixedPointEditorDecimal(TInt)const
CEikDialog::FixedPointEditorValue(TInt)const
CEikDialog::FloatEditorValue(TInt)const
CEikDialog::FloatingPointEditorValue(TInt)const
CEikDialog::FormFlagsFromActivePage()
CEikDialog::GetAutoValuesFromPage(CEikCapCArray *)
CEikDialog::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CEikDialog::GetCustomAutoValue(TAny *,TInt,const CCoeControl *)
CEikDialog::GetEdwinText(TDes &,TInt)const
CEikDialog::GetFileName(TFileName *,TInt)const
CEikDialog::GetFirstLineOnFirstPageOrNull()
CEikDialog::GetLabelText(TDes &,TInt)const
CEikDialog::GetLineByLineAndPageIndex(TInt,TInt)const
CEikDialog::GetNumberOfLinesOnPage(TInt)const
CEikDialog::GetNumberOfPages()const
CEikDialog::GetSecretEditorText(TDes &,TInt)const
CEikDialog::GetTextEditorText(CGlobalText *&,TInt)
CEikDialog::HandleControlEventL(CCoeControl *,TCoeEvent)
CEikDialog::HandleControlStateChangeL(TInt)
CEikDialog::HandleDialogPageEventL(TInt)
CEikDialog::HandleInteractionRefused(TInt)
CEikDialog::HandleResourceChange(TInt)
CEikDialog::IdOfFocusControl()const
CEikDialog::InsertLineL(TInt,TInt,TInt)
CEikDialog::IsEditable()const
CEikDialog::Layout()
CEikDialog::Line(TInt)const
CEikDialog::LineChangedL(TInt)
CEikDialog::ListBoxCurrentItem(TInt)const
CEikDialog::MakeLineVisible(TInt,TBool)
CEikDialog::MakePanelButtonVisible(TInt,TBool)
CEikDialog::MakeVisible(TBool)
CEikDialog::MakeWholeLineVisible(TInt,TBool)
CEikDialog::MappedCommandId(TInt)
CEikDialog::NumberEditorValue(TInt)const
CEikDialog::PageChangedL(TInt)
CEikDialog::PreferredSize(const TSize &)const
CEikDialog::PrepareContext(CWindowGc &)const
CEikDialog::PrepareForFocusTransitionL()
CEikDialog::PublishDialogL(TInt,TUid)
CEikDialog::RangeEditorValue(TInt)const
CEikDialog::ReadResourceLC(TInt)
CEikDialog::RegisterDialgWithPageSelector()
CEikDialog::ResetLineMinimumSizes()
CEikDialog::ResetSecretEditor(TInt)
CEikDialog::RotateFocusByL(TInt)
CEikDialog::RouseSleepingDialog()
CEikDialog::SetControlCaptionL(TInt,TInt)
CEikDialog::SetControlCaptionL(TInt,const TDesC &)
CEikDialog::SetDurationEditorMinAndMax(TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &)
CEikDialog::SetDurationEditorValue(TInt,const TTimeIntervalSeconds &)
CEikDialog::SetEditableL(TBool)
CEikDialog::SetEdwinTextL(TInt,const TDesC *)
CEikDialog::SetFileNameL(TInt,const TDesC *)
CEikDialog::SetFixedPointEditorDecimal(TInt,TInt)
CEikDialog::SetFixedPointEditorValueL(TInt,TInt)
CEikDialog::SetFloatEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetFloatEditorValueL(TInt,TReal)
CEikDialog::SetFloatingPointEditorValueL(TInt,const TReal *)
CEikDialog::SetInitialCurrentLine()
CEikDialog::SetLabelL(TInt,TInt)
CEikDialog::SetLabelL(TInt,const TDesC &)
CEikDialog::SetLabelReserveLengthL(TInt,TInt)
CEikDialog::SetLineDimmedNow(TInt,TBool)
CEikDialog::SetLineNonFocusing(TInt)
CEikDialog::SetListBoxCurrentItem(TInt,TInt)
CEikDialog::SetMediatorObserver(MAknDialogMediatorObserver *)
CEikDialog::SetMultilineQuery(TBool)
CEikDialog::SetNumberEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetNumberEditorValue(TInt,TInt)
CEikDialog::SetPageDensePacking(TInt,TBool)
CEikDialog::SetPageDimmedNow(TInt,TBool)
CEikDialog::SetRangeEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetRangeEditorValue(TInt,const SEikRange &)
CEikDialog::SetTTimeEditorMinAndMax(TInt,const TTime &,const TTime &)
CEikDialog::SetTTimeEditorValue(TInt,const TTime &)
CEikDialog::SetTextEditorTextL(TInt,const CGlobalText *)
CEikDialog::SetTimeOffsetEditorMinAndMax(TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &)
CEikDialog::SetTimeOffsetEditorValue(TInt,const TTimeIntervalSeconds &)
CEikDialog::SetTitleL(TInt)
CEikDialog::SetTitleL(const TDesC &)
CEikDialog::SlideDialog()
CEikDialog::SwapButtonGroupContainer(CEikButtonGroupContainer *)
CEikDialog::SwitchLineLatency(TInt,TInt)
CEikDialog::TTimeEditorValue(TInt)const
CEikDialog::TimeOffsetEditorValue(TInt)const
CEikDialog::Title()const
CEikDialog::TryChangeFocusToL(TInt)
CEikDialog::TryExitL(TInt)
CEikDialog::UpdatePageL(TBool)
CEikDialog::WriteInternalStateL(RWriteStream &)const
CEikDialog::~CEikDialog()
Public Member Enumerations
enumTTone { ENoTone = 0, EConfirmationTone = EAvkonSIDConfirmationTone, EWarningTone = EAvkonSIDWarningTone, EErrorTone = EAvkonSIDErrorTone }
Inherited Enumerations
CCoeControl:TZoomType
CEikDialog:@121
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

Constructor & Destructor Documentation

CAknQueryDialog(const TTone &)

IMPORT_CCAknQueryDialog(const TTone &aTone)

Construction

: will be made protected - use NewL

Parameters

const TTone & aTone

CAknQueryDialog()

IMPORT_CCAknQueryDialog()

do not use

CAknQueryDialog(TDesC &, const TTone &)

IMPORT_CCAknQueryDialog(TDesC &aPrompt,
const TTone &aTone = ENoTone
)

do not use

Parameters

TDesC & aPrompt
const TTone & aTone = ENoTone

~CAknQueryDialog()

IMPORT_C~CAknQueryDialog()[virtual]

Member Functions Documentation

CAknDialog_Reserved()

IMPORT_C voidCAknDialog_Reserved()[private, virtual]

CAknQueryDialog_Reserved()

IMPORT_C voidCAknQueryDialog_Reserved()[private, virtual]

CEikDialog_Reserved_1()

IMPORT_C voidCEikDialog_Reserved_1()[private, virtual]

CEikDialog_Reserved_2()

IMPORT_C voidCEikDialog_Reserved_2()[private, virtual]

DismissQueryL()

IMPORT_C voidDismissQueryL()[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.

DoSetPromptL()

IMPORT_C voidDoSetPromptL()[protected, virtual]

Set the prompt inside the query control. If dialog is active redo layout and draw.

ExecuteLD(TInt)

IMPORT_C TIntExecuteLD(TIntaResourceId)[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

Parameters

TInt aResourceIdresource for query

ExecuteLD(TInt, const TDesC &)

IMPORT_C TIntExecuteLD(TIntaResourceId,
const TDesC &aPrompt
)

Call PrepareLC and display dialog.

Parameters

TInt aResourceIdresource for query
const TDesC & aPrompttext for query prompt

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

FindControlOnAnyPageWithControlType(TInt, TInt *, TInt *)

CCoeControl *FindControlOnAnyPageWithControlType(TIntaControlType,
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.

Parameters

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.

Flags()

TBitFlags16 &Flags()[protected, inline]

Flags()

const TBitFlags16 &Flags()const [protected, inline]

GetLeftCBAShortKeyPress()

TInt GetLeftCBAShortKeyPress()[protected]

Returns left CBA short key press

GetRightCBAShortKeyPress()

TInt GetRightCBAShortKeyPress()[protected]

Returns right CBA short key press

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

Handles pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleQueryEditorSizeEventL(CAknQueryControl *, TQueryControlEvent)

IMPORT_C TBoolHandleQueryEditorSizeEventL(CAknQueryControl *aQueryControl,
TQueryControlEventaEventType
)

From MAknQueryControlObserver

Gets called when editor sends size event.

Parameters

CAknQueryControl * aQueryControlPointer to query control which sent the event
TQueryControlEvent aEventTypeType of the event

HandleQueryEditorStateEventL(CAknQueryControl *, TQueryControlEvent, TQueryValidationStatus)

IMPORT_C TBoolHandleQueryEditorStateEventL(CAknQueryControl *aQueryControl,
TQueryControlEventaEventType,
TQueryValidationStatusaStatus
)

From MAknQueryControlObserver

Gets called when editor sends state event

Parameters

CAknQueryControl * aQueryControlPointer to query control which sent the event
TQueryControlEvent aEventTypeType of the event
TQueryValidationStatus aStatusEditor validation status

Heading()

IMPORT_C CAknPopupHeadingPane *Heading()const

Deprecated method to return pointer to query heading or NULL (use QueryHeading())

InputCapabilities()

IMPORT_C TCoeInputCapabilitiesInputCapabilities()const [virtual]

From CCoeControl. Gets the control's input capabilities.

IsLeftSoftkeyVisible()

TBool IsLeftSoftkeyVisible()[protected]

Returns whether the left softkey is visible

LayoutAndDraw()

voidLayoutAndDraw()[protected]

Recreates layout and redraws the dialog

MakeLeftSoftkeyVisible(TBool)

IMPORT_C voidMakeLeftSoftkeyVisible(TBoolaVisible)

Set visibility of the left softkey. Softkey is hidden when data in the query is not acceptable.

Parameters

TBool aVisibleEFalse hides softkey label, ETrue shows it.

MaxTextLength(const CAknQueryControl *, const TDes &, TInt)

IMPORT_C TIntMaxTextLength(const CAknQueryControl *aControl,
const TDes &aDataText,
TIntaApiValue
)[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

Parameters

const CAknQueryControl * aControl
const TDes & aDataText
TInt aApiValue

MaxTextLength(const CAknQueryControl *, const TDes *, TInt)

IMPORT_C TIntMaxTextLength(const CAknQueryControl *aControl,
const TDes *aDataText,
TIntaApiValue
)[static]
  • use other version of MaxTextLength

Parameters

const CAknQueryControl * aControl
const TDes * aDataText
TInt aApiValue

NeedToDismissQueryL(const TKeyEvent &)

IMPORT_C TBoolNeedToDismissQueryL(const TKeyEvent &aKeyEvent)[virtual]

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

Parameters

const TKeyEvent & aKeyEvent

NewL(const TTone &)

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.

Parameters

const TTone & aTone = ENoTone

NewL(TDes &, const TTone &)

IMPORT_C CAknQueryDialog *NewL(TDes &aText,
const TTone &aTone = ENoTone
)[static]

Parameters

TDes & aText
const TTone & aTone = ENoTone

NewL(TInt &, const TTone &)

IMPORT_C CAknQueryDialog *NewL(TInt &aNumber,
const TTone &aTone = ENoTone
)[static]

Parameters

TInt & aNumber
const TTone & aTone = ENoTone

NewL(TTime &, const TTone &)

IMPORT_C CAknQueryDialog *NewL(TTime &aTime,
const TTone &aTone = ENoTone
)[static]

Parameters

TTime & aTime
const TTone & aTone = ENoTone

NewL(TTimeIntervalSeconds &, const TTone &)

IMPORT_C CAknQueryDialog *NewL(TTimeIntervalSeconds &aTime,
const TTone &aTone = ENoTone
)[static]

Parameters

TTimeIntervalSeconds & aTime
const TTone & aTone = ENoTone

NewL(TReal &, const TTone &)

IMPORT_C CAknQueryDialog *NewL(TReal &aNumber,
const TTone &aTone = ENoTone
)[static]

Parameters

TReal & aNumber
const TTone & aTone = ENoTone

NewL(TInetAddr &, const TTone &)

IMPORT_C CAknQueryDialog *NewL(TInetAddr &aInetAddr,
const TTone &aTone = ENoTone
)[static]

Parameters

TInetAddr & aInetAddr
const TTone & aTone = ENoTone

NewL(TPosition &, const TTone &)

IMPORT_C CAknQueryDialog *NewL(TPosition &aValue,
const TTone &aTone = ENoTone
)[static]

Not yet totally implemented!

Parameters

TPosition & aValue
const TTone & aTone = ENoTone

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[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,

Parameters

const TKeyEvent & aKeyEventThe key event.
TEventCode aTypeThe type of the event: EEventKey, EEventKeyUp or EEventKeyDown.

OkToExitL(TInt)

IMPORT_C TBoolOkToExitL(TIntaButtonId)[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

TInt aButtonIdThe ID of the button that was activated

PlayTone()

voidPlayTone()[protected]

Plays tone

PostLayoutDynInitL()

IMPORT_C voidPostLayoutDynInitL()[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.

PreLayoutDynInitL(void)

IMPORT_C voidPreLayoutDynInitL(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.

Parameters

void

Prompt()

IMPORT_C TPtrCPrompt()const [protected]

Prompt access for derived classes

QueryControl()

IMPORT_C CAknQueryControl *QueryControl()const [protected, virtual]

Return pointer to query control or NULL

QueryHeading()

IMPORT_C CAknPopupHeadingPane *QueryHeading()const [virtual]

Return pointer to query heading or NULL

RemoveEditorIndicator()

IMPORT_C voidRemoveEditorIndicator()

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.

ReportUserActivity()

voidReportUserActivity()const [protected]

Resets system's inactivity timer

RunDlgLD(TInt)

IMPORT_C TIntRunDlgLD(TIntaResourceId)
  • use RunLD or ExecuteLD instead

Parameters

TInt aResourceId

RunLD()

IMPORT_C TIntRunLD()[virtual]

Runs the querydialog and returns the ID of the button used to dismiss it. The dialog is destroyed on exit.

SetEmergencyCallSupport(TBool)

IMPORT_C voidSetEmergencyCallSupport(TBoolaOnOff)

Enable or disable emergency call support. This method is only valid in numeric queries (secret or normal).

Default is Off for both.

Parameters

TBool aOnOffSets emergency call support active or inactive, if feature is available in current type of control

SetEmergencyCallSupportForCBA(TBool)

IMPORT_C voidSetEmergencyCallSupportForCBA(TBoolaOnOff)

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.

Parameters

TBool aOnOffETrue to enable the ECS CBA support, EFalse otherwise.

SetHeaderImageL(CEikImage *)

IMPORT_C voidSetHeaderImageL(CEikImage *aImage)

Parameters

CEikImage * aImage

SetHeaderTextL(const TDesC &)

IMPORT_C voidSetHeaderTextL(const TDesC &aHeader)

Parameters

const TDesC & aHeader

SetPredictiveTextInputPermitted(TBool)

IMPORT_C voidSetPredictiveTextInputPermitted(TBoolaPermitted)

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.

Parameters

TBool aPermittedETrue - allow predictive text entry

SetPromptL(const TDesC &)

IMPORT_C voidSetPromptL(const TDesC &aPrompt)

Set prompt text for query. This this will override text given in constructor.

Parameters

const TDesC & aPromptText for prompt

SetSizeAndPosition(const TSize &)

IMPORT_C voidSetSizeAndPosition(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.

Parameters

const TSize & aSizeThe size for the dialog.

SoundSystem()

CAknKeySoundSystem *SoundSystem()const [protected, inline]

Tone()

TTone &Tone()[protected, inline]

Tone()

const TTone &Tone()const [protected, inline]

UpdateLeftSoftKeyL()

IMPORT_C voidUpdateLeftSoftKeyL()[protected, virtual]

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

Member Enumerations Documentation

Enum TTone

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

Enumerators

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.

Member Data Documentation

CAknQueryDialogExtension * iExtension

CAknQueryDialogExtension *iExtension[protected]

Caption Retriever

TBitFlags16 iFlags

TBitFlags16 iFlags[protected]

Flags for emergency call support Need these at least to store the ECS state until the control exists

TDesC * iPrompt

TDesC *iPrompt[protected]

Prompt text

CAknKeySoundSystem * iSoundSystem

CAknKeySoundSystem *iSoundSystem[protected]

Sound system

TInt iSpare_1

TInt iSpare_1[protected]

Spare variable for further development

TTone iTone

TTone iTone[protected]

Tone which is played when the query is executed These will be made private, use protected methods