- Cal3D 0.9 API Reference -

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   Related Pages  

TiXmlDocument Class Reference

Always the top level node. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

TiXmlNode TiXmlBase List of all members.

Public Methods

 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.

virtual ~TiXmlDocument ()
bool LoadFile ()
 Load a file using the current document value. More...

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)
 Parse the given null terminated block of xml data.

TiXmlElement * RootElement () const
 Get the root element -- the only top level element -- of the document. More...

bool Error () const
 If, during parsing, a 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() ). More...

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

void SetError (int err)

Protected Methods

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

int TiXmlDocument::ErrorId (    )  const [inline]
 

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

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

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

Parameters:
filename  STL std::string version.

bool TiXmlDocument::LoadFile (    ) 
 

Load a file using the current document value.

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

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

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.

The documentation for this class was generated from the following files:
Generated at Sun Oct 12 18:38:50 2003 by The Cal3D Team with doxygen 1.2.14 © 1997-2001 Dimitri van Heesch