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 memory chunk 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_CHUNKCONTAINER_H_INCLUDED |
williamr@2 | 25 |
#define XMLENGINE_CHUNKCONTAINER_H_INCLUDED |
williamr@2 | 26 |
|
williamr@2 | 27 |
#include "xmlengdatacontainer.h" |
williamr@2 | 28 |
|
williamr@2 | 29 |
|
williamr@2 | 30 |
/** |
williamr@2 | 31 |
* Instance of TXmlEngChunkContainer class represents data stored in RChunks in DOM tree |
williamr@2 | 32 |
* |
williamr@2 | 33 |
* RChunk data is treated in general as text nodes in DOM tree. |
williamr@2 | 34 |
* Some of the fields in xmlNode structure are reused in order to save memory. |
williamr@2 | 35 |
* Data is stored in memory referenced to by RChunk. |
williamr@2 | 36 |
* |
williamr@2 | 37 |
* Sample code for creating chunk container: |
williamr@2 | 38 |
* @code |
williamr@2 | 39 |
* RXmlEngDOMImplementation domImpl; |
williamr@2 | 40 |
* domImpl.OpenL(); ///< opening DOM implementation object |
williamr@2 | 41 |
* RXmlEngDocument iDoc; |
williamr@2 | 42 |
* ///< create document element |
williamr@2 | 43 |
* TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc")); |
williamr@2 | 44 |
* ///< create RChunk object with chunkName name and size |
williamr@2 | 45 |
* RChunk chunk; |
williamr@2 | 46 |
* chunk.CreateGlobal(chunkName, size, maxSize); |
williamr@2 | 47 |
* CleanupClosePushL(chunk); |
williamr@2 | 48 |
* ///< create chunk container from Rchunk object with offset to the |
williamr@2 | 49 |
* ///< binary data in chunk and binary data size in chunk (binarySize) |
williamr@2 | 50 |
* TXmlEngChunkContainer binData = iDoc.CreateChunkContainerL( |
williamr@2 | 51 |
* cid,chunk,offset,binarySize); |
williamr@2 | 52 |
* ///< append chunkcontainer to the dom tree |
williamr@2 | 53 |
* TXmlEngNode ref = iDoc.DocumentElement().AppendChildL(binData); |
williamr@2 | 54 |
* ///< closing all opened objects |
williamr@2 | 55 |
* CleanupStack::PopAndDestroy();//chunk |
williamr@2 | 56 |
* iDoc.Close(); |
williamr@2 | 57 |
* domImpl.Close(); |
williamr@2 | 58 |
* @endcode |
williamr@2 | 59 |
* |
williamr@2 | 60 |
* @lib XmlEngineDOM.lib |
williamr@2 | 61 |
* @since S60 v3.2 |
williamr@2 | 62 |
*/ |
williamr@2 | 63 |
class TXmlEngChunkContainer : public TXmlEngDataContainer |
williamr@2 | 64 |
{ |
williamr@2 | 65 |
public: |
williamr@2 | 66 |
/** |
williamr@2 | 67 |
* Get memory chunk reference |
williamr@2 | 68 |
* |
williamr@2 | 69 |
* @since S60 v3.2 |
williamr@2 | 70 |
* @return Memory chunk reference |
williamr@2 | 71 |
* |
williamr@2 | 72 |
*/ |
williamr@2 | 73 |
IMPORT_C RChunk& Chunk() const; |
williamr@2 | 74 |
|
williamr@2 | 75 |
/** |
williamr@2 | 76 |
* Get offset of binary data in memory chunk |
williamr@2 | 77 |
* |
williamr@2 | 78 |
* @since S60 v3.2 |
williamr@2 | 79 |
* @return Offset of binary data in memory chunk |
williamr@2 | 80 |
*/ |
williamr@2 | 81 |
IMPORT_C TUint ChunkOffset() const; |
williamr@2 | 82 |
|
williamr@2 | 83 |
protected: |
williamr@2 | 84 |
/** |
williamr@2 | 85 |
* Default constructor |
williamr@2 | 86 |
* |
williamr@2 | 87 |
* @since S60 v3.1 |
williamr@2 | 88 |
*/ |
williamr@2 | 89 |
inline TXmlEngChunkContainer(); |
williamr@2 | 90 |
|
williamr@2 | 91 |
/** |
williamr@2 | 92 |
* Constructor |
williamr@2 | 93 |
* |
williamr@2 | 94 |
* @since S60 v3.1 |
williamr@2 | 95 |
* @param aInternal node pointer |
williamr@2 | 96 |
*/ |
williamr@2 | 97 |
inline TXmlEngChunkContainer(void* aInternal); |
williamr@2 | 98 |
}; |
williamr@2 | 99 |
|
williamr@2 | 100 |
|
williamr@2 | 101 |
|
williamr@2 | 102 |
#include "xmlengchunkcontainer.inl" |
williamr@2 | 103 |
|
williamr@2 | 104 |
#endif /* XMLENGINE_CHUNKCONTAINER_H_INCLUDED */ |