aknglobalprogressdialog.h

00001 /*
00002 * ============================================================================
00003 *  Name        : CAknGlobalProgressDialog.h
00004 *  Part of     : UI Framework Core / AVKON Notifiers Client
00005 *  Description : Uses notification framework to show a global progress dialog.
00006 *  Version     : %version: %
00007 *
00008 *  Copyright © 2002-2007 Nokia.  All rights reserved.
00009 *  This material, including documentation and any related computer
00010 *  programs, is protected by copyright controlled by Nokia.  All
00011 *  rights are reserved.  Copying, including reproducing, storing,
00012 *  adapting or translating, any or all of this material requires the
00013 *  prior written consent of Nokia.  This material also contains
00014 *  confidential information which may not be disclosed to others
00015 *  without the prior written consent of Nokia.
00016 * ============================================================================
00017 */
00018 #ifndef __AKNGLOBALPROGRESSDIALOG_H__
00019 #define __AKNGLOBALPROGRESSDIALOG_H__
00020 
00021 #include <AknNotify.h>
00022 #include <aknnotifystd.h>
00023 #include <aknprogressdialog.h>
00024 #include <AknsItemID.h>
00025 
00026 class CAknSDData;
00027 
00086 NONSHARABLE_CLASS(CAknGlobalProgressDialog) : public CBase
00087     {
00088     public:
00089         IMPORT_C static CAknGlobalProgressDialog* NewL();
00090         IMPORT_C static CAknGlobalProgressDialog* NewLC();
00091         IMPORT_C ~CAknGlobalProgressDialog();
00092 
00102         IMPORT_C void SetIconL( const TDesC& aIconText,
00103                                 const TDesC& aIconFile,
00104                                 TInt aIconId = 0,
00105                                 TInt aIconMaskId = -1 );
00106 
00117         IMPORT_C void SetImageL( 
00118             const TDesC& aImageFile,
00119             TInt aImageId = 0,
00120             TInt aImageMaskId = -1 );
00121 
00134         IMPORT_C void ShowProgressDialogL( 
00135             TRequestStatus& aStatus,
00136             const TDesC& aPrompt,
00137             TInt aSoftkeys = 0,
00138             TInt aFinalValue = 0,
00139             CAknNoteDialog::TTone aTone = CAknNoteDialog::ENoTone );
00140 
00148         IMPORT_C void UpdateProgressDialog( 
00149             TInt aValue, 
00150             TInt aFinalValue = -1 );
00151 
00157         IMPORT_C void ProcessFinished();
00158 
00163         IMPORT_C void CancelProgressDialog();
00164 
00176         IMPORT_C void SetImageSkinIds( TAknsItemID& aImageId, TAknsItemID& aIconId );
00177         
00187         IMPORT_C void SetSecondaryDisplayData(CAknSDData* aData);
00188     
00189     private:
00193         CAknGlobalProgressDialog();
00194 
00198         void ConstructL(); 
00199 
00203         void UpdateNotifier();
00204 
00205     private:
00206         // Command send to server.
00207         TAknGlobalQueryCmd iCmd;
00208         // Final value of the process.
00209         TInt iFinalValue;
00210         // Current value of the process.
00211         TInt iValue;
00212         // Handle to session with notify server.
00213         RNotifier iNotify;
00214         // Buffer used to pass parameters to server.
00215         CBufFlat *iBuffer;
00216         // Pointer to iBuffer
00217         TPtrC8 iBufferPtr;
00218 
00219         // Id of the image.
00220         TInt iImageId;
00221         // Id of the image's mask.
00222         TInt iImageMaskId;
00223         // Id of the icon.
00224         TInt iIconId;
00225         // Id of the icon's mask.
00226         TInt iIconMaskId;
00227 
00228         // Icon's text.
00229         HBufC* iIconText;
00230         // Icon file name.
00231         HBufC* iIconFile;
00232         // Image file name.
00233         HBufC* iImageFile;
00234 
00235         TInt   iImageSkinsMajorId;
00236         TInt   iImageSkinsMinorId;
00237 
00238         TInt   iIconSkinsMajorId;
00239         TInt   iIconSkinsMinorId;
00240         CAknSDData* iAknSDData;
00241         TBuf8<1> iResultBuf; // Not really used, but needed to prevent buffer handling errors.
00242     };
00243 
00244 // __AKNGLOBALPROGRESSDIALOG_H__
00245 #endif