MBrCtlDownloadObserver Class Reference

#include <mw/brctldownloadobserver.h>

class MBrCtlDownloadObserver
Public Member Functions
pure virtual voidHandleDownloadEventL(TUint, TBrCtlDownloadEvent, TUint)
pure virtual TBool NewDownloadL(TUint, const TDesC &, const TDesC &, const TDesC &)
pure virtual voidResumeDownloadL(TUint, TUint, const TDesC &, const TDesC &, const TDesC &)

Detailed Description

The MBrCtlDownloadObserver class handles download events.

Usage:

  #include <brctldownloadobserver.h>

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

Member Function Documentation

HandleDownloadEventL ( TUint, TBrCtlDownloadEvent, TUint )

voidHandleDownloadEventL(TUintaTransactionID,
TBrCtlDownloadEventaDownloadEvent,
TUintaValue
)[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
Since
3.0
Parameters
aTransactionIDThe ID of the transaction, it is unique as long as the transaction is on-going
aDownloadEventEvent to be handled Examples: EventStarted, EventCompleted, EventProgress, EventCanceled, EventError EventPaused, EventResumed, EventPausable
aValueValue associated with the event. Examples: Total size of the downloaded file Size of that was downloaded so far
Return Value
void

NewDownloadL ( TUint, const TDesC &, const TDesC &, const TDesC & )

TBool NewDownloadL(TUintaTransactionID,
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
Since
3.0
Parameters
aTransactionIDThe ID of the transaction, it is unique as long as the transaction is on-going
aFileNameName of the file in which the downloaded content is stored
aContentTypeType of content to be downloaded. For example: Markup, Image, Cascading Style Sheet (CSS), Javascript, Netscape plug-in, Sound
aUrlThe Url of the request to be done in the new window
Return Value
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

ResumeDownloadL ( TUint, TUint, const TDesC &, const TDesC &, const TDesC & )

voidResumeDownloadL(TUintaTransactionID,
TUintaLength,
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.
Since
3.0
Parameters
aTransactionIDID of the transaction This ID must be unique while the transaction is in progress.
aLengthLength of the content previously downloaded
aFileNameName of the file in which the downloaded content is stored
aContentTypeType of content downloaded. For example: Markup, Image, Cascading Style Sheet (CSS), Javascript, Netscape plug-in, Sound
aUrlURL of the source of the content to be done in the new window
Return Value
None