C++ default constructor.

Destructor.

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

Activates the first page on the dialog. At least one page must be activated before the dialog can be used.

Gets a page id for the current page.

Returns the id of the dialog's active page.

Gets the index of the dialog's active page.

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

Returns the index of the dialog's active page. Pages are indexed from 0 in the order that they are added.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Adjusts the IDs of all controls on a specified page.

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

Adjusts all the ids of controls on the page identified by aPageId by incrementing their id values by aControlIdDelta.

Returns the border style for this dialog.

Returns the border style for this dialog.

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.

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

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

Returns a reference to the button group container supplying the command buttons for the dialog.

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

Does not imply transfer of ownership.

Returns a pointer to the component control at index aIndex in the component control list. Returns the title bar at index 0, then the page selector Does not imply transfer of ownership.

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.

Dynamically constructs a dialog with flags aFlags, buttons constructed from the resource aButtonsId, and with a single activated empty page with id 0. The dialog is therefore ready to dynamically add lines to.

Constructs the dialog from resources using the resource reader aReader.

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.

Constructs a sleeping dialog from the resources identified by aResourceId at a high priority on the control stack.

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.

Constructs a sleeping dialog from the resources identified by aResourceId. A sleeping dialog is one which can be displayed at any time since its memorey resources are pre-allocated.

Returns a pointer to the specified control.

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

Returns a pointer to the first control found to be identified by aControlId. Panics if the control id is invalid. Does not imply transfer of ownership.

Gets a pointer to the specified control's caption.

Returns a pointer to the caption of the control identified by aControlId. Does not imply transfer of ownership.

Gets a pointer to the specified control.

Returns a pointer to the control identified by aControlId or NULL if the control id is invalid. Does not imply transfer of ownership.

Gets all lines in the given page.

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 .

Returns the number of the control components.

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

* Returns the number of control components. In Avkon returns 2 as the button group container is not internal

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 .

Creates a custom control of type aControlType. Returns the control information for the custom control which is created. Called when creating a line on the dialog page if the Eikon control factory does not recognise the type aControlType.

This method panics by default. It must be reimplemented if it is to be called.

The parent of a custom control should be the line which contains it - not the dialog itself - but the line is not accessible at this stage. If necessary, the line should be set as the parent in PreLayoutDynInitL

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() .

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.

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() .

Overloaded member which creates a control line in the dialog on the page specified by aPageId.

Gets a pointer to the current line.

This does not imply transfer of ownership from the dialog.

Returns a pointer to the current line. Does not imply transfer of ownership.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Sets controllers return value.

Deletes the specified dialog line.

Deletes the dialog line with the control identified by aControlId.

Gets flags of the dialog.

From CCoeControl . Draws the border around the control. This function also clears the central area if the IsBlank() method returns ETrue .

From CCoeControl

CCoeControl::IsBlank() Border()

Not supported.

Enables/disables content observer.

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.

Prepares and runs the dialog and returns the id of the button used to dismiss it. The dialog is constructed from the resource with id aResourceId and is destroyed on exit.

Exits sleeping dialog without deleting it.

Exits a sleeping dialog without deleteing it.

Access to CEikDialog's extension object.

From CAknControl

Gets the line index of the specified control.

The control must be on the active page.

Returns the line index of the control aControl or KErrNotFound if the control is not on the active page.

Not supported.

Not supported.

Not supported.

Not supported.

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.

Hands focus to current dialog line.

Get form flags of the active page

Not supported.

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() .

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.

Not supported.

Not supported.

Gets first line of the first page.

Not supported.

Gets specified line from specified page.

Gets number of lines in the specified page.

Gets number of pages in the page selector.

Not supported.

Not supported.

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() .

Handles an event of type aEventType reported by the control aControl. By default, handles EEventStateChanged by calling HandleControlStateChangeL and EEventInteractionRefused by calling HandleInteractionRefused.

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

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

From CEikDialog ( MEikDialogPageObserver ).

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

Handles embedded softkey state change.

Call back method to handle CEikCba content changes.

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.

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

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() .

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() .

Gets the ID of the control in the focused line.

Returns the id of the control in the line with focus.

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.

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.

Inserts a line in the dialog on the page identified by aPageId at the line index aIndex and constructed from the resource specified by aResourceId.

Checks if the dialog is editable.

Returns the Editable state. This exists to support forms

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

TODO (RSD) I have noticed this routine and I suspect that it is responsible for one of the sizechanged cascades in Form. This should use best current information to layout the dialog, but I have not investigated too much

Gets a pointer to the line containing the specified control.

This does not imply transfer of ownership from the dialog.

