Collapse all Symbian^3 Application Developer Library

CMDXMLDocument Class Reference

class CMDXMLDocument : public CBase

An XML document.

An object of this type owns the root element of a DOM tree and is not itself an XML node.

Inherits from

CMDXMLDocument
- CBase

Public Member Functions
	~CMDXMLDocument ()
IMPORT_C TBool	CanElementHaveChildren (const TDesC &)
const TDesC &	DocTypeTag ()
CMDXMLElement *	DocumentElement ()
const MXMLDtd &	DtdRepresentation ()
IMPORT_C CMDXMLDocument *	NewL ( MXMLDtd &)
IMPORT_C CMDXMLDocument *	NewL ()
IMPORT_C CMDXMLDocument *	NewLC ( MXMLDtd &)
IMPORT_C CMDXMLDocument *	NewLC ()
IMPORT_C TBool	SetDocTypeTagL (const TDesC &)
IMPORT_C TBool	SetVersionTagL (const TDesC &)
IMPORT_C TBool	ValidElementNameL (const TDesC &)
const TDesC &	VersionTag ()

Private Member Functions
	CMDXMLDocument ( MXMLDtd &)
	CMDXMLDocument ()
void	ConstructL ()
IMPORT_C void	PlaceholderForRemovedExport1 ( MXMLDtd &)
IMPORT_C void	PlaceholderForRemovedExport2 ()
void	SetDocumentElement ( CMDXMLElement *)

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()

Protected Attributes
HBufC *	iDocTypeTag
HBufC *	iVersionTag

Private Attributes
MXMLDtd *	iDtdRepresentation
TBool	iOwnsDtd
CMDXMLElement *	iRootElement

Constructor & Destructor Documentation

CMDXMLDocument(MXMLDtd &)

CMDXMLDocument

(

MXMLDtd &

aDtdRepresentation

)

[private]

Parameters

MXMLDtd & aDtdRepresentation

CMDXMLDocument()

CMDXMLDocument

(

)

[private]

~CMDXMLDocument()

IMPORT_C

~CMDXMLDocument

(

)

[virtual]

Destructor.

Member Functions Documentation

CanElementHaveChildren(const TDesC &)

IMPORT_C TBool

CanElementHaveChildren

(

const TDesC &

aElement

)

const

Tests whether it is valid for a particular element to have children.

Parameters

const TDesC & aElement

the name of the element to be tested

ConstructL()

void

ConstructL

(

)

[private]

DocTypeTag()

const TDesC &

DocTypeTag

(

)

const [inline]

Gets the document's DOCTYPE declaration.

DocumentElement()

CMDXMLElement *

DocumentElement

(

)

[inline]

Gets the root element of the DOM tree.

DtdRepresentation()

const MXMLDtd &

DtdRepresentation

(

)

const

Gets a reference to the MXMLDtd object to use for DTD validation checking.

NewL(MXMLDtd &)

IMPORT_C CMDXMLDocument *

NewL

(

MXMLDtd &

iDtdRepresentation

)

[static]

Allocates and constructs a new CMDXMLDocument .

leave: KErrNoMemory Out of memory

Parameters

MXMLDtd & iDtdRepresentation

DTD for the document

NewL()

IMPORT_C CMDXMLDocument *

NewL

(

)

[static]

Allocates and constructs a new CMDXMLDocument , without specifying a DTD.

Documents created using this function will not be able to validate the XML.

leave: KErrNoMemory Out of memory

NewLC(MXMLDtd &)

IMPORT_C CMDXMLDocument *

NewLC

(

MXMLDtd &

iDtdRepresentation

)

[static]

Allocates and constructs a new CMDXMLDocument , leaving the object on the cleanup stack.

leave: KErrNoMemory Out of memory

Parameters

MXMLDtd & iDtdRepresentation

DTD for the document

NewLC()

IMPORT_C CMDXMLDocument *

NewLC

(

)

[static]

Allocates and constructs a new CMDXMLDocument , without specifying a DTD, leaving the object on the cleanup stack.

Documents created using this function will not be able to validate the XML.

leave: KErrNoMemory Out of memory

PlaceholderForRemovedExport1(MXMLDtd &)

IMPORT_C void

PlaceholderForRemovedExport1

(

MXMLDtd &

aDtdRepresentation

)

[private]

Parameters

MXMLDtd & aDtdRepresentation

PlaceholderForRemovedExport2()

IMPORT_C void

PlaceholderForRemovedExport2

(

)

[private]

SetDocTypeTagL(const TDesC &)

IMPORT_C TBool

SetDocTypeTagL

(

const TDesC &

aDocTypeTag

)

Sets the document's DOCTYPE declaration.

leave: KErrNoMemory Out of memory

Parameters

const TDesC & aDocTypeTag

The XML DOCTYPE declaration. This must begin<!DOCTYPE and end >.

SetDocumentElement(CMDXMLElement *)

void

SetDocumentElement

(

CMDXMLElement *

aRootElement

)

[private, inline]

Parameters

CMDXMLElement * aRootElement

SetVersionTagL(const TDesC &)

IMPORT_C TBool

SetVersionTagL

(

const TDesC &

aVersionTag

)

Sets the document's XML version processing instruction.

leave: KErrNoMemory Out of memory

Parameters

const TDesC & aVersionTag

The XML version processing instruction. This must begin with <?xml and end with >, for example <?xml version="1.0"?>.

ValidElementNameL(const TDesC &)

IMPORT_C TBool

ValidElementNameL

(

const TDesC &

aElement

)

const

Tests whether an element name is valid for the document.

leave: KErrNoMemory Out of memory

Parameters

const TDesC & aElement

The element name to be tested

VersionTag()

const TDesC &

VersionTag

(

)

const [inline]

Gets the document's XML version processing instruction.

Member Data Documentation

HBufC * iDocTypeTag

HBufC *

iDocTypeTag

[protected]

Document type text

MXMLDtd * iDtdRepresentation

MXMLDtd *

iDtdRepresentation

[private]

TBool iOwnsDtd

TBool

iOwnsDtd

[private]

CMDXMLElement * iRootElement

CMDXMLElement *

iRootElement

[private]

HBufC * iVersionTag

HBufC *

iVersionTag

[protected]

XML Version text