The parent class for everything in the Document Object Model. More...

#include <pandadoc.hpp>

Inheritance diagram for TiXmlNode:

Public Types
enum	NodeType { TINYXML_DOCUMENT = 0 , TINYXML_ELEMENT = 1 , TINYXML_COMMENT = 2 , TINYXML_UNKNOWN = 3 , TINYXML_TEXT = 4 , TINYXML_DECLARATION = 5 , TINYXML_TYPECOUNT = 6 }
	The types of XML nodes supported by TinyXml. More...

Public Types inherited from TiXmlBase
enum	{ TIXML_NO_ERROR = 0 , TIXML_ERROR = 1 , TIXML_ERROR_OPENING_FILE = 2 , TIXML_ERROR_PARSING_ELEMENT = 3 , TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME = 4 , TIXML_ERROR_READING_ELEMENT_VALUE = 5 , TIXML_ERROR_READING_ATTRIBUTES = 6 , TIXML_ERROR_PARSING_EMPTY = 7 , TIXML_ERROR_READING_END_TAG = 8 , TIXML_ERROR_PARSING_UNKNOWN = 9 , TIXML_ERROR_PARSING_COMMENT = 10 , TIXML_ERROR_PARSING_DECLARATION = 11 , TIXML_ERROR_DOCUMENT_EMPTY = 12 , TIXML_ERROR_EMBEDDED_NULL = 13 , TIXML_ERROR_PARSING_CDATA = 14 , TIXML_ERROR_DOCUMENT_TOP_ONLY = 15 , TIXML_ERROR_STRING_COUNT = 16 }

Public Member Functions
bool	Accept (TiXmlVisitor visitor)
	Accept a hierchical visit the nodes in the TinyXML DOM.

	Clear ()
	Delete all the children of this node. Does not affect 'this'.

TiXmlNode	Clone ()
	Create an exact duplicate of this node and return it.

TiXmlNode	FirstChild ()
	The first child of this node. Will be null if there are no children.

const TiXmlNode	FirstChild ()
	The first child of this node with the matching 'value'. Will be null if none found. The first child of this node with the matching 'value'. Will be null if none found.

TiXmlNode	FirstChild (str _value)

TiXmlNode	FirstChild (str _value)
	STL std::string form.

const TiXmlNode	FirstChild (str _value)

const TiXmlNode	FirstChild (str value)
	STL std::string form.

TiXmlElement	FirstChildElement ()

const TiXmlElement	FirstChildElement ()
	Convenience function to get through elements.

TiXmlElement	FirstChildElement (str _value)

const TiXmlElement	FirstChildElement (str _value)
	Convenience function to get through elements.

TiXmlElement	FirstChildElement (str _value)
	STL std::string form.

const TiXmlElement	FirstChildElement (str _value)

TiXmlDocument	GetDocument ()

const TiXmlDocument	GetDocument ()
	Return a pointer to the Document this node lives in.

TiXmlNode	InsertAfterChild (TiXmlNode afterThis, const TiXmlNode addThis)
	Add a new node related to this.

TiXmlNode	InsertBeforeChild (TiXmlNode beforeThis, const TiXmlNode addThis)
	Add a new node related to this.

TiXmlNode	InsertEndChild (const TiXmlNode addThis)
	Add a new node related to this.

TiXmlNode	IterateChildren (const TiXmlNode previous)

const TiXmlNode	IterateChildren (const TiXmlNode previous)
	An alternate way to walk the children of a node.

TiXmlNode	IterateChildren (str _value, const TiXmlNode previous)

TiXmlNode	IterateChildren (str _value, const TiXmlNode previous)
	STL std::string form.

const TiXmlNode	IterateChildren (str _value, const TiXmlNode previous)

const TiXmlNode	IterateChildren (str value, const TiXmlNode previous)
	This flavor of IterateChildren searches for children with a particular 'value'.

TiXmlNode	LastChild ()
	The last child of this node. Will be null if there are no children.

const TiXmlNode	LastChild ()
	The last child of this node. Will be null if there are no children.

TiXmlNode	LastChild (str _value)
	The last child of this node matching 'value'. Will be null if there are no children.

TiXmlNode	LastChild (str _value)
	STL std::string form.

const TiXmlNode	LastChild (str _value)

const TiXmlNode	LastChild (str value)
	The last child of this node matching 'value'. Will be null if there are no children.

