author | William Roberts <williamr@symbian.org> |
Wed, 31 Mar 2010 12:33:34 +0100 | |
branch | Symbian3 |
changeset 4 | 837f303aceeb |
parent 3 | e1b950c65cb4 |
permissions | -rw-r--r-- |
williamr@4 | 1 |
// Copyright (c) 2005-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 |
// Interface class describing class that may be used as |
williamr@4 | 15 |
// output stream for dom tree |
williamr@4 | 16 |
// |
williamr@4 | 17 |
|
williamr@4 | 18 |
|
williamr@4 | 19 |
|
williamr@4 | 20 |
/** |
williamr@4 | 21 |
@file |
williamr@4 | 22 |
@publishedAll |
williamr@4 | 23 |
@released |
williamr@2 | 24 |
*/ |
williamr@4 | 25 |
#ifndef XMLENGMOUTPUTSTREAM_H |
williamr@4 | 26 |
#define XMLENGMOUTPUTSTREAM_H |
williamr@2 | 27 |
|
williamr@2 | 28 |
#include <e32base.h> |
williamr@2 | 29 |
|
williamr@2 | 30 |
|
williamr@2 | 31 |
|
williamr@2 | 32 |
/** |
williamr@4 | 33 |
Provides an interface for writing serialized XML data to a stream. This |
williamr@4 | 34 |
interface should be implemented by client applications when the |
williamr@4 | 35 |
RXmlEngDocument::SaveL() method is used to serialize XML data to a stream. |
williamr@4 | 36 |
|
williamr@4 | 37 |
No ownership is transferred by RXmlEngDocument::SaveL(), thus an object |
williamr@4 | 38 |
of the implementing class should be freed after use. |
williamr@4 | 39 |
|
williamr@4 | 40 |
@see RXmlEngDocument::SaveL() |
williamr@4 | 41 |
*/ |
williamr@2 | 42 |
class MXmlEngOutputStream |
williamr@2 | 43 |
{ |
williamr@2 | 44 |
public: |
williamr@2 | 45 |
/** |
williamr@4 | 46 |
Writes the specified buffer to the output stream. |
williamr@4 | 47 |
@param aBuffer The data to write |
williamr@4 | 48 |
@return The number of bytes written or -1 in the case of an error |
williamr@4 | 49 |
*/ |
williamr@2 | 50 |
virtual TInt Write(const TDesC8& aBuffer) = 0; |
williamr@2 | 51 |
|
williamr@2 | 52 |
/** |
williamr@4 | 53 |
Closes the output stream. |
williamr@4 | 54 |
@return 0 if successful or -1 in the case of an error |
williamr@4 | 55 |
*/ |
williamr@2 | 56 |
virtual TInt Close() = 0; |
williamr@2 | 57 |
}; |
williamr@2 | 58 |
|
williamr@4 | 59 |
#endif /* XMLENGMOUTPUTSTREAM_H */ |
williamr@2 | 60 |