tinyxml2::XMLNode Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLNode:

List of all members.

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const =0
void	DeleteChild (XMLNode *node)
void	DeleteChildren ()
const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.
XMLNode *	FirstChild ()
const XMLElement *	FirstChildElement (const char *value=0) const
XMLElement *	FirstChildElement (const char *value=0)
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode.
XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.
XMLNode *	InsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
XMLNode *	InsertEndChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
const XMLNode *	LastChild () const
	Get the last child node, or null if none exists.
XMLNode *	LastChild ()
const XMLElement *	LastChildElement (const char *value=0) const
XMLElement *	LastChildElement (const char *value=0)
XMLNode *	LinkEndChild (XMLNode *addThis)
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.
XMLNode *	NextSibling ()
const XMLElement *	NextSiblingElement (const char *value=0) const
	Get the next (right) sibling element of this node, with an opitionally supplied name.
XMLElement *	NextSiblingElement (const char *value=0)
bool	NoChildren () const
	Returns true if this node has no children.
const XMLNode *	Parent () const
	Get the parent of this node on the DOM.
XMLNode *	Parent ()
virtual char *	ParseDeep (char *, StrPair *)
const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node.
XMLNode *	PreviousSibling ()
const XMLElement *	PreviousSiblingElement (const char *value=0) const
	Get the previous (left) sibling element of this node, with an opitionally supplied name.
XMLElement *	PreviousSiblingElement (const char *value=0)
void	SetValue (const char *val, bool staticMem=false)
virtual XMLNode *	ShallowClone (XMLDocument *document) const =0
virtual bool	ShallowEqual (const XMLNode *compare) const =0
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.
virtual const XMLComment *	ToComment () const
virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.
virtual const XMLDeclaration *	ToDeclaration () const
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual const XMLDocument *	ToDocument () const
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual const XMLElement *	ToElement () const
virtual XMLText *	ToText ()
	Safely cast to Text, or null.
virtual const XMLText *	ToText () const
virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.
virtual const XMLUnknown *	ToUnknown () const
const char *	Value () const
Protected Member Functions
XMLNode &	operator= (const XMLNode &)
	XMLNode (XMLDocument *)
	XMLNode (const XMLNode &)
virtual	~XMLNode ()
Protected Attributes
XMLDocument *	_document
XMLNode *	_firstChild
XMLNode *	_lastChild
XMLNode *	_next
XMLNode *	_parent
XMLNode *	_prev
StrPair	_value
Private Member Functions
void	Unlink (XMLNode *child)
Private Attributes
MemPool *	_memPool
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 540 of file tinyxml2.h.

---

Constructor & Destructor Documentation

tinyxml2::XMLNode::XMLNode

(

XMLDocument *

doc

)

[protected]

Definition at line 585 of file tinyxml2.cpp.

tinyxml2::XMLNode::~XMLNode

(

)

[protected, virtual]

Definition at line 594 of file tinyxml2.cpp.

tinyxml2::XMLNode::XMLNode

(

const XMLNode &

)

[protected]

---

Member Function Documentation

virtual bool tinyxml2::XMLNode::Accept

(

XMLVisitor *

visitor

)

const [pure virtual]

Accept a hierarchical visit of 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();
    	

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 646 of file tinyxml2.cpp.

void tinyxml2::XMLNode::DeleteChildren

(

)

Delete all the children of this node.

Definition at line 614 of file tinyxml2.cpp.

const XMLNode* tinyxml2::XMLNode::FirstChild

(

)

const [inline]

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

Definition at line 632 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::FirstChild

(

)

[inline]

Definition at line 636 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::FirstChildElement

(

const char *

value = 0

)

const

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

Definition at line 725 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::FirstChildElement

(

const char *

value = 0

)

[inline]

Definition at line 645 of file tinyxml2.h.

const XMLDocument* tinyxml2::XMLNode::GetDocument

(

)

const [inline]

Get the XMLDocument that owns this XMLNode.

Definition at line 547 of file tinyxml2.h.

XMLDocument* tinyxml2::XMLNode::GetDocument

(

)

[inline]

Get the XMLDocument that owns this XMLNode.

Definition at line 551 of file tinyxml2.h.

XMLNode * tinyxml2::XMLNode::InsertAfterChild	(	XMLNode *	afterThis,
		XMLNode *	addThis
	)

Add a node after the specified child node.

Definition at line 702 of file tinyxml2.cpp.

XMLNode * tinyxml2::XMLNode::InsertEndChild

(

XMLNode *

addThis

)

Add a child node as the last (right) child.

Definition at line 653 of file tinyxml2.cpp.

XMLNode * tinyxml2::XMLNode::InsertFirstChild

(

XMLNode *

addThis

)

Add a child node as the first (left) child.

Definition at line 677 of file tinyxml2.cpp.

const XMLNode* tinyxml2::XMLNode::LastChild

(

)

const [inline]

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

Definition at line 650 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::LastChild

(

)

[inline]

Definition at line 654 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::LastChildElement

(

const char *

value = 0

)

const

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

Definition at line 739 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::LastChildElement

(

const char *

value = 0

)

[inline]

Definition at line 663 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::LinkEndChild

(

XMLNode *

addThis

)

[inline]

Definition at line 704 of file tinyxml2.h.

const XMLNode* tinyxml2::XMLNode::NextSibling

(

)

const [inline]

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

Definition at line 684 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::NextSibling

(

)

[inline]

Definition at line 688 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::NextSiblingElement

(

const char *

value = 0

)

const

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

Definition at line 753 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::NextSiblingElement

(

const char *

value = 0

)

[inline]

Definition at line 695 of file tinyxml2.h.

bool tinyxml2::XMLNode::NoChildren

(

)

const [inline]

Returns true if this node has no children.

Definition at line 627 of file tinyxml2.h.

XMLNode& tinyxml2::XMLNode::operator=

(

const XMLNode &

)

[protected]

const XMLNode* tinyxml2::XMLNode::Parent

(

)

const [inline]

Get the parent of this node on the DOM.

Definition at line 618 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::Parent

(

)

[inline]

Definition at line 622 of file tinyxml2.h.

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

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

Definition at line 777 of file tinyxml2.cpp.

const XMLNode* tinyxml2::XMLNode::PreviousSibling

(

)

const [inline]

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

Definition at line 668 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::PreviousSibling

(

)

[inline]

Definition at line 672 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::PreviousSiblingElement

(

const char *

value = 0

)

const

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

Definition at line 765 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::PreviousSiblingElement

(

const char *

value = 0

)

[inline]

Definition at line 679 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 603 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

(

)

[inline, virtual]

Safely cast to a Comment, or null.

Reimplemented in tinyxml2::XMLComment.

Definition at line 564 of file tinyxml2.h.

virtual const XMLComment* tinyxml2::XMLNode::ToComment

(

)

const [inline, virtual]

Reimplemented in tinyxml2::XMLComment.

Definition at line 586 of file tinyxml2.h.

virtual XMLDeclaration* tinyxml2::XMLNode::ToDeclaration

(

)

[inline, virtual]

Safely cast to a Declaration, or null.

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 572 of file tinyxml2.h.

virtual const XMLDeclaration* tinyxml2::XMLNode::ToDeclaration

(

)

const [inline, virtual]

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 592 of file tinyxml2.h.

virtual XMLDocument* tinyxml2::XMLNode::ToDocument

(

)

[inline, virtual]

Safely cast to a Document, or null.

Reimplemented in tinyxml2::XMLDocument.

Definition at line 568 of file tinyxml2.h.

virtual const XMLDocument* tinyxml2::XMLNode::ToDocument

(

)

const [inline, virtual]

Reimplemented in tinyxml2::XMLDocument.

Definition at line 589 of file tinyxml2.h.

virtual XMLElement* tinyxml2::XMLNode::ToElement

(

)

[inline, virtual]

Safely cast to an Element, or null.

Reimplemented in tinyxml2::XMLElement.

Definition at line 556 of file tinyxml2.h.

virtual const XMLElement* tinyxml2::XMLNode::ToElement

(

)

const [inline, virtual]

Reimplemented in tinyxml2::XMLElement.

Definition at line 580 of file tinyxml2.h.

virtual XMLText* tinyxml2::XMLNode::ToText

(

)

[inline, virtual]

Safely cast to Text, or null.

Reimplemented in tinyxml2::XMLText.

Definition at line 560 of file tinyxml2.h.

virtual const XMLText* tinyxml2::XMLNode::ToText

(

)

const [inline, virtual]

Reimplemented in tinyxml2::XMLText.

Definition at line 583 of file tinyxml2.h.

virtual XMLUnknown* tinyxml2::XMLNode::ToUnknown

(

)

[inline, virtual]

Safely cast to an Unknown, or null.

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 576 of file tinyxml2.h.

virtual const XMLUnknown* tinyxml2::XMLNode::ToUnknown

(

)

const [inline, virtual]

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 595 of file tinyxml2.h.

void tinyxml2::XMLNode::Unlink

(

XMLNode *

child

)

[private]

Definition at line 626 of file tinyxml2.cpp.

const char* tinyxml2::XMLNode::Value

(

)

const [inline]

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

    	Document:	empty
    	Element:	name of the element
    	Comment:	the comment text
    	Unknown:	the tag contents
    	Text:		the text string
    	

Definition at line 608 of file tinyxml2.h.

---

Friends And Related Function Documentation

friend class XMLDocument [friend]

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

Definition at line 542 of file tinyxml2.h.

friend class XMLElement [friend]

Reimplemented in tinyxml2::XMLDocument.

Definition at line 543 of file tinyxml2.h.

---

Member Data Documentation

XMLDocument* tinyxml2::XMLNode::_document [protected]

Definition at line 778 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_firstChild [protected]

Definition at line 782 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_lastChild [protected]

Definition at line 783 of file tinyxml2.h.

MemPool* tinyxml2::XMLNode::_memPool [private]

Definition at line 789 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_next [protected]

Definition at line 786 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_parent [protected]

Definition at line 779 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_prev [protected]

Definition at line 785 of file tinyxml2.h.

StrPair tinyxml2::XMLNode::_value [mutable, protected]

Definition at line 780 of file tinyxml2.h.

---

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

• tinyxml2.h
• tinyxml2.cpp