epoc32/include/xml/dom/xmlengdatacontainer.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:       All binary data functions
    14 // All binary data functions
    15 *
    15 //
    16 */
       
    17 
    16 
    18 
    17 
    19 
    18 
       
    19 /**
       
    20  @file
       
    21  @publishedAll
       
    22  @released
       
    23 */
       
    24 #ifndef XMLENGDATACONTAINER_H
       
    25 #define XMLENGDATACONTAINER_H
    20 
    26 
    21 
    27 #include <xml/dom/xmlengnode.h>
    22 
       
    23 
       
    24 #ifndef XMLENGINE_DATACONTAINER_H_INCLUDED
       
    25 #define XMLENGINE_DATACONTAINER_H_INCLUDED
       
    26 
       
    27 #include "xmlengnode.h"
       
    28 
       
    29 
    28 
    30 /**
    29 /**
    31 * TXmlEngDataContainer is a class for representing different types
    30 This class represents different types of binary data in DOM tree.
    32 * of binary data in DOM tree.
    31 
    33 *
    32 It can be custom-serialized using the MXmlEngDataSerializer interface which can 
    34 * It can be cusom-serialized using MXmlEngDataSerializer interface which can 
    33 be set in the TXmlEngSerializationOptions used for saving the tree.
    35 * be set in TXmlEngSerializationOptions used for saving the tree.
       
    36 *
       
    37 * @lib XmlEngineDOM.lib
       
    38 * @since S60 v3.2
       
    39 */
    34 */
    40 class TXmlEngDataContainer : public TXmlEngNode
    35 class TXmlEngDataContainer : public TXmlEngNode
    41 {
    36 {
    42 public:
    37 public:
    43 
    38 
    44     /**
    39     /** Get CID of data container.
    45      * Get CID of data container.
    40     @return Cid of data container
    46      *
    41     */
    47      * @since S60 v3.2
       
    48      * @return Cid of data container
       
    49      * 
       
    50      */
       
    51     IMPORT_C TPtrC8 Cid() const;
    42     IMPORT_C TPtrC8 Cid() const;
    52         
    43         
    53     /**
    44     /** Get data size in bytes
    54      * Get data size in bytes
    45     @return Number of bytes occupied by data
    55      *
    46     */
    56      * @since S60 v3.1
       
    57      * @return Number of bytes occupied by data
       
    58      */
       
    59     IMPORT_C TUint Size() const;
    47     IMPORT_C TUint Size() const;
    60 
    48 
    61 protected:
    49 protected:
    62     /**
    50     /** Default constructor */
    63      * Default constructor
       
    64 	 *
       
    65      * @since S60 v3.1
       
    66      */
       
    67 	inline TXmlEngDataContainer(); 
    51 	inline TXmlEngDataContainer(); 
    68 
    52 
    69     /**
    53     /**
    70      * Constructor
    54     Constructor
    71      *
    55     @param aInternal node pointer
    72      * @since S60 v3.1
    56     */
    73      * @param aInternal node pointer
       
    74      */
       
    75 	inline TXmlEngDataContainer(void* aInternal);
    57 	inline TXmlEngDataContainer(void* aInternal);
    76 };
    58 };
       
    59  
       
    60 #include <xml/dom/xmlengdatacontainer.inl>
    77 
    61 
       
    62 #endif /* XMLENGDATACONTAINER_H */
    78 
    63 
    79  
       
    80 #include "xmlengdatacontainer.inl"
       
    81 
       
    82 #endif /* XMLENGINE_DATACONTAINER_H_INCLUDED */