1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // Definition of the data provider observer abstract class
15 // It is anticipated that this class will be used as a mixin for
16 // those objects which wish to provide services for an MDataProvider
22 #ifndef __MDATAPROVIDEROBSERVER_H__
23 #define __MDATAPROVIDEROBSERVER_H__
29 //##ModelId=3B712B2B01C2
30 class MDataProviderObserver
32 MDataProviderObserver provides a virtual interface for any class to observe
33 any MDataProvider, and provide data receiving services.
41 Intended Usage : Called by the data provider to request processing of
42 the data within the buffer.
44 @param aBuffer A reference to the buffer with the data to process
46 //##ModelId=3B712B2B0209
47 virtual void ProcessDataL(HBufC8& aBuffer) = 0;
50 Intended Usage : Called by the data provider to report its status to
51 its observer. A status code which is either a standard error condition,
52 (i.e. < 0), a percentage complete value, ( 0 > aStatus < 100), OR a
55 @param aStatusCode The status of the data provider
57 //##ModelId=3B712B2B0203
58 virtual void SetStatus(TInt aStatusCode = KErrNone) = 0;
61 Intended Usage : The request to construct a CDataHandler to process data
62 of aDataType, where aDataType is a string to match against some plugins
63 declared data handling ability.
65 @param aDataType A reference to a descriptor with the data type
67 //##ModelId=3B712B2B01FE
68 virtual void SetDocumentTypeL(const TDesC& aDataType) = 0;
71 Intended Usage : The request to construct a CDataHandler for aDataType with
72 non default document encoding where aDataType is a string to match against
73 some plugins declared data handling ability.
75 @param aDataType A reference to a descriptor with the data type
76 @param aContentType A reference to a descriptor with the content type
78 //##ModelId=3B712B2B0200
79 virtual void SetDocumentTypeL(const TDesC& aDataType, const TDesC& aContentType) = 0;
82 Intended Usage : The report of how many bytes of data is expected to be
83 passed to ProcessDataL, enabling %age reporting capabilities.
85 @param aAmountExpected An integer value of the expected amount
87 //##ModelId=3B712B2B01EC
88 virtual void SetDataExpected(TInt aAmountExpected) = 0;
91 Intended Usage : Set the URI that the DataProvider considers the base
92 URI for the current data.
94 @param aBaseUri A const pointer to the uri
96 //##ModelId=3B712B2B01EA
97 virtual void SetBaseUriL(const TDesC* aBaseUri) = 0;
102 Intended Usage : Reserved for future expansion.
105 //##ModelId=3B712B2B01E1
106 virtual void MDataProviderObserverReserved1() =0;
109 Intended Usage : Reserved for future expansion.
112 //##ModelId=3B712B2B01E0
113 virtual void MDataProviderObserverReserved2() =0;
115 }; // MDataProviderObserver
117 #endif // __MDATAPROVIDEROBSERVER_H__