1.1 --- a/epoc32/include/xml/dom/xmlengfilecontainer.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ b/epoc32/include/xml/dom/xmlengfilecontainer.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -1,90 +1,72 @@
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 file container data functions
1.18 -*
1.19 -*/
1.20 +// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
1.21 +// All rights reserved.
1.22 +// This component and the accompanying materials are made available
1.23 +// under the terms of "Eclipse Public License v1.0"
1.24 +// which accompanies this distribution, and is available
1.25 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.26 +//
1.27 +// Initial Contributors:
1.28 +// Nokia Corporation - initial contribution.
1.29 +//
1.30 +// Contributors:
1.31 +//
1.32 +// Description:
1.33 +// All file container data functions
1.34 +// @file
1.35 +// @publishedAll
1.36 +// @released
1.37 +//
1.38
1.39
1.40
1.41 +#ifndef XMLENGFILECONTAINER_H
1.42 +#define XMLENGFILECONTAINER_H
1.43
1.44 -
1.45 -
1.46 -
1.47 -#ifndef XMLENGINE_FILECONTAINER_H_INCLUDED
1.48 -#define XMLENGINE_FILECONTAINER_H_INCLUDED
1.49 -
1.50 -#include "xmlengdatacontainer.h"
1.51 +#include <xml/dom/xmlengdatacontainer.h>
1.52
1.53 class RFile;
1.54
1.55 +/**
1.56 +This class represents data stored as a RFile in the DOM tree.
1.57
1.58 +The RFile container is treated in general as a text node in the DOM tree. Data
1.59 +is stored in the file system referenced by the RFile handle.
1.60
1.61 -/**
1.62 -* Instance of TXmlEngFileContainer class represents data stored in RFile in DOM tree
1.63 -*
1.64 -* RFile container is treated in general as text nodes in DOM tree.
1.65 -* Some of the fields in xmlNode structure are reused in order to save memory.
1.66 -* Data is stored in file system referenced to by RFile handle.
1.67 -*
1.68 -* Sample code for creating filecontainer:
1.69 -* @code
1.70 -* RXmlEngDOMImplementation domImpl;
1.71 -* domImpl.OpenL(); ///< opening DOM implementation object
1.72 -* RXmlEngDocument iDoc;
1.73 -* ///< create document element
1.74 -* TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc"));
1.75 -* ///< create file container from file (file1 is an RFile object) and CID equals cid
1.76 -* TXmlEngFileContainer binData = iDoc.CreateFileContainerL(cid, file1);
1.77 -* elem.AppendChildL(binData); ///< append container to the dom tree
1.78 -* iDoc.Close(); ///< closing all opened objects
1.79 -* domImpl.Close();
1.80 -* @endcode
1.81 -*
1.82 -* @lib XmlEngineDOM.lib
1.83 -* @since S60 v3.2
1.84 +Sample code for creating a file container:
1.85 +@code
1.86 + RXmlEngDOMImplementation domImpl;
1.87 + domImpl.OpenL(); // opening DOM implementation object
1.88 + RXmlEngDocument iDoc;
1.89 + // create document element
1.90 + TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc"));
1.91 + // create file container from file (file1 is an RFile object) and CID equals cid
1.92 + TXmlEngFileContainer binData = iDoc.CreateFileContainerL(cid, file1);
1.93 + elem.AppendChildL(binData); // append container to the dom tree
1.94 + iDoc.Close(); // closing all opened objects
1.95 + domImpl.Close();
1.96 +@endcode
1.97 */
1.98 class TXmlEngFileContainer : public TXmlEngDataContainer
1.99 {
1.100 public:
1.101 /**
1.102 - * Get RFile reference
1.103 - *
1.104 - * @since S60 v3.2
1.105 - * @return RFile reference
1.106 - *
1.107 - */
1.108 + Gets the RFile reference
1.109 + @return RFile reference
1.110 + */
1.111 IMPORT_C RFile& File() const;
1.112
1.113 protected:
1.114 - /**
1.115 - * Default constructor
1.116 - *
1.117 - * @since S60 v3.1
1.118 - */
1.119 + /** Default constructor */
1.120 inline TXmlEngFileContainer();
1.121
1.122 /**
1.123 - * Constructor
1.124 - *
1.125 - * @since S60 v3.1
1.126 - * @param aInternal node pointer
1.127 - */
1.128 + Constructor
1.129 + @param aInternal Node pointer
1.130 + */
1.131 inline TXmlEngFileContainer(void* aInternal);
1.132 };
1.133
1.134 +#include <xml/dom/xmlengfilecontainer.inl>
1.135
1.136 +#endif // XMLENGFILECONTAINER_H
1.137
1.138 -#include "xmlengfilecontainer.inl"
1.139 -
1.140 -#endif /* XMLENGINE_FILECONTAINER_H_INCLUDED */