TiXmlNode	NextSibling ()

const TiXmlNode	NextSibling ()
	Navigate to a sibling node.

TiXmlNode	NextSibling (str _next)

TiXmlNode	NextSibling (str _value)
	STL std::string form.

const TiXmlNode	NextSibling (str _value)

const TiXmlNode	NextSibling (str)
	Navigate to a sibling node with the given 'value'.

TiXmlElement	NextSiblingElement ()

const TiXmlElement	NextSiblingElement ()
	Convenience function to get through elements.

TiXmlElement	NextSiblingElement (str _next)

TiXmlElement	NextSiblingElement (str _value)
	STL std::string form.

const TiXmlElement	NextSiblingElement (str _value)

const TiXmlElement	NextSiblingElement (str)
	Convenience function to get through elements.

bool	NoChildren ()
	Returns true if this node has no children.

TiXmlNode	Parent ()
	One step up the DOM.

const TiXmlNode	Parent ()
	The first child of this node. Will be null if there are no children.

TiXmlNode	PreviousSibling ()

const TiXmlNode	PreviousSibling ()
	Navigate to a sibling node.

TiXmlNode	PreviousSibling (str _prev)

TiXmlNode	PreviousSibling (str _value)
	STL std::string form.

const TiXmlNode	PreviousSibling (str _value)

const TiXmlNode	PreviousSibling (str)
	Navigate to a sibling node.

bool	RemoveChild (TiXmlNode removeThis)
	Delete a child of this node.

TiXmlNode	ReplaceChild (TiXmlNode replaceThis, const TiXmlNode withThis)
	Replace a child of this node.

	SetValue (str _value)
	Changes the value of the node.

	SetValue (str _value)
	STL std::string form.

TiXmlComment	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type.

const TiXmlComment	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type.

TiXmlDeclaration	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type.

const TiXmlDeclaration	ToDeclaration ()

TiXmlDocument	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type.

const TiXmlDocument	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type.

TiXmlElement	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type.

const TiXmlElement	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type.

TiXmlText	ToText ()
	Cast to a more defined type. Will return null if not of the requested type.

const TiXmlText	ToText ()
	Cast to a more defined type. Will return null if not of the requested type.

TiXmlUnknown	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type.

const TiXmlUnknown	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type.

int	Type ()
	Query the type (as an enumerated value, above) of this node.

str	Value ()
	The meaning of 'value' changes for the specific type of TiXmlNode.

str	ValueStr ()
	Return Value() as a std::string.

str	ValueTStr ()

Public Member Functions inherited from TiXmlBase
int	Column ()
	Get a pointer to arbitrary user data.

	GetUserData ()
	Get a pointer to arbitrary user data.

	GetUserData ()

str	Parse (str p, TiXmlParsingData data, TiXmlEncoding encoding)

	Print (FILE cfile, int depth)
	All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

int	Row ()
	Return the position, in the original source file, of this node or attribute.

Additional Inherited Members
Static Public Member Functions inherited from TiXmlBase
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.

static	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not.

Detailed Description

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.

Member Enumeration Documentation

◆ NodeType

enum NodeType

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Enumerator
TINYXML_DOCUMENT
TINYXML_ELEMENT
TINYXML_COMMENT
TINYXML_UNKNOWN
TINYXML_TEXT
TINYXML_DECLARATION
TINYXML_TYPECOUNT

Member Function Documentation

◆ Accept()

bool Accept ( TiXmlVisitor visitor )

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:

Which are both good references for "visiting".

An example of using Accept():

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

◆ Clear()

Clear ( )

Delete all the children of this node. Does not affect 'this'.

◆ Clone()

TiXmlNode Clone ( )

Create an exact duplicate of this node and return it.

The memory must be deleted by the caller.

◆ FirstChild() [1/6]

TiXmlNode FirstChild ( )

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

◆ FirstChild() [2/6]

const TiXmlNode FirstChild ( )

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

◆ FirstChild() [3/6]

TiXmlNode FirstChild ( str _value )

◆ FirstChild() [4/6]

TiXmlNode FirstChild ( str _value )

STL std::string form.

◆ FirstChild() [5/6]

const TiXmlNode FirstChild ( str _value )

◆ FirstChild() [6/6]

const TiXmlNode FirstChild ( str value )

STL std::string form.

◆ FirstChildElement() [1/6]

TiXmlElement FirstChildElement ( )

