Logo Search packages:      
Sourcecode: mapnik 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 1359 of file tinyxml.h.


Public 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_PARSING_CDATA,
  TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT
}
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}

Public Member Functions

virtual bool Accept (TiXmlVisitor *content) const
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 () const
 The column where the error occured. See ErrorRow().
const char * ErrorDesc () const
 Contains a textual (english) description of the error if one occurs.
int ErrorId () const
int ErrorRow () const
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlNodeFirstChild (const char *value) const
TiXmlNodeFirstChild ()
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlElementFirstChildElement (const char *_value)
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement ()
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlDocumentGetDocument ()
const TiXmlDocumentGetDocument () const
const void * GetUserData () const
 Get a pointer to arbitrary user data.
void * GetUserData ()
 Get a pointer to arbitrary user data.
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
TiXmlNodeIterateChildren (const char *_value, const TiXmlNode *previous)
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNodeIterateChildren (const TiXmlNode *previous)
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
TiXmlNodeLastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNodeLastChild (const char *value) const
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNodeLastChild () const
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
bool LoadFile (FILE *, 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 *_next)
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling ()
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlElementNextSiblingElement (const char *_next)
const TiXmlElementNextSiblingElement (const char *) const
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement () const
bool NoChildren () const
 Returns true if this node has no children.
void operator= (const TiXmlDocument &copy)
const TiXmlNodeParent () const
TiXmlNodeParent ()
 One step up the DOM.
virtual const char * Parse (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
TiXmlNodePreviousSibling (const char *_prev)
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling ()
const 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 TiXmlElementRootElement () const
int Row () const
bool SaveFile (FILE *) const
 Save a file using the given FILE*. Returns true if successful.
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)
 Set a pointer to arbitrary user data.
void SetValue (const char *_value)
int TabSize () const
 TiXmlDocument (const TiXmlDocument &copy)
 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.
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null not of the requested type.
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
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 Member Functions

virtual TiXmlNodeClone () const
void CopyTo (TiXmlNode *target) const
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)

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 (int c)
static bool IsWhiteSpace (char c)
static void PutString (const TIXML_STRING &str, TIXML_STRING *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 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
bool useMicrosoftBOM

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

Generated by  Doxygen 1.6.0   Back to index