williamr@2: /*
williamr@2: * Copyright (c) 2006-2006 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * 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: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:       All binary data functions
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef XMLENGINE_BINARYCONTAINER_H_INCLUDED
williamr@2: #define XMLENGINE_BINARYCONTAINER_H_INCLUDED
williamr@2: 
williamr@2: #include "xmlengdatacontainer.h"
williamr@2: 
williamr@2: /**
williamr@2: * Instance of TXmlEngBinaryContainer class represents binary data in 
williamr@2: * DOM tree.
williamr@2: *
williamr@2: * Binary data is treated in general as text nodes in DOM tree. 
williamr@2: * Some of the fields in xmlNode structure are reused in order to save memory. 
williamr@2: * Data is stored in process's heap memory.
williamr@2: *
williamr@2: * Sample code for creating binary container:
williamr@2: * @code  
williamr@2: *      RXmlEngDOMImplementation domImpl;
williamr@2: *      domImpl.OpenL();        ///< opening DOM implementation object 
williamr@2: *      RXmlEngDocument iDoc; 
williamr@2: *      ///< create document element
williamr@2: *      TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc"));
williamr@2: *      ///< create binary container from buffer (str1) and CID equals cid
williamr@2: *      TXmlEngBinaryContainer binData=iDoc.CreateBinaryContainerL(cid,*str1);  
williamr@2: *      elem.AppendChildL(binData);      ///< append container to the dom tree       
williamr@2: *      iDoc.Close();               ///< closing all opened objects
williamr@2: *      domImpl.Close();
williamr@2: * @endcode 
williamr@2: *
williamr@2: * @lib XmlEngineDOM.lib
williamr@2: * @since S60 v3.2
williamr@2: */
williamr@2: class TXmlEngBinaryContainer : public TXmlEngDataContainer
williamr@2: {
williamr@2: public:
williamr@2: 
williamr@2:     /**
williamr@2:      * Get content of the container.
williamr@2:      *
williamr@2:      * @since S60 v3.2
williamr@2:      * @return TPtrC8 with container content
williamr@2:      * 
williamr@2:      */
williamr@2:     IMPORT_C TPtrC8 Contents() const;
williamr@2:     
williamr@2:     /**
williamr@2:      * Sets contents of binary container
williamr@2:      *
williamr@2:      * @since S60 v3.2
williamr@2:      * @param aNewContents  The actual value to store
williamr@2:      */
williamr@2:     IMPORT_C void SetContentsL( const TDesC8& aNewContents );
williamr@2: 
williamr@2:     /**
williamr@2:      * Appends contents to binary container
williamr@2:      *
williamr@2:      * @since S60 v3.2
williamr@2:      * @param aData  Content to be appended to current content
williamr@2:      */    
williamr@2:     EXPORT_C void AppendContentsL( const TDesC8& aData );
williamr@2: 
williamr@2:     /**
williamr@2:      * Default constructor
williamr@2: 	 *
williamr@2:      * @since S60 v3.1
williamr@2:      */
williamr@2: 	inline TXmlEngBinaryContainer(); 
williamr@2: 
williamr@2: protected:
williamr@2: 
williamr@2:     /**
williamr@2:      * Constructor
williamr@2:      *
williamr@2:      * @since S60 v3.1
williamr@2:      * @param aInternal node pointer
williamr@2:      */
williamr@2: 	inline TXmlEngBinaryContainer(void* aInternal);
williamr@2: };
williamr@2: 
williamr@2: #include "xmlengbinarycontainer.inl"
williamr@2: 
williamr@2: #endif /* XMLENGINE_BINARYCONTAINER_H_INCLUDED */