Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

TiXmlDocument Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

TiXmlNode TiXmlBase 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.
bool LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool SaveFile () const
 SaveXML a file using the current document value. Returns true if successful.
bool LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 LoadXML a file using the given filename. Returns true if successful.
bool SaveFile (const char *filename) const
 SaveXML a file using the given filename. Returns true if successful.
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
 Contains a textual (english) description of the error if one occurs.
const int ErrorId () const
int ErrorRow ()
int ErrorCol ()
 The column where the error occured. See ErrorRow().
void SetTabSize (int _tabsize)
void ClearError ()
void Print () const
virtual void Print (FILE *cfile, int depth=0) const
 Print this Document to a FILE stream.

Protected Member Functions

virtual TiXmlNode * Clone () const

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 1090 of file tinyxml.h.

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 1197 of file tinyxml.h.

Referenced by Parse(), and TiXmlDocument().

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.

Definition at line 877 of file tinyxml.cpp.

References TiXmlDocument().

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 1150 of file tinyxml.h.

Referenced by LoadFile().

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.Definition at line 1158 of file tinyxml.h.

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 1167 of file tinyxml.h.

bool TiXmlDocument::LoadFile (  TiXmlEncoding  encoding = TIXML_DEFAULT_ENCODING  ) 
 

LoadXML a file using the current document value. Returns true if successful. Will delete any existing document data before loading.Definition at line 767 of file tinyxml.cpp.

Referenced by CXMLResource::LoadXML().

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.

Definition at line 674 of file tinyxmlparser.cpp.

References ClearError(), TiXmlDeclaration::Encoding(), TiXmlNode::LinkEndChild(), TiXmlBase::Parse(), and TiXmlNode::ToDeclaration().

Referenced by LoadFile().

void TiXmlDocument::Print (   )  const [inline]
 

Dump the document to standard out. Definition at line 1205 of file tinyxml.h.

References TiXmlElement::Print().

Referenced by SaveFile().

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 1143 of file tinyxml.h.

References TiXmlNode::FirstChildElement().

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.LoadXML( "myfile.xml" );

See also:
Row, Column
Definition at line 1190 of file tinyxml.h.

The documentation for this class was generated from the following files:
Generated on Sun Jul 17 21:34:30 2005 for OpenGL GUI by doxygen 1.3.8