S60 3rd Edition API Reference: CDownloadMgrUiDownloadsList Class Reference

CDownloadMgrUiDownloadsList Class Reference

API published in: S60 2nd Ed FP 3

Link against: downloadmgruilib.lib

Capability Information

Required Capabilities

None

Exceptions

None

Other Information

None

#include <cdownloadmgruidownloadslist.h>

Inherits CDownloadMgrUiBase, MHttpDownloadMgrObserver, and MDownloadsListDlgObserver.

Detailed Description

Display list of downloads.

Public Member Functions

virtual ~CDownloadMgrUiDownloadsList ()
 Destructor.
IMPORT_C CDownloadMgrUiDownloadMenu & DownloadMenu () const
 Access the Download Menu utility.
IMPORT_C void DisplayDownloadsListL ()
 Display the list of downloads (the method does not block the scheduler).
void DisplayDownloadsListL (RHttpDownload &aHighlightDl)
 Display the list of downloads (the method does not block the scheduler).
IMPORT_C void CancelDisplayingDownloadsList ()
 Cancel displaying the list of downloads.
IMPORT_C TBool IsVisible () const
 Is the List of Downloads visible?
IMPORT_C TInt Count () const
 Number of downloads in the List of Downloads.
void DeleteDownloadL (RHttpDownload &aDownload)
 Remove the given download from the list.
virtual IMPORT_C void GetIntAttributeL (const TUint aAttribute, TInt32 &aValue)
 Gets the value for a TInt attribute.
virtual IMPORT_C void GetBoolAttributeL (const TUint aAttribute, TBool &aValue)
 Gets the value for a TBool attribute.
virtual IMPORT_C void GetStringAttributeL (const TUint aAttribute, TDes16 &aValue)
 Gets the value for a TDes16 attribute.
virtual IMPORT_C void GetStringAttributeL (const TUint aAttribute, TDes8 &aValue)
 Gets the value for a TDes8 attribute.
virtual IMPORT_C void SetIntAttributeL (const TUint aAttribute, TInt32 aValue)
 Sets the value for a TInt attribute.
virtual IMPORT_C void SetBoolAttributeL (const TUint aAttribute, TBool aValue)
 Sets the value for a TBool attribute.
virtual IMPORT_C void SetStringAttributeL (const TUint aAttribute, const TDesC16 &aValue)
 Sets the value for a TDesC attribute.
virtual IMPORT_C void SetStringAttributeL (const TUint aAttribute, const TDesC8 &aValue)
 Sets the value for a TDesC8 attribute.

Static Public Member Functions

static CDownloadMgrUiDownloadsList * NewL (CDownloadMgrUiLibRegistry &aRegistryModel)
 Two-phased constructor.

Protected Member Functions

 CDownloadMgrUiDownloadsList (CDownloadMgrUiLibRegistry &aRegistryModel)
 C++ default constructor.
void ConstructL ()
 By default Symbian 2nd phase constructor is private.
void AddDownloadsToListModelL (CDownloadsListArray &aLBModel, RHttpDownloadMgr &aDownloadMgr)
 Add downloads to the list residing in aDownloadMgr.
TInt AddDownloadToListModelL (CDownloadsListArray &aLBModel, RHttpDownload &aDownload)
 Add the download to the list.
void NewDownloadCreatedL (RHttpDownload &aDownload)
void UpdateProgressInfoL (RHttpDownload &aDownload, THttpDownloadEvent aEvent)
void DownloadPausedL (RHttpDownload &aDownload, THttpDownloadEvent aEvent)
void DownloadCompletedL (RHttpDownload &aDownload, THttpDownloadEvent aEvent)
void DownloadFailedL (RHttpDownload &aDownload, THttpDownloadEvent aEvent)
void PauseableStateChangedL (RHttpDownload &aDownload, TBool aPausable)
void HideMenu ()
virtual void HandleDMgrEventL (RHttpDownload &aDownload, THttpDownloadEvent aEvent)
 Indicates an event.
virtual void PreLayoutDynInitL (CDownloadsListDlg &aDialog)
 Called for layouting the dialog before executing it.
