CAknMessageQueryDialog Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknmessagequerydialog.h>

Inherits CAknQueryDialog.

Detailed Description

Message query dialog.

The dialog contains text that can be scrolled page by page.

If you want to use links and/or bold text among message you must use SetMessageTextL method. Formatting text does not work through resource file. If there are incorrect/misplaced tags or tags are within each other, dialog will leave.


Public Member Functions
IMPORT_C	~CAknMessageQueryDialog ()
	Destructor.
IMPORT_C	CAknMessageQueryDialog (const TTone aTone)
	C++ default constructor.
IMPORT_C void	SetMessageTextL (const TDesC &aMessage)
	Sets message text.
IMPORT_C void	SetHeaderTextL (const TDesC &aHeader)
	Sets header text.
IMPORT_C void	SetLinkTextL (const TDesC &aLinkText)
IMPORT_C void	SetLink (TCallBack &aCallBack)
	Binds a callback to your link so that the dialog knows which callback to call when a link is activated by the user.
IMPORT_C TKeyResponse	OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode)
	From `CCoeControl`.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From `CCoeControl`.
virtual IMPORT_C void	ProcessCommandL (TInt aCommandId)
	From `MEikCommandObserver`.
void	CheckLinkTappedL (TAny *aParams)
	Checks if a link is tapped.
IMPORT_C	CAknMessageQueryDialog (TDesC aMessage, TDesC aHeader)
	C++ default constructor.
IMPORT_C	CAknMessageQueryDialog (TDesC aMessage, TDesC aHeader, CEikImage *aHeaderImage)
	C++ default constructor.
IMPORT_C	CAknMessageQueryDialog (TDesC aMessage, TDesC aHeader, const TTone aTone)
	C++ default constructor.
IMPORT_C	CAknMessageQueryDialog (TDesC aMessage, TDesC aHeader, CEikImage *aHeaderImage, const TTone aTone)
	C++ default constructor.
IMPORT_C void	SetMessageText (TDesC *aMessage)
	Sets the dialogs texts.
IMPORT_C void	SetMessageText (const TDesC &aMessage)
	Sets the dialogs texts.
IMPORT_C void	SetHeaderText (TDesC *aHeader)
	Sets the dialogs header texts.
IMPORT_C void	SetHeaderText (const TDesC &aHeader)
	Sets the dialogs header texts.
IMPORT_C	CAknMessageQueryDialog ()
	C++ default constructor.
Static Public Member Functions
static IMPORT_C CAknMessageQueryDialog *	NewL (TDesC &aMessage, const TTone &aTone=ENoTone)
	Two-phased constructor.
Protected Member Functions
virtual IMPORT_C void	PreLayoutDynInitL ()
	From `CEikDialog`.
virtual IMPORT_C void	SetSizeAndPosition (const TSize &aSize)
	From `CEikDialog`.
virtual IMPORT_C void	PostLayoutDynInitL ()
	From `CEikDialog`.

Constructor & Destructor Documentation

IMPORT_C CAknMessageQueryDialog::~CAknMessageQueryDialog

(

)

Destructor.

IMPORT_C CAknMessageQueryDialog::CAknMessageQueryDialog

C++ default constructor.

Parameters:

aTone

Tone played with the dialog.

IMPORT_C CAknMessageQueryDialog::CAknMessageQueryDialog	(	TDesC *	aMessage,
		TDesC *	aHeader
	)

C++ default constructor.

Parameters:

	aMessage	Dialog box text.
	aHeader	Header for the dialog.

Deprecated:

IMPORT_C CAknMessageQueryDialog::CAknMessageQueryDialog	(	TDesC *	aMessage,
		TDesC *	aHeader,
		CEikImage *	aHeaderImage
	)

C++ default constructor.

Parameters:

	aMessage	Dialog box text.
	aHeader	Header for the dialog.
	aHeaderImage	Image to be inserted to the header.

Deprecated:

IMPORT_C CAknMessageQueryDialog::CAknMessageQueryDialog	(	TDesC *	aMessage,
		TDesC *	aHeader,
		const TTone	aTone
	)

C++ default constructor.

Parameters:

	aMessage	Dialog box text.
	aHeader	Header for the dialog.
	aTone	Tone for the dialog.

Deprecated:

IMPORT_C CAknMessageQueryDialog::CAknMessageQueryDialog	(	TDesC *	aMessage,
		TDesC *	aHeader,
		CEikImage *	aHeaderImage,
		const TTone	aTone
	)

C++ default constructor.

Parameters:

	aMessage	Dialog box text.
	aHeader	Header for the dialog.
	aHeaderImage	Image to be used in the header.
	aTone	Ton for the dialog.

Deprecated:

