Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: mdataproviderobserver.h

Class MDataProviderObserver

class MDataProviderObserver;

Description

MDataProviderObserver provides a virtual interface for any class to observe any MDataProvider, and provide data receiving services.

Members

Defined in MDataProviderObserver:
MDataProviderObserverReserved1(), MDataProviderObserverReserved2(), ProcessDataL(), SetBaseUriL(), SetDataExpected(), SetDocumentTypeL(), SetDocumentTypeL(), SetStatus()


Member functions


ProcessDataL()

virtual void ProcessDataL(HBufC8 &aBuffer)=0;

Description

Intended Usage : Called by the data provider to request processing of the data within the buffer.

Parameters

HBufC8 &aBuffer

A reference to the buffer with the data to process


SetStatus()

virtual void SetStatus(TInt aStatusCode=KErrNone)=0;

Description

Intended Usage : Called by the data provider to report its status to its observer. A status code which is either a standard error condition, (i.e. < 0), a percentage complete value, ( 0 > aStatus < 100), OR a TPluginStatus value.

Parameters

TInt aStatusCode

The status of the data provider


SetDocumentTypeL()

virtual void SetDocumentTypeL(const TDesC &aDataType)=0;

Description

Intended Usage : The request to construct a CDataHandler to process data of aDataType, where aDataType is a string to match against some plugins declared data handling ability.

Parameters

const TDesC &aDataType

A reference to a descriptor with the data type


SetDocumentTypeL()

virtual void SetDocumentTypeL(const TDesC &aDataType, const TDesC &aContentType)=0;

Description

Intended Usage : The request to construct a CDataHandler for aDataType with non default document encoding where aDataType is a string to match against some plugins declared data handling ability.

Parameters

const TDesC &aDataType

A reference to a descriptor with the data type

const TDesC &aContentType

A reference to a descriptor with the content type


SetDataExpected()

virtual void SetDataExpected(TInt aAmountExpected)=0;

Description

Intended Usage : The report of how many bytes of data is expected to be passed to ProcessDataL, enabling age reporting capabilities.

Parameters

TInt aAmountExpected

An integer value of the expected amount


SetBaseUriL()

virtual void SetBaseUriL(const TDesC *aBaseUri)=0;

Description

Intended Usage : Set the URI that the DataProvider considers the base URI for the current data.

Parameters

const TDesC *aBaseUri

A const pointer to the uri


MDataProviderObserverReserved1()

private: virtual void MDataProviderObserverReserved1()=0;

Description

Intended Usage : Reserved for future expansion.


MDataProviderObserverReserved2()

private: virtual void MDataProviderObserverReserved2()=0;

Description

Intended Usage : Reserved for future expansion.