TiXmlVisitor Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlVisitor:

List of all members.

Public Member Functions
virtual bool	Visit (const TiXmlDeclaration &)
	Visit a declaration.
virtual bool	Visit (const TiXmlComment &)
	Visit a comment node.
virtual bool	Visit (const TiXmlUnknown &)
	Visit an unknow node.
virtual bool	Visit (const TiXmlText &text)
	Visit a text node.
virtual bool	Visit (const TiXmlComment &comment)
	Visit a comment node.
virtual bool	Visit (const TiXmlUnknown &unknown)
	Visit an unknow node.
virtual bool	Visit (const TiXmlText &)
	Visit a text node.
virtual bool	Visit (const TiXmlDeclaration &declaration)
	Visit a declaration.
virtual bool	VisitEnter (const TiXmlDocument &)
	Visit a document.
virtual bool	VisitEnter (const TiXmlElement &, const TiXmlAttribute *)
	Visit an element.
virtual bool	VisitEnter (const TiXmlDocument &doc)
	Visit a document.
virtual bool	VisitEnter (const TiXmlElement &element, const TiXmlAttribute *firstAttribute)
	Visit an element.
virtual bool	VisitExit (const TiXmlDocument &)
	Visit a document.
virtual bool	VisitExit (const TiXmlElement &)
	Visit an element.
virtual bool	VisitExit (const TiXmlElement &element)
	Visit an element.
virtual bool	VisitExit (const TiXmlDocument &doc)
	Visit a document.
virtual	~TiXmlVisitor ()
virtual	~TiXmlVisitor ()

---

Detailed Description

If you call the Accept() method, it requires being passed a TiXmlVisitor class to handle callbacks. For nodes that contain other nodes (Document, Element) you will get called with a VisitEnter/VisitExit pair. Nodes that are always leaves are simple called with Visit().

If you return 'true' from a Visit method, recursive parsing will continue. If you return false, no children of this node or its sibilings will be Visited.

All flavors of Visit methods have a default implementation that returns 'true' (continue visiting). You need to only override methods that are interesting to you.

Generally Accept() is called on the TiXmlDocument, although all nodes suppert Visiting.

You should never change the document from a callback.

See also:

TiXmlNode::Accept()

Definition at line 132 of file tinyxml.h.

---

Constructor & Destructor Documentation

virtual TiXmlVisitor::~TiXmlVisitor

(

)

[inline, virtual]

Definition at line 135 of file tinyxml.h.

{}

virtual TiXmlVisitor::~TiXmlVisitor

(

)

[inline, virtual]

Definition at line 123 of file tinyxml.h.

{}

---

Member Function Documentation

virtual bool TiXmlVisitor::Visit

(

const TiXmlDeclaration &

)

[inline, virtual]

Visit a declaration.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 148 of file tinyxml.h.

Referenced by TiXmlUnknown::Accept(), TiXmlText::Accept(), TiXmlComment::Accept(), and TiXmlDeclaration::Accept().

{ return true; }

virtual bool TiXmlVisitor::Visit

(

const TiXmlUnknown &

)

[inline, virtual]

Visit an unknow node.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 154 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::Visit

(

const TiXmlComment &

comment

)

[inline, virtual]

Visit a comment node.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 140 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::Visit

(

const TiXmlText &

text

)

[inline, virtual]

Visit a text node.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 138 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::Visit

(

const TiXmlUnknown &

unknown

)

[inline, virtual]

Visit an unknow node.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 142 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::Visit

(

const TiXmlText &

)

[inline, virtual]

Visit a text node.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 150 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::Visit

(

const TiXmlDeclaration &

declaration

)

[inline, virtual]

Visit a declaration.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 136 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::Visit

(

const TiXmlComment &

)

[inline, virtual]

Visit a comment node.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 152 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::VisitEnter

(

const TiXmlDocument &

doc

)

[inline, virtual]

Visit a document.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 126 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::VisitEnter	(	const TiXmlElement &	,
		const TiXmlAttribute *
	)		[inline, virtual]

Visit an element.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 143 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::VisitEnter

(

const TiXmlDocument &

)

[inline, virtual]

Visit a document.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 138 of file tinyxml.h.

Referenced by TiXmlDocument::Accept(), and TiXmlElement::Accept().

{ return true; }

virtual bool TiXmlVisitor::VisitEnter	(	const TiXmlElement &	element,
		const TiXmlAttribute *	firstAttribute
	)		[inline, virtual]

Visit an element.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 131 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::VisitExit

(

const TiXmlDocument &

)

[inline, virtual]

Visit a document.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 140 of file tinyxml.h.

Referenced by TiXmlDocument::Accept(), and TiXmlElement::Accept().

{ return true; }

virtual bool TiXmlVisitor::VisitExit

(

const TiXmlElement &

)

[inline, virtual]

Visit an element.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 145 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::VisitExit

(

const TiXmlDocument &

doc

)

[inline, virtual]

Visit a document.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 128 of file tinyxml.h.

{ return true; }

virtual bool TiXmlVisitor::VisitExit

(

const TiXmlElement &

element

)

[inline, virtual]

Visit an element.

Reimplemented in TiXmlPrinter, and TiXmlPrinter.

Definition at line 133 of file tinyxml.h.

{ return true; }