IMPORT_C CAknMessageQueryDialog::CAknMessageQueryDialog

(

)

C++ default constructor.

Deprecated:

Member Function Documentation

void CAknMessageQueryDialog::CheckLinkTappedL

Checks if a link is tapped.

If yes and the pointer event was of type TPointerEvent::EButton1Up, then calls the callback for the tapped link.

Parameters:

aParams

information on the position tapped and the pointer event

IMPORT_C void CAknMessageQueryDialog::HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

From CCoeControl.

Handles pointer events

Parameters:

aPointerEvent

The pointer event.

Reimplemented from CAknQueryDialog.

static IMPORT_C CAknMessageQueryDialog* CAknMessageQueryDialog::NewL	(	TDesC &	aMessage,
		const TTone &	aTone = `ENoTone`
	)	`[static]`

Two-phased constructor.

Parameters:

	aMessage	Text for the dialog.
	aTone=ENoTone	Tone played by the dialog.

IMPORT_C TKeyResponse CAknMessageQueryDialog::OfferKeyEventL	(	const TKeyEvent &	aKeyEvent,
		TEventCode
	)

From CCoeControl.

Handles key events.

If a control wishes to process key events, it should implement this function. The implementation must ensure that the function returns EKeyWasNotConsumed if it does not do anything in response to a key event, otherwise, other controls or dialogs may be prevented from receiving the key event. If it is able to process the event it should return EKeyWasConsumed.

Parameters:

	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.

Reimplemented from CAknQueryDialog.

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

From CEikDialog.

Not implemented.

Reimplemented from CAknQueryDialog.

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

From CEikDialog.

Should be derived to perform pre-layout dialog initialisation.

This function is called by the dialog framework before the dialog is sized and laid out. It may be overloaded to initialise the control values that should influence sizing and layout, the default implementation is empty.

Reimplemented from CAknQueryDialog.

virtual IMPORT_C void CAknMessageQueryDialog::ProcessCommandL ( TInt aCommandId ) [virtual]

From MEikCommandObserver.

Acts on the menu selection if menu is showing - pass on to client if not processed here.

Responds to EAknSoftkeyView and EAknSoftkeyEmpty commands.

Reimplemented from CAknDialog.

IMPORT_C void CAknMessageQueryDialog::SetHeaderText

Sets the dialogs header texts.

Parameters:

aHeader

Text to be inserter into the dialogs header.

Deprecated:

IMPORT_C void CAknMessageQueryDialog::SetHeaderText

Sets the dialogs header texts.

Parameters:

aHeader

Text to be inserter into the dialogs header.

Deprecated:

IMPORT_C void CAknMessageQueryDialog::SetHeaderTextL

Sets header text.

Parameters:

aHeader

Message query header text

Deprecated:

use Heading() + CAknPopupHeadingPane API instead

Reimplemented from CAknQueryDialog.

IMPORT_C void CAknMessageQueryDialog::SetLink

Binds a callback to your link so that the dialog knows which callback to call when a link is activated by the user.

Parameters:

aCallBack

Points to function which is executed when a link is activated by a user.

IMPORT_C void CAknMessageQueryDialog::SetLinkTextL

Deprecated:

use tags within text instead.

Changes the first occurance of aLinkText to a link within the Message. If you have many links with the same name, the method will set the links in the order you call them. Before you set a new link you have to bind the previous one with a callback by calling SetLink() function.

Note that you don't have to call this function if you have already marked your links between tags

and

in the Message. In that case only SetLink() method is used.

Parameters:


  aLinkText  Link text inside message.

IMPORT_C void CAknMessageQueryDialog::SetMessageText

Sets the dialogs texts.

Deprecated:

Parameters:

aMessage

Text to be inserter into the dialog.

IMPORT_C void CAknMessageQueryDialog::SetMessageText

Sets the dialogs texts.

Parameters:

aMessage

Text to be inserter into the dialog.

Deprecated:

IMPORT_C void CAknMessageQueryDialog::SetMessageTextL

Sets message text.

If you have links in your message you can mark link texts between tags

and

in the message text. For links see also SetLink. Bold text can be achieved using tags

and

Parameters:


  aMessage  Message text inside query. Insert '\n' to get new line.

virtual IMPORT_C void CAknMessageQueryDialog::SetSizeAndPosition ( const TSize & aSize ) [protected, virtual]

From CEikDialog.

Sets the size and position of the dialog.

Positions the dialog in the centre of the screen by default.

Parameters:

aSize

Not used.

Reimplemented from CAknQueryDialog.

The documentation for this class was generated from the following file:

aknmessagequerydialog.h

CAknMessageQueryDialog Class Reference

Capability Information

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation