btobexprofiles/obexserviceman/utils/inc/obexutilsdialog.h
author hgs
Fri, 28 May 2010 17:03:06 +0300
changeset 32 19bd632b5100
child 40 997690c3397a
permissions -rw-r--r--
201021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
32
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: 
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef COBEXUTILSDIALOG_H
hgs
parents:
diff changeset
    20
#define COBEXUTILSDIALOG_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
//  INCLUDES
hgs
parents:
diff changeset
    23
#include    <e32base.h>
hgs
parents:
diff changeset
    24
#include    <AknWaitDialog.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    27
class CAknWaitDialog;
hgs
parents:
diff changeset
    28
class CObexUtilsDialogTimer;
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// CLASS DECLARATION
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
/**
hgs
parents:
diff changeset
    33
*  An observer interface for asking progress status of an operation using 
hgs
parents:
diff changeset
    34
*  a progress dialog.
hgs
parents:
diff changeset
    35
*/
hgs
parents:
diff changeset
    36
NONSHARABLE_CLASS(  MObexUtilsProgressObserver )
hgs
parents:
diff changeset
    37
    {
hgs
parents:
diff changeset
    38
    public:
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
        /**
hgs
parents:
diff changeset
    41
        * Returns the progress status of the operation.
hgs
parents:
diff changeset
    42
        * @since 2.6
hgs
parents:
diff changeset
    43
        * @return A progress value relative to final value.
hgs
parents:
diff changeset
    44
        */
hgs
parents:
diff changeset
    45
        virtual TInt GetProgressStatus() = 0;
hgs
parents:
diff changeset
    46
    };
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
// CLASS DECLARATION
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
/**
hgs
parents:
diff changeset
    51
*  An observer interface for informing about dialog events.
hgs
parents:
diff changeset
    52
*/
hgs
parents:
diff changeset
    53
NONSHARABLE_CLASS(  MObexUtilsDialogObserver )
hgs
parents:
diff changeset
    54
    {
hgs
parents:
diff changeset
    55
    public:
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
        /**
hgs
parents:
diff changeset
    58
        * Informs the observer that a dialog has been dismissed.
hgs
parents:
diff changeset
    59
        * @since 2.6
hgs
parents:
diff changeset
    60
        * @param aButtonId The button that was used to dismiss the dialog.
hgs
parents:
diff changeset
    61
        * @return None.
hgs
parents:
diff changeset
    62
        */
hgs
parents:
diff changeset
    63
        virtual void DialogDismissed( TInt aButtonId ) = 0;
hgs
parents:
diff changeset
    64
    };
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
// CLASS DECLARATION
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
/**
hgs
parents:
diff changeset
    70
*  A class for launching and managing dialogs.
hgs
parents:
diff changeset
    71
*/
hgs
parents:
diff changeset
    72
