#include <mw/aknlistquerydialog.h>
| class CAknListQueryDialog : public CAknQueryDialog |
| Public Member Functions | |
|---|---|
| CAknListQueryDialog(TInt *) | |
| CAknListQueryDialog(CListBoxView::CSelectionIndexArray *) | |
| virtual | ~CAknListQueryDialog() |
| virtual IMPORT_C void | ActivateL() |
| IMPORT_C void | HandleListBoxEventL(CEikListBox *, TListBoxEvent) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| virtual IMPORT_C void | HandleResourceChange(TInt) |
| IMPORT_C CEikListBox * | ListBox() |
| IMPORT_C CAknListQueryControl * | ListControl() |
| IMPORT_C CAknMessageQueryControl * | MessageBox() |
| virtual IMPORT_C TKeyResponse | OfferKeyEventL(const TKeyEvent &, TEventCode) |
| IMPORT_C void | PublishDialogL(TInt, TUid, CArrayFixFlat< TInt > *) |
| virtual IMPORT_C CAknPopupHeadingPane * | QueryHeading() |
| IMPORT_C void | SetIconArrayL(CArrayPtr< CGulIcon > *) |
| IMPORT_C void | SetItemTextArray(MDesCArray *) |
| IMPORT_C void | SetMediatorObserver(MAknDialogMediatorObserver *) |
| IMPORT_C void | SetOwnershipType(TListBoxModelItemArrayOwnership) |
| virtual IMPORT_C void | SetSizeAndPosition(const TSize &) |
| IMPORT_C void | SetTone(TInt) |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C TInt | BorderStyle() |
| IMPORT_C void | CloseState() |
| IMPORT_C CAknSearchField * | FindBox() |
| virtual IMPORT_C TBool | OkToExitL(TInt) |
| virtual IMPORT_C void | PostLayoutDynInitL() |
| virtual IMPORT_C void | PreLayoutDynInitL(void) |
| Inherited Enumerations | |
|---|---|
| CAknQueryDialog:TTone | |
| CCoeControl:TZoomType | |
| CEikDialog:@113 | |
List query class.
This class is be used for list or multiselection list queries.
| IMPORT_C | CAknListQueryDialog | ( | TInt * | aIndex | ) |
C++ default constructor.
| Parameter | Description |
|---|---|
| aIndex | After the query is dismissed, the index will hold the value of selected item. |
| IMPORT_C | CAknListQueryDialog | ( | CListBoxView::CSelectionIndexArray * | aSelectionIndexArray | ) |
C++ default constructor.
| Parameter | Description |
|---|---|
| aSelectionIndexArray | Will hold the values of selected items (in multiselection list). |
| IMPORT_C void | ActivateL | ( | ) | [virtual] |
Reimplemented from CCoeControl::ActivateL()
From CCoeControl.
Sets the control to be ready for drawing.
| IMPORT_C TInt | BorderStyle | ( | ) | [protected, virtual] |
Reimplemented from CEikDialog::BorderStyle()
Gets border style of the list query.
Returns: Border style (AknBorderId type)
| IMPORT_C void | CloseState | ( | ) | [protected] |
From MAknIntermediateState.
Tries to close the query with non-leaving way.
| IMPORT_C CAknSearchField * | FindBox | ( | ) | const [protected] |
Gets search field if it has been set.
Returns: Pointer to search field. If no search field is used returns NULL.
| IMPORT_C void | HandleListBoxEventL | ( | CEikListBox * | aListBox, |
| TListBoxEvent | aEventType | |||
| ) | ||||
From MEikListBoxObserver.
Handles events from listbox.
| Parameter | Description |
|---|---|
| aListBox | The listbox which caused the event. |
| aEventType | Type of the event. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CAknQueryDialog::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().
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Reimplemented from CEikDialog::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 CAknListQueryControl * | ListControl | ( | ) | const |
Gets pointer to list query control or NULL.
Returns: Pointer to list query control or in case that there is no such element a NULL pointer.
| IMPORT_C CAknMessageQueryControl * | MessageBox | ( | ) | const |
Gets pointer to message query control or NULL.
Returns: Pointer to message query control or in case that there is no such element a NULL pointer.
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
Reimplemented from CAknQueryDialog::OfferKeyEventL(const TKeyEvent &,TEventCode)
From CCoeControl.
Handles key events. When a key event occurs, CONE calls this function for each control on the control stack, until one of them returns EKeyWasConsumed to indicate that it processed the key event.
| Parameter | Description |
|---|---|
| aKeyEvent | The key event. |
| aType | The type of the event: EEventKey, EEventKeyUp or EEventKeyDown. |
Returns: Indicates whether or not the key event was used by this control.
Reimplemented from CAknQueryDialog::OkToExitL(TInt)
From CEikDialog.
This function is called by the EIKON framework if the user activates a button in the button panel. It is not called if the Cancel button is activated, unless the EEikDialogFlagNotifyEsc flag is set.
| Parameter | Description |
|---|---|
| aButtonId | The ID of the button that was activated |
Returns: ETrue if the dialog should exit, and EFalse if it should not.
| IMPORT_C void | PostLayoutDynInitL | ( | ) | [protected, virtual] |
Reimplemented from CAknQueryDialog::PostLayoutDynInitL()
From CEikDialog.
This function is called by the EIKON dialog framework just before the dialog is activated, after it has called PreLayoutDynInitL() and the dialog has been sized.
| IMPORT_C void | PreLayoutDynInitL | ( | void | ) | [protected, virtual] |
Reimplemented from CAknQueryDialog::PreLayoutDynInitL(void)
From CEikDialog.
This function is called by the EIKON dialog framework just before the dialog is activated, but before it is sized, and before PostLayoutDynInitL() is called.
| IMPORT_C void | PublishDialogL | ( | TInt | aDialogIndex, |
| TUid | aCatUid = KNullUid, | |||
| CArrayFixFlat< TInt > * | aItemIds = 0 | |||
| ) | ||||
| Parameter | Description |
|---|---|
| aDialogIndex | Unique index to identify a dialog within the category 0 has special meaning, it causes implementation to omit all communication with secondary display. (use with sleeping dialogs only) |
| aCatUid | gategory uid, if default paramter is passed, application uid is used as a category |
Returns: void
| IMPORT_C CAknPopupHeadingPane * | QueryHeading | ( | ) | const [virtual] |
Reimplemented from CAknQueryDialog::QueryHeading()const
Gets pointer to query heading or NULL.
Returns: Pointer to query heading or in case there is no such element a NULL pointer.
| IMPORT_C void | SetItemTextArray | ( | MDesCArray * | aItemTextArray | ) |
Sets item text array to the listbox.
| Parameter | Description |
|---|---|
| aItemTextArray | Item text array to be added. |
| IMPORT_C void | SetMediatorObserver | ( | MAknDialogMediatorObserver * | aObserver | ) |
Reimplemented from CEikDialog::SetMediatorObserver(MAknDialogMediatorObserver *)
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 | SetOwnershipType | ( | TListBoxModelItemArrayOwnership | aOwnershipType | ) |
Sets ownership type of the item array.
| Parameter | Description |
|---|---|
| aOwnershipType | Type of ownership. |
| IMPORT_C void | SetSizeAndPosition | ( | const TSize & | aSize | ) | [virtual] |
Reimplemented from CAknQueryDialog::SetSizeAndPosition(const TSize &)
From CEikDialog.
Sets the type and position of the list box.
| Parameter | Description |
|---|---|
| aSize | Not used. |
| IMPORT_C void | SetTone | ( | TInt | aTone | ) |
Sets the tone for the dialog.
| Parameter | Description |
|---|---|
| aTone | Tone to be used by the dialog. |