#include <mw/eikdialg.h>
| class CEikDialog : public CEikBorderedControl |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { ETypeId } |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
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.
| IMPORT_C void | ActivateFirstPageL | ( | ) | const |
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.
| IMPORT_C TInt | ActivePageId | ( | ) | const |
Gets a page id for the current page.
Returns the id of the dialog's active page.
Returns: Page id.
| IMPORT_C TInt | ActivePageIndex | ( | ) | const [protected] |
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.
Returns: The index of the active page.
| IMPORT_C void | AddAutoDurationEditorL | ( | const TDesC & | aPrompt, |
| TInt | aId, | |||
| const TTimeIntervalSeconds & | aMin, | |||
| const TTimeIntervalSeconds & | aMax, | |||
| TBool | aNoSeconds, | |||
| TTimeIntervalSeconds * | aReturn | |||
| ) | ||||
DeprecatedNot supported.
| IMPORT_C void | AddAutoTimeOffsetEditorL | ( | const TDesC & | aPrompt, |
| TInt | aId, | |||
| const TTimeIntervalSeconds & | aMin, | |||
| const TTimeIntervalSeconds & | aMax, | |||
| TBool | aNoSeconds, | |||
| TTimeIntervalSeconds * | aReturn | |||
| ) | ||||
DeprecatedNot 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.
| Parameter | Description |
|---|---|
| aPageId | The page on which the control IDs are to be adjusted. |
| aControlIdDelta | The amount to increment the IDs. |
| IMPORT_C TInt | BorderStyle | ( | ) | [protected, virtual] |
Returns the border style for this dialog.
Returns the border style for this dialog.
Returns: Border style. Always returns AknBorderId::EAknBorderNotePopup.
| 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.
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.
Returns: A pointer to the dialog's internal button command observer.
| IMPORT_C CEikButtonGroupContainer & | ButtonGroupContainer | ( | ) | const |
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: The dialog's button group container.
| IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [protected, virtual] |
Reimplemented from CCoeControl::ComponentControl(TInt)const
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.
| Parameter | Description |
|---|---|
| aIndex | The index of the required component control. |
Returns: The required component control.
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.
| Parameter | Description |
|---|---|
| aFlags | Dialog flags. |
| aButtonsId | Dialog buttons. |
| IMPORT_C void | ConstructSleepingAlertDialogL | ( | TInt | aResourceId | ) | [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.
Constructs a sleeping dialog from the resources identified by aResourceId at a high priority on the control stack.
| Parameter | Description |
|---|---|
| aResourceId | The resource ID of the dialog to be constructed. |
| IMPORT_C void | ConstructSleepingDialogL | ( | TInt | aResourceId | ) | [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.
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.
| Parameter | Description |
|---|---|
| aResourceId | The resource ID of the dialog to be constructed. |
| IMPORT_C CCoeControl * | Control | ( | TInt | aControlId | ) | const |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control for which a pointer is required. |
Returns: A pointer to the control with ID aControlId.
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control for which the label is required. |
Returns: A pointer to the caption.
| IMPORT_C CCoeControl * | ControlOrNull | ( | TInt | aControlId | ) | const |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control for which a pointer is required. |
Returns: A pointer to the control with ID aControlId, or NULL if it doesn't exist.
| IMPORT_C void | ControlsOnPage | ( | RArray< CEikCaptionedControl * > & | aControls, |
| TInt | aPageId | |||
| ) | const [protected] | |||
Gets all lines in the given page.
| Parameter | Description |
|---|---|
| aControls | After execution holds all captions in the page. |
| aPageId | ID of the target page. |
| IMPORT_C MEikDialogPageObserver::TFormControlTypes | ConvertCustomControlTypeToBaseControlType | ( | TInt | aControlType | ) | 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.
| Parameter | Description |
|---|---|
| aControlType | Not used. |
Returns: Current implementation always returns MEikDialogPageObserver::EUnknownType.
| IMPORT_C TInt | CountComponentControls | ( | ) | const [protected, virtual] |
Reimplemented from CCoeControl::CountComponentControls()const
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
Returns: Number of control components.
| IMPORT_C SEikControlInfo | CreateCustomControlL | ( | TInt | aControlType | ) | [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.
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
| Parameter | Description |
|---|---|
| aControlType | The type of the custom control. |
Returns: Information for the custom control.
| IMPORT_C CCoeControl * | CreateLineByTypeL | ( | const TDesC & | aCaption, |
| TInt | aControlId, | |||
| TInt | aControlType, | |||
| 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().
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.
| Parameter | Description |
|---|---|
| aCaption | The caption to appear in the dialog line. |
| aControlId | The ID of the active page on which the control line is to be created. |
| aControlType | The type of control to create. |
| aReturnValue | Deprecated. A random pointer. |
Returns: A pointer to the newly created control.
| IMPORT_C CCoeControl * | CreateLineByTypeL | ( | const TDesC & | aCaption, |
| TInt | aPageId, | |||
| TInt | aControlId, | |||
| TInt | aControlType, | |||
| 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().
Overloaded member which creates a control line in the dialog on the page specified by aPageId.
| Parameter | Description |
|---|---|
| aCaption | The active page on which the control line is to be created. |
| aPageId | The ID of the active page on which the control line is to be created. |
| aControlId | The ID of the control. After the line is created this can be used to access it. |
| aControlType | The type of control to create. |
| aReturnValue | Deprecated. A random pointer. |
Returns: A pointer to the newly created control.
| IMPORT_C CEikCaptionedControl * | CurrentLine | ( | ) | const [protected] |
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.
Returns: A pointer to the current line.
| IMPORT_C void | DeclareAutoDurationEditor | ( | TInt | aId, |
| TTimeIntervalSeconds * | aDuration | |||
| ) | ||||
DeprecatedNot supported.
| IMPORT_C void | DeclareAutoTimeOffsetEditor | ( | TInt | aId, |
| TTimeIntervalSeconds * | aTimeOffset | |||
| ) | ||||
DeprecatedNot supported.
| Parameter | Description |
|---|---|
| aControlId | Control identifier for wanted caption controller. |
| aControlType | Type of control. |
| aReturnValue | Controllers return value. |
| IMPORT_C TTimeIntervalSeconds | DurationEditorValue | ( | TInt | aControlId | ) | const [protected] |
DeprecatedNot supported.
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.
| Parameter | Description |
|---|---|
| aResourceId | The resource ID of the dialog to load. |
Returns: 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).
| IMPORT_C void | ExitSleepingDialog | ( | ) | [protected] |
Exits sleeping dialog without deleting it.
Exits a sleeping dialog without deleteing it.
| IMPORT_C CEikDialogExtension * | Extension | ( | ) | const |
Access to CEikDialog's extension object.
Returns: Pointer to extension object. Constructed in CEikDialog::BaseContructL
| IMPORT_C TInt | FindLineIndex | ( | const CCoeControl & | aControl | ) | const [protected] |
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.
| Parameter | Description |
|---|---|
| aControl | The control for which the line index is required. |
Returns: The line index, or KErrNotFound if the control is not on the active page.
| IMPORT_C void | FocusChanged | ( | TDrawNow | aDrawNow | ) | [virtual] |
Reimplemented from CCoeControl::FocusChanged(TDrawNow)
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.
| Parameter | Description |
|---|---|
| aDrawNow | Contains the value that was passed to it by SetFocus(). |
| IMPORT_C TInt | FormFlagsFromActivePage | ( | ) | [protected] |
Get form flags of the active page
Returns: Active page's form flags
| IMPORT_C void | GetAutoValuesFromPage | ( | CEikCapCArray * | aLines | ) | [protected] |
DeprecatedNot supported.
| IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
Reimplemented from CEikBorderedControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
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().
| IMPORT_C void | GetCustomAutoValue | ( | TAny * | aReturnValue, |
| TInt | aControlType, | |||
| 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.
| Parameter | Description |
|---|---|
| aReturnValue | The custom controls return value. |
| aControlType | The type of the custom control. |
| aControl | The control whose auto value is being retrieved. |
| IMPORT_C CEikCaptionedControl * | GetFirstLineOnFirstPageOrNull | ( | ) | [protected, virtual] |
Gets first line of the first page.
Returns: Pointer to the first line of the first page. If NULL there is no such line.
| IMPORT_C CEikCaptionedControl * | GetLineByLineAndPageIndex | ( | TInt | aLineIndex, |
| TInt | aPageIndex | |||
| ) | const [protected] | |||
Gets specified line from specified page.
| Parameter | Description |
|---|---|
| aLineIndex | Index of the requested line. |
| aPageIndex | Index of the requested page. |
Returns: The wanted line.
| IMPORT_C TInt | GetNumberOfPages | ( | ) | const [protected] |
Gets number of pages in the page selector.
Returns: The number of pages.
| IMPORT_C void | GetTextEditorText | ( | CGlobalText *& | aGlobalText, |
| TInt | aControlId | |||
| ) | [protected] | |||
DeprecatedNot supported.
| IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| TCoeEvent | aEventType | |||
| ) | [protected] | |||
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.
| Parameter | Description |
|---|---|
| aControl | The control reporting the event. |
| aEventType | The event type. |
| IMPORT_C void | HandleControlStateChangeL | ( | TInt | aControlId | ) | [protected, virtual] |
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.
| Parameter | Description |
|---|---|
| aControlId | Not used. |
| IMPORT_C void | HandleDialogPageEventL | ( | TInt | aEventID | ) | [virtual] |
From CEikDialog (MEikDialogPageObserver).
The interface method which is called when dialog page is tapped with a stylus.
| Parameter | Description |
|---|---|
| aEventID | An event identification number. |
| IMPORT_C void | HandleInteractionRefused | ( | TInt | aControlId | ) | [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.
Handles an attempt by the user to activate a dimmed button with id aControlId. Prints an info message by default.
| Parameter | Description |
|---|---|
| aControlId | Not used. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CEikBorderedControl::HandlePointerEventL(const TPointerEvent &)
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().
| Parameter | Description |
|---|---|
| aPointerEvent | The pointer event. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Reimplemented from CEikBorderedControl::HandleResourceChange(TInt)
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().
| Parameter | Description |
|---|---|
| aType | A message UID value. |
| IMPORT_C TInt | IdOfFocusControl | ( | ) | const [protected] |
Gets the ID of the control in the focused line.
Returns the id of the control in the line with focus.
Returns: Current control ID.
| IMPORT_C TCoeInputCapabilities | InputCapabilities | ( | ) | const [virtual] |
Reimplemented from CCoeControl::InputCapabilities()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.
Returns: The control's input capabilities.
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.
| Parameter | Description |
|---|---|
| aIndex | The index at which the line is to be inserted. |
| aResourceId | The ID of the resource which defines the line. |
| aPageId | The page on which the line is to be added. |
| IMPORT_C TBool | IsEditable | ( | ) | const |
Checks if the dialog is editable.
Returns the Editable state. This exists to support forms
Returns: ETrue if editable.
| IMPORT_C void | Layout | ( | ) |
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
| IMPORT_C CEikCaptionedControl * | Line | ( | TInt | aControlId | ) | const [protected] |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control. |
Returns: A pointer to the line containing the control identified by aControlId.
| IMPORT_C void | LineChangedL | ( | TInt | aControlId | ) | [protected, virtual] |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control being switched to. |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control to make visible or invisible. |
| aVisible | ETrue to make the control visible. EFalse to make the control invisible. |
Makes the specified panel button visible or invisible.
Makes the panel button identified by aButtonId visible if aVisible is ETrue.
| Parameter | Description |
|---|---|
| aButtonId | The ID of the panel button to make visible or invisible. |
| aVisible | ETrue to make the panel visible. EFalse to make it invisible. |
| IMPORT_C void | MakeVisible | ( | TBool | aVisible | ) | [virtual] |
Reimplemented from CCoeControl::MakeVisible(TBool)
From CCoeControl.
Sets the dialog visibility
| Parameter | Description |
|---|---|
| aVisible | ETrue control is visible. EFalse control is invisible. |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control on the line to make visible or invisible. |
| aVisible | ETrue to make the line visible. EFalse to make the line invisible. |
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
| Parameter | Description |
|---|---|
| aButtonId | input id to map. |
Returns: 0 for re-mapped negative command ids other values are returned as their original command id values.
| IMPORT_C TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected] |
Reimplemented from CCoeControl::MopSupplyObject(TTypeUid)
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.
| Parameter | Description |
|---|---|
| aId | An encapsulated object type ID. |
Returns: Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
Reimplemented from CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
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.
| Parameter | Description |
|---|---|
| aKeyEvent | The key event. |
| aType | The type of key event: EEventKey, EEventKeyUp or EEventKeyDown. |
Returns: 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.
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.
| Parameter | Description |
|---|---|
| aButtonId | Not used. |
Returns: Always return ETrue.
| IMPORT_C void | PageChangedL | ( | TInt | aPageId | ) | [protected, virtual] |
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.
| Parameter | Description |
|---|---|
| aPageId | The ID of the page being switched to. |
| IMPORT_C void | PostLayoutDynInitL | ( | ) | [protected, virtual] |
Initializes the dialog's controls after the dialog has been sized but before it has been activated. Empty by default.
| IMPORT_C void | PreLayoutDynInitL | ( | ) | [protected, virtual] |
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.
| Parameter | Description |
|---|---|
| aMaxSize | The maximum size of the area in which the dialog must fit. |
Returns: The preferred size of the dialog.
| IMPORT_C void | PrepareContext | ( | 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.
Prepares the graphics context aGc for drawing the control in its normal state.
| Parameter | Description |
|---|---|
| aGc | The graphics context to be initialised. |
| IMPORT_C void | PrepareForFocusTransitionL | ( | ) | [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.
Prepares for a transistion in focus in the dialog. By default, calls the currently focused control to prepare fo loss of focus.
| IMPORT_C void | PrepareLC | ( | TInt | aResourceId | ) | [virtual] |
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.
| Parameter | Description |
|---|---|
| aResourceId | The resource ID of the dialog. |
Instantiates mediator support and send a command with given parameters when a dialog is brought to display.
| Parameter | Description |
|---|---|
| aDialogIndex | unique index to identify a dialog within the category. |
| aCatUid | gategory uid, if default paramter is passed, application uid is used as a category. |
| IMPORT_C void | ReadResourceLC | ( | TInt | aResourceId | ) |
Code is same as in PrepareLC() but iEikonEnv->EikAppUi()->AddToStackL() is omitted
| Parameter | Description |
|---|---|
| aResourceId | The resource ID of the dialog. |
| void | RegisterDialgWithPageSelector | ( | ) | [protected] |
Sets the current Dialog into the Page selector
| IMPORT_C void | ResetLineMinimumSizes | ( | ) | [protected] |
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.
| IMPORT_C void | ResetSecretEditor | ( | TInt | aControlId | ) | [protected] |
DeprecatedNot 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..
| Parameter | Description |
|---|---|
| aDelta | The number of steps. |
Returns: ETrue if rotation of focus is successful, EFalse if there are no lines in the dialog or the rotation is otherwise unsuccessful.
| IMPORT_C TInt | RouseSleepingDialog | ( | ) | [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.
Rouses a sleeping dialog by dynamically constructing it and then bringing it to the front.
Returns: Zero.
| IMPORT_C TInt | RunLD | ( | ) | [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.
Runs the dialog and returns the id of the button used to dismiss it. The dialog is destroyed on exit.
Returns: The ID of the button used to dismiss the dialog.
Sets the specified control's caption text from a descriptor.
Sets the caption of the control identified by aControlId to the descriptor aText.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control for which the caption text is being set. |
| aText | The text for the caption. |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control for which the caption text is being set. |
| aResourceId | The ID of the resource containing the text for the caption. |
| IMPORT_C void | SetDurationEditorMinAndMax | ( | TInt | aControlId, |
| const TTimeIntervalSeconds & | aMinimumDuration, | |||
| const TTimeIntervalSeconds & | aMaximumDuration | |||
| ) | [protected] | |||
DeprecatedNot supported.
| IMPORT_C void | SetDurationEditorValue | ( | TInt | aControlId, |
| const TTimeIntervalSeconds & | aDuration | |||
| ) | [protected] | |||
DeprecatedNot supported.
| IMPORT_C void | SetEditableL | ( | TBool | aEditable | ) |
Sets the dialog to either editable or uneditable
Sets the Editable state. This exists to support forms
| Parameter | Description |
|---|---|
| aEditable | ETrue if dialog is editable. EFalse if dialog is uneditable. |
| IMPORT_C void | SetInitialCurrentLine | ( | ) | [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.
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.
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the line to dim or un-dim. |
| aDimmed | ETrue to dim the line, EFalse to un-dim it. |
| IMPORT_C void | SetLineNonFocusing | ( | TInt | aControlId | ) |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the control in the line which is to be set as non-focusing. |
| IMPORT_C void | SetMediatorObserver | ( | 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.
| Parameter | Description |
|---|---|
| aObserver | Pointer to instance implementing MAknDialogMediatorObserver API. Can be NULL. |
| IMPORT_C void | SetMultilineQuery | ( | TBool | aIsMultilineQuery | ) |
| Parameter | Description |
|---|---|
| aIsMultilineQuery | Whether this dialog is multiline query |
| IMPORT_C void | SetNumberEditorMinAndMax | ( | TInt | aControlId, |
| TInt | aMinimumValue, | |||
| TInt | aMaximumValue | |||
| ) | [protected] | |||
DeprecatedNot 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.
| Parameter | Description |
|---|---|
| aPageId | The ID of the page to be densely packed. |
| aDensePacking | ETrue for dense packing. EFalse for normal packing. |
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.
| Parameter | Description |
|---|---|
| aPageId | The ID of the page to be dimmed. |
| aDimmed | ETrue to dim the page, EFalse to un-dim it. |
| IMPORT_C void | SetRangeEditorMinAndMax | ( | TInt | aControlId, |
| TInt | aMinimumValue, | |||
| TInt | aMaximumValue | |||
| ) | [protected] | |||
DeprecatedNot supported.
| IMPORT_C void | SetSizeAndPosition | ( | 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.
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
| Parameter | Description |
|---|---|
| aSize | The new size. |
| IMPORT_C void | SetTTimeEditorMinAndMax | ( | TInt | aControlId, |
| const TTime & | aMinimumTime, | |||
| const TTime & | aMaximumTime | |||
| ) | [protected] | |||
DeprecatedNot supported.
| IMPORT_C void | SetTextEditorTextL | ( | TInt | aControlId, |
| const CGlobalText * | aGlobalText | |||
| ) | [protected] | |||
DeprecatedNot supported.
| IMPORT_C void | SetTimeOffsetEditorMinAndMax | ( | TInt | aControlId, |
| const TTimeIntervalSeconds & | aMinimumTimeOffset, | |||
| const TTimeIntervalSeconds & | aMaximumTimeOffset | |||
| ) | [protected] | |||
DeprecatedNot supported.
| IMPORT_C void | SetTimeOffsetEditorValue | ( | TInt | aControlId, |
| const TTimeIntervalSeconds & | aTimeOffset | |||
| ) | [protected] | |||
DeprecatedNot supported.
| IMPORT_C void | SetTitleL | ( | const TDesC & | aText | ) |
Sets the dialog title text from a descriptor.
DeprecatedSets the title text for the dialog to aText.
| Parameter | Description |
|---|---|
| aText | The descriptor containing the new title text. |
| IMPORT_C void | SetTitleL | ( | TInt | aResourceId | ) |
Sets the dialog title text from a resource.
DeprecatedSets the title text for the dialog by reading it from the resource with id aResourceId.
| Parameter | Description |
|---|---|
| aResourceId | The ID of the resource containing the title text. |
| 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.
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.
| Parameter | Description |
|---|---|
| aContainer | The new button group container. |
Returns: A pointer to the old button group container. This is no longer owned by the dialog.
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.
| Parameter | Description |
|---|---|
| aBecomesLatent | The line ID of the line to become latent. |
| aNoLongerLatent | The line ID of the line to that is no longer latent. |
| IMPORT_C TTimeIntervalSeconds | TimeOffsetEditorValue | ( | TInt | aControlId | ) | const [protected] |
DeprecatedNot supported.
| IMPORT_C CEikMover & | Title | ( | ) | const |
Gets a reference to the dialog title bar.
Returns a reference to the dialog title bar.
Returns: A reference to the dialog title bar.
| IMPORT_C void | TryChangeFocusToL | ( | TInt | aControlId | ) |
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.
| Parameter | Description |
|---|---|
| aControlId | The ID of the line to focus. |
| IMPORT_C void | TryExitL | ( | TInt | aButtonId | ) | [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.
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.
| Parameter | Description |
|---|---|
| aButtonId | The id of the pressed button. |
| IMPORT_C void | UpdatePageL | ( | TBool | aRedraw | ) | [protected] |
Only has effect on forms, call this after adding or deleting lines.
| Parameter | Description |
|---|---|
| aRedraw | Whether to redraw the page. Usually expect this to be ETrue. |
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Reimplemented from CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
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.
| Parameter | Description |
|---|---|
| aWriteStream | Target stream. |