NONSHARABLE_CLASS( CObexUtilsDialog ) : public CBase, public MProgressDialogCallback
hgs
parents:
diff changeset
    73
    {
hgs
parents:
diff changeset
    74
    public:// Constructors and destructor
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
        /**
hgs
parents:
diff changeset
    77
        * Two-phased constructor.
hgs
parents:
diff changeset
    78
        */
hgs
parents:
diff changeset
    79
        IMPORT_C static CObexUtilsDialog* NewL( 
hgs
parents:
diff changeset
    80
            MObexUtilsDialogObserver* aObserverPtr );        
hgs
parents:
diff changeset
    81
        
hgs
parents:
diff changeset
    82
        IMPORT_C static CObexUtilsDialog* NewLC( 
hgs
parents:
diff changeset
    83
            MObexUtilsDialogObserver* aObserverPtr );
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
        /**
hgs
parents:
diff changeset
    86
        * Destructor.
hgs
parents:
diff changeset
    87
        */
hgs
parents:
diff changeset
    88
        virtual ~CObexUtilsDialog();
hgs
parents:
diff changeset
    89
   
hgs
parents:
diff changeset
    90
    public: // New functions
hgs
parents:
diff changeset
    91
        
hgs
parents:
diff changeset
    92
        /**
hgs
parents:
diff changeset
    93
        * Launches a progress dialog.
hgs
parents:
diff changeset
    94
        * @since 2.6
hgs
parents:
diff changeset
    95
        * @param aObserverPtr A pointer to progress observer. A NULL pointer if 
hgs
parents:
diff changeset
    96
                              the progress dialog is updated manually.
hgs
parents:
diff changeset
    97
        * @param aFinalValue The final value of the operation (progress=100%).
hgs
parents:
diff changeset
    98
        * @param aResId A resource id for the string to be shown in the dialog.
hgs
parents:
diff changeset
    99
        * @param aTimeoutValue A value telling how often should the dialog be
hgs
parents:
diff changeset
   100
                               updated. Relevant only if observer given.
hgs
parents:
diff changeset
   101
        * @return None.
hgs
parents:
diff changeset
   102
        */
hgs
parents:
diff changeset
   103
        IMPORT_C void LaunchProgressDialogL( 
hgs
parents:
diff changeset
   104
            MObexUtilsProgressObserver* aObserverPtr, TInt aFinalValue, 
hgs
parents:
diff changeset
   105
            TInt aResId, TInt aTimeoutValue );    
hgs
parents:
diff changeset
   106
        
hgs
parents:
diff changeset
   107
        /**
hgs
parents:
diff changeset
   108
        * Launches a wait dialog.
hgs
parents:
diff changeset
   109
        * @since 2.6
hgs
parents:
diff changeset
   110
        * @param aResId A resource id for the string to be shown in the dialog.
hgs
parents:
diff changeset
   111
        * @return None.
hgs
parents:
diff changeset
   112
        */
hgs
parents:
diff changeset
   113
        IMPORT_C void LaunchWaitDialogL( TInt aResId );
hgs
parents:
diff changeset
   114
        
hgs
parents:
diff changeset
   115
        /**
hgs
parents:
diff changeset
   116
        * Cancels a wait dialog if one exists.
hgs
parents:
diff changeset
   117
        * @since 2.6        
hgs
parents:
diff changeset
   118
        * @return None.
hgs
parents:
diff changeset
   119
        */
hgs
parents:
diff changeset
   120
        IMPORT_C void CancelWaitDialogL();
hgs
parents:
diff changeset
   121
        
hgs
parents:
diff changeset
   122
        /**
hgs
parents:
diff changeset
   123
        * Cancels a wait progress dialog if one exists.
hgs
parents:
diff changeset
   124
        * @since 2.6       
hgs
parents:
diff changeset
   125
        * @return None.
hgs
parents:
diff changeset
   126
        */
hgs
parents:
diff changeset
   127
        IMPORT_C void CancelProgressDialogL();
hgs
parents:
diff changeset
   128
        
hgs
parents:
diff changeset
   129
        /**
hgs
parents:
diff changeset
   130
        * Updates a progress dialog. Should not be used if the 
hgs
parents:
diff changeset
   131
        * MObexUtilsDialogObserver pointer was given.
hgs
parents:
diff changeset
   132
        * @since 2.6
hgs
parents:
diff changeset
   133
        * @param aValue A progress value relative to final value.
hgs
parents:
diff changeset
   134
        * @param aResId A resource id for the string to be shown in the dialog.
hgs
parents:
diff changeset
   135
        * @return None
hgs
parents:
diff changeset
   136
        */
hgs
parents:
diff changeset
   137
        IMPORT_C void UpdateProgressDialogL( TInt aValue, TInt aResId );
hgs
parents:
diff changeset
   138
        
hgs
parents:
diff changeset
   139
        /**
hgs
parents:
diff changeset
   140
        * Show a query note
hgs
parents:
diff changeset
   141
        * @param aResourceID A resource id for the note.
hgs
parents:
diff changeset
   142
        * @return User's input - Yes/No
hgs
parents:
diff changeset
   143
        */
hgs
parents:
diff changeset
   144
        IMPORT_C TInt LaunchQueryDialogL( const TInt& aResourceID );
hgs
parents:
diff changeset
   145
        
hgs
parents:
diff changeset
   146
        /**
hgs
parents:
diff changeset
   147
        * Show how many files are sent in case not all images are supported
hgs
parents:
diff changeset
   148
        * @param aSentNum Number of sent files
hgs
parents:
diff changeset
   149
        * @param aTotlNum Number of total files
hgs
parents:
diff changeset
   150
        * return None.
hgs
parents:
diff changeset
   151
        */
hgs
parents:
diff changeset
   152
        
hgs
parents:
diff changeset
   153
        IMPORT_C void ShowNumberOfSendFileL( TInt aSentNum, TInt aTotalNum );
hgs
parents:
diff changeset
   154
hgs
parents:
diff changeset
   155
        /**
hgs
parents:
diff changeset
   156
        * Prepares dialog for execution
hgs
parents:
diff changeset
   157
        * @param aResourceID Resource ID of the dialog
hgs
parents:
diff changeset
   158
        * @param aDialog Dialog
hgs
parents:
diff changeset
   159
        */
hgs
parents:
diff changeset
   160
        void PrepareDialogExecuteL( const TInt& aResourceID, CEikDialog* aDialog );
hgs
parents:
diff changeset
   161
hgs
parents:
diff changeset
   162
        /**
hgs
parents:
diff changeset
   163
        * Check if cover display is enabled
hgs
parents:
diff changeset
   164
        * return True if enabled
hgs
parents:
diff changeset
   165
        */
hgs
parents:
diff changeset
   166
        TBool IsCoverDisplayL();
hgs
parents:
diff changeset
   167
hgs
parents:
diff changeset
   168
    public: // New functions (not exported)
hgs
parents:
diff changeset
   169
hgs
parents:
diff changeset
   170
        /**
hgs
parents:
diff changeset
   171
        * Updates the progress dialog.
hgs
parents:
diff changeset
   172
        * @return None.
hgs
parents:
diff changeset
   173
        */
hgs
parents:
diff changeset
   174
        void UpdateProgressDialog();
hgs
parents:
diff changeset
   175
hgs
parents:
diff changeset
   176
    private: // Functions from base classes
hgs
parents:
diff changeset
   177
hgs
parents:
diff changeset
   178
        /**
hgs
parents:
diff changeset
   179
        * From MProgressDialogCallback A dialog has been dismissed.
hgs
parents:
diff changeset
   180
        * @param aButtonId The button that was used to dismiss the dialog.
hgs
parents:
diff changeset
   181
        * @return None.
hgs
parents:
diff changeset
   182
        */
hgs
parents:
diff changeset
   183
        void DialogDismissedL( TInt aButtonId );
hgs
parents:
diff changeset
   184
hgs
parents:
diff changeset
   185
    private:
hgs
parents:
diff changeset
   186
        TInt ExecuteDialogL( const TInt& aResourceID, CEikDialog* aDialog );
hgs
parents:
diff changeset
   187
hgs
parents:
diff changeset
   188
    private:
hgs
parents:
diff changeset
   189
hgs
parents:
diff changeset
   190
        /**
hgs
parents:
diff changeset
   191
        * C++ default constructor.
hgs
parents:
diff changeset
   192
        */
hgs
parents:
diff changeset
   193
        CObexUtilsDialog( MObexUtilsDialogObserver* aObserverPtr );
hgs
parents:
diff changeset
   194
	
hgs
parents:
diff changeset
   195
        /**
hgs
parents:
diff changeset
   196
        * By default Symbian OS constructor is private.
hgs
parents:
diff changeset
   197
        */
hgs
parents:
diff changeset
   198
        void ConstructL();
hgs
parents:
diff changeset
   199
hgs
parents:
diff changeset
   200
    private: // Data
hgs
parents:
diff changeset
   201
hgs
parents:
diff changeset
   202
        CAknProgressDialog*         iProgressDialog;
hgs
parents:
diff changeset
   203
        CAknWaitDialog*             iWaitDialog;
hgs
parents:
diff changeset
   204
        CObexUtilsDialogTimer*      iObexDialogTimer;
hgs
parents:
diff changeset
   205
        TInt                        iResourceFileId;
hgs
parents:
diff changeset
   206
        TInt                        iProgressDialogResId;
hgs
parents:
diff changeset
   207
        TBool                       iCoverDisplayEnabled;
hgs
parents:
diff changeset
   208
hgs
parents:
diff changeset
   209
        // Not Owned
hgs
parents:
diff changeset
   210
        //
hgs
parents:
diff changeset
   211
        MObexUtilsProgressObserver* iProgressObserverPtr;
hgs
parents:
diff changeset
   212
        MObexUtilsDialogObserver*   iDialogObserverPtr;
hgs
parents:
diff changeset
   213
    };
hgs
parents:
diff changeset
   214
hgs
parents:
diff changeset
   215
#endif      // COBEXUTILSDIALOG_H
hgs
parents:
diff changeset
   216
            
hgs
parents:
diff changeset
   217
// End of File