author | William Roberts <williamr@symbian.org> |
Wed, 31 Mar 2010 12:33:34 +0100 | |
branch | Symbian3 |
changeset 4 | 837f303aceeb |
parent 3 | e1b950c65cb4 |
permissions | -rw-r--r-- |
williamr@4 | 1 |
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). |
williamr@4 | 2 |
// All rights reserved. |
williamr@4 | 3 |
// This component and the accompanying materials are made available |
williamr@4 | 4 |
// under the terms of "Eclipse Public License v1.0" |
williamr@4 | 5 |
// which accompanies this distribution, and is available |
williamr@4 | 6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html". |
williamr@4 | 7 |
// |
williamr@4 | 8 |
// Initial Contributors: |
williamr@4 | 9 |
// Nokia Corporation - initial contribution. |
williamr@4 | 10 |
// |
williamr@4 | 11 |
// Contributors: |
williamr@4 | 12 |
// |
williamr@4 | 13 |
// Description: |
williamr@4 | 14 |
// All file container data functions |
williamr@4 | 15 |
// @file |
williamr@4 | 16 |
// @publishedAll |
williamr@4 | 17 |
// @released |
williamr@4 | 18 |
// |
williamr@2 | 19 |
|
williamr@2 | 20 |
|
williamr@2 | 21 |
|
williamr@4 | 22 |
#ifndef XMLENGFILECONTAINER_H |
williamr@4 | 23 |
#define XMLENGFILECONTAINER_H |
williamr@2 | 24 |
|
williamr@4 | 25 |
#include <xml/dom/xmlengdatacontainer.h> |
williamr@2 | 26 |
|
williamr@2 | 27 |
class RFile; |
williamr@2 | 28 |
|
williamr@4 | 29 |
/** |
williamr@4 | 30 |
This class represents data stored as a RFile in the DOM tree. |
williamr@2 | 31 |
|
williamr@4 | 32 |
The RFile container is treated in general as a text node in the DOM tree. Data |
williamr@4 | 33 |
is stored in the file system referenced by the RFile handle. |
williamr@2 | 34 |
|
williamr@4 | 35 |
Sample code for creating a file container: |
williamr@4 | 36 |
@code |
williamr@4 | 37 |
RXmlEngDOMImplementation domImpl; |
williamr@4 | 38 |
domImpl.OpenL(); // opening DOM implementation object |
williamr@4 | 39 |
RXmlEngDocument iDoc; |
williamr@4 | 40 |
// create document element |
williamr@4 | 41 |
TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc")); |
williamr@4 | 42 |
// create file container from file (file1 is an RFile object) and CID equals cid |
williamr@4 | 43 |
TXmlEngFileContainer binData = iDoc.CreateFileContainerL(cid, file1); |
williamr@4 | 44 |
elem.AppendChildL(binData); // append container to the dom tree |
williamr@4 | 45 |
iDoc.Close(); // closing all opened objects |
williamr@4 | 46 |
domImpl.Close(); |
williamr@4 | 47 |
@endcode |
williamr@2 | 48 |
*/ |
williamr@2 | 49 |
class TXmlEngFileContainer : public TXmlEngDataContainer |
williamr@2 | 50 |
{ |
williamr@2 | 51 |
public: |
williamr@2 | 52 |
/** |
williamr@4 | 53 |
Gets the RFile reference |
williamr@4 | 54 |
@return RFile reference |
williamr@4 | 55 |
*/ |
williamr@2 | 56 |
IMPORT_C RFile& File() const; |
williamr@2 | 57 |
|
williamr@2 | 58 |
protected: |
williamr@4 | 59 |
/** Default constructor */ |
williamr@2 | 60 |
inline TXmlEngFileContainer(); |
williamr@2 | 61 |
|
williamr@2 | 62 |
/** |
williamr@4 | 63 |
Constructor |
williamr@4 | 64 |
@param aInternal Node pointer |
williamr@4 | 65 |
*/ |
williamr@2 | 66 |
inline TXmlEngFileContainer(void* aInternal); |
williamr@2 | 67 |
}; |
williamr@2 | 68 |
|
williamr@4 | 69 |
#include <xml/dom/xmlengfilecontainer.inl> |
williamr@2 | 70 |
|
williamr@4 | 71 |
#endif // XMLENGFILECONTAINER_H |
williamr@2 | 72 |