epoc32/include/xmlengbinarycontainer.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000 (2010-03-16)
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2006-2006 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     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
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:       All binary data functions
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
#ifndef XMLENGINE_BINARYCONTAINER_H_INCLUDED
williamr@2
    25
#define XMLENGINE_BINARYCONTAINER_H_INCLUDED
williamr@2
    26
williamr@2
    27
#include "xmlengdatacontainer.h"
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
* Instance of TXmlEngBinaryContainer class represents binary data in 
williamr@2
    31
* DOM tree.
williamr@2
    32
*
williamr@2
    33
* Binary data is treated in general as text nodes in DOM tree. 
williamr@2
    34
* Some of the fields in xmlNode structure are reused in order to save memory. 
williamr@2
    35
* Data is stored in process's heap memory.
williamr@2
    36
*
williamr@2
    37
* Sample code for creating binary container:
williamr@2
    38
* @code  
williamr@2
    39
*      RXmlEngDOMImplementation domImpl;
williamr@2
    40
*      domImpl.OpenL();        ///< opening DOM implementation object 
williamr@2
    41
*      RXmlEngDocument iDoc; 
williamr@2
    42
*      ///< create document element
williamr@2
    43
*      TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc"));
williamr@2
    44
*      ///< create binary container from buffer (str1) and CID equals cid
williamr@2
    45
*      TXmlEngBinaryContainer binData=iDoc.CreateBinaryContainerL(cid,*str1);  
williamr@2
    46
*      elem.AppendChildL(binData);      ///< append container to the dom tree       
williamr@2
    47
*      iDoc.Close();               ///< closing all opened objects
williamr@2
    48
*      domImpl.Close();
williamr@2
    49
* @endcode 
williamr@2
    50
*
williamr@2
    51
* @lib XmlEngineDOM.lib
williamr@2
    52
* @since S60 v3.2
williamr@2
    53
*/
williamr@2
    54
class TXmlEngBinaryContainer : public TXmlEngDataContainer
williamr@2
    55
{
williamr@2
    56
public:
williamr@2
    57
williamr@2
    58
    /**
williamr@2
    59
     * Get content of the container.
williamr@2
    60
     *
williamr@2
    61
     * @since S60 v3.2
williamr@2
    62
     * @return TPtrC8 with container content
williamr@2
    63
     * 
williamr@2
    64
     */
williamr@2
    65
    IMPORT_C TPtrC8 Contents() const;
williamr@2
    66
    
williamr@2
    67
    /**
williamr@2
    68
     * Sets contents of binary container
williamr@2
    69
     *
williamr@2
    70
     * @since S60 v3.2
williamr@2
    71
     * @param aNewContents  The actual value to store
williamr@2
    72
     */
williamr@2
    73
    IMPORT_C void SetContentsL( const TDesC8& aNewContents );
williamr@2
    74
williamr@2
    75
    /**
williamr@2
    76
     * Appends contents to binary container
williamr@2
    77
     *
williamr@2
    78
     * @since S60 v3.2
williamr@2
    79
     * @param aData  Content to be appended to current content
williamr@2
    80
     */    
williamr@2
    81
    EXPORT_C void AppendContentsL( const TDesC8& aData );
williamr@2
    82
williamr@2
    83
    /**
williamr@2
    84
     * Default constructor
williamr@2
    85
	 *
williamr@2
    86
     * @since S60 v3.1
williamr@2
    87
     */
williamr@2
    88
	inline TXmlEngBinaryContainer(); 
williamr@2
    89
williamr@2
    90
protected:
williamr@2
    91
williamr@2
    92
    /**
williamr@2
    93
     * Constructor
williamr@2
    94
     *
williamr@2
    95
     * @since S60 v3.1
williamr@2
    96
     * @param aInternal node pointer
williamr@2
    97
     */
williamr@2
    98
	inline TXmlEngBinaryContainer(void* aInternal);
williamr@2
    99
};
williamr@2
   100
williamr@2
   101
#include "xmlengbinarycontainer.inl"
williamr@2
   102
williamr@2
   103
#endif /* XMLENGINE_BINARYCONTAINER_H_INCLUDED */