author | William Roberts <williamr@symbian.org> |
Tue, 16 Mar 2010 16:12:26 +0000 | |
branch | Symbian2 |
changeset 2 | 2fe1408b6811 |
parent 1 | 666f914201fb |
child 4 | 837f303aceeb |
permissions | -rw-r--r-- |
williamr@2 | 1 |
/* |
williamr@2 | 2 |
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). |
williamr@2 | 3 |
* All rights reserved. |
williamr@2 | 4 |
* This component and the accompanying materials are made available |
williamr@2 | 5 |
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
williamr@2 | 6 |
* which accompanies this distribution, and is available |
williamr@2 | 7 |
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
williamr@2 | 8 |
* |
williamr@2 | 9 |
* Initial Contributors: |
williamr@2 | 10 |
* Nokia Corporation - initial contribution. |
williamr@2 | 11 |
* |
williamr@2 | 12 |
* Contributors: |
williamr@2 | 13 |
* |
williamr@2 | 14 |
* Description: |
williamr@2 | 15 |
* CAknWaitDialog should be used when the progress of the process cannot be |
williamr@2 | 16 |
* traced and the length of the process is unknown. If that's not the case |
williamr@2 | 17 |
* please use CAknProgressDialog. |
williamr@2 | 18 |
* |
williamr@2 | 19 |
*/ |
williamr@2 | 20 |
|
williamr@2 | 21 |
|
williamr@2 | 22 |
#ifndef __AKN_WAIT_DIALOG__ |
williamr@2 | 23 |
#define __AKN_WAIT_DIALOG__ |
williamr@2 | 24 |
|
williamr@2 | 25 |
#include <aknprogressdialog.h> |
williamr@2 | 26 |
|
williamr@2 | 27 |
/** |
williamr@2 | 28 |
* This class is exactly like CAknProgressDialog except it should be used |
williamr@2 | 29 |
* when the progress of the process cannot be |
williamr@2 | 30 |
* traced and the length of the process is unknown. If that's not the case |
williamr@2 | 31 |
* please use CAknProgressDialog. |
williamr@2 | 32 |
* |
williamr@2 | 33 |
* @see CAknProgressDialog |
williamr@2 | 34 |
* |
williamr@2 | 35 |
* Usage: |
williamr@2 | 36 |
* iWaitDialog = new(ELeave)CAknWaitDialog( |
williamr@2 | 37 |
* (REINTERPRET_CAST(CEikDialog**,&iWaitDialog))); |
williamr@2 | 38 |
* iWaitDialog->SetTone( CAknNoteDialog::EConfirmationTone ); |
williamr@2 | 39 |
* iWaitDialog->ExecuteLD(R_WAIT_NOTE); |
williamr@2 | 40 |
* |
williamr@2 | 41 |
* // Process finished |
williamr@2 | 42 |
* iWaitDialog->ProcessFinishedL(); // deletes the dialog |
williamr@2 | 43 |
* |
williamr@2 | 44 |
* Callback: |
williamr@2 | 45 |
* To get a callback when/if the dialog has been dismissed |
williamr@2 | 46 |
* use SetCallBack API (for more info see aknprogressdialog.h) or |
williamr@2 | 47 |
* make your dialog modal. If the dialog is used as a modal, RunDlgLD |
williamr@2 | 48 |
* returns 0 if the dialog is dismissed and EAknSoftkeyDone if not. |
williamr@2 | 49 |
* |
williamr@2 | 50 |
* Resource flags: |
williamr@2 | 51 |
* - Always set EEikDialogFlagNotifyEsc. (or use preset avkon |
williamr@2 | 52 |
* dialog resource flag, i.e. EAknWaitNoteFlags). |
williamr@2 | 53 |
* - To make a dialog modal use EEikDialogFlagWait |
williamr@2 | 54 |
* |
williamr@2 | 55 |
* Note! Dialog should be dismissed only by using ProcessFinishedL() method, |
williamr@2 | 56 |
* it should not be deleted directly (i.e. delete iWaitDialog)!!! |
williamr@2 | 57 |
* |
williamr@2 | 58 |
*/ |
williamr@2 | 59 |
|
williamr@2 | 60 |
class CAknWaitDialog : public CAknProgressDialog |
williamr@2 | 61 |
{ |
williamr@2 | 62 |
public: |
williamr@2 | 63 |
/** |
williamr@2 | 64 |
* A class constructor |
williamr@2 | 65 |
* |
williamr@2 | 66 |
* @param aSelfPtr Pointer to itself. The pointer needs to be |
williamr@2 | 67 |
* valid when the dialog is dismissed and must not |
williamr@2 | 68 |
* be on the stack. |
williamr@2 | 69 |
*/ |
williamr@2 | 70 |
IMPORT_C CAknWaitDialog(CEikDialog** aSelfPtr); |
williamr@2 | 71 |
|
williamr@2 | 72 |
/** |
williamr@2 | 73 |
* A class constructor |
williamr@2 | 74 |
* |
williamr@2 | 75 |
* @param aSelfPtr Pointer to itself. The pointer needs to be |
williamr@2 | 76 |
* valid when the dialog is dismissed and must not |
williamr@2 | 77 |
* be on the stack. |
williamr@2 | 78 |
* @param aVisibilityDelayOff If set ETrue the dialog will be visible |
williamr@2 | 79 |
* immediality. Use only when the length of |
williamr@2 | 80 |
* the process is ALWAYS over 1.5 seconds. |
williamr@2 | 81 |
*/ |
williamr@2 | 82 |
IMPORT_C CAknWaitDialog(CEikDialog** aSelfPtr,TBool aVisibilityDelayOff); |
williamr@2 | 83 |
|
williamr@2 | 84 |
/** |
williamr@2 | 85 |
* From CCoeControl |
williamr@2 | 86 |
* Handles pointer events |
williamr@2 | 87 |
*/ |
williamr@2 | 88 |
IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent); |
williamr@2 | 89 |
|
williamr@2 | 90 |
private: |
williamr@2 | 91 |
/** |
williamr@2 | 92 |
* From CAknControl |
williamr@2 | 93 |
*/ |
williamr@2 | 94 |
IMPORT_C void* ExtensionInterface( TUid aInterface ); |
williamr@2 | 95 |
|
williamr@2 | 96 |
private: |
williamr@2 | 97 |
IMPORT_C virtual void CEikDialog_Reserved_1(); |
williamr@2 | 98 |
IMPORT_C virtual void CEikDialog_Reserved_2(); |
williamr@2 | 99 |
private: |
williamr@2 | 100 |
IMPORT_C virtual void CAknNoteDialog_Reserved(); |
williamr@2 | 101 |
public: |
williamr@2 | 102 |
|
williamr@2 | 103 |
/** |
williamr@2 | 104 |
* CAknWaitDialog does not support this and hence this method will PANIC. |
williamr@2 | 105 |
* Therefore do not use it. |
williamr@2 | 106 |
*/ |
williamr@2 | 107 |
IMPORT_C CEikProgressInfo* GetProgressInfo(); |
williamr@2 | 108 |
|
williamr@2 | 109 |
private: |
williamr@2 | 110 |
TInt iSpare; |
williamr@2 | 111 |
|
williamr@2 | 112 |
}; |
williamr@2 | 113 |
|
williamr@2 | 114 |
#endif |