Class TiXmlNode

• Defined in File tinyxml.h

Inheritance Relationships

Base Type

• public TiXmlBase (Class TiXmlBase)

Derived Types

• public TiXmlComment (Class TiXmlComment)

• public TiXmlDeclaration (Class TiXmlDeclaration)

• public TiXmlDocument (Class TiXmlDocument)

• public TiXmlElement (Class TiXmlElement)

• public TiXmlText (Class TiXmlText)

• public TiXmlUnknown (Class TiXmlUnknown)

Class Documentation

class TiXmlNode : public TiXmlBase

The parent class for everything in the Document Object Model. (Except for attributes). Nodes have siblings, a parent, and children. A node can be in a document, or stand on its own. The type of a TiXmlNode can be queried, and it can be cast to its more defined type.

Subclassed by TiXmlComment, TiXmlDeclaration, TiXmlDocument, TiXmlElement, TiXmlText, TiXmlUnknown

Public Types

enum NodeType

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)

Values:

enumerator TINYXML_DOCUMENT

enumerator TINYXML_ELEMENT

enumerator TINYXML_COMMENT

enumerator TINYXML_UNKNOWN

enumerator TINYXML_TEXT

enumerator TINYXML_DECLARATION

enumerator TINYXML_TYPECOUNT

Public Functions

virtual ~TiXmlNode()

inline const char *Value() const

The meaning of ‘value’ changes for the specific type of TiXmlNode.

Document:   filename of the xml file
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

The subclasses will wrap this function.

inline const TIXML_STRING &ValueTStr() const

inline void SetValue(const char *_value)

Changes the value of the node. Defined as:

Document:   filename of the xml file
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

void Clear()

Delete all the children of this node. Does not affect ‘this’.

inline TiXmlNode *Parent()

One step up the DOM.

inline const TiXmlNode *Parent() const

inline const TiXmlNode *FirstChild() const

The first child of this node. Will be null if there are no children.

inline TiXmlNode *FirstChild()

const TiXmlNode *FirstChild(const char *value) const

The first child of this node with the matching ‘value’. Will be null if none found.

inline TiXmlNode *FirstChild(const char *_value)

The first child of this node with the matching ‘value’. Will be null if none found.

inline const TiXmlNode *LastChild() const

inline TiXmlNode *LastChild()

The last child of this node. Will be null if there are no children.

const TiXmlNode *LastChild(const char *value) const

inline TiXmlNode *LastChild(const char *_value)

The last child of this node matching ‘value’. Will be null if there are no children.

const TiXmlNode *IterateChildren(const TiXmlNode *previous) const

An alternate way to walk the children of a node. One way to iterate over nodes is:

  for( child = parent->FirstChild(); child; child = child->NextSibling() )

IterateChildren does the same thing with the syntax:

  child = 0;
  while( child = parent->IterateChildren( child ) )

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

inline TiXmlNode *IterateChildren(const TiXmlNode *previous)

const TiXmlNode *IterateChildren(const char *value, const TiXmlNode *previous) const

This flavor of IterateChildren searches for children with a particular ‘value’.

inline TiXmlNode *IterateChildren(const char *_value, const TiXmlNode *previous)

TiXmlNode *InsertEndChild(const TiXmlNode &addThis)

Add a new node related to this. Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode *LinkEndChild(TiXmlNode *addThis)

Add a new node related to this. Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also

InsertEndChild

TiXmlNode *InsertBeforeChild(TiXmlNode *beforeThis, const TiXmlNode &addThis)

Add a new node related to this. Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode *InsertAfterChild(TiXmlNode *afterThis, const TiXmlNode &addThis)

Add a new node related to this. Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode *ReplaceChild(TiXmlNode *replaceThis, const TiXmlNode &withThis)

Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.

bool RemoveChild(TiXmlNode *removeThis)

Delete a child of this node.

inline const TiXmlNode *PreviousSibling() const

Navigate to a sibling node.

inline TiXmlNode *PreviousSibling()

const TiXmlNode *PreviousSibling(const char*) const

Navigate to a sibling node.

inline TiXmlNode *PreviousSibling(const char *_prev)

inline const TiXmlNode *NextSibling() const

Navigate to a sibling node.

inline TiXmlNode *NextSibling()

const TiXmlNode *NextSibling(const char*) const

Navigate to a sibling node with the given ‘value’.

inline TiXmlNode *NextSibling(const char *_next)

const TiXmlElement *NextSiblingElement() const

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

inline TiXmlElement *NextSiblingElement()

const TiXmlElement *NextSiblingElement(const char*) const

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

inline TiXmlElement *NextSiblingElement(const char *_next)

const TiXmlElement *FirstChildElement() const

Convenience function to get through elements.

inline TiXmlElement *FirstChildElement()

const TiXmlElement *FirstChildElement(const char *_value) const

Convenience function to get through elements.

inline TiXmlElement *FirstChildElement(const char *_value)

inline int Type() const

Query the type (as an enumerated value, above) of this node. The possible types are: TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, and TINYXML_DECLARATION.

const TiXmlDocument *GetDocument() const

Return a pointer to the Document this node lives in. Returns null if not in a document.

inline TiXmlDocument *GetDocument()

inline bool NoChildren() const

Returns true if this node has no children.

inline virtual const TiXmlDocument *ToDocument() const

Cast to a more defined type. Will return null if not of the requested type.

inline virtual const TiXmlElement *ToElement() const

Cast to a more defined type. Will return null if not of the requested type.

inline virtual const TiXmlComment *ToComment() const

Cast to a more defined type. Will return null if not of the requested type.

inline virtual const TiXmlUnknown *ToUnknown() const

Cast to a more defined type. Will return null if not of the requested type.

inline virtual const TiXmlText *ToText() const

Cast to a more defined type. Will return null if not of the requested type.

inline virtual const TiXmlDeclaration *ToDeclaration() const

Cast to a more defined type. Will return null if not of the requested type.

inline virtual TiXmlDocument *ToDocument()

Cast to a more defined type. Will return null if not of the requested type.

inline virtual TiXmlElement *ToElement()

Cast to a more defined type. Will return null if not of the requested type.

inline virtual TiXmlComment *ToComment()

Cast to a more defined type. Will return null if not of the requested type.

inline virtual TiXmlUnknown *ToUnknown()

Cast to a more defined type. Will return null if not of the requested type.

inline virtual TiXmlText *ToText()

Cast to a more defined type. Will return null if not of the requested type.

inline virtual TiXmlDeclaration *ToDeclaration()

Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlNode *Clone() const = 0

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

virtual bool Accept(TiXmlVisitor *visitor) const = 0

Accept a hierchical visit the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn’t re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

• http://www.saxproject.org/

• http://c2.com/cgi/wiki?HierarchicalVisitorPattern

Which are both good references for “visiting”.

An example of using Accept():

TiXmlPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Protected Functions

TiXmlNode(NodeType _type)

void CopyTo(TiXmlNode *target) const

TiXmlNode *Identify(const char *start, TiXmlEncoding encoding)

Protected Attributes

TiXmlNode *parent

NodeType type

TiXmlNode *firstChild

TiXmlNode *lastChild

TIXML_STRING value

TiXmlNode *prev

TiXmlNode *next