virtual void ProcessCommandL (CDownloadsListDlg &aDialog, TInt aCommandId)
 Called for processing not dialog specific commands.
virtual void DynInitMenuPaneL (CDownloadsListDlg &aDialog, TInt aResourceId, CEikMenuPane *aMenuPane)
 Called for initializing Options menu.
virtual TKeyResponse OfferKeyEventL (CDownloadsListDlg &aDialog, const TKeyEvent &aKeyEvent, TEventCode aType)
 Key events first forwarded to the observer.

Friends

class CDownloadsListExtension

Constructor & Destructor Documentation

virtual CDownloadMgrUiDownloadsList::~CDownloadMgrUiDownloadsList (   )  [virtual]
 

Destructor.

CDownloadMgrUiDownloadsList::CDownloadMgrUiDownloadsList ( CDownloadMgrUiLibRegistry &  aRegistryModel  )  [protected]
 

C++ default constructor.

Member Function Documentation

void CDownloadMgrUiDownloadsList::AddDownloadsToListModelL ( CDownloadsListArray &  aLBModel,
RHttpDownloadMgr &  aDownloadMgr
)  [protected]
 

Add downloads to the list residing in aDownloadMgr.

If a given download is already on the list, the list item is only updated.

TInt CDownloadMgrUiDownloadsList::AddDownloadToListModelL ( CDownloadsListArray &  aLBModel,
RHttpDownload &  aDownload
)  [protected]
 

Add the download to the list.

If the download is already on the list, the list item is only updated. This method should be used for adding new downloads - not for updating existing ones.

Returns:
Returns the index relative to zero of the appended or updated item.
IMPORT_C void CDownloadMgrUiDownloadsList::CancelDisplayingDownloadsList (   ) 
 

Cancel displaying the list of downloads.

Returns:
-
void CDownloadMgrUiDownloadsList::ConstructL (   )  [protected]
 

By default Symbian 2nd phase constructor is private.

IMPORT_C TInt CDownloadMgrUiDownloadsList::Count (   )  const
 

Number of downloads in the List of Downloads.

Returns:
TInt
void CDownloadMgrUiDownloadsList::DeleteDownloadL ( RHttpDownload &  aDownload  ) 
 

Remove the given download from the list.

void CDownloadMgrUiDownloadsList::DisplayDownloadsListL ( RHttpDownload &  aHighlightDl  ) 
 

Display the list of downloads (the method does not block the scheduler).

It means that this method initializes an active object, that completes itself and it executes the Downloads List dialog in it's RunL. Using this method the caller is not blocked by the wait-dialog. This method is not exported!

Parameters:
aHighlightDl This download is highlighted in the list.
Returns:
-
IMPORT_C void CDownloadMgrUiDownloadsList::DisplayDownloadsListL (   ) 
 

Display the list of downloads (the method does not block the scheduler).

It means that this method initializes an active object, that completes itself and it executes the Downloads List dialog in it's RunL. Using this method the caller is not blocked by the wait-dialog.

Returns:
-
void CDownloadMgrUiDownloadsList::DownloadCompletedL ( RHttpDownload &  aDownload,
THttpDownloadEvent  aEvent
)  [protected]
 
void CDownloadMgrUiDownloadsList::DownloadFailedL ( RHttpDownload &  aDownload,
THttpDownloadEvent  aEvent
)  [protected]
 
IMPORT_C CDownloadMgrUiDownloadMenu& CDownloadMgrUiDownloadsList::DownloadMenu (   )  const
 

Access the Download Menu utility.

Returns:
-
void CDownloadMgrUiDownloadsList::DownloadPausedL ( RHttpDownload &  aDownload,
THttpDownloadEvent  aEvent
)  [protected]
 
virtual void CDownloadMgrUiDownloadsList::DynInitMenuPaneL ( CDownloadsListDlg &  aDialog,
TInt  aResourceId,
CEikMenuPane *  aMenuPane
)  [protected, virtual]
 

Called for initializing Options menu.

Implements MDownloadsListDlgObserver.

virtual IMPORT_C void CDownloadMgrUiDownloadsList::GetBoolAttributeL ( const TUint  aAttribute,
TBool &  aValue
)  [virtual]
 

Gets the value for a TBool attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be retrived.
aValue On completion, contains the requested TBool attribute.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiDownloadsList::GetIntAttributeL ( const TUint  aAttribute,
TInt32 &  aValue
)  [virtual]
 

Gets the value for a TInt attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be retrived.
aValue On completion, contains the requested TInt attribute.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiDownloadsList::GetStringAttributeL ( const TUint  aAttribute,
TDes8 &  aValue
)  [virtual]
 

Gets the value for a TDes8 attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be retrived.
aValue On completion, contains the requested TDes8 attribute.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiDownloadsList::GetStringAttributeL ( const TUint  aAttribute,
TDes16 &  aValue
)  [virtual]
 

Gets the value for a TDes16 attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be retrived.
aValue On completion, contains the requested TDes16 attribute.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual void CDownloadMgrUiDownloadsList::HandleDMgrEventL ( RHttpDownload &  aDownload,
THttpDownloadEvent  aEvent
)  [protected, virtual]
 

Indicates an event.

Parameters:
aDownload The download with which the event occured.
aEvent Event type.
Returns:
None.

Implements MHttpDownloadMgrObserver.

void CDownloadMgrUiDownloadsList::HideMenu (   )  [protected]
 
IMPORT_C TBool CDownloadMgrUiDownloadsList::IsVisible (   )  const
 

Is the List of Downloads visible?

Returns:
ETrue/EFalse
void CDownloadMgrUiDownloadsList::NewDownloadCreatedL ( RHttpDownload &  aDownload  )  [protected]
 
static CDownloadMgrUiDownloadsList* CDownloadMgrUiDownloadsList::NewL ( CDownloadMgrUiLibRegistry &  aRegistryModel  )  [static]
 

Two-phased constructor.

virtual TKeyResponse CDownloadMgrUiDownloadsList::OfferKeyEventL ( CDownloadsListDlg &  aDialog,
const TKeyEvent &  aKeyEvent,
TEventCode  aType
)  [protected, virtual]
 

Key events first forwarded to the observer.

Implements MDownloadsListDlgObserver.

void CDownloadMgrUiDownloadsList::PauseableStateChangedL ( RHttpDownload &  aDownload,
TBool  aPausable
)  [protected]
 
virtual void CDownloadMgrUiDownloadsList::PreLayoutDynInitL ( CDownloadsListDlg &  aDialog  )  [protected, virtual]
 

Called for layouting the dialog before executing it.

Implements MDownloadsListDlgObserver.

virtual void CDownloadMgrUiDownloadsList::ProcessCommandL ( CDownloadsListDlg &  aDialog,
TInt  aCommandId
)  [protected, virtual]
 

Called for processing not dialog specific commands.

Implements MDownloadsListDlgObserver.

virtual IMPORT_C void CDownloadMgrUiDownloadsList::SetBoolAttributeL ( const TUint  aAttribute,
TBool  aValue
)  [virtual]
 

Sets the value for a TBool attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be set.
aValue The value to be set.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiDownloadsList::SetIntAttributeL ( const TUint  aAttribute,
TInt32  aValue
)  [virtual]
 

Sets the value for a TInt attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be set.
aValue The value to be set.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiDownloadsList::SetStringAttributeL ( const TUint  aAttribute,
const TDesC8 &  aValue
)  [virtual]
 

Sets the value for a TDesC8 attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be set.
aValue The value to be set.
Returns:
None.

Implements CDownloadMgrUiBase.

virtual IMPORT_C void CDownloadMgrUiDownloadsList::SetStringAttributeL ( const TUint  aAttribute,
const TDesC16 &  aValue
)  [virtual]
 

Sets the value for a TDesC attribute.

Leaves with KErrNotSupported, if the attribute is not supported.

Parameters:
aAttribute Identifies the attribute to be set.
aValue The value to be set.
Returns:
None.

Implements CDownloadMgrUiBase.

void CDownloadMgrUiDownloadsList::UpdateProgressInfoL ( RHttpDownload &  aDownload,
THttpDownloadEvent  aEvent
)  [protected]
 

Friends And Related Function Documentation

friend class CDownloadsListExtension [friend]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top