◆ FirstChildElement() [2/6]

const TiXmlElement FirstChildElement ( )

Convenience function to get through elements.

◆ FirstChildElement() [3/6]

TiXmlElement FirstChildElement ( str _value )

◆ FirstChildElement() [4/6]

const TiXmlElement FirstChildElement ( str _value )

Convenience function to get through elements.

STL std::string form.

◆ FirstChildElement() [5/6]

TiXmlElement FirstChildElement ( str _value )

STL std::string form.

◆ FirstChildElement() [6/6]

const TiXmlElement FirstChildElement ( str _value )

◆ GetDocument() [1/2]

TiXmlDocument GetDocument ( )

◆ GetDocument() [2/2]

const TiXmlDocument GetDocument ( )

Return a pointer to the Document this node lives in.

Returns null if not in a document.

◆ InsertAfterChild()

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.

◆ InsertBeforeChild()

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.

◆ InsertEndChild()

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.

◆ IterateChildren() [1/6]

TiXmlNode IterateChildren ( const TiXmlNode previous )

◆ IterateChildren() [2/6]

const TiXmlNode IterateChildren ( const TiXmlNode previous )

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.

◆ IterateChildren() [3/6]

TiXmlNode IterateChildren	(	str	_value,
		const TiXmlNode	previous )

◆ IterateChildren() [4/6]

TiXmlNode IterateChildren	(	str	_value,
		const TiXmlNode	previous )

STL std::string form.

◆ IterateChildren() [5/6]

const TiXmlNode IterateChildren	(	str	_value,
		const TiXmlNode	previous )

◆ IterateChildren() [6/6]

const TiXmlNode IterateChildren	(	str	value,
		const TiXmlNode	previous )

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

STL std::string form.

◆ LastChild() [1/6]

TiXmlNode LastChild ( )

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

◆ LastChild() [2/6]

const TiXmlNode LastChild ( )

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

◆ LastChild() [3/6]

TiXmlNode LastChild ( str _value )

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

◆ LastChild() [4/6]

TiXmlNode LastChild ( str _value )

STL std::string form.

◆ LastChild() [5/6]

const TiXmlNode LastChild ( str _value )

◆ LastChild() [6/6]

const TiXmlNode LastChild ( str value )

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

STL std::string form.

◆ NextSibling() [1/6]

TiXmlNode NextSibling ( )

◆ NextSibling() [2/6]

const TiXmlNode NextSibling ( )

Navigate to a sibling node.

◆ NextSibling() [3/6]

TiXmlNode NextSibling ( str _next )

◆ NextSibling() [4/6]

TiXmlNode NextSibling ( str _value )

STL std::string form.

◆ NextSibling() [5/6]

const TiXmlNode NextSibling ( str _value )

◆ NextSibling() [6/6]

const TiXmlNode NextSibling ( str )

Navigate to a sibling node with the given 'value'.

STL std::string form.

◆ NextSiblingElement() [1/6]

TiXmlElement NextSiblingElement ( )

◆ NextSiblingElement() [2/6]

const TiXmlElement NextSiblingElement ( )

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

◆ NextSiblingElement() [3/6]

TiXmlElement NextSiblingElement ( str _next )

◆ NextSiblingElement() [4/6]

TiXmlElement NextSiblingElement ( str _value )

STL std::string form.

◆ NextSiblingElement() [5/6]

const TiXmlElement NextSiblingElement ( str _value )

◆ NextSiblingElement() [6/6]

const TiXmlElement NextSiblingElement ( str )

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element. STL std::string form.

◆ NoChildren()

bool NoChildren ( )

Returns true if this node has no children.

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

◆ Parent() [1/2]

TiXmlNode Parent ( )

One step up the DOM.

◆ Parent() [2/2]

const TiXmlNode Parent ( )

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

◆ PreviousSibling() [1/6]

TiXmlNode PreviousSibling ( )

◆ PreviousSibling() [2/6]

const TiXmlNode PreviousSibling ( )

Navigate to a sibling node.

◆ PreviousSibling() [3/6]

TiXmlNode PreviousSibling ( str _prev )

◆ PreviousSibling() [4/6]

TiXmlNode PreviousSibling ( str _value )

STL std::string form.

◆ PreviousSibling() [5/6]

const TiXmlNode PreviousSibling ( str _value )

◆ PreviousSibling() [6/6]

const TiXmlNode PreviousSibling ( str )

