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.
	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 (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the given FILE*.
bool	SaveFile (FILE *) const
	Save a file using the given FILE*. 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)
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null not of the requested type.
Protected Member Functions
virtual void	StreamOut (TIXML_OSTREAM *out) const
virtual TiXmlNode *	Clone () const
	Create an exact duplicate of this node and return it.
virtual void	StreamIn (TIXML_ISTREAM in, TIXML_STRING tag)
Private Member Functions
void	CopyTo (TiXmlDocument *target) const
Private Attributes
bool	error
int	errorId
TIXML_STRING	errorDesc
int	tabsize
TiXmlCursor	errorLocation
bool	useMicrosoftBOM

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 )

Constructor.

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

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.
The error state is automatically cleared if you Parse a new XML block.

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.

void TiXmlDocument::CopyTo ( TiXmlDocument * target ) const [private]

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)

int TiXmlDocument::ErrorCol ( ) [inline]

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

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

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

int TiXmlDocument::ErrorId ( ) const [inline]

Generally, you probably want the error string ( ErrorDesc() ).
But if you prefer the ErrorId, this function will fetch it.

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

bool TiXmlDocument::LoadFile ( const std::string & filename,

TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING

) [inline]

Parameters:

encoding STL std::string version.

bool TiXmlDocument::LoadFile ( FILE * ,

TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING

)

Load a file using the given FILE*.
Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.

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 )

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.

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.

TiXmlElement* TiXmlDocument::RootElement ( ) [inline]

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.

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

< STL std::string version.

bool TiXmlDocument::SaveFile ( FILE * ) const

Save a file using the given FILE*. Returns true if successful.

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

void TiXmlDocument::StreamIn ( TIXML_ISTREAM * in,

TIXML_STRING * tag

) [protected, virtual]

Implements TiXmlNode.

void TiXmlDocument::StreamOut ( TIXML_OSTREAM * out ) const [protected, virtual]

Implements TiXmlBase.

int TiXmlDocument::TabSize ( ) const [inline]

virtual TiXmlDocument* TiXmlDocument::ToDocument ( ) [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

virtual const TiXmlDocument* TiXmlDocument::ToDocument ( ) const [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Member Data Documentation

bool TiXmlDocument::error [private]

TIXML_STRING TiXmlDocument::errorDesc [private]

int TiXmlDocument::errorId [private]

TiXmlCursor TiXmlDocument::errorLocation [private]

int TiXmlDocument::tabsize [private]

bool TiXmlDocument::useMicrosoftBOM [private]

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

Generated for TinyXPath by

TiXmlDocument Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation