Collapse all Symbian^3 Product Developer Library

ChspsDomDocument Class Reference

class ChspsDomDocument : public CBase

Provides the primary access to the document's data.

hspsdomdocument.lib

Since: S60 5.0

Inherits from

ChspsDomDocument
- CBase

Public Member Functions
	~ChspsDomDocument()
IMPORT_C ChspsDomDocument *	CloneL()
IMPORT_C ChspsDomNode *	CreateElementNSL(const TDesC8 &, const TDesC8 &)
IMPORT_C TInt	DomNodeCount()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C ChspsDomNode *	LastNode()
IMPORT_C HBufC8 *	MarshallL()
IMPORT_C ChspsDomDocument *	NewL()
IMPORT_C ChspsDomDocument *	NewL(RReadStream &)
IMPORT_C ChspsDomDocument *	NewL(const HBufC8 *)
IMPORT_C ChspsDomNode *	RootNode()
IMPORT_C void	SetRootNode(ChspsDomNode *)
IMPORT_C TInt	Size()
IMPORT_C ChspsDomStringPool &	StringPool()

Private Member Functions
	ChspsDomDocument()
void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
ChspsDomStringPool *	iDomStringPool
ChspsDomNode *	iRootNode

Constructor & Destructor Documentation

ChspsDomDocument()

ChspsDomDocument

(

)

[private]

C++ default constructor.

~ChspsDomDocument()

IMPORT_C

~ChspsDomDocument

(

)

[virtual]

Destructor.

Member Functions Documentation

CloneL()

IMPORT_C ChspsDomDocument *

CloneL

(

)

Makes a clone of this document.

Since: S60 5.0

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

CreateElementNSL(const TDesC8 &, const TDesC8 &)

IMPORT_C ChspsDomNode *	CreateElementNSL	(	const TDesC8 &	aName,
			const TDesC8 &	aNamespace
		)

Factory method to create node elements, because elements cannot exist outside the context of a document.

Since: S60 5.0

Parameters

const TDesC8 & aName	UTF-8 encoded Element name.
const TDesC8 & aNamespace	UTF-8 encoded Element namespace.

DomNodeCount()

IMPORT_C TInt

DomNodeCount

(

)

const

Get document node count.

Since: S60 5.0

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalize document's data.

Since: S60 5.0

Parameters

RWriteStream & aStream

Output stream.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalize document's data.

Since: S60 5.0

Parameters

RReadStream & aStream

Input stream.

LastNode()

IMPORT_C ChspsDomNode *

LastNode

(

)

const

Get the last node of the document.

Since: S60 5.0

MarshallL()

IMPORT_C HBufC8 *

MarshallL

(

)

Returns document's data as a streamed buffer.

Since: S60 5.0

NewL()

IMPORT_C ChspsDomDocument *

NewL

(

)

[static]

Two-phased constructor.

Since: S60 5.0

NewL(RReadStream &)

IMPORT_C ChspsDomDocument *

NewL

(

RReadStream &

aStream

)

[static]

Two-phased stream constructor.

Since: S60 5.0

Parameters

RReadStream & aStream

Source stream.

NewL(const HBufC8 *)

IMPORT_C ChspsDomDocument *

NewL

(

const HBufC8 *

aBufStream

)

[static]

Construct ChspsDomDocument from streamed HBufC8.

Since: S60 5.0

Parameters

const HBufC8 * aBufStream

Source buffer stream.

RootNode()

IMPORT_C ChspsDomNode *

RootNode

(

)

const

Get the root node of the document.

Since: S60 5.0

SetRootNode(ChspsDomNode *)

IMPORT_C void

SetRootNode

(

ChspsDomNode *

aRootNode

)

Set the root of the document tree. Root node provides primary access to document data. This class owns root node.

Since: S60 5.0

Parameters

ChspsDomNode * aRootNode

Documents's root node. Document takes ownership.

Size()

IMPORT_C TInt

Size

(

)

const

Get the size of the document's data.

Since: S60 5.0

StringPool()

IMPORT_C ChspsDomStringPool &

StringPool

(

)

const

Get reference to string pool.

Since: S60 5.0

Member Data Documentation

ChspsDomStringPool * iDomStringPool

ChspsDomStringPool *

iDomStringPool

[private]

ChspsDomNode * iRootNode

ChspsDomNode *

iRootNode

[private]