- Cal3D 0.11 API Reference -

cal3d::TiXmlDocument

cal3d::TiXmlDocument Class Reference

Always the top level node. More...

#include <tinyxml.h>

Inheritance diagram for cal3d::TiXmlDocument:

cal3d::TiXmlNode cal3d::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.
 TiXmlDocument (const std::string &documentName)
 Constructor.
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, TiXmlParsingData *data=0)
 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 an 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() ).
int ErrorRow ()
 Returns the location (if known) of the error.
int ErrorCol ()
 The column where the error occured. See ErrorRow().
void SetTabSize (int _tabsize)
 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.
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
 All TinyXml classes can print themselves to a filestream.
void SetError (int err, const char *errorLocation, TiXmlParsingData *prevData)

Protected Member Functions

virtual void StreamOut (TIXML_OSTREAM *out) const
virtual TiXmlNode * Clone () const
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)

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.

Member Function Documentation

void cal3d::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 cal3d::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)

const int cal3d::TiXmlDocument::ErrorId (   )  const [inline]
 

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

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

int cal3d::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 cal3d::TiXmlDocument::LoadFile (  const std::string &  filename  )  [inline]
 

Parameters:
filename  STL std::string version.

bool cal3d::TiXmlDocument::LoadFile (   ) 
 

Load a file using the current document value.

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

void cal3d::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 cal3d::TiXmlBase.

TiXmlElement* cal3d::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.

void cal3d::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

The documentation for this class was generated from the following files:
Generated at Thu Jun 29 19:04:00 2006 by The Cal3D Team with Doxygen 1.4.6