TiXmlDocument Class Reference

#include <tinyxml.hh>

Inheritance diagram for TiXmlDocument:

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.

Definition at line 1226 of file tinyxml.hh.

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.
TiXmlDocument (const TiXmlDocument &copy)
void operator= (const TiXmlDocument &copy)
virtual ~TiXmlDocument ()
bool LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
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, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
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, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool SaveFile (const std::string &filename) const
< STL std::string version.
virtual const char * Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
Parse the given null terminated block of xml data.
const TiXmlElement * RootElement () const
Get the root element -- the only top level element -- of the document.
TiXmlElement * RootElement ()
bool Error () const
If an error occurs, Error will be set to true.
const char * ErrorDesc () const
Contains a textual (english) description of the error if one occurs.
int ErrorId () const
Generally, you probably want the error string ( ErrorDesc() ).
int ErrorRow ()
Returns the location (if known) of the error.
int ErrorCol ()
The column where the error occured. See ErrorRow().
void SetTabSize (int _tabsize)
SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column.
int TabSize () const
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
Print this Document to a FILE stream.
void SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)
void FormatStream (bool fm)
virtual void StreamOut (TIXML_OSTREAM *out, int depth) const

Public Attributes

int formatStream

Protected Member Functions

virtual TiXmlNode * Clone () const
Create an exact duplicate of this node and return it.
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)

Friends

VUTIL_API std::ostream & operator> (std::ostream &out, const TiXmlDocument &base)
VUTIL_API std::string & operator<< (std::string &out, const TiXmlDocument &base)

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 )

Constructor.

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

virtual TiXmlDocument::~TiXmlDocument ( ) [inline, virtual]

Definition at line 1242 of file tinyxml.hh.

Member Function Documentation

void TiXmlDocument::ClearError ( ) [inline]

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

The error state is automatically cleared if you Parse a new XML block.

Definition at line 1338 of file tinyxml.hh.

virtual TiXmlNode* TiXmlDocument::Clone ( ) const [protected, virtual]

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

Implements TiXmlNode.

bool TiXmlDocument::Error ( ) const [inline]

If an error occurs, Error will be set to true.

Also,

The ErrorId() will contain the integer identifier of the error (not generally useful)
The ErrorDesc() method will return the name of the error. (very useful)
The ErrorRow() and ErrorCol() will return the location of the error (if known)

Definition at line 1287 of file tinyxml.hh.

int TiXmlDocument::ErrorCol ( ) [inline]

The column where the error occured. See ErrorRow().

Definition at line 1305 of file tinyxml.hh.

const char* TiXmlDocument::ErrorDesc ( ) const [inline]

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

Definition at line 1290 of file tinyxml.hh.

int TiXmlDocument::ErrorId ( ) const [inline]

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

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

Definition at line 1295 of file tinyxml.hh.

int TiXmlDocument::ErrorRow ( ) [inline]

Returns the location (if known) of the error.

The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)

See also:: SetTabSize, Row, Column

Definition at line 1304 of file tinyxml.hh.

void TiXmlDocument::FormatStream ( bool fm )

bool TiXmlDocument::LoadFile	(	const std::string &	filename,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)			`[inline]`

Parameters:

encoding

STL std::string version.

Definition at line 1257 of file tinyxml.hh.

bool TiXmlDocument::LoadFile	(	const char *	filename,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

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

bool TiXmlDocument::LoadFile ( TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )

Load a file using the current document value.

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

void TiXmlDocument::operator= ( const TiXmlDocument & copy )

virtual const char* TiXmlDocument::Parse	(	const char *	p,
		TiXmlParsingData *	data = `0`,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)			`[virtual]`

Parse the given null terminated block of xml data.

Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.

Implements TiXmlBase.

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

Print this Document to a FILE stream.

Implements TiXmlBase.

void TiXmlDocument::Print ( ) const [inline]

Dump the document to standard out.

Definition at line 1346 of file tinyxml.hh.

TiXmlElement* TiXmlDocument::RootElement ( ) [inline]

Definition at line 1280 of file tinyxml.hh.

const 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.

Definition at line 1279 of file tinyxml.hh.

bool TiXmlDocument::SaveFile ( const std::string & filename ) const [inline]

< STL std::string version.

Definition at line 1262 of file tinyxml.hh.

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,
		const char *	errorLocation,
		TiXmlParsingData *	prevData,
		TiXmlEncoding	encoding
	)

void TiXmlDocument::SetTabSize ( int _tabsize ) [inline]

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column.

It does not change the output or input in any way.

By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.

The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.

Note that row and column tracking is not supported when using operator>>.

The tab size needs to be enabled before the parse or load. Correct usage:

                TiXmlDocument doc;
                doc.SetTabSize( 8 );
                doc.Load( "myfile.xml" );

See also:: Row, Column

Definition at line 1331 of file tinyxml.hh.

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

Implements TiXmlNode.

virtual void TiXmlDocument::StreamOut	(	TIXML_OSTREAM *	out,
		int	depth
	)			const `[virtual]`

Implements TiXmlBase.

int TiXmlDocument::TabSize ( ) const [inline]

Definition at line 1333 of file tinyxml.hh.

Friends And Related Function Documentation

VUTIL_API std::string& operator<<	(	std::string &	out,
		const TiXmlDocument &	base
	)			`[friend]`

VUTIL_API std::ostream& operator>	(	std::ostream &	out,
		const TiXmlDocument &	base
	)			`[friend]`

Member Data Documentation

int TiXmlDocument::formatStream

Definition at line 1361 of file tinyxml.hh.

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

/home/tetron/hack/vos/libs/vos/vutil/tinyxml.hh

[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]