epoc32/include/xml/dom/xmlengextendedcontenthandler.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
// Content handler for binary data
williamr@4
    15
//
williamr@4
    16
williamr@4
    17
williamr@4
    18
williamr@4
    19
/**
williamr@4
    20
 @file
williamr@4
    21
 @publishedAll
williamr@4
    22
 @released
williamr@4
    23
*/
williamr@4
    24
#ifndef XMLENGEXTENDEDCONTENTHANDLER_H
williamr@4
    25
#define XMLENGEXTENDEDCONTENTHANDLER_H
williamr@4
    26
williamr@4
    27
#include <xml/dom/xmlengdatacontainer.h>
williamr@4
    28
williamr@4
    29
/**
williamr@4
    30
This class extends MContentHandler with functions for binary data handling.
williamr@4
    31
Used by clients during XOP deserialization.
williamr@4
    32
williamr@4
    33
@see Xml::MContentHandler
williamr@4
    34
*/
williamr@4
    35
class MXmlEngExtendedHandler
williamr@4
    36
	{
williamr@4
    37
public:
williamr@4
    38
	/** The uid identifying this extension interface. */
williamr@4
    39
	enum TExtInterfaceUid {EExtInterfaceUid = 0x101F9794}; 
williamr@4
    40
williamr@4
    41
	/**
williamr@4
    42
	Called when binary content has been parsed.
williamr@4
    43
 	 
williamr@4
    44
	@param aBytes The raw binary data of the element
williamr@4
    45
	@param aCid The CID of the binary data
williamr@4
    46
	@param aErrorcode The parsing error code.  If this is not KErrNone, special
williamr@4
    47
	action may be required.
williamr@4
    48
	@leave - One of the system-wide error codes
williamr@4
    49
 	*/
williamr@4
    50
	virtual void OnBinaryContentL(const TDesC8& aBytes,
williamr@4
    51
	                              const TDesC8& aCid,
williamr@4
    52
	                              TInt aErrorCode) = 0;
williamr@4
    53
	
williamr@4
    54
	/**
williamr@4
    55
	Called when a reference to external data has been parsed.  
williamr@4
    56
	@see CXmlEngDeserializer::ExternalData()
williamr@4
    57
williamr@4
    58
	Any class derived from TXmlEngDataContainer may be passed to this function.
williamr@4
    59
	@see TXmlEngBinaryContainer
williamr@4
    60
	@see TXmlEngChunkContainer
williamr@4
    61
	@see TXmlEngFileContainer
williamr@4
    62
williamr@4
    63
	@param aContainer The container that holds the external binary data.
williamr@4
    64
	@param aErrorcode The parsing error code.  If this is not KErrNone, special
williamr@4
    65
	action may be required.
williamr@4
    66
	@leave - One of the system-wide error codes
williamr@4
    67
 	*/	
williamr@4
    68
	virtual void OnDataContainerL( const TXmlEngDataContainer& aContainer, 
williamr@4
    69
								   TInt aErrorCode) = 0;
williamr@4
    70
	};
williamr@4
    71
williamr@4
    72
#endif //XMLENGINE_EXTENDEDCONTENTHANDLER_H
williamr@4
    73