epoc32/include/xml/dom/xmlengdataserializer.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 /*
     1 // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 2006-2006 Nokia Corporation and/or its subsidiary(-ies). 
     2 // All rights reserved.
     3 * All rights reserved.
     3 // This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     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
     5 // which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 *
     8 // Initial Contributors:
     9 * Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    10 //
    11 *
    11 // Contributors:
    12 * Contributors:
    12 //
    13 *
    13 // Description:
    14 * Description:       Interface class describing class that may be used as
    14 // Interface class describing class that may be used as
    15 *                serializer for binary data
    15 // serializer for binary data
    16 *
    16 //
    17 */
       
    18 
    17 
    19 
    18 
    20 
    19 
       
    20 /**
       
    21  @file
       
    22  @publishedAll
       
    23  @released
       
    24 */
       
    25 #ifndef XMLENGMDATASERIALIZER_H
       
    26 #define XMLENGMDATASERIALIZER_H
    21 
    27 
    22 
    28 #include <xml/dom/xmlengnode.h>
    23 
       
    24 
       
    25 #ifndef XMLENGINE_MDATASERIALIZER_H_INCLUDED
       
    26 #define XMLENGINE_MDATASERIALIZER_H_INCLUDED
       
    27 
       
    28 #include "xmlengnode.h"
       
    29 
    29 
    30 /**
    30 /**
    31  * MXmlEngDataSerializer interface used by XML Engine to serialize binary data for example binary data
    31 This interface is used to serialize binary data stored in a node, external
    32  * stored in node, external memory chunk (RChunk) or file. This interface may be implemented by client application.
    32 memory chunk (RChunk) or file.  This interface may be implemented by client
    33  *
    33 applications.
    34  * @lib XmlEngineDOM.lib
    34 @see TXmlEngSerializationOptions
    35  * @since S60 v3.2
    35 */
    36  */
       
    37 class MXmlEngDataSerializer
    36 class MXmlEngDataSerializer
    38     {
    37     {
    39 public:
    38 public:
    40     /**
    39     /** 
    41      * Callback for serializing data
    40 	Serializes the node.  The implementor of this class must allocate and own
    42      *
    41 	the memory returned by this method until serialization is complete.
    43      * @since S60 v3.1
    42     @param aNode A node to serialize
    44      * @param aNode is a node to serialize
    43     @return The serialized node
    45      * @return Replacement string for node data
    44 	@leave - One of the system-wide error codes
    46      */
    45     */
    47     virtual TPtrC8 SerializeDataL(TXmlEngNode aNode) = 0;
    46     virtual TPtrC8 SerializeDataL(TXmlEngNode aNode) = 0;
    48     };
    47     };
    49 
    48 
    50 
    49 
    51 #endif /* XMLENGINE_MDATASERIALIZER_H_INCLUDED */  
    50 #endif /* XMLENGMDATASERIALIZER_H */