williamr@4: // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4: // All rights reserved.
williamr@4: // This component and the accompanying materials are made available
williamr@4: // under the terms of "Eclipse Public License v1.0"
williamr@4: // which accompanies this distribution, and is available
williamr@4: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4: //
williamr@4: // Initial Contributors:
williamr@4: // Nokia Corporation - initial contribution.
williamr@4: //
williamr@4: // Contributors:
williamr@4: //
williamr@4: // Description:
williamr@4: // All file container data functions
williamr@4: // @file
williamr@4: // @publishedAll
williamr@4: // @released
williamr@4: //
williamr@2: 
williamr@2: 
williamr@2: 
williamr@4: #ifndef XMLENGFILECONTAINER_H
williamr@4: #define XMLENGFILECONTAINER_H
williamr@2: 
williamr@4: #include <xml/dom/xmlengdatacontainer.h>
williamr@2: 
williamr@2: class RFile;
williamr@2: 
williamr@4: /**
williamr@4: This class represents data stored as a RFile in the DOM tree.
williamr@2: 
williamr@4: The RFile container is treated in general as a text node in the DOM tree.  Data
williamr@4: is stored in the file system referenced by the RFile handle.
williamr@2: 
williamr@4: Sample code for creating a file container:
williamr@4: @code  
williamr@4:      RXmlEngDOMImplementation domImpl;
williamr@4:      domImpl.OpenL();        		// opening DOM implementation object 
williamr@4:      RXmlEngDocument iDoc; 
williamr@4:      // create document element
williamr@4:      TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc"));
williamr@4:      // create file container from file (file1 is an RFile object) and CID equals cid
williamr@4:      TXmlEngFileContainer binData = iDoc.CreateFileContainerL(cid, file1);
williamr@4:      elem.AppendChildL(binData);    // append container to the dom tree       
williamr@4:      iDoc.Close();               	// closing all opened objects
williamr@4:      domImpl.Close();
williamr@4: @endcode 
williamr@2: */
williamr@2: class TXmlEngFileContainer : public TXmlEngDataContainer
williamr@2: {
williamr@2: public:
williamr@2:     /**
williamr@4:     Gets the RFile reference
williamr@4:     @return RFile reference
williamr@4:     */
williamr@2:     IMPORT_C RFile& File() const;
williamr@2: 	
williamr@2: protected:
williamr@4:     /** Default constructor */
williamr@2: 	inline TXmlEngFileContainer(); 
williamr@2: 	
williamr@2:     /**
williamr@4:     Constructor
williamr@4:     @param aInternal Node pointer
williamr@4:     */
williamr@2: 	inline TXmlEngFileContainer(void* aInternal);
williamr@2: };
williamr@2: 
williamr@4: #include <xml/dom/xmlengfilecontainer.inl>
williamr@2: 
williamr@4: #endif // XMLENGFILECONTAINER_H 
williamr@2: