CAknGlobalConfirmationQuery Class Reference
API published in: S60 1st Ed
Link against: aknnotify.lib eiksrv.lib
Capability Information
Required Capabilities
None
#include <aknglobalconfirmationquery.h>
Detailed Description
CAknGlobalConfirmationQuery Uses notification framework to show a global confirmation query.
Usage: Create an active object, start it and pass its TRequestStatus as a parameter to ShowConfirmationQueryL. After the user
presses a softkey, the request status will hold the id of the pressed softkey. E.g. If the user selected Cancel, the request
status will hold -1.
Example 1. Show the global confirmation query: if ( iConfObserver ) { iConfObserver->Cancel(); delete iConfObserver; } iConfObserver
= new(ELeave) CGlobalConfirmationObserver(iEikonEnv); iConfObserver->Start(); iGlobalConfirmationQuery->ShowMsgQueryL( iConfObserver->iStatus,
iPrompt, R_AVKON_SOFTKEYS_OK_CANCEL, R_QUERY_NOTE_ANIMATION);
Example 2. Get and handle the result in active object. void CMyActiveObject::RunL() { TBuf<120> msg = _L("Received: "); msg.AppendNum(
iStatus.Int() ); iEnv->InfoMsg(msg); Cancel(); }
Example 3. Update the query (softkeys) iGlobalConfirmationQuery->UpdateConfirmationQuery( R_AVKON_SOFTKEYS_BACK );
Example 4. Cancel the query iGlobalConfirmationQuery->CancelConfirmationQuery();
NOTE !!! All descriptors passed as parameters need to be class members, i.e. they cannot be local variables of a method. That
is because they need to exist when server gets the message.
Constructor & Destructor Documentation
| IMPORT_C CAknGlobalConfirmationQuery::~CAknGlobalConfirmationQuery |
( |
|
) |
|
|
Member Function Documentation
| IMPORT_C void CAknGlobalConfirmationQuery::CancelConfirmationQuery |
( |
|
) |
|
|
|
|
Cancel the confirmation query.
|
| IMPORT_C void CAknGlobalConfirmationQuery::SetImageSkinId |
( |
TAknsItemID &
|
aId
|
) |
|
|
|
|
Set skin id for query image.
Must be called before ShowConfirmationQueryL in order to have effect. No need to use this method if image from avkon.mbm is
used.
aId SkinId for image in query. If image is not found from the active skin, image definitions used in ShowConfirmationQueryL
are used instead.
|
| IMPORT_C void CAknGlobalConfirmationQuery::SetSecondaryDisplayData |
( |
CAknSDData * |
aData
|
) |
|
|
|
|
Sets additional information to be sent to secondary display.
Takes ownership of object. Must be called before sending data to notifier to have effect.
- Parameters:
-
|
aData
|
Data to be sent to cover UI. |
|
| IMPORT_C void CAknGlobalConfirmationQuery::ShowConfirmationQueryL |
( |
TRequestStatus & |
aStatus,
|
|
|
const TDesC & |
aPrompt,
|
|
|
TInt |
aSoftkeys = 0,
|
|
|
TInt |
aAnimation = 0,
|
|
|
const TDesC & |
aImageFile = KNullDesC,
|
|
|
TInt |
aImageId = 0,
|
|
|
TInt |
aImageMaskId = 0,
|
|
|
CAknQueryDialog::TTone
|
aTone = CAknQueryDialog::ENoTone,
|
|
|
TBool |
aDismissWithAllKeys = EFalse |
|
) |
|
|
|
|
Shows global confirmation query synchronously.
- Parameters:
-
|
aStatus
|
TRequestStatus which will be completed when user selects one item from the list query. |
|
aPrompt
|
Prompt text. |
|
aSoftkeys
|
Softkey resource. |
|
aAnimation
|
Animation resource. |
|
aTone
|
Tone id. |
|
aDismissWithAllKeys
|
If set ETrue the query gets dismissed with all keypresses. |
|
| IMPORT_C void CAknGlobalConfirmationQuery::UpdateConfirmationQuery |
( |
TInt |
aSoftkeys
|
) |
|
|
|
|
Update the softkeys of the confirmation query.
- Parameters:
-
|
aSoftkeys
|
New resource for softkeys. |
|
The documentation for this class was generated from the following file:
