author | William Roberts <williamr@symbian.org> |
Tue, 16 Mar 2010 16:12:26 +0000 | |
branch | Symbian2 |
changeset 2 | 2fe1408b6811 |
parent 0 | 061f57f2323e |
permissions | -rw-r--r-- |
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 file container 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_FILECONTAINER_H_INCLUDED |
williamr@2 | 25 |
#define XMLENGINE_FILECONTAINER_H_INCLUDED |
williamr@2 | 26 |
|
williamr@2 | 27 |
#include "xmlengdatacontainer.h" |
williamr@2 | 28 |
|
williamr@2 | 29 |
class RFile; |
williamr@2 | 30 |
|
williamr@2 | 31 |
|
williamr@2 | 32 |
|
williamr@2 | 33 |
/** |
williamr@2 | 34 |
* Instance of TXmlEngFileContainer class represents data stored in RFile in DOM tree |
williamr@2 | 35 |
* |
williamr@2 | 36 |
* RFile container is treated in general as text nodes in DOM tree. |
williamr@2 | 37 |
* Some of the fields in xmlNode structure are reused in order to save memory. |
williamr@2 | 38 |
* Data is stored in file system referenced to by RFile handle. |
williamr@2 | 39 |
* |
williamr@2 | 40 |
* Sample code for creating filecontainer: |
williamr@2 | 41 |
* @code |
williamr@2 | 42 |
* RXmlEngDOMImplementation domImpl; |
williamr@2 | 43 |
* domImpl.OpenL(); ///< opening DOM implementation object |
williamr@2 | 44 |
* RXmlEngDocument iDoc; |
williamr@2 | 45 |
* ///< create document element |
williamr@2 | 46 |
* TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc")); |
williamr@2 | 47 |
* ///< create file container from file (file1 is an RFile object) and CID equals cid |
williamr@2 | 48 |
* TXmlEngFileContainer binData = iDoc.CreateFileContainerL(cid, file1); |
williamr@2 | 49 |
* elem.AppendChildL(binData); ///< append container to the dom tree |
williamr@2 | 50 |
* iDoc.Close(); ///< closing all opened objects |
williamr@2 | 51 |
* domImpl.Close(); |
williamr@2 | 52 |
* @endcode |
williamr@2 | 53 |
* |
williamr@2 | 54 |
* @lib XmlEngineDOM.lib |
williamr@2 | 55 |
* @since S60 v3.2 |
williamr@2 | 56 |
*/ |
williamr@2 | 57 |
class TXmlEngFileContainer : public TXmlEngDataContainer |
williamr@2 | 58 |
{ |
williamr@2 | 59 |
public: |
williamr@2 | 60 |
/** |
williamr@2 | 61 |
* Get RFile reference |
williamr@2 | 62 |
* |
williamr@2 | 63 |
* @since S60 v3.2 |
williamr@2 | 64 |
* @return RFile reference |
williamr@2 | 65 |
* |
williamr@2 | 66 |
*/ |
williamr@2 | 67 |
IMPORT_C RFile& File() const; |
williamr@2 | 68 |
|
williamr@2 | 69 |
protected: |
williamr@2 | 70 |
/** |
williamr@2 | 71 |
* Default constructor |
williamr@2 | 72 |
* |
williamr@2 | 73 |
* @since S60 v3.1 |
williamr@2 | 74 |
*/ |
williamr@2 | 75 |
inline TXmlEngFileContainer(); |
williamr@2 | 76 |
|
williamr@2 | 77 |
/** |
williamr@2 | 78 |
* Constructor |
williamr@2 | 79 |
* |
williamr@2 | 80 |
* @since S60 v3.1 |
williamr@2 | 81 |
* @param aInternal node pointer |
williamr@2 | 82 |
*/ |
williamr@2 | 83 |
inline TXmlEngFileContainer(void* aInternal); |
williamr@2 | 84 |
}; |
williamr@2 | 85 |
|
williamr@2 | 86 |
|
williamr@2 | 87 |
|
williamr@2 | 88 |
#include "xmlengfilecontainer.inl" |
williamr@2 | 89 |
|
williamr@2 | 90 |
#endif /* XMLENGINE_FILECONTAINER_H_INCLUDED */ |