Collapse all Symbian^3 Application Developer Library

MBrCtlDownloadObserver Class Reference

class MBrCtlDownloadObserver

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

Public Member Functions
void	HandleDownloadEventL ( TUint , TBrCtlDownloadEvent , TUint )
TBool	NewDownloadL ( TUint , const TDesC &, const TDesC &, const TDesC &)
void	ResumeDownloadL ( TUint , TUint , const TDesC &, const TDesC &, const TDesC &)

Member Functions Documentation

HandleDownloadEventL(TUint, TBrCtlDownloadEvent, TUint)

void	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

Since: 3.0

Parameters

TUint aTransactionID	The ID of the transaction, it is unique as long as the transaction is on-going
TBrCtlDownloadEvent aDownloadEvent	Event to be handled Examples: EventStarted, EventCompleted, EventProgress, EventCanceled, EventError EventPaused, EventResumed, EventPausable
TUint aValue	Value associated with the event. Examples: Total size of the downloaded file Size of that was downloaded so far

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

TBool	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

Since: 3.0

Parameters

TUint aTransactionID	The ID of the transaction, it is unique as long as the transaction is on-going
const TDesC & aFileName	Name of the file in which the downloaded content is stored
const TDesC & aContentType	Type of content to be downloaded. For example: Markup, Image, Cascading Style Sheet (CSS), Javascript, Netscape plug-in, Sound
const TDesC & aUrl	The Url of the request to be done in the new window

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

void	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.

Since: 3.0

Parameters

TUint aTransactionID	ID of the transaction This ID must be unique while the transaction is in progress.
TUint aLength	Length of the content previously downloaded
const TDesC & aFileName	Name of the file in which the downloaded content is stored
const TDesC & aContentType	Type of content downloaded. For example: Markup, Image, Cascading Style Sheet (CSS), Javascript, Netscape plug-in, Sound
const TDesC & aUrl	URL of the source of the content to be done in the new window