Returns a pointer to the line containing the control identified by aControlId. Does not imply transfer of ownership.

From MEikDialogPageObserver

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

Not implemented.

Takes any action required when the current line is changed to aControlId. Empty by default.

Not supported.

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

Makes the dialog line containing the control identified by aControlId visible, i.e. sets it to draw itself, if aVisible is ETrue.

Makes the specified panel button visible or invisible.

Makes the panel button identified by aButtonId visible if aVisible is ETrue.

From CCoeControl .

Sets the dialog visibility

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

Makes the whole dialog line containing the control identified by aControlId visible, i.e. sets it to draw itself, if aVisible is ETrue.

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.

Routine to map the button id ( Avkon softkey command id) to CEikBidCancel if it is a "cancel" type command type and to CEikBidOk if it is an "accept" type command Other cases left unchanged

Returns the minimum size of the area that the contents of the dialog should occupy.

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.

Not supported.

From CCoeControl .

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

Handles the key event aKeyEvent with code aType. Returns EKeyWasConsumed if the control takes action on the key event or EKeyWasNotConsumed otherwise.

Not implemented.

Handles a dialog button press for the button with id aButtonId. The cancel button press is not passed to the handler unless EEikDialogFlagNotifyEsc is set. Returns ETrue if the dialog is ready to exit. Returns ETrue by default.

From MEikDialogPageObserver .

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

Not implemented.

Takes any action required when the active dialog page is changed to aPageId. Empty by default.

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

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

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.

Returns the preferred size of the dialog given that it must fit in a maximum size of aMaxSize.

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.

Prepares the graphics context aGc for drawing the control in its normal state.

From MEikDialogPageObserver .

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

For example to validate the contents of the current control.

Prepares for a transistion in focus in the dialog. By default, calls the currently focused control to prepare fo loss of focus.

Prepares the dialog, constructing it from the specified resource.

Prepares the dialog, constructing it from the resource with id aResourceId.

The dialog is added to the stack in here to avoid a possible reallocation of the stack in RunLD, the purpose is to be able to display note dialogs in OOM situations.

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

Not supported.

Code is same as in PrepareLC() but iEikonEnv->EikAppUi()->AddToStackL() is omitted

Sets the current Dialog into the Page selector

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

Overrides CCoeControl::ResetLineMinimumSizes() .

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

Not supported.

Rotates the focus by a specified number of steps.

Each line is a step, as are dialog tabs.

Rotates the focus by aDelta steps. Each line is a step, as are dialog tabs..

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.

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

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.

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

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

Sets the caption of the control identified by aControlId to the descriptor aText.

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

Sets the caption of the control identified by aControlId by reading the caption text from the resource specified by aResourceId.

Not supported.

Not supported.

Sets the dialog to either editable or uneditable

Sets the Editable state. This exists to support forms

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

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.

Set 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.

Not supported.

Not supported.

Not supported.

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

Dims and inactivates the dialog line containing the control identified by aControlId if aDimmed is ETrue. Does not cause a redraw.

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

Sets the dialog line containing the control identified by aControlId to a non-focusing state so that it will never be given keyboard focus.

Not supported.

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 .

Not supported.

Not supported.

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

Sets the page identified by aPageId to be densely packed if aDensePacking is ETrue. The spacing between the dialog's lines is then reduced. TODO (RSD) This seems to be rather un-avkonlike. Perhaps should be stubbed out.

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

Sets the page identified by aPageId to be dimmed if aDimmmed is ETrue.

Not supported.

Not supported.

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.

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

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

Not supported.

Not supported.

Not supported.

Not supported.

Not supported.

Sets the dialog title text from a descriptor.

Sets the title text for the dialog to aText.

Sets the dialog title text from a resource.

Sets the title text for the dialog by reading it from the resource with id aResourceId.

Lays out the dialog's components when the size of the dialog is changed. Position of DpSel is always at (0,0) relative to dialog. For Avkon, the DPSEL always stays the same size as the CEikDialog minus an optional title bar.

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.

Swaps the the button group container with a new container aContainer. The dialog takes ownership of the new container. Returns a pointer to the old button group container and transfers ownership.

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.

Switches the latent line 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.

Not supported.

Not supported.

Gets a reference to the dialog title bar.

Returns a reference to the dialog title bar.

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.

Tries to change focus to the line identified by aLineId. Fails if the line id is not valid. Calls PrepareForFocusTransitionL before focus is given to the line.

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.

Tries to initiate user exit of the dialog when the button identified by aButtonId 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.

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

From CCoeControl .

Writes the internal state to the given stream.

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.