epoc32/include/xml/dom/xmlengoutputstream.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
equal deleted inserted replaced
2:2fe1408b6811 3:e1b950c65cb4
       
     1 /*
       
     2 * Copyright (c) 2004-2005 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * 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
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:       Interface class describing class that may be used as
       
    15 *                 output stream for dom tree
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 #ifndef XMLENGINE_MOUTPUTSTREAM_H_INCLUDED
       
    26 #define XMLENGINE_MOUTPUTSTREAM_H_INCLUDED
       
    27 
       
    28 #include <e32base.h>
       
    29 
       
    30 
       
    31 
       
    32 /**
       
    33  * MXmlEngOutputStream is used by XML Engine to write serialized XML data
       
    34  * to stream. This interface should be implemented by client application
       
    35  * when RXmlEngDocument::SaveL() method is used to serialize xml data to stream.
       
    36  *
       
    37  * @lib XmlEngineDOM.lib
       
    38  * @since S60 v3.1
       
    39  */
       
    40 class MXmlEngOutputStream
       
    41     {
       
    42 public:
       
    43     /**
       
    44      * Callback for writing a buffer with data to output stream
       
    45      *
       
    46      * @since S60 v3.1
       
    47      * @return number of bytes written or -1 in case of error
       
    48      */
       
    49     virtual TInt Write(const TDesC8& aBuffer) = 0;
       
    50 
       
    51     /**
       
    52      * Callback for closing output stream
       
    53      *
       
    54      * @since S60 v3.1
       
    55      * @return 
       
    56      *       0 is succeeded, 
       
    57      *      -1 in case of error
       
    58      */
       
    59     virtual TInt Close() = 0;
       
    60     };
       
    61 
       
    62 
       
    63 
       
    64 #endif /* XMLENGINE_MOUTPUTSTREAM_H_INCLUDED */