Navigate to a sibling node.

STL std::string form.

◆ RemoveChild()

bool RemoveChild ( TiXmlNode removeThis )

Delete a child of this node.

◆ ReplaceChild()

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.

◆ SetValue() [1/2]

SetValue ( str _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

◆ SetValue() [2/2]

SetValue ( str _value )

STL std::string form.

◆ ToComment() [1/2]

TiXmlComment ToComment ( )

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

◆ ToComment() [2/2]

const TiXmlComment ToComment ( )

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

◆ ToDeclaration() [1/2]

TiXmlDeclaration ToDeclaration ( )

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

◆ ToDeclaration() [2/2]

const TiXmlDeclaration ToDeclaration ( )

◆ ToDocument() [1/2]

TiXmlDocument ToDocument ( )

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

◆ ToDocument() [2/2]

const TiXmlDocument ToDocument ( )

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

◆ ToElement() [1/2]

TiXmlElement ToElement ( )

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

◆ ToElement() [2/2]

const TiXmlElement ToElement ( )

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

◆ ToText() [1/2]

TiXmlText ToText ( )

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

◆ ToText() [2/2]

const TiXmlText ToText ( )

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

◆ ToUnknown() [1/2]

TiXmlUnknown ToUnknown ( )

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

◆ ToUnknown() [2/2]

const TiXmlUnknown ToUnknown ( )

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

◆ Type()

int Type ( )

Query the type (as an enumerated value, above) of this node.

The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

◆ Value()

str Value ( )

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.

◆ ValueStr()

str ValueStr ( )

Return Value() as a std::string.

If you only use STL, this is more efficient than calling Value(). Only available in STL mode.

◆ ValueTStr()

str ValueTStr ( )

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ NodeType

Member Function Documentation

◆ Accept()

◆ Clear()

◆ Clone()

◆ FirstChild() [1/6]

◆ FirstChild() [2/6]

◆ FirstChild() [3/6]

◆ FirstChild() [4/6]

◆ FirstChild() [5/6]

◆ FirstChild() [6/6]

◆ FirstChildElement() [1/6]

◆ FirstChildElement() [2/6]

◆ FirstChildElement() [3/6]

◆ FirstChildElement() [4/6]

◆ FirstChildElement() [5/6]

◆ FirstChildElement() [6/6]

◆ GetDocument() [1/2]

◆ GetDocument() [2/2]

◆ InsertAfterChild()

◆ InsertBeforeChild()

◆ InsertEndChild()

◆ IterateChildren() [1/6]

◆ IterateChildren() [2/6]

◆ IterateChildren() [3/6]

◆ IterateChildren() [4/6]

◆ IterateChildren() [5/6]

◆ IterateChildren() [6/6]

◆ LastChild() [1/6]

◆ LastChild() [2/6]

◆ LastChild() [3/6]

◆ LastChild() [4/6]

◆ LastChild() [5/6]

◆ LastChild() [6/6]

◆ NextSibling() [1/6]

◆ NextSibling() [2/6]

◆ NextSibling() [3/6]

◆ NextSibling() [4/6]

◆ NextSibling() [5/6]

◆ NextSibling() [6/6]

◆ NextSiblingElement() [1/6]

◆ NextSiblingElement() [2/6]

◆ NextSiblingElement() [3/6]

◆ NextSiblingElement() [4/6]

◆ NextSiblingElement() [5/6]

◆ NextSiblingElement() [6/6]

◆ NoChildren()

◆ Parent() [1/2]

◆ Parent() [2/2]

◆ PreviousSibling() [1/6]

◆ PreviousSibling() [2/6]

◆ PreviousSibling() [3/6]

◆ PreviousSibling() [4/6]

◆ PreviousSibling() [5/6]

◆ PreviousSibling() [6/6]

◆ RemoveChild()

◆ ReplaceChild()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ ToComment() [1/2]

◆ ToComment() [2/2]

◆ ToDeclaration() [1/2]

◆ ToDeclaration() [2/2]

◆ ToDocument() [1/2]

◆ ToDocument() [2/2]

◆ ToElement() [1/2]

◆ ToElement() [2/2]

◆ ToText() [1/2]

◆ ToText() [2/2]

◆ ToUnknown() [1/2]

◆ ToUnknown() [2/2]

◆ Type()

◆ Value()

◆ ValueStr()

◆ ValueTStr()