CEikDialog Class Reference

class CEikDialog : public MCoeControlObserver

The CEikDialog class provides an instantiable base class for dialogs. Controls can be added directly to this class but it is normal to create a subclass to handle the controls appearing on the dialog dynamically.

Inherits from

Public Member Functions
~CEikDialog()
IMPORT_C voidActivateFirstPageL()
IMPORT_C TIntActivePageId()
IMPORT_C voidAddAutoDateEditorL(const TDesC &, TInt, const TTime &, const TTime &, TBool, TTime *)
IMPORT_C voidAddAutoDurationEditorL(const TDesC &, TInt, const TTimeIntervalSeconds &, const TTimeIntervalSeconds &, TBool, TTimeIntervalSeconds *)
IMPORT_C voidAddAutoFixedPointEditorL(const TDesC &, TInt, TInt, TInt, TInt *, TInt)
IMPORT_C voidAddAutoFloatEditorL(const TDesC &, TInt, const TReal &, const TReal &, TReal *)
IMPORT_C voidAddAutoGlobalTextEditorL(const TDesC &, TInt, TInt, TInt, TInt, TInt, CGlobalText *, TInt, TInt)
IMPORT_C voidAddAutoNumberEditorL(const TDesC &, TInt, TInt, TInt, TInt *)
IMPORT_C voidAddAutoRangeEditorL(const TDesC &, TInt, TInt, TInt, HBufC *, SEikRange *)
IMPORT_C voidAddAutoRichTextEditorL(const TDesC &, TInt, TInt, TInt, TInt, TInt, CGlobalText *, TInt, TInt)
IMPORT_C voidAddAutoSecretEditorL(const TDesC &, TInt, TDes *)
IMPORT_C voidAddAutoTextEditorL(const TDesC &, TInt, TInt, TInt, TInt, TDes *)
IMPORT_C voidAddAutoTimeAndDateEditorL(const TDesC &, TInt, const TTime &, const TTime &, TBool, TBool, HBufC *, TTime *)
IMPORT_C voidAddAutoTimeEditorL(const TDesC &, TInt, const TTime &, const TTime &, TBool, TTime *)
IMPORT_C voidAddAutoTimeOffsetEditorL(const TDesC &, TInt, const TTimeIntervalSeconds &, const TTimeIntervalSeconds &, TBool, TTimeIntervalSeconds *)
IMPORT_C CEikButtonGroupContainer &ButtonGroupContainer()
IMPORT_C voidConstructAutoDialogLC(TInt, TInt)
IMPORT_C CCoeControl *Control(TInt)
IMPORT_C CEikLabel *ControlCaption(TInt)
IMPORT_C CCoeControl *ControlOrNull(TInt)
IMPORT_C MEikDialogPageObserver::TFormControlTypesConvertCustomControlTypeToBaseControlType(TInt)
IMPORT_C SEikControlInfoCreateCustomControlL(TInt)
IMPORT_C CCoeControl *CreateLineByTypeL(const TDesC &, TInt, TInt, TAny *)
IMPORT_C CCoeControl *CreateLineByTypeL(const TDesC &, TInt, TInt, TInt, TAny *)
DECLARE_TYPE_ID(0x10282EA8)
IMPORT_C voidDeclareAutoDateEditor(TInt, TTime *)
IMPORT_C voidDeclareAutoDurationEditor(TInt, TTimeIntervalSeconds *)
IMPORT_C voidDeclareAutoFixedPointEditor(TInt, TInt *)
IMPORT_C voidDeclareAutoNumberEditor(TInt, TInt *)
IMPORT_C voidDeclareAutoRangeEditor(TInt, SEikRange *)
IMPORT_C voidDeclareAutoSecretEditor(TInt, TDes *)
IMPORT_C voidDeclareAutoTextEditorL(TInt, TDes *)
IMPORT_C voidDeclareAutoTimeAndDateEditor(TInt, TTime *)
IMPORT_C voidDeclareAutoTimeEditor(TInt, TTime *)
IMPORT_C voidDeclareAutoTimeOffsetEditor(TInt, TTimeIntervalSeconds *)
IMPORT_C voidDeclareItemAuto(TInt, TInt, TAny *)
IMPORT_C voidDeleteLine(TInt, TBool)
IMPORT_C TIntDialogFlags()
IMPORT_C TIntExecuteLD(TInt)
IMPORT_C CEikDialogExtension *Extension()
IMPORT_C voidFocusChanged(TDrawNow)
IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &)
IMPORT_C voidGetCustomAutoValue(TAny *, TInt, const CCoeControl *)
IMPORT_C voidHandleDialogPageEventL(TInt)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C TCoeInputCapabilitiesInputCapabilities()
IMPORT_C voidInsertLineL(TInt, TInt, TInt)
IMPORT_C TBoolIsEditable()
IMPORT_C voidLayout()
IMPORT_C voidMakeLineVisible(TInt, TBool)
IMPORT_C voidMakePanelButtonVisible(TInt, TBool)
IMPORT_C voidMakeVisible(TBool)
IMPORT_C voidMakeWholeLineVisible(TInt, TBool)
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C TSizePreferredSize(const TSize &)
IMPORT_C voidPrepareLC(TInt)
IMPORT_C voidPublishDialogL(TInt, TUid)
IMPORT_C voidReadResourceLC(TInt)
IMPORT_C TIntRunLD()
IMPORT_C voidSetControlCaptionL(TInt, const TDesC &)
IMPORT_C voidSetControlCaptionL(TInt, TInt)
IMPORT_C voidSetEditableL(TBool)
IMPORT_C voidSetLineDimmedNow(TInt, TBool)
IMPORT_C voidSetLineNonFocusing(TInt)
IMPORT_C voidSetMediatorObserver(MAknDialogMediatorObserver *)
IMPORT_C voidSetMultilineQuery(TBool)
IMPORT_C voidSetPageDensePacking(TInt, TBool)
IMPORT_C voidSetPageDimmedNow(TInt, TBool)
IMPORT_C voidSetTitleL(const TDesC &)
IMPORT_C voidSetTitleL(TInt)
IMPORT_C voidSlideDialog()
IMPORT_C voidSwitchLineLatency(TInt, TInt)
IMPORT_C CEikMover &Title()
IMPORT_C voidTryChangeFocusToL(TInt)
Protected Member Functions
IMPORT_C TIntActivePageIndex()
IMPORT_C voidAdjustAllIdsOnPage(TInt, TInt)
IMPORT_C TIntBorderStyle()
IMPORT_C MEikCommandObserver *ButtonCommandObserver()
IMPORT_C CCoeControl *ComponentControl(TInt)
IMPORT_C voidConstructSleepingAlertDialogL(TInt)
IMPORT_C voidConstructSleepingDialogL(TInt)
IMPORT_C voidControlsOnPage(RArray< CEikCaptionedControl * > &, TInt)
IMPORT_C TIntCountComponentControls()
IMPORT_C CEikCaptionedControl *CurrentLine()
IMPORT_C TTimeIntervalSecondsDurationEditorValue(TInt)
IMPORT_C voidExitSleepingDialog()
IMPORT_C TIntFindLineIndex(const CCoeControl &)
IMPORT_C TIntFixedPointEditorDecimal(TInt)
IMPORT_C TIntFixedPointEditorValue(TInt)
IMPORT_C TRealFloatEditorValue(TInt)
IMPORT_C TRealFloatingPointEditorValue(TInt)
IMPORT_C TIntFormFlagsFromActivePage()
IMPORT_C voidGetAutoValuesFromPage(CEikCapCArray *)
IMPORT_C voidGetEdwinText(TDes &, TInt)
IMPORT_C voidGetFileName(TFileName *, TInt)
IMPORT_C CEikCaptionedControl *GetFirstLineOnFirstPageOrNull()
IMPORT_C voidGetLabelText(TDes &, TInt)
IMPORT_C CEikCaptionedControl *GetLineByLineAndPageIndex(TInt, TInt)
IMPORT_C TIntGetNumberOfLinesOnPage(TInt)
IMPORT_C TIntGetNumberOfPages()
IMPORT_C voidGetSecretEditorText(TDes &, TInt)
IMPORT_C voidGetTextEditorText(CGlobalText *&, TInt)
IMPORT_C voidHandleControlEventL(CCoeControl *, TCoeEvent)
IMPORT_C voidHandleControlStateChangeL(TInt)
IMPORT_C voidHandleInteractionRefused(TInt)
IMPORT_C TIntIdOfFocusControl()
IMPORT_C CEikCaptionedControl *Line(TInt)
IMPORT_C voidLineChangedL(TInt)
IMPORT_C TIntListBoxCurrentItem(TInt)
IMPORT_C TIntMappedCommandId(TInt)
IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUid)
IMPORT_C TIntNumberEditorValue(TInt)
IMPORT_C TBoolOkToExitL(TInt)
IMPORT_C voidPageChangedL(TInt)
IMPORT_C voidPostLayoutDynInitL()
IMPORT_C voidPreLayoutDynInitL()
IMPORT_C voidPrepareContext(CWindowGc &)
IMPORT_C voidPrepareForFocusTransitionL()
IMPORT_C SEikRangeRangeEditorValue(TInt)
voidRegisterDialgWithPageSelector()
IMPORT_C voidResetLineMinimumSizes()
IMPORT_C voidResetSecretEditor(TInt)
IMPORT_C TBoolRotateFocusByL(TInt)
IMPORT_C TIntRouseSleepingDialog()
IMPORT_C voidSetDurationEditorMinAndMax(TInt, const TTimeIntervalSeconds &, const TTimeIntervalSeconds &)
IMPORT_C voidSetDurationEditorValue(TInt, const TTimeIntervalSeconds &)
IMPORT_C voidSetEdwinTextL(TInt, const TDesC *)
IMPORT_C voidSetFileNameL(TInt, const TDesC *)
IMPORT_C voidSetFixedPointEditorDecimal(TInt, TInt)
IMPORT_C voidSetFixedPointEditorValueL(TInt, TInt)
IMPORT_C voidSetFloatEditorMinAndMax(TInt, TInt, TInt)
IMPORT_C voidSetFloatEditorValueL(TInt, TReal)
IMPORT_C voidSetFloatingPointEditorValueL(TInt, const TReal *)
IMPORT_C voidSetInitialCurrentLine()
IMPORT_C voidSetLabelL(TInt, const TDesC &)
IMPORT_C voidSetLabelL(TInt, TInt)
IMPORT_C voidSetLabelReserveLengthL(TInt, TInt)
IMPORT_C voidSetListBoxCurrentItem(TInt, TInt)
IMPORT_C voidSetNumberEditorMinAndMax(TInt, TInt, TInt)
IMPORT_C voidSetNumberEditorValue(TInt, TInt)
IMPORT_C voidSetRangeEditorMinAndMax(TInt, TInt, TInt)
IMPORT_C voidSetRangeEditorValue(TInt, const SEikRange &)
IMPORT_C voidSetSizeAndPosition(const TSize &)
IMPORT_C voidSetTTimeEditorMinAndMax(TInt, const TTime &, const TTime &)
IMPORT_C voidSetTTimeEditorValue(TInt, const TTime &)
IMPORT_C voidSetTextEditorTextL(TInt, const CGlobalText *)
IMPORT_C voidSetTimeOffsetEditorMinAndMax(TInt, const TTimeIntervalSeconds &, const TTimeIntervalSeconds &)
IMPORT_C voidSetTimeOffsetEditorValue(TInt, const TTimeIntervalSeconds &)
IMPORT_C CEikButtonGroupContainer *SwapButtonGroupContainer(CEikButtonGroupContainer *)
IMPORT_C TTimeTTimeEditorValue(TInt)
IMPORT_C TTimeIntervalSecondsTimeOffsetEditorValue(TInt)
IMPORT_C voidTryExitL(TInt)
IMPORT_C voidUpdatePageL(TBool)
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
voidBaseConstructL()
IMPORT_C voidCEikDialog_Reserved_1()
IMPORT_C voidCEikDialog_Reserved_2()
voidCommonConstructSleepingDialogL(TInt)
IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C TIntCountFadedComponents()
voidCreateButtonGroupContainerL(TInt)
voidCreatePageSelectorL()
voidCreatePageSelectorL(TInt)
voidCreateTitleBarL()
voidDoFadeBehindPopup(TBool)
voidDoResourceChangeLayout()
IMPORT_C voidDraw(const TRect &)
voidDynamicConstructL()
voidEnableContentObserver(TBool)
IMPORT_C void *ExtensionInterface(TUid)
voidFadeBehindPopup(TBool)
IMPORT_C CCoeControl *FadedComponent(TInt)
voidGetAutoValues()
voidHandleEmbeddedSofkeyStateChange()
TInt HandleEmbeddedSoftkeyStateChangeCallBack(TAny *)
IMPORT_C TSizeMinimumSize()
IMPORT_C voidReserved_2()
voidSetBorderStyle()
IMPORT_C voidSizeChanged()
voidStaticConstructL(TInt)
voidStopWaitingAsRequired()
TKeyResponseTryAnimateButtonAndExitL(TInt)
TInt WaitAsRequired()
Inherited Functions
MCoeControlObserver::MCoeControlObserver()
Inherited Enumerations
MCoeControlObserver:TCoeEvent
Private Attributes
CEikDialogButtonCommandObserver *iButtonCommandObserver
CEikButtonGroupContainer *iButtonGroupContainer
TInt iDialogFlags
TInt *iExitConfirmed
CEikDialogExtension *iExtension
TBool iIsEditable
CEikDialogPageSelector *iPageSelector
TAknPopupFaderiPopupFader
CEikMover *iTitleBar
CActiveSchedulerWait iWait

Constructor & Destructor Documentation

~CEikDialog()

IMPORT_C~CEikDialog()

Destructor.

Member Functions Documentation

ActivateFirstPageL()

IMPORT_C voidActivateFirstPageL()const

Activates the first page on the dialog. At least one page must be active before this method can be used.

ActivePageId()

IMPORT_C TIntActivePageId()const

Gets a page id for the current page.

Page id.

ActivePageIndex()

IMPORT_C TIntActivePageIndex()const [protected]

Gets the index of the dialog's active page.

Pages are indexed from 0 in the order they are added.

The index of the active page.

AddAutoDateEditorL(const TDesC &, TInt, const TTime &, const TTime &, TBool, TTime *)

IMPORT_C voidAddAutoDateEditorL(const TDesC &aPrompt,
TIntaId,
const TTime &aMin,
const TTime &aMax,
TBoolaNoPopout,
TTime *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
const TTime & aMin
const TTime & aMax
TBool aNoPopout
TTime * aReturn

AddAutoDurationEditorL(const TDesC &, TInt, const TTimeIntervalSeconds &, const TTimeIntervalSeconds &, TBool, TTimeIntervalSeconds *)

IMPORT_C voidAddAutoDurationEditorL(const TDesC &aPrompt,
TIntaId,
const TTimeIntervalSeconds &aMin,
const TTimeIntervalSeconds &aMax,
TBoolaNoSeconds,
TTimeIntervalSeconds *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
const TTimeIntervalSeconds & aMin
const TTimeIntervalSeconds & aMax
TBool aNoSeconds
TTimeIntervalSeconds * aReturn

AddAutoFixedPointEditorL(const TDesC &, TInt, TInt, TInt, TInt *, TInt)

IMPORT_C voidAddAutoFixedPointEditorL(const TDesC &aPrompt,
TIntaId,
TIntaMin,
TIntaMax,
TInt *aRetValue,
TIntaDecimalPlaces
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
TInt aMin
TInt aMax
TInt * aRetValue
TInt aDecimalPlaces

AddAutoFloatEditorL(const TDesC &, TInt, const TReal &, const TReal &, TReal *)

IMPORT_C voidAddAutoFloatEditorL(const TDesC &aPrompt,
TIntaId,
const TReal &aMin,
const TReal &aMax,
TReal *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
const TReal & aMin
const TReal & aMax
TReal * aReturn

AddAutoGlobalTextEditorL(const TDesC &, TInt, TInt, TInt, TInt, TInt, CGlobalText *, TInt, TInt)

IMPORT_C voidAddAutoGlobalTextEditorL(const TDesC &aPrompt,
TIntaId,
TIntaFlags,
TIntaWidthInChars,
TIntaNoOfLines,
TIntaTextLimit,
CGlobalText *aReturn,
TIntaFontControlFlags = EGulFontControlAll,
TIntaFontNameFlags = EGulNoSymbolFonts
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
TInt aFlags
TInt aWidthInChars
TInt aNoOfLines
TInt aTextLimit
CGlobalText * aReturn
TInt aFontControlFlags = EGulFontControlAll
TInt aFontNameFlags = EGulNoSymbolFonts

AddAutoNumberEditorL(const TDesC &, TInt, TInt, TInt, TInt *)

IMPORT_C voidAddAutoNumberEditorL(const TDesC &aPrompt,
TIntaId,
TIntaMin,
TIntaMax,
TInt *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
TInt aMin
TInt aMax
TInt * aReturn

AddAutoRangeEditorL(const TDesC &, TInt, TInt, TInt, HBufC *, SEikRange *)

IMPORT_C voidAddAutoRangeEditorL(const TDesC &aPrompt,
TIntaId,
TIntaMin,
TIntaMax,
HBufC *aSeparatorText,
SEikRange *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
TInt aMin
TInt aMax
HBufC * aSeparatorText
SEikRange * aReturn

AddAutoRichTextEditorL(const TDesC &, TInt, TInt, TInt, TInt, TInt, CGlobalText *, TInt, TInt)

IMPORT_C voidAddAutoRichTextEditorL(const TDesC &aPrompt,
TIntaId,
TIntaFlags,
TIntaWidthInChars,
TIntaNoOfLines,
TIntaTextLimit,
CGlobalText *aReturn,
TIntaFontControlFlags = EGulFontControlAll,
TIntaFontNameFlags = EGulNoSymbolFonts
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
TInt aFlags
TInt aWidthInChars
TInt aNoOfLines
TInt aTextLimit
CGlobalText * aReturn
TInt aFontControlFlags = EGulFontControlAll
TInt aFontNameFlags = EGulNoSymbolFonts

AddAutoSecretEditorL(const TDesC &, TInt, TDes *)

IMPORT_C voidAddAutoSecretEditorL(const TDesC &aPrompt,
TIntaId,
TDes *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
TDes * aReturn

AddAutoTextEditorL(const TDesC &, TInt, TInt, TInt, TInt, TDes *)

IMPORT_C voidAddAutoTextEditorL(const TDesC &aPrompt,
TIntaId,
TIntaFlags,
TIntaWidthInChars,
TIntaNoOfLines,
TDes *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
TInt aFlags
TInt aWidthInChars
TInt aNoOfLines
TDes * aReturn

AddAutoTimeAndDateEditorL(const TDesC &, TInt, const TTime &, const TTime &, TBool, TBool, HBufC *, TTime *)

IMPORT_C voidAddAutoTimeAndDateEditorL(const TDesC &aPrompt,
TIntaId,
const TTime &aMin,
const TTime &aMax,
TBoolaNoSeconds,
TBoolaNoPopout,
HBufC *aInterveningText,
TTime *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
const TTime & aMin
const TTime & aMax
TBool aNoSeconds
TBool aNoPopout
HBufC * aInterveningText
TTime * aReturn

AddAutoTimeEditorL(const TDesC &, TInt, const TTime &, const TTime &, TBool, TTime *)

IMPORT_C voidAddAutoTimeEditorL(const TDesC &aPrompt,
TIntaId,
const TTime &aMin,
const TTime &aMax,
TBoolaNoSeconds,
TTime *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
const TTime & aMin
const TTime & aMax
TBool aNoSeconds
TTime * aReturn

AddAutoTimeOffsetEditorL(const TDesC &, TInt, const TTimeIntervalSeconds &, const TTimeIntervalSeconds &, TBool, TTimeIntervalSeconds *)

IMPORT_C voidAddAutoTimeOffsetEditorL(const TDesC &aPrompt,
TIntaId,
const TTimeIntervalSeconds &aMin,
const TTimeIntervalSeconds &aMax,
TBoolaNoSeconds,
TTimeIntervalSeconds *aReturn
)

Not supported.

Parameters

const TDesC & aPrompt
TInt aId
const TTimeIntervalSeconds & aMin
const TTimeIntervalSeconds & aMax
TBool aNoSeconds
TTimeIntervalSeconds * aReturn

AdjustAllIdsOnPage(TInt, TInt)

IMPORT_C voidAdjustAllIdsOnPage(TIntaPageId,
TIntaControlIdDelta
)[protected]

Adjusts the IDs of all controls on a specified page.

The adjustment consists of incrementing all the control IDs by aControlIdDelta.

Parameters

TInt aPageIdThe page on which the control IDs are to be adjusted.
TInt aControlIdDeltaThe amount to increment the IDs.

BaseConstructL()

voidBaseConstructL()[private]

BorderStyle()

IMPORT_C TIntBorderStyle()[protected, virtual]

Returns the border style for this dialog.

Border style. Always returns AknBorderId::EAknBorderNotePopup.

ButtonCommandObserver()

IMPORT_C MEikCommandObserver *ButtonCommandObserver()const [protected]

Gets a pointer to the dialog's internal button command observer.

This is required when creating a new button group container for the dialog.

A dialog uses a proxy to observe button commands. This means dialog subclasses can directly observe commands, either issued by controls added to the dialog pages, or by menus launched by the dialog.

5.1

A pointer to the dialog's internal button command observer.

ButtonGroupContainer()

IMPORT_C CEikButtonGroupContainer &ButtonGroupContainer()const

Gets a reference to the dialog's command button container.

The dialog's button group container.

CEikDialog_Reserved_1()

IMPORT_C voidCEikDialog_Reserved_1()[private, virtual]

CEikDialog_Reserved_2()

IMPORT_C voidCEikDialog_Reserved_2()[private, virtual]

CommonConstructSleepingDialogL(TInt)

voidCommonConstructSleepingDialogL(TIntaResourceId)[private]

Parameters

TInt aResourceId

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)const [protected]

Returns a pointer to the component control at the specified index in the component control list.

Does not imply transfer of ownership.

The required component control.

Parameters

TInt aIndexThe index of the required component control.

ConstructAutoDialogLC(TInt, TInt)

IMPORT_C voidConstructAutoDialogLC(TIntaFlags,
TIntaButtonsId
)

Dynamically constructs a dialog with the specified flags and buttons and with a single activated empty page with ID 0. The dialog is therefore ready to dynamically add lines to.

Parameters

TInt aFlagsDialog flags.
TInt aButtonsIdDialog buttons.

ConstructFromResourceL(TResourceReader &)

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[private]

Parameters

TResourceReader & aReader

ConstructSleepingAlertDialogL(TInt)

IMPORT_C voidConstructSleepingAlertDialogL(TIntaResourceId)[protected]

Protected construction of a high priority sleeping dialog from a resource.

A sleeping dialog is one which can be displayed at any time since its memory resources are pre-allocated.

Parameters

TInt aResourceIdThe resource ID of the dialog to be constructed.

ConstructSleepingDialogL(TInt)

IMPORT_C voidConstructSleepingDialogL(TIntaResourceId)[protected]

Protected constructor creates a sleeping dialog from a resource.

A sleeping dialog is one which can be displayed at any time since its memory resources are pre-allocated.

Parameters

TInt aResourceIdThe resource ID of the dialog to be constructed.

Control(TInt)

IMPORT_C CCoeControl *Control(TIntaControlId)const

Returns a pointer to the specified control.

Panics if the control ID is invalid. Does not imply transfer of ownership.

A pointer to the control with ID aControlId.

Parameters

TInt aControlIdThe ID of the control for which a pointer is required.

ControlCaption(TInt)

IMPORT_C CEikLabel *ControlCaption(TIntaControlId)const

Gets a pointer to the specified control's caption.

A pointer to the caption.

Parameters

TInt aControlIdThe ID of the control for which the label is required.

ControlOrNull(TInt)

IMPORT_C CCoeControl *ControlOrNull(TIntaControlId)const

Gets a pointer to the specified control.

A pointer to the control with ID aControlId, or NULL if it doesn't exist.

Parameters

TInt aControlIdThe ID of the control for which a pointer is required.

ControlsOnPage(RArray< CEikCaptionedControl * > &, TInt)

IMPORT_C voidControlsOnPage(RArray< CEikCaptionedControl * > &aControls,
TIntaPageId
)const [protected]

Gets all lines in the given page.

Parameters

RArray< CEikCaptionedControl * > & aControlsAfter execution holds all captions in the page.
TInt aPageIdID of the target page.

ConvertCustomControlTypeToBaseControlType(TInt)

IMPORT_C MEikDialogPageObserver::TFormControlTypesConvertCustomControlTypeToBaseControlType(TIntaControlType)const

From MEikDialogPageObserver.

For forms only: Ths should be overriden with mappings between the base control types that form knows how to layout.

Always returns MEikDialogPageObserver::EUnknownType.

Current implementation always returns MEikDialogPageObserver::EUnknownType.

Parameters

TInt aControlTypeNot used.

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [protected]

Returns the number of the control components.

In Avkon returns 2 as the button group container is not internal.

Number of control components.

CountFadedComponents()

IMPORT_C TIntCountFadedComponents()[private, virtual]

CreateButtonGroupContainerL(TInt)

voidCreateButtonGroupContainerL(TIntaResourceId)[private]

Parameters

TInt aResourceId

CreateCustomControlL(TInt)

IMPORT_C SEikControlInfoCreateCustomControlL(TIntaControlType)[virtual]

From MEikDialogPageObserver.

Creates a control line in the dialog.on the active page with caption text aCaption. The line can thereafter be accessed through the identifier aControlId. A control of type aControlType is created by the Eikon control factory and the return value of the line set to aReturnValue. If the value of aControlType is not known to the Eikon control factory then the construction of the control must be handled by CreateCustomControlL.

Information for the custom control.

Parameters

TInt aControlTypeThe type of the custom control.

CreateLineByTypeL(const TDesC &, TInt, TInt, TAny *)

IMPORT_C CCoeControl *CreateLineByTypeL(const TDesC &aCaption,
TIntaControlId,
TIntaControlType,
TAny *aReturnValue
)

Creates a control line on the page ID specified active page in the dialog. The line can thereafter be accessed through the identifier aControlId. A control of type aControlType is created by the control factory and the return value of the line set to aReturnValue. If the value of aControlType is not known to the control factory then the construction of the control must be handled by CreateCustomControlL().

A pointer to the newly created control.

Parameters

const TDesC & aCaptionThe caption to appear in the dialog line.
TInt aControlIdThe ID of the active page on which the control line is to be created.
TInt aControlTypeThe type of control to create.
TAny * aReturnValueDeprecated. A random pointer.

CreateLineByTypeL(const TDesC &, TInt, TInt, TInt, TAny *)

IMPORT_C CCoeControl *CreateLineByTypeL(const TDesC &aCaption,
TIntaPageId,
TIntaControlId,
TIntaControlType,
TAny *aReturnValue
)

Creates a control line on the caption specified active page in the dialog. The line can thereafter be accessed through the identifier aControlId. A control of type aControlType is created by the control factory and the return value of the line set to aReturnValue. If the value of aControlType is not known to the control factory then the construction of the control must be handled by CreateCustomControlL().

A pointer to the newly created control.

Parameters

const TDesC & aCaptionThe active page on which the control line is to be created.
TInt aPageIdThe ID of the active page on which the control line is to be created.
TInt aControlIdThe ID of the control. After the line is created this can be used to access it.
TInt aControlTypeThe type of control to create.
TAny * aReturnValueDeprecated. A random pointer.

CreatePageSelectorL()

voidCreatePageSelectorL()[private]

CreatePageSelectorL(TInt)

voidCreatePageSelectorL(TIntaResourceId)[private]

Parameters

TInt aResourceId

CreateTitleBarL()

voidCreateTitleBarL()[private]

CurrentLine()

IMPORT_C CEikCaptionedControl *CurrentLine()const [protected]

Gets a pointer to the current line.

This does not imply transfer of ownership from the dialog.

A pointer to the current line.

DECLARE_TYPE_ID(0x10282EA8)

DECLARE_TYPE_ID(0x10282EA8)

C++ default constructor.

Parameters

0x10282EA8

DeclareAutoDateEditor(TInt, TTime *)

IMPORT_C voidDeclareAutoDateEditor(TIntaId,
TTime *aDate
)

Not supported.

Parameters

TInt aId
TTime * aDate

DeclareAutoDurationEditor(TInt, TTimeIntervalSeconds *)

IMPORT_C voidDeclareAutoDurationEditor(TIntaId,
TTimeIntervalSeconds *aDuration
)

Not supported.

Parameters

TInt aId
TTimeIntervalSeconds * aDuration

DeclareAutoFixedPointEditor(TInt, TInt *)

IMPORT_C voidDeclareAutoFixedPointEditor(TIntaId,
TInt *aValue
)

Not supported.

Parameters

TInt aId
TInt * aValue

DeclareAutoNumberEditor(TInt, TInt *)

IMPORT_C voidDeclareAutoNumberEditor(TIntaId,
TInt *aNumber
)

Not supported.

Parameters

TInt aId
TInt * aNumber

DeclareAutoRangeEditor(TInt, SEikRange *)

IMPORT_C voidDeclareAutoRangeEditor(TIntaId,
SEikRange *aRange
)

Not supported.

Parameters

TInt aId
SEikRange * aRange

DeclareAutoSecretEditor(TInt, TDes *)

IMPORT_C voidDeclareAutoSecretEditor(TIntaId,
TDes *aText
)

Not supported.

Parameters

TInt aId
TDes * aText

DeclareAutoTextEditorL(TInt, TDes *)

IMPORT_C voidDeclareAutoTextEditorL(TIntaId,
TDes *aText
)

Not supported.

Parameters

TInt aId
TDes * aText

DeclareAutoTimeAndDateEditor(TInt, TTime *)

IMPORT_C voidDeclareAutoTimeAndDateEditor(TIntaId,
TTime *aTimeAndDate
)

Not supported.

Parameters

TInt aId
TTime * aTimeAndDate

DeclareAutoTimeEditor(TInt, TTime *)

IMPORT_C voidDeclareAutoTimeEditor(TIntaId,
TTime *aTime
)

Not supported.

Parameters

TInt aId
TTime * aTime

DeclareAutoTimeOffsetEditor(TInt, TTimeIntervalSeconds *)

IMPORT_C voidDeclareAutoTimeOffsetEditor(TIntaId,
TTimeIntervalSeconds *aTimeOffset
)

Not supported.

Parameters

TInt aId
TTimeIntervalSeconds * aTimeOffset

DeclareItemAuto(TInt, TInt, TAny *)

IMPORT_C voidDeclareItemAuto(TIntaControlId,
TIntaControlType,
TAny *aReturnValue
)

Sets controllers return value.

Parameters

TInt aControlIdControl identifier for wanted caption controller.
TInt aControlTypeType of control.
TAny * aReturnValueControllers return value.

DeleteLine(TInt, TBool)

IMPORT_C voidDeleteLine(TIntaControlId,
TBoolaRedraw = ETrue
)

Deletes the specified dialog line.

Parameters

TInt aControlIdThe dialog line to delete.
TBool aRedraw = ETrueWhether to redraw the page. Default value is ETrue.

DialogFlags()

IMPORT_C TIntDialogFlags()

Gets flags of the dialog.

Dialog flags.

DoFadeBehindPopup(TBool)

voidDoFadeBehindPopup(TBoolaFade)[private]

Parameters

TBool aFade

DoResourceChangeLayout()

voidDoResourceChangeLayout()[private]

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [private]

Parameters

const TRect & aRect

DurationEditorValue(TInt)

IMPORT_C TTimeIntervalSecondsDurationEditorValue(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

DynamicConstructL()

voidDynamicConstructL()[private]

EnableContentObserver(TBool)

voidEnableContentObserver(TBoolaEnabled)[private]

Enables/disables content observer.

Parameters

TBool aEnabled

ExecuteLD(TInt)

IMPORT_C TIntExecuteLD(TIntaResourceId)[virtual]

Loads, displays, and destroys the dialog.

This function loads the specified dialog from a resource and displays it. The method then destroys the dialog when it exits, therefore there is no need for the application program to destroy the dialog.

In the resource file, use the EEikBidOk dialog button ID for an OK/Done/Continue button and EEikBidCancel for a Cancel button.

The function returns immediately unless EEikDialogFlagWait has been specified in the DIALOG resource. If EEikDialogFlagWait is specified, it returns when the dialog exits.

Zero, unless it is a waiting dialog. For a waiting dialog, the return value is the ID of the button that closed the dialog, or zero if it was the cancel button (EEikBidCancel).

Parameters

TInt aResourceIdThe resource ID of the dialog to load.

ExitSleepingDialog()

IMPORT_C voidExitSleepingDialog()[protected]

Exits sleeping dialog without deleting it.

Extension()

IMPORT_C CEikDialogExtension *Extension()const

Access to CEikDialog's extension object.

Pointer to extension object. Constructed in CEikDialog::BaseContructL

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private]

From CAknControl

Parameters

TUid aInterface

FadeBehindPopup(TBool)

voidFadeBehindPopup(TBoolaFade)[private]

Parameters

TBool aFade

FadedComponent(TInt)

IMPORT_C CCoeControl *FadedComponent(TIntaIndex)[private, virtual]

Parameters

TInt aIndex

FindLineIndex(const CCoeControl &)

IMPORT_C TIntFindLineIndex(const CCoeControl &aControl)const [protected]

Gets the line index of the specified control.

The control must be on the active page.

The line index, or KErrNotFound if the control is not on the active page.

Parameters

const CCoeControl & aControlThe control for which the line index is required.

FixedPointEditorDecimal(TInt)

IMPORT_C TIntFixedPointEditorDecimal(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

FixedPointEditorValue(TInt)

IMPORT_C TIntFixedPointEditorValue(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

FloatEditorValue(TInt)

IMPORT_C TRealFloatEditorValue(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

FloatingPointEditorValue(TInt)

IMPORT_C TRealFloatingPointEditorValue(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

FocusChanged(TDrawNow)

IMPORT_C voidFocusChanged(TDrawNowaDrawNow)

From CCoeControl.

Responds to a change in focus.

This is called whenever the control gains or loses focus, as a result of a call to SetFocus(). A typical use of FocusChanged() is to change the appearance of the control, for example by drawing a focus rectangle around it.

The default implementation is empty, and should be overridden by the CCoeControl-derived class.

Parameters

TDrawNow aDrawNowContains the value that was passed to it by SetFocus().

FormFlagsFromActivePage()

IMPORT_C TIntFormFlagsFromActivePage()[protected]

Get form flags of the active page

Active page's form flags

GetAutoValues()

voidGetAutoValues()[private]

GetAutoValuesFromPage(CEikCapCArray *)

IMPORT_C voidGetAutoValuesFromPage(CEikCapCArray *aLines)[protected]

Not supported.

Parameters

CEikCapCArray * aLines

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList)const [virtual]

From CCoeControl.

Gets the list of logical colours used to draw the control.

The list includes an explanation of how each colour is used. The default implementation is empty.

If overriding GetColorUseListL(), the implementation must include a base call to CCoeControl's GetColorUseListL().

ER5U

Parameters

CArrayFix< TCoeColorUse > & aColorUseList

GetCustomAutoValue(TAny *, TInt, const CCoeControl *)

IMPORT_C voidGetCustomAutoValue(TAny *aReturnValue,
TIntaControlType,
const CCoeControl *aControl
)[virtual]

From MEikDialogPageObserver.

Should be implemented to get the custom auto value for the custom control aControl of type aControlType with return value aReturnValue.

This method is included in the interface to support deprecated legacy code only.

Not implemented.

Parameters

TAny * aReturnValueThe custom controls return value.
TInt aControlTypeThe type of the custom control.
const CCoeControl * aControlThe control whose auto value is being retrieved.

GetEdwinText(TDes &, TInt)

IMPORT_C voidGetEdwinText(TDes &aDes,
TIntaControlId
)const [protected]

Not supported.

Parameters

TDes & aDes
TInt aControlId

GetFileName(TFileName *, TInt)

IMPORT_C voidGetFileName(TFileName *aFileName,
TIntaControlId
)const [protected]

Not supported.

Parameters

TFileName * aFileName
TInt aControlId

GetFirstLineOnFirstPageOrNull()

IMPORT_C CEikCaptionedControl *GetFirstLineOnFirstPageOrNull()[protected, virtual]

Gets first line of the first page.

Pointer to the first line of the first page. If NULL there is no such line.

GetLabelText(TDes &, TInt)

IMPORT_C voidGetLabelText(TDes &aDes,
TIntaControlId
)const [protected]

Not supported.

Parameters

TDes & aDes
TInt aControlId

GetLineByLineAndPageIndex(TInt, TInt)

IMPORT_C CEikCaptionedControl *GetLineByLineAndPageIndex(TIntaLineIndex,
TIntaPageIndex
)const [protected]

Gets specified line from specified page.

The wanted line.

Parameters

TInt aLineIndexIndex of the requested line.
TInt aPageIndexIndex of the requested page.

GetNumberOfLinesOnPage(TInt)

IMPORT_C TIntGetNumberOfLinesOnPage(TIntaPageIndex)const [protected]

Gets number of lines in the specified page.

The number of lines in the page.

Parameters

TInt aPageIndexIndex of the page container.

GetNumberOfPages()

IMPORT_C TIntGetNumberOfPages()const [protected]

Gets number of pages in the page selector.

The number of pages.

GetSecretEditorText(TDes &, TInt)

IMPORT_C voidGetSecretEditorText(TDes &aDes,
TIntaControlId
)const [protected]

Not supported.

Parameters

TDes & aDes
TInt aControlId

GetTextEditorText(CGlobalText *&, TInt)

IMPORT_C voidGetTextEditorText(CGlobalText *&aGlobalText,
TIntaControlId
)[protected]

Not supported.

Parameters

CGlobalText *& aGlobalText
TInt aControlId

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C voidHandleControlEventL(CCoeControl *aControl,
TCoeEventaEventType
)[protected, virtual]

From MCoeControlObserver.

Handles control events.

The default implementation handles events of type EEventStateChanged, EEventInteractionRefused, and EEventPrepareFocusTransition by calling HandleControlStateChangeL(), HandleInteractionRefused(), and PrepareForFocusTransitionL() respectively.

Overrides MCoeControlObserver::HandleControlEventL().

Parameters

CCoeControl * aControlThe control reporting the event.
TCoeEvent aEventTypeThe event type.

HandleControlStateChangeL(TInt)

IMPORT_C voidHandleControlStateChangeL(TIntaControlId)[protected, virtual]

Handles a state change in the control with id aControlId. Empty by default.

Parameters

TInt aControlIdNot used.

HandleDialogPageEventL(TInt)

IMPORT_C voidHandleDialogPageEventL(TIntaEventID)[virtual]

From CEikDialog (MEikDialogPageObserver).

The interface method which is called when dialog page is tapped with a stylus.

Parameters

TInt aEventIDAn event identification number.

HandleEmbeddedSofkeyStateChange()

voidHandleEmbeddedSofkeyStateChange()[private]

Handles embedded softkey state change.

HandleEmbeddedSoftkeyStateChangeCallBack(TAny *)

TInt HandleEmbeddedSoftkeyStateChangeCallBack(TAny *aAny)[private, static]

Call back method to handle CEikCba content changes.

Parameters

TAny * aAny

HandleInteractionRefused(TInt)

IMPORT_C voidHandleInteractionRefused(TIntaControlId)[protected, virtual]

Should handle an attempt by the user to activate a dimmed button with id aControlId. Prints an info message by default.

Not implemented / Does nothing in Avkon.

Parameters

TInt aControlIdNot used.

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)

From CCoeControl.

Handles pointer events.

This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer. The control should implement this function to handle pointer events.

Note: events of type EButton1Down are processed before HandlePointerEventL() is called, in order to transfer keyboard focus to the control in which the EButton1Down event occurred.

If overriding HandlePointerEventL(), the implementation must include a base call to CCoeControl's HandlePointerEventL().

Parameters

const TPointerEvent & aPointerEventThe pointer event.

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[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. For colour scheme changes, DrawDeferred() is called in order to redraw the control.

If overriding HandleResourceChange(), the implementation must include a base call to CCoeControl's HandleResourceChange().

ER5U

Parameters

TInt aTypeA message UID value.

IdOfFocusControl()

IMPORT_C TIntIdOfFocusControl()const [protected]

Gets the ID of the control in the focused line.

Current control ID.

InputCapabilities()

IMPORT_C TCoeInputCapabilitiesInputCapabilities()const

From CCoeControl.

Gets the control's input capabilities.

Classes that override CCoeControl::OfferKeyEventL() should also override this function, returning a TCoeInputCapabilities object whose attributes correspond to the behaviour of the OfferKeyEventL() function. The default implementation returns TCoeInputCapabilities::ENone.

It is not necessary to call InputCapabilities() on any component controls from inside a class's InputCapabilities() function. This is done automatically by the UI Control Framework.

ER5U

The control's input capabilities.

InsertLineL(TInt, TInt, TInt)

IMPORT_C voidInsertLineL(TIntaIndex,
TIntaResourceId,
TIntaPageId = 0
)

Inserts a line in the dialog. The function takes as arguments the page and line index at which the line is to be inserted, and the resource used to construct it.

Parameters

TInt aIndexThe index at which the line is to be inserted.
TInt aResourceIdThe ID of the resource which defines the line.
TInt aPageId = 0The page on which the line is to be added.

IsEditable()

IMPORT_C TBoolIsEditable()const

Checks if the dialog is editable.

ETrue if editable.

Layout()

IMPORT_C voidLayout()

Lays out the dialog, setting it to take its preferred size and position for the screen.

5.1

Line(TInt)

IMPORT_C CEikCaptionedControl *Line(TIntaControlId)const [protected]

Gets a pointer to the line containing the specified control.

This does not imply transfer of ownership from the dialog.

A pointer to the line containing the control identified by aControlId.

Parameters

TInt aControlIdThe ID of the control.

LineChangedL(TInt)

IMPORT_C voidLineChangedL(TIntaControlId)[protected, virtual]

From MEikDialogPageObserver

Should be implemented to take any action required when the current line is changed to aControlId.

Not implemented.

Parameters

TInt aControlIdThe ID of the control being switched to.

ListBoxCurrentItem(TInt)

IMPORT_C TIntListBoxCurrentItem(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

MakeLineVisible(TInt, TBool)

IMPORT_C voidMakeLineVisible(TIntaControlId,
TBoolaVisible
)

Makes the specified control visible or invisible. This function affects the specified control, the visibility of the caption is not affected.

Parameters

TInt aControlIdThe ID of the control to make visible or invisible.
TBool aVisibleETrue to make the control visible. EFalse to make the control invisible.

MakePanelButtonVisible(TInt, TBool)

IMPORT_C voidMakePanelButtonVisible(TIntaButtonId,
TBoolaVisible
)

Makes the specified panel button visible or invisible.

Parameters

TInt aButtonIdThe ID of the panel button to make visible or invisible.
TBool aVisibleETrue to make the panel visible. EFalse to make it invisible.

MakeVisible(TBool)

IMPORT_C voidMakeVisible(TBoolaVisible)

From CCoeControl.

Sets the dialog visibility

Parameters

TBool aVisibleETrue control is visible. EFalse control is invisible.

MakeWholeLineVisible(TInt, TBool)

IMPORT_C voidMakeWholeLineVisible(TIntaControlId,
TBoolaVisible
)

Makes the whole specified line visible and active or invisible and inactive. This function affects both the specified control and the caption.

Parameters

TInt aControlIdThe ID of the control on the line to make visible or invisible.
TBool aVisibleETrue to make the line visible. EFalse to make the line invisible.

MappedCommandId(TInt)

IMPORT_C TIntMappedCommandId(TIntaButtonId)[protected, virtual]

Routine to map the button id ( Avkon softkey command id) to CEikBidCancel if it is a "cancel" type command type.

The following cases are mapped to a give an ExecuteLD return value of 0:

EAknSoftkeyCancel: EAknSoftkeyBack: EAknSoftkeyNo:

Other cases are left unchanged.

This operation is performed at the last minute and does not affect other processing in CEik/AknDialog.

It is a framework method; It can be overridded to obtain customized behaviour.

0 for re-mapped negative command ids other values are returned as their original command id values.

Parameters

TInt aButtonIdinput id to map.

MinimumSize()

IMPORT_C TSizeMinimumSize()[private]

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUidaId)[protected]

From MObjectProvider.

Retrieves an object of the same type as that encapsulated in aId.

This function is used to allow controls to ask their owners for access to other objects that they own.

Other than in the case where NULL is returned, the object returned must be of the same object type - that is, the ETypeId member of the object pointed to by the pointer returned by this function must be equal to the iUid member of aId.

Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.

Parameters

TTypeUid aIdAn encapsulated object type ID.

NumberEditorValue(TInt)

IMPORT_C TIntNumberEditorValue(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)

From CCoeControl.

Handles a key event. Overrides CCoeControl::OfferKeyEventL().

Indicates whether or not the key event was used by this control. EKeyWasConsumed if the control takes action on the key event or EKeyWasNotConsumed otherwise.

Parameters

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

OkToExitL(TInt)

IMPORT_C TBoolOkToExitL(TIntaButtonId)[protected, virtual]

Not implemented.

Always return ETrue.

Parameters

TInt aButtonIdNot used.

PageChangedL(TInt)

IMPORT_C voidPageChangedL(TIntaPageId)[protected, virtual]

From MEikDialogPageObserver.

Should be implemented to take any action required when the active dialog page is changed.

Not implemented.

Parameters

TInt aPageIdThe ID of the page being switched to.

PostLayoutDynInitL()

IMPORT_C voidPostLayoutDynInitL()[protected, virtual]

Initializes the dialog's controls after the dialog has been sized but before it has been activated. Empty by default.

PreLayoutDynInitL()

IMPORT_C voidPreLayoutDynInitL()[protected, virtual]

Initializes the dialog's controls before the dialog is sized and layed out. Empty by default.

PreferredSize(const TSize &)

IMPORT_C TSizePreferredSize(const TSize &aMaxSize)const

Gets the preferred size of a dialog. The maximum size that the dialog must fit within must be specified, e.g. the size of the physical screen.

The preferred size of the dialog.

Parameters

const TSize & aMaxSizeThe maximum size of the area in which the dialog must fit.

PrepareContext(CWindowGc &)

IMPORT_C voidPrepareContext(CWindowGc &aGc)const [protected]

From MCoeControlContext.

Initialises graphics context settings.

This function should be implemented by derived classes to initialise the graphics context, given by aGc, with the required settings.

Parameters

CWindowGc & aGcThe graphics context to be initialised.

PrepareForFocusTransitionL()

IMPORT_C voidPrepareForFocusTransitionL()[protected, virtual]

From MEikDialogPageObserver.

Should be implemented to prepare for focus transition from the current line.

For example to validate the contents of the current control.

PrepareLC(TInt)

IMPORT_C voidPrepareLC(TIntaResourceId)[virtual]

Prepares the dialog, constructing it from the specified resource.

Parameters

TInt aResourceIdThe resource ID of the dialog.

PublishDialogL(TInt, TUid)

IMPORT_C voidPublishDialogL(TIntaDialogIndex,
TUidaCatUid = KNullUid
)

Instantiates mediator support and send a command with given parameters when a dialog is brought to display.

3.1

Parameters

TInt aDialogIndexunique index to identify a dialog within the category.
TUid aCatUid = KNullUidgategory uid, if default paramter is passed, application uid is used as a category.

RangeEditorValue(TInt)

IMPORT_C SEikRangeRangeEditorValue(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

ReadResourceLC(TInt)

IMPORT_C voidReadResourceLC(TIntaResourceId)

Reads the dialog resources into the dialog, constructing it from the specified resource. The function is only to help loading dialog resources and extracting dialog data, in other cases use (PrepareLC()). Unlike PrepareLC(), it does not add the dialog to control stack. 3.2

Parameters

TInt aResourceIdThe resource ID of the dialog.

RegisterDialgWithPageSelector()

voidRegisterDialgWithPageSelector()[protected]

Sets the current Dialog into the Page selector

Reserved_2()

IMPORT_C voidReserved_2()[private]

ResetLineMinimumSizes()

IMPORT_C voidResetLineMinimumSizes()[protected]

Recalculates the minimum sizes of the lines on the active page.

Overrides CCoeControl::ResetLineMinimumSizes().

ResetSecretEditor(TInt)

IMPORT_C voidResetSecretEditor(TIntaControlId)[protected]

Not supported.

Parameters

TInt aControlId

RotateFocusByL(TInt)

IMPORT_C TBoolRotateFocusByL(TIntaDelta)[protected]

Rotates the focus by a specified number of steps.

Each line is a step, as are dialog tabs.

ETrue if rotation of focus is successful, EFalse if there are no lines in the dialog or the rotation is otherwise unsuccessful.

Parameters

TInt aDeltaThe number of steps.

RouseSleepingDialog()

IMPORT_C TIntRouseSleepingDialog()[protected]

Rouses a sleeping dialog by dynamically constructing the dialog and then bringing it to the front.

Derived dialogs should pre-allocate any memory they need for initialisation during construction via ConstructFromResourceL() for each individual control. Derived versions of PreLayoutDynInitL() cannot rely on allocating any further memory.

Zero.

RunLD()

IMPORT_C TIntRunLD()[virtual]

Runs the dialog and returns the ID of the button used to dismiss it.

The dialog is destroyed on exit.

This function is called by the dialog framework (ExecuteLD()) to perform dynamic construction (layout) and to display/destroy the dialog. Static construction of the dialog must already be complete before this function is called, e.g. using PrepareLC().

The function returns immediately unless EEikDialogFlagWait has been specified in the DIALOG resource. If EEikDialogFlagWait is specified it returns when the dialog exits.

The ID of the button used to dismiss the dialog.

SetBorderStyle()

voidSetBorderStyle()[private]

SetControlCaptionL(TInt, const TDesC &)

IMPORT_C voidSetControlCaptionL(TIntaControlId,
const TDesC &aText
)

Sets the specified control's caption text from a descriptor.

Parameters

TInt aControlIdThe ID of the control for which the caption text is being set.
const TDesC & aTextThe text for the caption.

SetControlCaptionL(TInt, TInt)

IMPORT_C voidSetControlCaptionL(TIntaControlId,
TIntaResourceId
)

Sets the specified control's caption text from a resource.

Parameters

TInt aControlIdThe ID of the control for which the caption text is being set.
TInt aResourceIdThe ID of the resource containing the text for the caption.

SetDurationEditorMinAndMax(TInt, const TTimeIntervalSeconds &, const TTimeIntervalSeconds &)

IMPORT_C voidSetDurationEditorMinAndMax(TIntaControlId,
const TTimeIntervalSeconds &aMinimumDuration,
const TTimeIntervalSeconds &aMaximumDuration
)[protected]

Not supported.

Parameters

TInt aControlId
const TTimeIntervalSeconds & aMinimumDuration
const TTimeIntervalSeconds & aMaximumDuration

SetDurationEditorValue(TInt, const TTimeIntervalSeconds &)

IMPORT_C voidSetDurationEditorValue(TIntaControlId,
const TTimeIntervalSeconds &aDuration
)[protected]

Not supported.

Parameters

TInt aControlId
const TTimeIntervalSeconds & aDuration

SetEditableL(TBool)

IMPORT_C voidSetEditableL(TBoolaEditable)

Sets the dialog to either editable or uneditable

Parameters

TBool aEditableETrue if dialog is editable. EFalse if dialog is uneditable.

SetEdwinTextL(TInt, const TDesC *)

IMPORT_C voidSetEdwinTextL(TIntaControlId,
const TDesC *aDes
)[protected]

Not supported.

Parameters

TInt aControlId
const TDesC * aDes

SetFileNameL(TInt, const TDesC *)

IMPORT_C voidSetFileNameL(TIntaControlId,
const TDesC *aFileName
)[protected]

Not supported.

Parameters

TInt aControlId
const TDesC * aFileName

SetFixedPointEditorDecimal(TInt, TInt)

IMPORT_C voidSetFixedPointEditorDecimal(TIntaControlId,
TIntaDecimal
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aDecimal

SetFixedPointEditorValueL(TInt, TInt)

IMPORT_C voidSetFixedPointEditorValueL(TIntaControlId,
TIntaValue
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aValue

SetFloatEditorMinAndMax(TInt, TInt, TInt)

IMPORT_C voidSetFloatEditorMinAndMax(TIntaControlId,
TIntaMin,
TIntaMax
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aMin
TInt aMax

SetFloatEditorValueL(TInt, TReal)

IMPORT_C voidSetFloatEditorValueL(TIntaControlId,
TRealaFloat
)[protected]

Not supported.

Parameters

TInt aControlId
TReal aFloat

SetFloatingPointEditorValueL(TInt, const TReal *)

IMPORT_C voidSetFloatingPointEditorValueL(TIntaControlId,
const TReal *aValue
)[protected]

Not supported.

Parameters

TInt aControlId
const TReal * aValue

SetInitialCurrentLine()

IMPORT_C voidSetInitialCurrentLine()[protected, virtual]

Sets the line which initally receives focus. This is the first focusable line on the first page in the dialog by default. Reimplementations of this method must activate a page before doing anything else.

SetLabelL(TInt, const TDesC &)

IMPORT_C voidSetLabelL(TIntaControlId,
const TDesC &aDes
)[protected]

Not supported.

Parameters

TInt aControlId
const TDesC & aDes

SetLabelL(TInt, TInt)

IMPORT_C voidSetLabelL(TIntaControlId,
TIntaResourceId
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aResourceId

SetLabelReserveLengthL(TInt, TInt)

IMPORT_C voidSetLabelReserveLengthL(TIntaControlId,
TIntaLength
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aLength

SetLineDimmedNow(TInt, TBool)

IMPORT_C voidSetLineDimmedNow(TIntaControlId,
TBoolaDimmed
)

Dims and deactivates, or un-dims and re-activates, the specified line.

Parameters

TInt aControlIdThe ID of the line to dim or un-dim.
TBool aDimmedETrue to dim the line, EFalse to un-dim it.

SetLineNonFocusing(TInt)

IMPORT_C voidSetLineNonFocusing(TIntaControlId)

Sets the specified dialog line to a non-focusing state. After this function is called, the line will never be given keyboard focus.

Parameters

TInt aControlIdThe ID of the control in the line which is to be set as non-focusing.

SetListBoxCurrentItem(TInt, TInt)

IMPORT_C voidSetListBoxCurrentItem(TIntaControlId,
TIntaItem
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aItem

SetMediatorObserver(MAknDialogMediatorObserver *)

IMPORT_C voidSetMediatorObserver(MAknDialogMediatorObserver *aObserver)

Instantiates mediator support and passes possible feedback to given intance. If no observer is set, dialog tries to handle feedback by it self. Please note that no commands will be instantiated unless command identifiers are are set using PublishDialogL.

3.1

Parameters

MAknDialogMediatorObserver * aObserverPointer to instance implementing MAknDialogMediatorObserver API. Can be NULL.

SetMultilineQuery(TBool)

IMPORT_C voidSetMultilineQuery(TBoolaIsMultilineQuery)

3.2 Sets dialog to be multilinequery.

This is called by multiline query only. Changes tab-key behaviour of the dialog page. Tab key works differently for forms and multiline queries.

Parameters

TBool aIsMultilineQueryWhether this dialog is multiline query

SetNumberEditorMinAndMax(TInt, TInt, TInt)

IMPORT_C voidSetNumberEditorMinAndMax(TIntaControlId,
TIntaMinimumValue,
TIntaMaximumValue
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aMinimumValue
TInt aMaximumValue

SetNumberEditorValue(TInt, TInt)

IMPORT_C voidSetNumberEditorValue(TIntaControlId,
TIntaNumber
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aNumber

SetPageDensePacking(TInt, TBool)

IMPORT_C voidSetPageDensePacking(TIntaPageId,
TBoolaDensePacking
)

Sets the specified page to be densely packed, or normally packed. This reduces the spacing between the dialog's lines.

Parameters

TInt aPageIdThe ID of the page to be densely packed.
TBool aDensePackingETrue for dense packing. EFalse for normal packing.

SetPageDimmedNow(TInt, TBool)

IMPORT_C voidSetPageDimmedNow(TIntaPageId,
TBoolaDimmed
)

Sets the specified page to be dimmed or undimmed. The page is redrawn immediately.

Parameters

TInt aPageIdThe ID of the page to be dimmed.
TBool aDimmedETrue to dim the page, EFalse to un-dim it.

SetRangeEditorMinAndMax(TInt, TInt, TInt)

IMPORT_C voidSetRangeEditorMinAndMax(TIntaControlId,
TIntaMinimumValue,
TIntaMaximumValue
)[protected]

Not supported.

Parameters

TInt aControlId
TInt aMinimumValue
TInt aMaximumValue

SetRangeEditorValue(TInt, const SEikRange &)

IMPORT_C voidSetRangeEditorValue(TIntaControlId,
const SEikRange &aRange
)[protected]

Not supported.

Parameters

TInt aControlId
const SEikRange & aRange

SetSizeAndPosition(const TSize &)

IMPORT_C voidSetSizeAndPosition(const TSize &aSize)[protected, virtual]

Sets the size and position of the dialog given the specified size hint.

The parameter is ignored if the FlagFillAppClientRect is set. Otherwise it it centered and given the size that was asked for.

Parameters

const TSize & aSizeThe new size.

SetTTimeEditorMinAndMax(TInt, const TTime &, const TTime &)

IMPORT_C voidSetTTimeEditorMinAndMax(TIntaControlId,
const TTime &aMinimumTime,
const TTime &aMaximumTime
)[protected]

Not supported.

Parameters

TInt aControlId
const TTime & aMinimumTime
const TTime & aMaximumTime

SetTTimeEditorValue(TInt, const TTime &)

IMPORT_C voidSetTTimeEditorValue(TIntaControlId,
const TTime &aTime
)[protected]

Not supported.

Parameters

TInt aControlId
const TTime & aTime

SetTextEditorTextL(TInt, const CGlobalText *)

IMPORT_C voidSetTextEditorTextL(TIntaControlId,
const CGlobalText *aGlobalText
)[protected]

Not supported.

Parameters

TInt aControlId
const CGlobalText * aGlobalText

SetTimeOffsetEditorMinAndMax(TInt, const TTimeIntervalSeconds &, const TTimeIntervalSeconds &)

IMPORT_C voidSetTimeOffsetEditorMinAndMax(TIntaControlId,
const TTimeIntervalSeconds &aMinimumTimeOffset,
const TTimeIntervalSeconds &aMaximumTimeOffset
)[protected]

Not supported.

Parameters

TInt aControlId
const TTimeIntervalSeconds & aMinimumTimeOffset
const TTimeIntervalSeconds & aMaximumTimeOffset

SetTimeOffsetEditorValue(TInt, const TTimeIntervalSeconds &)

IMPORT_C voidSetTimeOffsetEditorValue(TIntaControlId,
const TTimeIntervalSeconds &aTimeOffset
)[protected]

Not supported.

Parameters

TInt aControlId
const TTimeIntervalSeconds & aTimeOffset

SetTitleL(const TDesC &)

IMPORT_C voidSetTitleL(const TDesC &aText)

Sets the dialog title text from a descriptor.

Parameters

const TDesC & aTextThe descriptor containing the new title text.

SetTitleL(TInt)

IMPORT_C voidSetTitleL(TIntaResourceId)

Sets the dialog title text from a resource.

Parameters

TInt aResourceIdThe ID of the resource containing the title text.

SizeChanged()

IMPORT_C voidSizeChanged()[private]

SlideDialog()

IMPORT_C voidSlideDialog()

StaticConstructL(TInt)

voidStaticConstructL(TIntaResourceId)[private]

Parameters

TInt aResourceId

StopWaitingAsRequired()

voidStopWaitingAsRequired()[private]

SwapButtonGroupContainer(CEikButtonGroupContainer *)

IMPORT_C CEikButtonGroupContainer *SwapButtonGroupContainer(CEikButtonGroupContainer *aContainer)[protected]

Swaps the dialog's button group container with a new container.

The dialog takes ownership of the new container. A pointer to the old button group container is returned and ownership of this object is transferred to the calling object.

A pointer to the old button group container. This is no longer owned by the dialog.

Parameters

CEikButtonGroupContainer * aContainerThe new button group container.

SwitchLineLatency(TInt, TInt)

IMPORT_C voidSwitchLineLatency(TIntaBecomesLatent,
TIntaNoLongerLatent
)

Switches the latent line. The latent line is switched from aNoLongerLatent to aBecomesLatent. If dialog lines are latent they are not visible and are not taken into account when laying out the dialog. Latent lines can then be swapped around on the dialog later.

Parameters

TInt aBecomesLatentThe line ID of the line to become latent.
TInt aNoLongerLatentThe line ID of the line to that is no longer latent.

TTimeEditorValue(TInt)

IMPORT_C TTimeTTimeEditorValue(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

TimeOffsetEditorValue(TInt)

IMPORT_C TTimeIntervalSecondsTimeOffsetEditorValue(TIntaControlId)const [protected]

Not supported.

Parameters

TInt aControlId

Title()

IMPORT_C CEikMover &Title()const

Gets a reference to the dialog title bar.

A reference to the dialog title bar.

TryAnimateButtonAndExitL(TInt)

TKeyResponseTryAnimateButtonAndExitL(TIntaKeycode)[private]

Parameters

TInt aKeycode

TryChangeFocusToL(TInt)

IMPORT_C voidTryChangeFocusToL(TIntaControlId)

Tries to change focus to the specified line. Fails if the line ID is not valid. Calls PrepareForFocusTransitionL() before focus is given to the line.

Parameters

TInt aControlIdThe ID of the line to focus.

TryExitL(TInt)

IMPORT_C voidTryExitL(TIntaButtonId)[protected]

Tries to exit the dialog when the specified button is pressed, if this button should exit the dialog.

See OkToExitL() to determine which buttons can exit the dialog.

This will fail if user exit is prevented by the EEikDialogFlagNoUserExit flag. If the EEikDialogFlagNotifyEsc flag is not set and the dialog has been cancelled it immediately deletes itself.

Parameters

TInt aButtonIdThe id of the pressed button.

UpdatePageL(TBool)

IMPORT_C voidUpdatePageL(TBoolaRedraw)[protected]

Only has effect on forms, call this after adding or deleting lines.

Parameters

TBool aRedrawWhether to redraw the page. Usually expect this to be ETrue.

WaitAsRequired()

TInt WaitAsRequired()[private]

WriteInternalStateL(RWriteStream &)

IMPORT_C voidWriteInternalStateL(RWriteStream &aWriteStream)const [protected]

From CCoeControl.

Writes the internal state to the given stream.

Parameters

RWriteStream & aWriteStreamTarget stream.

Member Data Documentation

CEikDialogButtonCommandObserver * iButtonCommandObserver

CEikDialogButtonCommandObserver *iButtonCommandObserver[private]

CEikButtonGroupContainer * iButtonGroupContainer

CEikButtonGroupContainer *iButtonGroupContainer[private]

TInt iDialogFlags

TInt iDialogFlags[private]

TInt * iExitConfirmed

TInt *iExitConfirmed[private]

CEikDialogExtension * iExtension

CEikDialogExtension *iExtension[private]

TBool iIsEditable

TBool iIsEditable[private]

CEikDialogPageSelector * iPageSelector

CEikDialogPageSelector *iPageSelector[private]

TAknPopupFader iPopupFader

TAknPopupFaderiPopupFader[private]

CEikMover * iTitleBar

CEikMover *iTitleBar[private]

CActiveSchedulerWait iWait

CActiveSchedulerWait iWait[private]