TXmlEngChunkContainer Class Reference

#include <xml/dom/xmlengchunkcontainer.h>

Link against: xmlenginedom.lib

class TXmlEngChunkContainer : public TXmlEngDataContainer

Inherits from

Public Member Functions
IMPORT_C RChunk &Chunk()
IMPORT_C TUintChunkOffset()
Protected Member Functions
TXmlEngChunkContainer()
TXmlEngChunkContainer(void *)
Inherited Attributes
TXmlEngNode::iInternal
Inherited Enumerations
TXmlEngNode:TXmlEngDOMNodeType
Inherited Functions
TXmlEngDataContainer::Cid()const
TXmlEngDataContainer::Size()const
TXmlEngDataContainer::TXmlEngDataContainer()
TXmlEngDataContainer::TXmlEngDataContainer(void *)
TXmlEngNode::AddUserData(MXmlEngUserData *)
TXmlEngNode::AppendChildL(TXmlEngNode)
TXmlEngNode::AsAttr()const
TXmlEngNode::AsBinaryContainer()const
TXmlEngNode::AsCDATASection()const
TXmlEngNode::AsChunkContainer()const
TXmlEngNode::AsComment()const
TXmlEngNode::AsDataContainer()const
TXmlEngNode::AsDocumentFragment()const
TXmlEngNode::AsElement()const
TXmlEngNode::AsEntityReference()const
TXmlEngNode::AsFileContainer()const
TXmlEngNode::AsNamespace()const
TXmlEngNode::AsProcessingInstruction()const
TXmlEngNode::AsText()const
TXmlEngNode::BaseUriL(RBuf8 &)const
TXmlEngNode::CopyL()const
TXmlEngNode::CopyToL(TXmlEngNode)const
TXmlEngNode::DoUnlinkNode()
TXmlEngNode::FirstChild()const
TXmlEngNode::GetChildNodes(RXmlEngNodeList< TXmlEngNode > &)const
TXmlEngNode::HasAttributes()const
TXmlEngNode::HasChildNodes()const
TXmlEngNode::InnerXmlL(RBuf8 &)
TXmlEngNode::IsDefaultNamespaceL(const TDesC8 &)const
TXmlEngNode::IsNull()const
TXmlEngNode::IsSameNode(TXmlEngNode)const
TXmlEngNode::IsSimpleTextContents()const
TXmlEngNode::LastChild()const
TXmlEngNode::LinkBefore(TXmlEngNode)
TXmlEngNode::LookupNamespaceUriL(const TDesC8 &)const
TXmlEngNode::LookupPrefixL(const TDesC8 &)const
TXmlEngNode::MoveAfterSibling(TXmlEngNode)
TXmlEngNode::MoveBeforeSibling(TXmlEngNode)
TXmlEngNode::MoveTo(TXmlEngNode)
TXmlEngNode::MoveToL(TXmlEngNode)
TXmlEngNode::Name()const
TXmlEngNode::NamespaceDeclaration()const
TXmlEngNode::NamespaceUri()const
TXmlEngNode::NextSibling()const
TXmlEngNode::NodeType()const
TXmlEngNode::NotNull()const
TXmlEngNode::OuterXmlL(RBuf8 &)
TXmlEngNode::OwnerDocument()const
TXmlEngNode::ParentNode()const
TXmlEngNode::Prefix()const
TXmlEngNode::PreviousSibling()const
TXmlEngNode::ReconcileNamespacesL()
TXmlEngNode::Remove()
TXmlEngNode::RemoveUserData()
TXmlEngNode::ReplaceWith(TXmlEngNode)
TXmlEngNode::ReplaceWithL(TXmlEngNode)
TXmlEngNode::SetAsFirstSibling()
TXmlEngNode::SetAsLastSibling()
TXmlEngNode::SetValueL(const TDesC8 &)
TXmlEngNode::SubstituteForL(TXmlEngNode)
TXmlEngNode::TXmlEngNode()
TXmlEngNode::TXmlEngNode(void *)
TXmlEngNode::Unlink()
TXmlEngNode::UserData()const
TXmlEngNode::Value()const
TXmlEngNode::WholeTextContentsCopyL(RBuf8 &)const

Detailed Description

This class stores a reference to a RChunk handle within the DOM tree. No ownership is tranferred and the client is expected to close the RChunk when it is no longer required. Multiple chunk containers can refer to the same RChunk, regardless of whether the offsets overlap.

This class is most often instantiated by calling RXmlEngDocument::CreateChunkContainerL().

Sample code for creating chunk container:
     RXmlEngDOMImplementation domImpl;
     domImpl.OpenL();        // opening DOM implementation object 
     RXmlEngDocument iDoc; 
     // create document element
     TXmlEngElement elem = iDoc.CreateDocumentElementL(_L8("doc"));
     // create RChunk object with chunkName name and size
     RChunk chunk;
     chunk.CreateGlobal(chunkName, size, maxSize);
     CleanupClosePushL(chunk); 
     // create chunk container from Rchunk object with offset to the 
     // binary data in chunk and binary data size in chunk (binarySize) 
     TXmlEngChunkContainer binData = iDoc.CreateChunkContainerL(
								cid,chunk,offset,binarySize); 
     // append chunkcontainer to the dom tree          
     TXmlEngNode ref = iDoc.DocumentElement().AppendChildL(binData);
     // closing all opened objects
     CleanupStack::PopAndDestroy(); //chunk
     iDoc.Close();              
     domImpl.Close();

Constructor & Destructor Documentation

TXmlEngChunkContainer ( )

TXmlEngChunkContainer()[protected, inline]

Default constructor

TXmlEngChunkContainer ( void * )

TXmlEngChunkContainer(void *aInternal)[protected, inline]

Constructor

Parameters
aInternalnode pointer

Member Function Documentation

Chunk ( )

IMPORT_C RChunk &Chunk()const

Get memory chunk reference

Return Value
Memory chunk reference

ChunkOffset ( )

IMPORT_C TUintChunkOffset()const

Get offset of binary data in memory chunk

Return Value
Offset of binary data in memory chunk