1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/xml/dom/xmlengbinarycontainer.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,103 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006-2006 Nokia Corporation and/or its subsidiary(-ies). 
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* 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
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:       All binary data functions
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +
    1.27 +#ifndef XMLENGINE_BINARYCONTAINER_H_INCLUDED
    1.28 +#define XMLENGINE_BINARYCONTAINER_H_INCLUDED
    1.29 +
    1.30 +#include "xmlengdatacontainer.h"
    1.31 +
    1.32 +/**
    1.33 +* Instance of TXmlEngBinaryContainer class represents binary data in 
    1.34 +* DOM tree.
    1.35 +*
    1.36 +* Binary data is treated in general as text nodes in DOM tree. 
    1.37 +* Some of the fields in xmlNode structure are reused in order to save memory. 
    1.38 +* Data is stored in process's heap memory.
    1.39 +*
    1.40 +* Sample code for creating binary container:
    1.41 +* @code  
    1.42 +*      RXmlEngDOMImplementation domImpl;
    1.43 +*      domImpl.OpenL();        ///< opening DOM implementation object 
    1.44 +*      RXmlEngDocument iDoc; 
    1.45 +*      ///< create document element
    1.46 +*      TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc"));
    1.47 +*      ///< create binary container from buffer (str1) and CID equals cid
    1.48 +*      TXmlEngBinaryContainer binData=iDoc.CreateBinaryContainerL(cid,*str1);  
    1.49 +*      elem.AppendChildL(binData);      ///< append container to the dom tree       
    1.50 +*      iDoc.Close();               ///< closing all opened objects
    1.51 +*      domImpl.Close();
    1.52 +* @endcode 
    1.53 +*
    1.54 +* @lib XmlEngineDOM.lib
    1.55 +* @since S60 v3.2
    1.56 +*/
    1.57 +class TXmlEngBinaryContainer : public TXmlEngDataContainer
    1.58 +{
    1.59 +public:
    1.60 +
    1.61 +    /**
    1.62 +     * Get content of the container.
    1.63 +     *
    1.64 +     * @since S60 v3.2
    1.65 +     * @return TPtrC8 with container content
    1.66 +     * 
    1.67 +     */
    1.68 +    IMPORT_C TPtrC8 Contents() const;
    1.69 +    
    1.70 +    /**
    1.71 +     * Sets contents of binary container
    1.72 +     *
    1.73 +     * @since S60 v3.2
    1.74 +     * @param aNewContents  The actual value to store
    1.75 +     */
    1.76 +    IMPORT_C void SetContentsL( const TDesC8& aNewContents );
    1.77 +
    1.78 +    /**
    1.79 +     * Appends contents to binary container
    1.80 +     *
    1.81 +     * @since S60 v3.2
    1.82 +     * @param aData  Content to be appended to current content
    1.83 +     */    
    1.84 +    EXPORT_C void AppendContentsL( const TDesC8& aData );
    1.85 +
    1.86 +    /**
    1.87 +     * Default constructor
    1.88 +	 *
    1.89 +     * @since S60 v3.1
    1.90 +     */
    1.91 +	inline TXmlEngBinaryContainer(); 
    1.92 +
    1.93 +protected:
    1.94 +
    1.95 +    /**
    1.96 +     * Constructor
    1.97 +     *
    1.98 +     * @since S60 v3.1
    1.99 +     * @param aInternal node pointer
   1.100 +     */
   1.101 +	inline TXmlEngBinaryContainer(void* aInternal);
   1.102 +};
   1.103 +
   1.104 +#include "xmlengbinarycontainer.inl"
   1.105 +
   1.106 +#endif /* XMLENGINE_BINARYCONTAINER_H_INCLUDED */