widgets/widgetinstaller/inc/WidgetInstallerUi.h
changeset 0 dd21522fd290
equal deleted inserted replaced
-1:000000000000 0:dd21522fd290
       
     1 /*
       
     2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "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".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  This file contains the header file of the CWidgetInstallerUI class.
       
    15 *
       
    16 *                This class implements the ECom SWInstUIPluginAPI interface
       
    17 *                for widget installation.
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 #ifndef WIDGETINSTALLERUI_H
       
    23 #define WIDGETINSTALLERUI_H
       
    24 
       
    25 //  INCLUDES
       
    26 #include <SWInstUIPluginAPI.h>
       
    27 
       
    28 // FORWARD DECLARATION
       
    29 class CEikonEnv;
       
    30 
       
    31 namespace SwiUI
       
    32 {
       
    33 
       
    34 // FORWARD DECLARATIONS
       
    35 class CWidgetUIOperationsWatcher;
       
    36 
       
    37 /**
       
    38 * This class implements the ECom SWInstUIPluginAPI interface for WidgetInstaller
       
    39 * installation.
       
    40 *
       
    41 * @lib WidgetInstallerUI
       
    42 * @since 3.1
       
    43 */
       
    44 class CWidgetInstallerUI : public CSWInstUIPluginAPI
       
    45     {
       
    46     public:  // Constructors and destructor
       
    47 
       
    48         /**
       
    49         * Two-phased constructor.
       
    50         */
       
    51         static CWidgetInstallerUI* NewL();
       
    52 
       
    53         /**
       
    54         * Destructor.
       
    55         */
       
    56         virtual ~CWidgetInstallerUI();
       
    57 
       
    58     public:  // From base classes
       
    59 
       
    60        /**
       
    61         * From SWInstUIPlugin, Perform installation.
       
    62         * @since 3.1
       
    63         */
       
    64         void InstallL( RFile& aFile,
       
    65                        TInstallReq& aInstallParams,
       
    66                        TBool aIsDRM,
       
    67                        TRequestStatus& aStatus );
       
    68 
       
    69         /**
       
    70         * From SWInstUIPlugin, Perform silent installation.
       
    71         * @since 3.1
       
    72         */
       
    73         void SilentInstallL( RFile& aFile,
       
    74                              TInstallReq& aInstallParams,
       
    75                              TBool aIsDRM,
       
    76                              TInstallOptions& aOptions,
       
    77                              TRequestStatus& aStatus );
       
    78 
       
    79         /**
       
    80         * From SWInstUIPlugin, Perform uninstallation.
       
    81         * @since 3.1
       
    82         */
       
    83         void UninstallL( const TUid& aUid,
       
    84                          const TDesC8& aMIME,
       
    85                          TRequestStatus& aStatus );
       
    86 
       
    87         /**
       
    88         * From SWInstUIPlugin, Perform silent uninstallation.
       
    89         * @since 3.1
       
    90         */
       
    91         void SilentUninstallL( const TUid& aUid,
       
    92                                const TDesC8& aMIME,
       
    93                                TUninstallOptions& aOptions,
       
    94                                TRequestStatus& aStatus );
       
    95 
       
    96         /**
       
    97         * From SWInstUIPlugin, Indicates if the application shell must be updated.
       
    98         * @since 3.1
       
    99         */
       
   100         TBool IsAppShellUpdate();
       
   101 
       
   102         /**
       
   103         * Cancel the current operation.
       
   104         * @since 3.1
       
   105         */
       
   106         void Cancel();
       
   107 
       
   108         /**
       
   109         * Informs the plugin about completed operation. Called when all tasks are completed.
       
   110         * @since 3.1
       
   111         */
       
   112         void CompleteL();
       
   113 
       
   114         /**        
       
   115         * GetErrorDetails
       
   116         * @since 3.1
       
   117         */
       
   118         CErrDetails* GetErrorDetails();
       
   119 
       
   120         /**
       
   121         * Perform a silent custom uninstallation.
       
   122         * @since 3.1
       
   123         * @param aOperation - The uninstall operation to be performed
       
   124         * @param aParams - Parameters for the operation
       
   125         */
       
   126         void SilentCustomUninstallL( TOperation aOperation,
       
   127                                      TUninstallOptions& aOptions,
       
   128                                      const TDesC8& aParams,
       
   129                                      TRequestStatus& aStatus );
       
   130 
       
   131         /**
       
   132         * Perform a custom uninstallation.
       
   133         * @since 3.1
       
   134         * @param aOperation - The uninstall operation to be performed
       
   135         * @param aParams - Parameters for the operation
       
   136         */
       
   137         void CustomUninstallL(  TOperation aOperation,
       
   138                                 const TDesC8& aParams,
       
   139                                 TRequestStatus& aStatus );
       
   140 
       
   141     private:
       
   142 
       
   143         /**
       
   144         * C++ Constructor.
       
   145         */
       
   146         CWidgetInstallerUI();
       
   147 
       
   148         /**
       
   149         * 2nd phase constructor.
       
   150         */
       
   151         void ConstructL();
       
   152 
       
   153     private: //  Data
       
   154 
       
   155         TInt iResourceFileOffset;
       
   156 
       
   157         CWidgetUIOperationsWatcher* iWatcher;   // watcher to carry out install process, owned
       
   158     };
       
   159 }
       
   160 
       
   161 #endif      // WIDGETINSTALLERUI_H
       
   162 
       
   163 // End of File