TiXmlDocument Class Reference

Always the top level node. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

[legend]Collaboration diagram for TiXmlDocument:

[legend]List of all members.

Public Member Functions
	TiXmlDocument ()
	Create an empty document, that has no name.
	TiXmlDocument (const char *documentName)
	Create a document with a name. The name of the document is also the filename of the xml.
	TiXmlDocument (const std::string &documentName)
	Constructor.
virtual	~TiXmlDocument ()
bool	LoadFile ()
	Load a file using the current document value.
bool	SaveFile () const
	Save a file using the current document value. Returns true if successful.
bool	LoadFile (const char *filename)
	Load a file using the given filename. Returns true if successful.
bool	SaveFile (const char *filename) const
	Save a file using the given filename. Returns true if successful.
bool	LoadFile (const std::string &filename)
bool	SaveFile (const std::string &filename) const
	< STL std::string version.
virtual const char *	Parse (const char *p)
	Parse the given null terminated block of xml data.
TiXmlElement *	RootElement () const
	Get the root element -- the only top level element -- of the document.
bool	Error () const
	If, during parsing, a error occurs, Error will be set to true.
const char *	ErrorDesc () const
	Contains a textual (english) description of the error if one occurs.
const int	ErrorId () const
	Generally, you probably want the error string ( ErrorDesc() ).
void	ClearError ()
	If you have handled the error, it can be reset with this call.
void	Print () const
	Dump the document to standard out.
virtual void	Print (FILE *cfile, int depth=0) const
	All TinyXml classes can print themselves to a filestream.
void	SetError (int err)
Protected Member Functions
virtual void	StreamOut (TIXML_OSTREAM *out) const
virtual TiXmlNode *	Clone () const
virtual void	StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
Private Attributes
bool	error
int	errorId
TIXML_STRING	errorDesc

---

Detailed Description

Always the top level node.

A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.

---

Constructor & Destructor Documentation

TiXmlDocument::TiXmlDocument

(

)

Create an empty document, that has no name.

TiXmlDocument::TiXmlDocument

(

const char *

documentName

)

Create a document with a name. The name of the document is also the filename of the xml.

TiXmlDocument::TiXmlDocument

(

const std::string &

documentName

)

[inline]

Constructor.

virtual TiXmlDocument::~TiXmlDocument

(

)

[inline, virtual]

---

Member Function Documentation

void TiXmlDocument::ClearError

(

)

[inline]

If you have handled the error, it can be reset with this call.

virtual TiXmlNode* TiXmlDocument::Clone

(

)

const [protected, virtual]

Implements TiXmlNode.

bool TiXmlDocument::Error

(

)

const [inline]

If, during parsing, a error occurs, Error will be set to true.

const char* TiXmlDocument::ErrorDesc

(

)

const [inline]

Contains a textual (english) description of the error if one occurs.

const int TiXmlDocument::ErrorId

(

)

const [inline]

Generally, you probably want the error string ( ErrorDesc() ).

But if you prefer the ErrorId, this function will fetch it.

bool TiXmlDocument::LoadFile

(

const std::string &

filename

)

[inline]

Parameters:

filename

STL std::string version.

bool TiXmlDocument::LoadFile

(

const char *

filename

)

Load a file using the given filename. Returns true if successful.

bool TiXmlDocument::LoadFile

(

)

Load a file using the current document value.

Returns true if successful. Will delete any existing document data before loading.

virtual const char* TiXmlDocument::Parse

(

const char *

p

)

[virtual]

Parse the given null terminated block of xml data.

Implements TiXmlBase.

virtual void TiXmlDocument::Print	(	FILE *	cfile,
		int	depth = 0
	)			const [virtual]

All TinyXml classes can print themselves to a filestream.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

void TiXmlDocument::Print

(

)

const [inline]

Dump the document to standard out.

TiXmlElement* TiXmlDocument::RootElement

(

)

const [inline]

Get the root element -- the only top level element -- of the document.

In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.

bool TiXmlDocument::SaveFile

(

const std::string &

filename

)

const [inline]

< STL std::string version.

bool TiXmlDocument::SaveFile

(

const char *

filename

)

const

Save a file using the given filename. Returns true if successful.

bool TiXmlDocument::SaveFile

(

)

const

Save a file using the current document value. Returns true if successful.

void TiXmlDocument::SetError

(

int

err

)

[inline]

virtual void TiXmlDocument::StreamIn	(	TIXML_ISTREAM *	in,
		TIXML_STRING *	tag
	)			[protected, virtual]

Implements TiXmlNode.

virtual void TiXmlDocument::StreamOut

(

TIXML_OSTREAM *

out

)

const [protected, virtual]

Implements TiXmlBase.

---

Member Data Documentation

bool TiXmlDocument::error [private]

TIXML_STRING TiXmlDocument::errorDesc [private]

int TiXmlDocument::errorId [private]

---

The documentation for this class was generated from the following file:

• aedGUI/tinyxml/tinyxml.h

---