epoc32/include/mw/cdownloadmgruidownloadslist.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Supports Download Menu and Downloads List
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
#ifndef CDOWNLOADMGRUIDOWNLOADSLIST_H
williamr@2
    19
#define CDOWNLOADMGRUIDOWNLOADSLIST_H
williamr@2
    20
williamr@2
    21
//  INCLUDES
williamr@4
    22
#include <cdownloadmgruibase.h>
williamr@4
    23
#include <downloadmgrclient.h>
williamr@4
    24
#include <httpdownloadmgrcommon.h>
williamr@4
    25
#include <downloadslistdlgobserver.h>
williamr@2
    26
williamr@2
    27
#include <AiwServiceHandler.h>
williamr@2
    28
#include <AiwCommon.hrh>
williamr@2
    29
williamr@2
    30
// FORWARD DECLARATIONS
williamr@2
    31
class CDownloadMgrUiDownloadMenu;
williamr@2
    32
class CDownloadMgrUiUserInteractions;
williamr@2
    33
class CDownloadsListArray;
williamr@2
    34
class CDownloadsListDlg;
williamr@2
    35
class CUserInteractionsUtils;
williamr@2
    36
class CDownloadMgrUiLibRegistry;
williamr@2
    37
class CAsyncEventHandlerArray;
williamr@2
    38
class CAsyncEventHandlerBase;
williamr@2
    39
class CDownloadsListExtension;
williamr@2
    40
williamr@2
    41
// CLASS DECLARATION
williamr@2
    42
williamr@2
    43
/**
williamr@2
    44
*  Display list of downloads.
williamr@2
    45
*
williamr@2
    46
*  @lib Download Manager UI Lib
williamr@2
    47
*  @since Series 60 2.8
williamr@2
    48
*/
williamr@2
    49
NONSHARABLE_CLASS( CDownloadMgrUiDownloadsList ) : 
williamr@2
    50
                                                public CDownloadMgrUiBase, 
williamr@2
    51
                                                public MHttpDownloadMgrObserver,
williamr@2
    52
                                                public MDownloadsListDlgObserver,
williamr@2
    53
                                                public MAiwNotifyCallback 
williamr@2
    54
    {
williamr@2
    55
    public:  // Constructors and destructor
williamr@2
    56
        
williamr@2
    57
        /**
williamr@2
    58
        * Two-phased constructor.
williamr@2
    59
        */
williamr@2
    60
        static CDownloadMgrUiDownloadsList* NewL
williamr@2
    61
               ( CDownloadMgrUiLibRegistry& aRegistryModel );
williamr@2
    62
        
williamr@2
    63
        /**
williamr@2
    64
        * Destructor.
williamr@2
    65
        */
williamr@2
    66
        virtual ~CDownloadMgrUiDownloadsList();
williamr@2
    67
williamr@2
    68
    public: // New functions
williamr@2
    69
williamr@2
    70
        // -------------------------------------------------------------
williamr@2
    71
        // ************** Download Menu
williamr@2
    72
        // -------------------------------------------------------------
williamr@2
    73
williamr@2
    74
        /**
williamr@2
    75
        * Access the Download Menu utility.
williamr@2
    76
        * @since Series 60 2.8
williamr@2
    77
        * @return -
williamr@2
    78
        */
williamr@2
    79
        IMPORT_C CDownloadMgrUiDownloadMenu& DownloadMenu() const;
williamr@2
    80
williamr@2
    81
        // -------------------------------------------------------------
williamr@2
    82
        // ************** Downloads List
williamr@2
    83
        // -------------------------------------------------------------
williamr@2
    84
williamr@2
    85
        /**
williamr@2
    86
        * Display the list of downloads (the method does not block the scheduler).
williamr@2
    87
        * It means that this method initializes an active object, that completes 
williamr@2
    88
        * itself and it executes the Downloads List dialog in it's RunL.
williamr@2
    89
        * Using this method the caller is not blocked by the wait-dialog.
williamr@2
    90
        * @since Series 60 2.8
williamr@2
    91
        * @return -
williamr@2
    92
        */
williamr@2
    93
        IMPORT_C void DisplayDownloadsListL();
williamr@2
    94
williamr@2
    95
        /**
williamr@2
    96
        * Display the list of downloads (the method does not block the scheduler).
williamr@2
    97
        * It means that this method initializes an active object, that completes 
williamr@2
    98
        * itself and it executes the Downloads List dialog in it's RunL.
williamr@2
    99
        * Using this method the caller is not blocked by the wait-dialog.
williamr@2
   100
        * This method is not exported!
williamr@2
   101
        * @param aHighlightDl This download is highlighted in the list.
williamr@2
   102
        * @since Series 60 3.0
williamr@2
   103
        * @return -
williamr@2
   104
        */
williamr@2
   105
        void DisplayDownloadsListL( RHttpDownload& aHighlightDl );
williamr@2
   106
williamr@2
   107
        /**
williamr@2
   108
        * Cancel displaying the list of downloads.
williamr@2
   109
        * @since Series 60 2.8
williamr@2
   110
        * @return -
williamr@2
   111
        */
williamr@2
   112
        IMPORT_C void CancelDisplayingDownloadsList();
williamr@2
   113
williamr@2
   114
        /**
williamr@2
   115
        * Is the List of Downloads visible?
williamr@2
   116
        * @since Series 60 2.8
williamr@2
   117
        * @return ETrue/EFalse
williamr@2
   118
        */
williamr@2
   119
        IMPORT_C TBool IsVisible() const;
williamr@2
   120
williamr@2
   121
        /**
williamr@2
   122
        * Number of downloads in the List of Downloads.
williamr@2
   123
        * @since Series 60 2.8
williamr@2
   124
        * @return TInt
williamr@2
   125
        */
williamr@2
   126
        IMPORT_C TInt Count() const;
williamr@2
   127
williamr@2
   128
        /**
williamr@2
   129
        * Remove the given download from the list.
williamr@2
   130
        */ 
williamr@2
   131
        void DeleteDownloadL( RHttpDownload& aDownload );
williamr@2
   132
williamr@2
   133
        /**
williamr@2
   134
        * Is one of them progressive
williamr@2
   135
        * @since Series 60 3.2
williamr@2
   136
        * @return TBool 
williamr@2
   137
        */
williamr@2
   138
        TBool IsOneProgressive();
williamr@2
   139
        
williamr@2
   140
        /**
williamr@2
   141
        * Is one of them progressive
williamr@2
   142
        * @since Series 60 3.2
williamr@2
   143
        * @return TBool 
williamr@2
   144
        */
williamr@2
   145
        inline TBool IsProgressiveDownloadEnabled() {return iProgressiveDownload; }
williamr@2
   146
        
williamr@4
   147
        /**
williamr@4
   148
        * Gets the value of downloadlist hide
williamr@4
   149
        * @return TBool 
williamr@4
   150
        */
williamr@4
   151
        inline TBool GetDownloadHide() { return iDownloadListHide; }
williamr@4
   152
#ifdef BRDO_SINGLE_CLICK_ENABLED_FF
williamr@4
   153
        /**
williamr@4
   154
        * Adding Aiw Commands to the given MenuPane
williamr@4
   155
        */
williamr@4
   156
        void AIWPlugInMenusL(TInt aResourceId,CEikMenuPane* aMenuPane);
williamr@4
   157
#endif        
williamr@2
   158
williamr@2
   159
    public: // Functions from CDownloadMgrUiBase
williamr@2
   160
williamr@2
   161
        IMPORT_C virtual void GetIntAttributeL( const TUint aAttribute, TInt32& aValue );
williamr@2
   162
        IMPORT_C virtual void GetBoolAttributeL( const TUint aAttribute, TBool& aValue );
williamr@2
   163
        IMPORT_C virtual void GetStringAttributeL( const TUint aAttribute, TDes16& aValue  );
williamr@2
   164
        IMPORT_C virtual void GetStringAttributeL( const TUint aAttribute, TDes8& aValue  );
williamr@2
   165
        IMPORT_C virtual void SetIntAttributeL( const TUint aAttribute, TInt32 aValue );
williamr@2
   166
        IMPORT_C virtual void SetBoolAttributeL( const TUint aAttribute, TBool aValue );
williamr@2
   167
        IMPORT_C virtual void SetStringAttributeL( const TUint aAttribute, const TDesC16& aValue );
williamr@2
   168
        IMPORT_C virtual void SetStringAttributeL( const TUint aAttribute, const TDesC8& aValue );
williamr@2
   169
williamr@2
   170
    protected: // Constructors
williamr@2
   171
williamr@2
   172
        /**
williamr@2
   173
        * C++ default constructor.
williamr@2
   174
        */
williamr@2
   175
        CDownloadMgrUiDownloadsList( CDownloadMgrUiLibRegistry& aRegistryModel );
williamr@2
   176
williamr@2
   177
        /**
williamr@2
   178
        * By default Symbian 2nd phase constructor is private.
williamr@2
   179
        */
williamr@2
   180
        void ConstructL();
williamr@2
   181
williamr@2
   182
    protected: // New functions
williamr@2
   183
williamr@2
   184
        // -------------------------------------------------------------
williamr@2
   185
        // ************** List box utilities
williamr@2
   186
        // -------------------------------------------------------------
williamr@2
   187
williamr@2
   188
        /**
williamr@2
   189
        * Add downloads to the list residing in aDownloadMgr.
williamr@2
   190
        * If a given download is already on the list, the list item is only updated.
williamr@2
   191
        */ 
williamr@2
   192
        void AddDownloadsToListModelL( CDownloadsListArray& aLBModel, 
williamr@2
   193
                                       RHttpDownloadMgr& aDownloadMgr );
williamr@2
   194
williamr@2
   195
        /**
williamr@2
   196
        * Add the download to the list.
williamr@2
   197
        * If the download is already on the list, the list item is only updated.
williamr@2
   198
        * This method should be used for adding new downloads - 
williamr@2
   199
        * not for updating existing ones.
williamr@2
   200
        * @return Returns the index relative to zero of the appended or updated item.
williamr@2
   201
        */
williamr@2
   202
        TInt AddDownloadToListModelL( CDownloadsListArray& aLBModel, 
williamr@2
   203
                                      RHttpDownload& aDownload );
williamr@2
   204
williamr@2
   205
        // -------------------------------------------------------------
williamr@2
   206
        // ************** Responses to download events
williamr@2
   207
        // -------------------------------------------------------------
williamr@2
   208
williamr@2
   209
        void NewDownloadCreatedL( RHttpDownload& aDownload );
williamr@2
   210
        void UpdateProgressInfoL( RHttpDownload& aDownload, THttpDownloadEvent aEvent );
williamr@2
   211
        void DownloadPausedL( RHttpDownload& aDownload, THttpDownloadEvent aEvent );
williamr@2
   212
        void DownloadCompletedL( RHttpDownload& aDownload, THttpDownloadEvent aEvent );
williamr@2
   213
        void DownloadFailedL( RHttpDownload& aDownload, THttpDownloadEvent aEvent );
williamr@2
   214
        void PauseableStateChangedL( RHttpDownload& aDownload, TBool aPausable );
williamr@2
   215
williamr@2
   216
        // -------------------------------------------------------------
williamr@2
   217
        // ************** Other utility
williamr@2
   218
        // -------------------------------------------------------------
williamr@2
   219
williamr@2
   220
        void HideMenu();
williamr@2
   221
williamr@2
   222
    protected: // Functions from MHttpDownloadMgrObserver
williamr@2
   223
williamr@2
   224
        virtual void HandleDMgrEventL( RHttpDownload& aDownload, THttpDownloadEvent aEvent );
williamr@2
   225
williamr@2
   226
    protected: // Functions from MDownloadsListDlgObserver
williamr@2
   227
williamr@2
   228
        virtual void PreLayoutDynInitL( CDownloadsListDlg& aDialog );
williamr@2
   229
        virtual void ProcessCommandL( CDownloadsListDlg& aDialog, TInt aCommandId );
williamr@2
   230
        virtual void DynInitMenuPaneL( CDownloadsListDlg& aDialog, TInt aResourceId, CEikMenuPane* aMenuPane );
williamr@2
   231
        virtual TKeyResponse OfferKeyEventL( CDownloadsListDlg& aDialog, const TKeyEvent& aKeyEvent, TEventCode aType );
williamr@2
   232
williamr@2
   233
williamr@2
   234
    protected: // Function from MAIWNotifyCallback 
williamr@2
   235
        TInt HandleNotifyL( TInt /*aCmdId*/,
williamr@2
   236
                            TInt /*aEventId*/,
williamr@2
   237
                            CAiwGenericParamList& /*aEventParamList*/,
williamr@2
   238
                            const CAiwGenericParamList& /*aInParamList*/ ){return KErrNone;}
williamr@2
   239
    private: 
williamr@2
   240
        void AttachAIWInterestL();
williamr@2
   241
        void HandleAIWCommandL(TInt aCommand, RHttpDownload& aDownload);
williamr@2
   242
        void InitializeAIWPlugInMenusL( TInt aResourceId, 
williamr@2
   243
                                        CEikMenuPane* aMenuPane,
williamr@2
   244
                                        RHttpDownload& aDownload );
williamr@2
   245
        void ProvideInputParametersL( CAiwGenericParamList& aParams,
williamr@2
   246
                                      TInt& /*aCommandOptions*/,
williamr@2
   247
                                      RHttpDownload& aDownload);
williamr@2
   248
                                      
williamr@2
   249
        void LaunchFileManagerApplication();
williamr@2
   250
williamr@4
   251
    public:
williamr@4
   252
        /**
williamr@4
   253
        * Sets the value of downloadlist hide
williamr@4
   254
        * @return void 
williamr@4
   255
        */
williamr@4
   256
        void SetDownloadListHide( TBool aHide );
williamr@4
   257
williamr@2
   258
    private:  // Data
williamr@2
   259
        
williamr@2
   260
        CDownloadsListExtension*    iExtension; ///< Extension class. Owned.
williamr@2
   261
williamr@2
   262
        CUserInteractionsUtils*     iUiUtils; ///< Utility. Owned.
williamr@2
   263
        CDownloadMgrUiDownloadMenu* iDownloadMenu; ///< Download Menu utility. Owned.
williamr@2
   264
        CAsyncEventHandlerArray*    iEventHandlerArray; ///< Owned.
williamr@2
   265
        CDownloadsListArray*        iListModel; ///< Association array: list item-download. Owned.
williamr@2
   266
        CDownloadsListDlg*          iDialog; ///< Owned. Unused member.
williamr@2
   267
        TBool                       iIsVisible; ///< Unused member.
williamr@2
   268
		TBool						iIsTimerStarted;
williamr@2
   269
		CAiwServiceHandler* iAIWServiceHandler;
williamr@2
   270
		TBool						iProgressiveDownload;
williamr@2
   271
		
williamr@2
   272
		TBool						iIsCancelInProgress;
williamr@2
   273
		TBool                       iPlatformSupportsGallery;
williamr@2
   274
williamr@4
   275
        TBool                       iDownloadListHide;
williamr@2
   276
    private: // Friend classes
williamr@2
   277
williamr@2
   278
        friend class CDownloadsListExtension;
williamr@2
   279
    };
williamr@2
   280
williamr@2
   281
#endif /* CDOWNLOADMGRUIDOWNLOADSLIST_H */