- Cal3D 0.11 API Reference -

Public Member Functions | Protected Member Functions | List of all members
cal3d::TiXmlDocument Class Reference

Always the top level node. More...

#include <tinyxml.h>

Inheritance diagram for cal3d::TiXmlDocument:
cal3d::TiXmlNode cal3d::TiXmlBase

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. 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, TiXmlParsingData *data=0)
 Parse the given null terminated block of xml data.
 
TiXmlElementRootElement () const
 Get the root element – the only top level element – of the document. More...
 
bool Error () const
 If an error occurs, Error will be set to true. More...
 
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() ). More...
 
int ErrorRow ()
 Returns the location (if known) of the error. More...
 
int ErrorCol ()
 The column where the error occurred. 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. More...
 
int TabSize () const
 
void ClearError ()
 If you have handled the error, it can be reset with this call. More...
 
void Print () const
 Dump the document to standard out. More...
 
virtual void Print (FILE *cfile, int depth=0) const
 All TinyXml classes can print themselves to a filestream. More...
 
void SetError (int err, const char *errorLocation, TiXmlParsingData *prevData)
 
- Public Member Functions inherited from cal3d::TiXmlNode
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode. More...
 
void SetValue (const char *_value)
 Changes the value of the node. More...
 
void SetValue (const std::string &_value)
 STL std::string form.
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNodeParent () const
 One step up the DOM.
 
TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
 
TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeLastChild () const
 
TiXmlNodeLastChild (const char *value) const
 The last child of this node. Will be null if there are no children.
 
TiXmlNodeFirstChild (const std::string &_value) const
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeIterateChildren (TiXmlNode *previous) const
 An alternate way to walk the children of a node. More...
 
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
 
TiXmlNodeIterateChildren (const std::string &_value, TiXmlNode *previous) const
 STL std::string form.
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this. More...
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this. More...
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node. More...
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
 
TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
 
TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.
 
TiXmlNodeNextSibling () const
 Navigate to a sibling node.
 
TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
TiXmlElementNextSiblingElement () const
 Convenience function to get through elements. More...
 
TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements. More...
 
TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.
 
TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
 
TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.
 
virtual int Type () const
 Query the type (as an enumerated value, above) of this node. More...
 
TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in. More...
 
bool NoChildren () const
 Returns true if this node has no children.
 
TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
 
void SetUserData (void *user)
 
void * GetUserData ()
 
- Public Member Functions inherited from cal3d::TiXmlBase
int Row () const
 Return the position, in the original source file, of this node or attribute. More...
 
int Column () const
 See Row()
 

Protected Member Functions

virtual void StreamOut (TIXML_OSTREAM *out) const
 
virtual TiXmlNodeClone () const
 
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
 
- Protected Member Functions inherited from cal3d::TiXmlNode
 TiXmlNode (NodeType type)
 
TiXmlNodeIdentify (const char *start)
 
void CopyToClone (TiXmlNode *target) const
 
TIXML_STRING SValue () const
 

Additional Inherited Members

- Public Types inherited from cal3d::TiXmlNode
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 The types of XML nodes supported by TinyXml. More...
 
- Static Public Member Functions inherited from cal3d::TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not. More...
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Protected Types inherited from cal3d::TiXmlBase
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,
  TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES,
  TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT,
  TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_STRING_COUNT
}
 
- Static Protected Member Functions inherited from cal3d::TiXmlBase
static const char * SkipWhiteSpace (const char *)
 
static bool IsWhiteSpace (int c)
 
static bool StreamWhiteSpace (TIXML_ISTREAM *in, TIXML_STRING *tag)
 
static bool StreamTo (TIXML_ISTREAM *in, int character, TIXML_STRING *tag)
 
static const char * ReadName (const char *p, TIXML_STRING *name)
 
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase)
 
static const char * GetEntity (const char *in, char *value)
 
static const char * GetChar (const char *p, char *_value)
 
static void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase)
 
- Protected Attributes inherited from cal3d::TiXmlNode
TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TIXML_STRING value
 
TiXmlNodeprev
 
TiXmlNodenext
 
void * userData
 
- Protected Attributes inherited from cal3d::TiXmlBase
TiXmlCursor location
 
- Static Protected Attributes inherited from cal3d::TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

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

◆ ClearError()

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.

◆ Error()

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)

◆ ErrorId()

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.

◆ ErrorRow()

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

◆ LoadFile() [1/2]

bool cal3d::TiXmlDocument::LoadFile ( )

Load a file using the current document value.

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

◆ LoadFile() [2/2]

bool cal3d::TiXmlDocument::LoadFile ( const std::string &  filename)
inline
Parameters
filenameSTL std::string version.

◆ Print() [1/2]

void cal3d::TiXmlDocument::Print ( ) const
inline

Dump the document to standard out.

◆ Print() [2/2]

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.

◆ RootElement()

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.

◆ SetTabSize()

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 by The Cal3D Team with Doxygen 1.8.14