Logo Search packages:      
Sourcecode: balder2d version File versions  Download package

TiXmlDocument Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

TiXmlNode TiXmlBase

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.

Definition at line 1092 of file tinyxml.h.


Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}

Public Member Functions

void Clear ()
 Delete all the children of this node. Does not affect 'this'.
void ClearError ()
int Column () const
 See Row().
bool Error () const
int ErrorCol ()
 The column where the error occured. See ErrorRow().
const char * ErrorDesc () const
 Contains a textual (english) description of the error if one occurs.
const int ErrorId () const
int ErrorRow ()
TiXmlNodeFirstChild (const std::string &_value) const
 The last child of this node matching 'value'. 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.
TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.
TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlDocumentGetDocument () const
void * GetUserData ()
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
TiXmlNodeIterateChildren (const std::string &_value, TiXmlNode *previous) const
 STL std::string form.
TiXmlNodeIterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNodeIterateChildren (TiXmlNode *previous) const
TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.
TiXmlNodeLastChild (const char *value) const
 The last child of this node. Will be null if there are no children.
TiXmlNodeLastChild () const
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
bool LoadFile (const std::string &filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
bool LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
 Load a file using the given filename. Returns true if successful.
bool LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.
TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.
TiXmlElementNextSiblingElement (const char *) const
TiXmlElementNextSiblingElement () const
bool NoChildren () const
 Returns true if this node has no children.
void operator= (const TiXmlDocument &copy)
TiXmlNodeParent () const
 One step up the DOM.
virtual const char * Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.
TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
virtual void Print (FILE *cfile, int depth=0) const
 Print this Document to a FILE stream.
void Print () const
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
TiXmlElementRootElement () const
int Row () const
bool SaveFile (const std::string &filename) const
 < STL std::string version.
bool SaveFile (const char *filename) const
 Save a file using the given filename. Returns true if successful.
bool SaveFile () const
 Save a file using the current document value. Returns true if successful.
void SetError (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)
void SetTabSize (int _tabsize)
void SetUserData (void *user)
void SetValue (const std::string &_value)
 STL std::string form.
void SetValue (const char *_value)
int TabSize () const
 TiXmlDocument (const TiXmlDocument &copy)
 TiXmlDocument (const std::string &documentName)
 Constructor.
 TiXmlDocument (const char *documentName)
 Create a document with a name. The name of the document is also the filename of the xml.
 TiXmlDocument ()
 Create an empty document, that has no name.
TiXmlCommentToComment () 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.
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.
TiXmlTextToText () 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.
virtual int Type () const
const char * Value () const

Static Public Member Functions

static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
static void SetCondenseWhiteSpace (bool condense)

Static Public Attributes

static const int utf8ByteTable [256]

Protected Types

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_EMBEDDED_NULL, TIXML_ERROR_STRING_COUNT
}

Protected Member Functions

virtual TiXmlNodeClone () const
void CopyTo (TiXmlNode *target) const
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)
virtual void StreamOut (TIXML_OSTREAM *out) const
const TIXML_STRING & SValue () const

Static Protected Member Functions

static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static bool IsWhiteSpace (char c)
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
static void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool StreamTo (TIXML_ISTREAM *in, int character, TIXML_STRING *tag)
static bool StreamWhiteSpace (TIXML_ISTREAM *in, TIXML_STRING *tag)
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static int ToLower (int v, TiXmlEncoding encoding)

Protected Attributes

TiXmlNodefirstChild
TiXmlNodelastChild
TiXmlCursor location
TiXmlNodenext
TiXmlNodeparent
TiXmlNodeprev
NodeType type
void * userData
 Field containing a generic user pointer.
TIXML_STRING value

Static Protected Attributes

static const char * errorString [TIXML_ERROR_STRING_COUNT]

Private Member Functions

void CopyTo (TiXmlDocument *target) const

Private Attributes

bool error
TIXML_STRING errorDesc
int errorId
TiXmlCursor errorLocation
int tabsize

Friends

std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string.
std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
std::istream & operator>> (std::istream &in, TiXmlNode &base)

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index