CAknListQueryDialog Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknlistquerydialog.h>

Inherits CAknQueryDialog, MEikListBoxObserver, and MAknIntermediateState.

Detailed Description

List query class.

This class is be used for list or multiselection list queries.


Public Member Functions
IMPORT_C	CAknListQueryDialog (TInt *aIndex)
	C++ default constructor.
IMPORT_C	CAknListQueryDialog (CListBoxView::CSelectionIndexArray *aSelectionIndexArray)
	C++ default constructor.
virtual IMPORT_C	~CAknListQueryDialog ()
	Destructor.
IMPORT_C void	SetSizeAndPosition (const TSize &aSize)
	From `CEikDialog`.
IMPORT_C TKeyResponse	OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
	From `CCoeControl`.
IMPORT_C void	HandleListBoxEventL (CEikListBox *aListBox, TListBoxEvent aEventType)
	From `MEikListBoxObserver`.
IMPORT_C void	SetItemTextArray (MDesCArray *aItemTextArray)
	Sets item text array to the listbox.
IMPORT_C void	SetOwnershipType (TListBoxModelItemArrayOwnership aOwnershipType)
	Sets ownership type of the item array.
IMPORT_C void	SetIconArrayL (CArrayPtr< CGulIcon > *aIcons)
	Destroys a possible old icon array in the listbox and installs a new one and takes ownership of the new icon array.
IMPORT_C CEikListBox *	ListBox () const
	Gets list query's listbox.
IMPORT_C CAknListQueryControl *	ListControl () const
	Gets pointer to list query control or `NULL`.
IMPORT_C CAknMessageQueryControl *	MessageBox () const
	Gets pointer to message query control or `NULL`.
IMPORT_C CAknPopupHeadingPane *	QueryHeading () const
	Gets pointer to query heading or `NULL`.
IMPORT_C void	ActivateL ()
	From `CCoeControl`.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From `CCoeControl`.
IMPORT_C void	SetTone (TInt aTone)
	Sets the tone for the dialog.
IMPORT_C void	HandleResourceChange (TInt aType)
	From `CCoeControl`.
IMPORT_C void	PublishDialogL (TInt aDialogIndex, TUid aCatUid=KNullUid, CArrayFixFlat< TInt > *aItemIds=0)
	Override to CEikDialog default functionality Instantiates mediator support and send a command with given parameters when a dialog is brought to display.
IMPORT_C void	SetMediatorObserver (MAknDialogMediatorObserver *aObserver)
	Instantiates mediator support and passes possible feedback to given intance.
Protected Member Functions
IMPORT_C void	PreLayoutDynInitL (void)
	From `CEikDialog`.
IMPORT_C void	PostLayoutDynInitL ()
	From `CEikDialog`.
IMPORT_C TBool	OkToExitL (TInt aButtonId)
	From `CEikDialog`.
IMPORT_C TInt	BorderStyle ()
	Gets border style of the list query.
IMPORT_C void	CloseState ()
	From `MAknIntermediateState`.
IMPORT_C CAknSearchField *	FindBox () const
	Gets search field if it has been set.

Constructor & Destructor Documentation

IMPORT_C CAknListQueryDialog::CAknListQueryDialog

C++ default constructor.

Parameters:

aIndex

After the query is dismissed, the index will hold the value of selected item.

IMPORT_C CAknListQueryDialog::CAknListQueryDialog

(

CListBoxView::CSelectionIndexArray *

aSelectionIndexArray

)

C++ default constructor.

Parameters:

aSelectionIndexArray

Will hold the values of selected items (in multiselection list).

virtual IMPORT_C CAknListQueryDialog::~CAknListQueryDialog ( ) [virtual]

Destructor.

Member Function Documentation

IMPORT_C void CAknListQueryDialog::ActivateL

(

)

From CCoeControl.

Sets the control to be ready for drawing.

IMPORT_C TInt CAknListQueryDialog::BorderStyle ( ) [protected, virtual]

Gets border style of the list query.

Returns:: Border style (AknBorderId type)

Reimplemented from CEikDialog.

IMPORT_C void CAknListQueryDialog::CloseState ( ) [protected, virtual]

From MAknIntermediateState.

Tries to close the query with non-leaving way.

Implements MAknIntermediateState.

IMPORT_C CAknSearchField* CAknListQueryDialog::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 CAknListQueryDialog::HandleListBoxEventL	(	CEikListBox *	aListBox,
		TListBoxEvent	aEventType
	)

From MEikListBoxObserver.

Handles events from listbox.

Parameters:

	aListBox	The listbox which caused the event.
	aEventType	Type of the event.

IMPORT_C void CAknListQueryDialog::HandlePointerEventL

(

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:

&aPointerEvent

The pointer event.

Reimplemented from CAknQueryDialog.

IMPORT_C void CAknListQueryDialog::HandleResourceChange ( TInt aType ) [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().

Parameters:

aType

A message UID value.

Reimplemented from CEikDialog.

IMPORT_C CEikListBox* CAknListQueryDialog::ListBox

(

)

const

Gets list query's listbox.

Returns:: The requested list box.

IMPORT_C CAknListQueryControl* CAknListQueryDialog::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* CAknListQueryDialog::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 CAknListQueryDialog::OfferKeyEventL	(	const TKeyEvent &	aKeyEvent,
		TEventCode	aType
	)

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.

Parameters:

	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.

IMPORT_C TBool CAknListQueryDialog::OkToExitL ( TInt aButtonId ) [protected, virtual]

From CEikDialog.

This function is called by the EIKON framework if the user activates a button in the button panel. It is not called if the Cancel button is activated, unless the EEikDialogFlagNotifyEsc flag is set.

Parameters:

aButtonId

The ID of the button that was activated

Returns:: ETrue if the dialog should exit, and EFalse if it should not.

Reimplemented from CAknQueryDialog.

IMPORT_C void CAknListQueryDialog::PostLayoutDynInitL ( ) [protected, virtual]

From CEikDialog.

This function is called by the EIKON dialog framework just before the dialog is activated, after it has called PreLayoutDynInitL() and the dialog has been sized.

Reimplemented from CAknQueryDialog.

IMPORT_C void CAknListQueryDialog::PreLayoutDynInitL ( void ) [protected, virtual]

From CEikDialog.

This function is called by the EIKON dialog framework just before the dialog is activated, but before it is sized, and before PostLayoutDynInitL() is called.

Reimplemented from CAknQueryDialog.

IMPORT_C void CAknListQueryDialog::PublishDialogL	(	TInt	aDialogIndex,
		TUid	aCatUid = `KNullUid`,
		CArrayFixFlat< TInt > *	aItemIds = `0`
	)

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

Parameters:

	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* CAknListQueryDialog::QueryHeading ( ) const [virtual]

Gets pointer to query heading or NULL.

Returns:: Pointer to query heading or in case there is no such element a NULL pointer.

Reimplemented from CAknQueryDialog.

IMPORT_C void CAknListQueryDialog::SetIconArrayL

(

CArrayPtr< CGulIcon > *

aIcons

)

Destroys a possible old icon array in the listbox and installs a new one and takes ownership of the new icon array.

Parameters:

aIcons

Icon pointer which will be installed.

IMPORT_C void CAknListQueryDialog::SetItemTextArray

Sets item text array to the listbox.

Parameters:

aItemTextArray

Item text array to be added.

IMPORT_C void CAknListQueryDialog::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.

Parameters:

aObserver Pointer to instance implementing MAknDialogMediatorObserver API. Can be NULL.

Reimplemented from CEikDialog.

IMPORT_C void CAknListQueryDialog::SetOwnershipType

(

TListBoxModelItemArrayOwnership

aOwnershipType

)

Sets ownership type of the item array.

Parameters:

aOwnershipType

Type of ownership.