Class XMLNode

Defined in File tinyxml2.h

Inheritance Relationships

Derived Types

public tinyxml2::XMLComment (Class XMLComment)
public tinyxml2::XMLDeclaration (Class XMLDeclaration)
public tinyxml2::XMLDocument (Class XMLDocument)
public tinyxml2::XMLElement (Class XMLElement)
public tinyxml2::XMLText (Class XMLText)
public tinyxml2::XMLUnknown (Class XMLUnknown)

Class Documentation

class XMLNode

XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes. Nodes have siblings, a parent, and children which can be navigated. A node is always in a XMLDocument. The type of a XMLNode can be queried, and it can be cast to its more defined type.

A XMLDocument allocates memory for all its Nodes. When the XMLDocument gets deleted, all its Nodes will also be deleted.

A Document can contain: Element (container or leaf)
                        Comment (leaf)
                        Unknown (leaf)
                        Declaration( leaf )

An Element can contain: Element (container or leaf)
                        Text    (leaf)
                        Attributes (not on tree)
                        Comment (leaf)
                        Unknown (leaf)

Subclassed by tinyxml2::XMLComment, tinyxml2::XMLDeclaration, tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLText, tinyxml2::XMLUnknown

Public Functions

inline const XMLDocument *GetDocument() const: Get the XMLDocument that owns this XMLNode.

inline XMLDocument *GetDocument(): Get the XMLDocument that owns this XMLNode.

inline virtual XMLElement *ToElement(): Safely cast to an Element, or null.

inline virtual XMLText *ToText(): Safely cast to Text, or null.

inline virtual XMLComment *ToComment(): Safely cast to a Comment, or null.

inline virtual XMLDocument *ToDocument(): Safely cast to a Document, or null.

inline virtual XMLDeclaration *ToDeclaration(): Safely cast to a Declaration, or null.

inline virtual XMLUnknown *ToUnknown(): Safely cast to an Unknown, or null.

inline virtual const XMLElement *ToElement() const

inline virtual const XMLText *ToText() const

inline virtual const XMLComment *ToComment() const

inline virtual const XMLDocument *ToDocument() const

inline virtual const XMLDeclaration *ToDeclaration() const

inline virtual const XMLUnknown *ToUnknown() const

int ChildElementCount(const char *value) const

int ChildElementCount() const

const char *Value() const

The meaning of 'value' changes for the specific type.

Document:   empty (NULL is returned, not an empty string)
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

void SetValue(const char *val, bool staticMem = false)

Set the Value of an XML node.

See also

Value()

inline int GetLineNum() const: Gets the line number the node is in, if the document was parsed from a file.

inline const XMLNode *Parent() const: Get the parent of this node on the DOM.

inline XMLNode *Parent()

inline bool NoChildren() const: Returns true if this node has no children.

inline const XMLNode *FirstChild() const: Get the first child node, or null if none exists.

inline XMLNode *FirstChild()

const XMLElement *FirstChildElement(const char *name = 0) const: Get the first child element, or optionally the first child element with the specified name.

inline XMLElement *FirstChildElement(const char *name = 0)

inline const XMLNode *LastChild() const: Get the last child node, or null if none exists.

inline XMLNode *LastChild()

const XMLElement *LastChildElement(const char *name = 0) const: Get the last child element or optionally the last child element with the specified name.

inline XMLElement *LastChildElement(const char *name = 0)

inline const XMLNode *PreviousSibling() const: Get the previous (left) sibling node of this node.

inline XMLNode *PreviousSibling()

const XMLElement *PreviousSiblingElement(const char *name = 0) const: Get the previous (left) sibling element of this node, with an optionally supplied name.

inline XMLElement *PreviousSiblingElement(const char *name = 0)

inline const XMLNode *NextSibling() const: Get the next (right) sibling node of this node.

inline XMLNode *NextSibling()

const XMLElement *NextSiblingElement(const char *name = 0) const: Get the next (right) sibling element of this node, with an optionally supplied name.

inline XMLElement *NextSiblingElement(const char *name = 0)

XMLNode *InsertEndChild(XMLNode *addThis): Add a child node as the last (right) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

inline XMLNode *LinkEndChild(XMLNode *addThis)

XMLNode *InsertFirstChild(XMLNode *addThis): Add a child node as the first (left) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

XMLNode *InsertAfterChild(XMLNode *afterThis, XMLNode *addThis): Add a node after the specified child node. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the afterThis node is not a child of this node, or if the node does not belong to the same document.

void DeleteChildren(): Delete all the children of this node.

void DeleteChild(XMLNode *node): Delete a child of this node.

virtual XMLNode *ShallowClone(XMLDocument *document) const = 0

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

XMLNode *DeepClone(XMLDocument *target) const

Make a copy of this node and all its children.

If the 'target' is null, then the nodes will be allocated in the current document. If 'target' is specified, the memory will be allocated is the specified XMLDocument.

NOTE: This is probably not the correct tool to copy a document, since XMLDocuments can have multiple top level XMLNodes. You probably want to use XMLDocument::DeepCopy()

virtual bool ShallowEqual(const XMLNode *compare) const = 0

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

virtual bool Accept(XMLVisitor *visitor) const = 0

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

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

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

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

inline void SetUserData(void *userData): Set user data into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.