#include <mw/aknmessagequerydialog.h>
| class CAknMessageQueryDialog : public CAknQueryDialog |
| Public Member Functions | |
|---|---|
| CAknMessageQueryDialog(const TTone) | |
| CAknMessageQueryDialog(TDesC *, TDesC *) | |
| CAknMessageQueryDialog(TDesC *, TDesC *, CEikImage *) | |
| CAknMessageQueryDialog(TDesC *, TDesC *, const TTone) | |
| CAknMessageQueryDialog(TDesC *, TDesC *, CEikImage *, const TTone) | |
| CAknMessageQueryDialog() | |
| ~CAknMessageQueryDialog() | |
| void | CheckLinkTappedL(TAny *) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| IMPORT_C CAknMessageQueryDialog * | NewL(TDesC &, const TTone &) |
| virtual IMPORT_C TKeyResponse | OfferKeyEventL(const TKeyEvent &, TEventCode) |
| virtual IMPORT_C void | ProcessCommandL(TInt) |
| IMPORT_C void | SetHeaderText(TDesC *) |
| IMPORT_C void | SetHeaderText(const TDesC &) |
| IMPORT_C void | SetHeaderTextL(const TDesC &) |
| IMPORT_C void | SetLink(TCallBack &) |
| IMPORT_C void | SetLinkTextL(const TDesC &) |
| IMPORT_C void | SetMessageText(TDesC *) |
| IMPORT_C void | SetMessageText(const TDesC &) |
| IMPORT_C void | SetMessageTextL(const TDesC &) |
| void | UpdateSoftkeyLabels() |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C void | PostLayoutDynInitL() |
| virtual IMPORT_C void | PreLayoutDynInitL() |
| virtual IMPORT_C void | SetSizeAndPosition(const TSize &) |
| Inherited Enumerations | |
|---|---|
| CAknQueryDialog:TTone | |
| CCoeControl:TZoomType | |
| CEikDialog:@115 | |
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.
| IMPORT_C | CAknMessageQueryDialog | ( | const TTone | aTone | ) |
C++ default constructor.
| Parameter | Description |
|---|---|
| aTone | Tone played with the dialog. |
C++ default constructor.
| Parameter | Description |
|---|---|
| aMessage | Dialog box text. |
| aHeader | Header for the dialog. |
C++ default constructor.
| Parameter | Description |
|---|---|
| aMessage | Dialog box text. |
| aHeader | Header for the dialog. |
| aHeaderImage | Image to be inserted to the header. |
C++ default constructor.
| Parameter | Description |
|---|---|
| aMessage | Dialog box text. |
| aHeader | Header for the dialog. |
| aTone | Tone for the dialog. |
| void | CheckLinkTappedL | ( | TAny * | aParams | ) |
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.
| Parameter | Description |
|---|---|
| aParams | information on the position tapped and the pointer event |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CAknQueryDialog::HandlePointerEventL(const TPointerEvent &)
From CCoeControl.
Handles pointer events
| Parameter | Description |
|---|---|
| aPointerEvent | The pointer event. |
| IMPORT_C CAknMessageQueryDialog * | NewL | ( | TDesC & | aMessage, |
| const TTone & | aTone = ENoTone | |||
| ) | [static] | |||
Two-phased constructor.
| Parameter | Description |
|---|---|
| aMessage | Text for the dialog. |
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | ||||
| ) | [virtual] | |||
Reimplemented from CAknQueryDialog::OfferKeyEventL(const TKeyEvent &,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.
| Parameter | Description |
|---|---|
| aKeyEvent | The key event. |
Returns: Indicates whether or not the key event was used by this control.
| IMPORT_C void | PostLayoutDynInitL | ( | ) | [protected, virtual] |
Reimplemented from CAknQueryDialog::PostLayoutDynInitL()
From CEikDialog
Not implemented.
| IMPORT_C void | PreLayoutDynInitL | ( | ) | [protected, virtual] |
Reimplemented from CAknQueryDialog::PreLayoutDynInitL(void)
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.
| IMPORT_C void | ProcessCommandL | ( | TInt | aCommandId | ) | [virtual] |
Reimplemented from CAknDialog::ProcessCommandL(TInt)
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.
| IMPORT_C void | SetHeaderText | ( | TDesC * | aHeader | ) |
Sets the dialogs header texts.
| Parameter | Description |
|---|---|
| aHeader | Text to be inserter into the dialogs header. |
| IMPORT_C void | SetHeaderText | ( | const TDesC & | aHeader | ) |
Sets the dialogs header texts.
| Parameter | Description |
|---|---|
| aHeader | Text to be inserter into the dialogs header. |
| IMPORT_C void | SetHeaderTextL | ( | const TDesC & | aHeader | ) |
Reimplemented from CAknQueryDialog::SetHeaderTextL(const TDesC &)
Sets header text.
use Heading() + CAknPopupHeadingPane API instead
| Parameter | Description |
|---|---|
| aHeader | Message query header text |
| 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.
| Parameter | Description |
|---|---|
| aCallBack | Points to function which is executed when a link is activated by a user. |
| IMPORT_C void | SetLinkTextL | ( | const TDesC & | aLinkText | ) |
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 <AknMessageQuery link>=""> and </AknMessageQuery> in the Message. In that case only SetLink() method is used.
| Parameter | Description |
|---|---|
| aLinkText | Link text inside message. |
| IMPORT_C void | SetMessageText | ( | TDesC * | aMessage | ) |
Sets the dialogs texts.
| Parameter | Description |
|---|---|
| aMessage | Text to be inserter into the dialog. |
| IMPORT_C void | SetMessageText | ( | const TDesC & | aMessage | ) |
Sets the dialogs texts.
| Parameter | Description |
|---|---|
| aMessage | Text to be inserter into the dialog. |
| IMPORT_C void | SetMessageTextL | ( | const TDesC & | aMessage | ) |
Sets message text. If you have links in your message you can mark link texts between tags <AknMessageQuery link>=""> and </AknMessageQuery> in the message text. For links see also SetLink. Bold text can be achieved using tags <AknMessageQuery bold>=""> and </AknMessageQuery>
| Parameter | Description |
|---|---|
| aMessage | Message text inside query. Insert '\n' to get new line. |
| IMPORT_C void | SetSizeAndPosition | ( | const TSize & | aSize | ) | [protected, virtual] |
Reimplemented from CAknQueryDialog::SetSizeAndPosition(const TSize &)
From CEikDialog
Sets the size and position of the dialog.
Positions the dialog in the centre of the screen by default.
| Parameter | Description |
|---|---|
| aSize | Not used. |