TiXmlDocument Class Reference
[Basic XML support]

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

[legend]Collaboration diagram for TiXmlDocument:

[legend]List of all members.

---

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.

Public Member Functions
	TiXmlDocument ()
	TiXmlDocument (const char *documentName)
	TiXmlDocument (const TiXmlDocument &copy)
void	operator= (const TiXmlDocument &copy)
bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool	SaveFile () const
bool	LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool	SaveFile (const char *filename) const
virtual const char *	Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
TiXmlElement *	RootElement () const
bool	Error () const
const char *	ErrorDesc () const
const int	ErrorId () const
int	ErrorRow ()
int	ErrorCol ()
void	SetTabSize (int _tabsize)
int	TabSize () const
void	ClearError ()
void	Print () const
virtual void	Print (FILE *cfile, int depth=0) const
void	SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)
Protected Member Functions
virtual void	StreamOut (TIXML_OSTREAM *out) const
virtual TiXmlNode *	Clone () const

---

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.

---

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.

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.

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.

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

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 (   )  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 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::SetTabSize (  int  _tabsize  )  [inline]

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

---