S60 3rd Edition API Reference: MBrCtlDownloadObserver Class Reference

MBrCtlDownloadObserver Class Reference

API published in: S60 2nd Ed FP 3

Link against: browserengine.lib

#include <brctldownloadobserver.h>

Detailed Description

The MBrCtlDownloadObserver class handles download events.

Usage:

  #include <BrCtlDownloadObserver.h>

  
 @see S60 Platform: Browser Control API Developer's Guide Version 2.0
 
 @file BrCtlDownloadObserver.h
*

Public Member Functions

virtual TBool NewDownloadL (TUint aTransactionID, const TDesC &aFileName, const TDesC &aContentType, const TDesC &aUrl)=0
 Inform the host application that a new download has started using the Download Manager.
virtual void ResumeDownloadL (TUint aTransactionID, TUint aLength, const TDesC &aFileName, const TDesC &aContentType, const TDesC &aUrl)=0
 Tells the host application to resume an incomplete download.
virtual void HandleDownloadEventL (TUint aTransactionID, TBrCtlDownloadEvent aDownloadEvent, TUint aValue)=0
 Informs the host application that one of the following download events is in progress: NOTE: All events have the prefix EDownload: EventStarted, EventCompleted, EventProgress, EventCanceled, EventError EventPaused, EventResumed, EventPausable.

Member Function Documentation

virtual void MBrCtlDownloadObserver::HandleDownloadEventL ( TUint  aTransactionID,
TBrCtlDownloadEvent  aDownloadEvent,
TUint  aValue
)  [pure virtual]
 

Informs the host application that one of the following download events is in progress: NOTE: All events have the prefix EDownload: EventStarted, EventCompleted, EventProgress, EventCanceled, EventError EventPaused, EventResumed, EventPausable.

Parameters:
aTransactionID The ID of the transaction, it is unique as long as the transaction is on-going
aDownloadEvent Event to be handled Examples: EventStarted, EventCompleted, EventProgress, EventCanceled, EventError EventPaused, EventResumed, EventPausable
aValue Value associated with the event. Examples: Total size of the downloaded file Size of that was downloaded so far
Returns:
void
virtual TBool MBrCtlDownloadObserver::NewDownloadL ( TUint  aTransactionID,
const TDesC &  aFileName,
const TDesC &  aContentType,
const TDesC &  aUrl
)  [pure virtual]
 

Inform the host application that a new download has started using the Download Manager.

Parameters:
aTransactionID The ID of the transaction, it is unique as long as the transaction is on-going
aFileName Name of the file in which the downloaded content is stored
aContentType Type of content to be downloaded. For example: Markup, Image, Cascading Style Sheet (CSS), Javascript, Netscape plug-in, Sound
aUrl The Url of the request to be done in the new window
Returns:
ETrue if the file can be displayed or played while it is downloading (progressive download) EFalse if the file cannot be displayed or played while it is downloading
virtual void MBrCtlDownloadObserver::ResumeDownloadL ( TUint  aTransactionID,
TUint  aLength,
const TDesC &  aFileName,
const TDesC &  aContentType,
const TDesC &  aUrl
)  [pure virtual]
 

Tells the host application to resume an incomplete download.

After the host application restarts, this method is called for each file whose download was interrupted when the host application closed.

Parameters:
aTransactionID ID of the transaction This ID must be unique while the transaction is in progress.
aLength Length of the content previously downloaded
aFileName Name of the file in which the downloaded content is stored
aContentType Type of content downloaded. For example: Markup, Image, Cascading Style Sheet (CSS), Javascript, Netscape plug-in, Sound
aUrl URL of the source of the content to be done in the new window
Returns:
None
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top