appinstall_plat/sifui_api/inc/sifui.h
changeset 42 d17dc5398051
parent 37 6e7b00453237
child 55 ac7f90a6ff4c
child 60 245df5276b97
equal deleted inserted replaced
37:6e7b00453237 42:d17dc5398051
    62         IMPORT_C static CSifUi* NewL();
    62         IMPORT_C static CSifUi* NewL();
    63 
    63 
    64         /**
    64         /**
    65          * Destructor.
    65          * Destructor.
    66          */
    66          */
    67         CSifUi::~CSifUi();
    67         ~CSifUi();
    68 
    68 
    69     public:     // new functions
    69     public:     // new functions
    70         /**
    70         /**
    71          * Displays main installation confirmation query and waits for user response.
    71          * Displays main installation confirmation query and waits for user response.
    72          * Returns ETrue if user accepted the query. The next ShowProgressL() call
    72          * Returns ETrue if user accepted the query. The next ShowProgressL() call
   117 
   117 
   118         /**
   118         /**
   119          * Updates the progress bar value displayed in progress note. Initially progress bar
   119          * Updates the progress bar value displayed in progress note. Initially progress bar
   120          * shows 0%. Each aIncrement increases the value displayed in progress bar. When all
   120          * shows 0%. Each aIncrement increases the value displayed in progress bar. When all
   121          * increments reach the final value defined in ShowProgressNoteL() method, then the
   121          * increments reach the final value defined in ShowProgressNoteL() method, then the
   122          * progress bar shows full 100%.
   122          * progress bar shows full 100%. Caller should check using IsCancelled() method if
       
   123          * the user has cancelled the progress note before updating the progress bar value.
   123          * @param aIncrement - progress bar value increment
   124          * @param aIncrement - progress bar value increment
   124          */
   125          */
   125         IMPORT_C void IncreaseProgressBarValueL( TInt aIncrement );
   126         IMPORT_C void IncreaseProgressBarValueL( TInt aIncrement );
       
   127 
       
   128         /**
       
   129          * Returns ETrue if the user has cancelled the progress dialog.
       
   130          * @return TBool - ETrue if the progress dialog has been cancelled
       
   131          */
       
   132         IMPORT_C TBool IsCancelled();
       
   133 
       
   134         /**
       
   135          * Toolbar buttons in progress and complete notes that can be disabled/hidden.
       
   136          */
       
   137         enum TOptionalButton
       
   138             {
       
   139             EHideProgressButton,
       
   140             ECancelProgressButton,
       
   141             EShowInAppLibButton,
       
   142             EErrorDetailsButton
       
   143             };
       
   144 
       
   145         /**
       
   146          * Hides or shows optional toolbar buttons from installation progress note
       
   147          * or installation complete note. All optional buttos are visible by default.
       
   148          * Buttons visibility becomes effective in the next ShowProgressL(),
       
   149          * ShowCompleteL(), or IncreseProgressBarValueL() method calls.
       
   150          * @param aButton - button which visibility is changed
       
   151          * @param aIsVisible - EFalse if button needs to be hidden
       
   152          */
       
   153         IMPORT_C void SetButtonVisible( TOptionalButton aButton, TBool aIsVisible );
   126 
   154 
   127         /**
   155         /**
   128          * Displays main installation complete note. Installation complete note contains
   156          * Displays main installation complete note. Installation complete note contains
   129          * button to launch the application libaray to show the recently installed apps.
   157          * button to launch the application libaray to show the recently installed apps.
   130          */
   158          */
   138          * @param aErrorDetails - localized error message details (if any)
   166          * @param aErrorDetails - localized error message details (if any)
   139          */
   167          */
   140         IMPORT_C void ShowFailedL( TInt aErrorCode, const TDesC& aErrorMessage,
   168         IMPORT_C void ShowFailedL( TInt aErrorCode, const TDesC& aErrorMessage,
   141             const TDesC& aErrorDetails = KNullDesC );
   169             const TDesC& aErrorDetails = KNullDesC );
   142 
   170 
   143 
       
   144 
       
   145         /** DEPRECATED -- DO NOT USE -- WILL BE REMOVED */
       
   146         enum TMode {
       
   147             EUnspecified = 0,
       
   148             EInstalling = 1,
       
   149             EUninstalling = 2
       
   150         };
       
   151         IMPORT_C void SetMode( TMode aMode );
       
   152         IMPORT_C TMode Mode();
       
   153         IMPORT_C void ShowFailedL( TInt aErrorCode );
       
   154         IMPORT_C void SetCertificateInfoL(
       
   155                 const RPointerArray<Swi::CCertificateInfo>& aCertificates );
       
   156         IMPORT_C TBool ShowConfirmationL( const Swi::CAppInfo& aAppInfo,
       
   157                 TInt aAppSize = 0, const CApaMaskedBitmap* aAppIcon = NULL );
       
   158         IMPORT_C void ShowProgressL( const Swi::CAppInfo& aAppInfo,
       
   159                  TInt aAppSize, TInt aProgressBarFinalValue );
       
   160 
       
   161     private:    // new functions
   171     private:    // new functions
   162         CSifUi();
   172         CSifUi();
   163         void ConstructL();
   173         void ConstructL();
   164 
   174 
   165     private:    // data
   175     private:    // data