#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLNode:

Public Member Functions
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode. More...

XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode. More...

virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null. More...

virtual XMLText *	ToText ()
	Safely cast to Text, or null. More...

virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null. More...

virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null. More...

virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null. More...

virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null. More...

virtual const XMLElement *	ToElement () const

virtual const XMLText *	ToText () const

virtual const XMLComment *	ToComment () const

virtual const XMLDocument *	ToDocument () const

virtual const XMLDeclaration *	ToDeclaration () const

virtual const XMLUnknown *	ToUnknown () const

const char *	Value () const

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

const XMLNode *	Parent () const
	Get the parent of this node on the DOM. More...

XMLNode *	Parent ()

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

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

XMLNode *	FirstChild ()

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

XMLElement *	FirstChildElement (const char *name=0)

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

XMLNode *	LastChild ()

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

XMLElement *	LastChildElement (const char *name=0)

const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node. More...

XMLNode *	PreviousSibling ()

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

XMLElement *	PreviousSiblingElement (const char *name=0)

const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node. More...

XMLNode *	NextSibling ()

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

XMLElement *	NextSiblingElement (const char *name=0)

XMLNode *	InsertEndChild (XMLNode *addThis)

XMLNode *	LinkEndChild (XMLNode *addThis)

XMLNode *	InsertFirstChild (XMLNode *addThis)

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)

void	DeleteChildren ()

void	DeleteChild (XMLNode *node)

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

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

virtual bool	Accept (XMLVisitor *visitor) const =0

void	SetUserData (void *userData)

void *	GetUserData () const

Protected Member Functions
	XMLNode (XMLDocument *)

virtual	~XMLNode ()

virtual char *	ParseDeep (char , StrPair )

Protected Attributes
XMLDocument *	_document

XMLNode *	_parent

StrPair	_value

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_prev

XMLNode *	_next

void *	_userData

Friends
class	XMLDocument

class	XMLElement

Detailed Description

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)

Definition at line 641 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLNode::XMLNode ( XMLDocument * doc )

protected

Definition at line 734 of file tinyxml2.cpp.

tinyxml2::XMLNode::~XMLNode ( )

protectedvirtual

Definition at line 745 of file tinyxml2.cpp.

Member Function Documentation

virtual bool tinyxml2::XMLNode::Accept ( XMLVisitor * visitor ) const

pure virtual

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();

Implemented in tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

void tinyxml2::XMLNode::DeleteChild ( XMLNode * node )

Delete a child of this node.

Definition at line 804 of file tinyxml2.cpp.

void tinyxml2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

Definition at line 772 of file tinyxml2.cpp.

const XMLNode* tinyxml2::XMLNode::FirstChild ( ) const

inline

Get the first child node, or null if none exists.

Definition at line 733 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::FirstChild ( )

inline

Definition at line 737 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::FirstChildElement ( const char * name = 0 ) const

Get the first child element, or optionally the first child element with the specified name.

Definition at line 906 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::FirstChildElement ( const char * name = 0 )

inline

Definition at line 746 of file tinyxml2.h.

const XMLDocument* tinyxml2::XMLNode::GetDocument ( ) const

inline

Get the XMLDocument that owns this XMLNode.

Definition at line 648 of file tinyxml2.h.

XMLDocument* tinyxml2::XMLNode::GetDocument ( )

inline

Get the XMLDocument that owns this XMLNode.

Definition at line 653 of file tinyxml2.h.

void* tinyxml2::XMLNode::GetUserData ( ) const

inline

Get user data set into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

Definition at line 895 of file tinyxml2.h.

XMLNode * tinyxml2::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.

Definition at line 875 of file tinyxml2.cpp.

XMLNode * tinyxml2::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.

Definition at line 814 of file tinyxml2.cpp.

XMLNode * tinyxml2::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.

Definition at line 844 of file tinyxml2.cpp.

const XMLNode* tinyxml2::XMLNode::LastChild ( ) const

inline

Get the last child node, or null if none exists.

Definition at line 751 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::LastChild ( )

inline

Definition at line 755 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::LastChildElement ( const char * name = 0 ) const

Get the last child element or optionally the last child element with the specified name.

Definition at line 918 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::LastChildElement ( const char * name = 0 )

inline

Definition at line 764 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::LinkEndChild ( XMLNode * addThis )

inline

Definition at line 809 of file tinyxml2.h.

const XMLNode* tinyxml2::XMLNode::NextSibling ( ) const

inline

Get the next (right) sibling node of this node.

Definition at line 785 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::NextSibling ( )

inline

Definition at line 789 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::NextSiblingElement ( const char * name = 0 ) const

Get the next (right) sibling element of this node, with an optionally supplied name.

Definition at line 930 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::NextSiblingElement ( const char * name = 0 )

inline

