2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * under the terms of "Eclipse Public License v1.0"
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
15 * CAknWaitDialog should be used when the progress of the process cannot be
16 * traced and the length of the process is unknown. If that's not the case
17 * please use CAknProgressDialog.
22 #ifndef __AKN_WAIT_DIALOG__
23 #define __AKN_WAIT_DIALOG__
25 #include <AknProgressDialog.h>
28 * This class is exactly like CAknProgressDialog except it should be used
29 * when the progress of the process cannot be
30 * traced and the length of the process is unknown. If that's not the case
31 * please use CAknProgressDialog.
33 * @see CAknProgressDialog
36 * iWaitDialog = new(ELeave)CAknWaitDialog(
37 * (REINTERPRET_CAST(CEikDialog**,&iWaitDialog)));
38 * iWaitDialog->SetTone( CAknNoteDialog::EConfirmationTone );
39 * iWaitDialog->ExecuteLD(R_WAIT_NOTE);
42 * iWaitDialog->ProcessFinishedL(); // deletes the dialog
45 * To get a callback when/if the dialog has been dismissed
46 * use SetCallBack API (for more info see aknprogressdialog.h) or
47 * make your dialog modal. If the dialog is used as a modal, RunDlgLD
48 * returns 0 if the dialog is dismissed and EAknSoftkeyDone if not.
51 * - Always set EEikDialogFlagNotifyEsc. (or use preset avkon
52 * dialog resource flag, i.e. EAknWaitNoteFlags).
53 * - To make a dialog modal use EEikDialogFlagWait
55 * Note! Dialog should be dismissed only by using ProcessFinishedL() method,
56 * it should not be deleted directly (i.e. delete iWaitDialog)!!!
60 class CAknWaitDialog : public CAknProgressDialog
66 * @param aSelfPtr Pointer to itself. The pointer needs to be
67 * valid when the dialog is dismissed and must not
70 IMPORT_C CAknWaitDialog(CEikDialog** aSelfPtr);
75 * @param aSelfPtr Pointer to itself. The pointer needs to be
76 * valid when the dialog is dismissed and must not
78 * @param aVisibilityDelayOff If set ETrue the dialog will be visible
79 * immediality. Use only when the length of
80 * the process is ALWAYS over 1.5 seconds.
82 IMPORT_C CAknWaitDialog(CEikDialog** aSelfPtr,TBool aVisibilityDelayOff);
86 * Handles pointer events
88 IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
94 IMPORT_C void* ExtensionInterface( TUid aInterface );
97 IMPORT_C virtual void CEikDialog_Reserved_1();
98 IMPORT_C virtual void CEikDialog_Reserved_2();
100 IMPORT_C virtual void CAknNoteDialog_Reserved();
104 * CAknWaitDialog does not support this and hence this method will PANIC.
105 * Therefore do not use it.
107 IMPORT_C CEikProgressInfo* GetProgressInfo();