Definition at line 796 of file tinyxml2.h.

bool tinyxml2::XMLNode::NoChildren ( ) const

inline

Returns true if this node has no children.

Definition at line 728 of file tinyxml2.h.

const XMLNode* tinyxml2::XMLNode::Parent ( ) const

inline

Get the parent of this node on the DOM.

Definition at line 719 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::Parent ( )

inline

Definition at line 723 of file tinyxml2.h.

char * tinyxml2::XMLNode::ParseDeep	(	char *	p,
		StrPair *	parentEnd
	)

protectedvirtual

Reimplemented in tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

Definition at line 954 of file tinyxml2.cpp.

const XMLNode* tinyxml2::XMLNode::PreviousSibling ( ) const

inline

Get the previous (left) sibling node of this node.

Definition at line 769 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::PreviousSibling ( )

inline

Definition at line 773 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::PreviousSiblingElement ( const char * name = 0 ) const

Get the previous (left) sibling element of this node, with an optionally supplied name.

Definition at line 942 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::PreviousSiblingElement ( const char * name = 0 )

inline

Definition at line 780 of file tinyxml2.h.

void tinyxml2::XMLNode::SetUserData ( void * userData )

inline

Set user data into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

Definition at line 888 of file tinyxml2.h.

void tinyxml2::XMLNode::SetValue	(	const char *	val,
		bool	staticMem = `false`
	)

Set the Value of an XML node.

See also: Value()

Definition at line 761 of file tinyxml2.cpp.

virtual XMLNode* tinyxml2::XMLNode::ShallowClone ( XMLDocument * document ) const

pure virtual

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.

Implemented in tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

virtual bool tinyxml2::XMLNode::ShallowEqual ( const XMLNode * compare ) const

pure virtual

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.

Implemented in tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

virtual XMLComment* tinyxml2::XMLNode::ToComment ( )

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented in tinyxml2::XMLComment.

Definition at line 667 of file tinyxml2.h.

virtual const XMLComment* tinyxml2::XMLNode::ToComment ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLComment.

Definition at line 689 of file tinyxml2.h.

virtual XMLDeclaration* tinyxml2::XMLNode::ToDeclaration ( )

inlinevirtual

Safely cast to a Declaration, or null.

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 675 of file tinyxml2.h.

virtual const XMLDeclaration* tinyxml2::XMLNode::ToDeclaration ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 695 of file tinyxml2.h.

virtual XMLDocument* tinyxml2::XMLNode::ToDocument ( )

inlinevirtual

Safely cast to a Document, or null.

Reimplemented in tinyxml2::XMLDocument.

Definition at line 671 of file tinyxml2.h.

virtual const XMLDocument* tinyxml2::XMLNode::ToDocument ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLDocument.

Definition at line 692 of file tinyxml2.h.

virtual XMLElement* tinyxml2::XMLNode::ToElement ( )

inlinevirtual

Safely cast to an Element, or null.

Reimplemented in tinyxml2::XMLElement.

Definition at line 659 of file tinyxml2.h.

virtual const XMLElement* tinyxml2::XMLNode::ToElement ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLElement.

Definition at line 683 of file tinyxml2.h.

virtual XMLText* tinyxml2::XMLNode::ToText ( )

inlinevirtual

Safely cast to Text, or null.

Reimplemented in tinyxml2::XMLText.

Definition at line 663 of file tinyxml2.h.

virtual const XMLText* tinyxml2::XMLNode::ToText ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLText.

Definition at line 686 of file tinyxml2.h.

virtual XMLUnknown* tinyxml2::XMLNode::ToUnknown ( )

inlinevirtual

Safely cast to an Unknown, or null.

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 679 of file tinyxml2.h.

virtual const XMLUnknown* tinyxml2::XMLNode::ToUnknown ( ) const

inlinevirtual

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 698 of file tinyxml2.h.

const char * tinyxml2::XMLNode::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

Definition at line 753 of file tinyxml2.cpp.

Friends And Related Function Documentation

friend class XMLDocument

friend

Definition at line 643 of file tinyxml2.h.

friend class XMLElement

friend

Definition at line 644 of file tinyxml2.h.

Member Data Documentation

XMLDocument* tinyxml2::XMLNode::_document

protected

Definition at line 903 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_firstChild

protected

Definition at line 907 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_lastChild

protected

Definition at line 908 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_next

protected

Definition at line 911 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_parent

protected

Definition at line 904 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_prev

protected

Definition at line 910 of file tinyxml2.h.

void* tinyxml2::XMLNode::_userData

protected

Definition at line 913 of file tinyxml2.h.

StrPair tinyxml2::XMLNode::_value

mutableprotected

Definition at line 905 of file tinyxml2.h.

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

src/tinyxml2/tinyxml2.h
src/tinyxml2/tinyxml2.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation