eXperiment robotics framework

TiXmlVisitor Class Reference

If you call the Accept() method, it requires being passed a TiXmlVisitor class to handle callbacks. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlVisitor:

Inheritance graph
[legend]

List of all members.

Public Member Functions

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


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 133 of file tinyxml.h.


Constructor & Destructor Documentation

virtual TiXmlVisitor::~TiXmlVisitor (  )  [inline, virtual]

Definition at line 136 of file tinyxml.h.


Member Function Documentation

virtual bool TiXmlVisitor::VisitEnter ( const TiXmlDocument  )  [inline, virtual]

Visit a document.

Reimplemented in TiXmlPrinter.

Definition at line 139 of file tinyxml.h.

virtual bool TiXmlVisitor::VisitExit ( const TiXmlDocument  )  [inline, virtual]

Visit a document.

Reimplemented in TiXmlPrinter.

Definition at line 141 of file tinyxml.h.

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

Visit an element.

Reimplemented in TiXmlPrinter.

Definition at line 144 of file tinyxml.h.

virtual bool TiXmlVisitor::VisitExit ( const TiXmlElement  )  [inline, virtual]

Visit an element.

Reimplemented in TiXmlPrinter.

Definition at line 146 of file tinyxml.h.

virtual bool TiXmlVisitor::Visit ( const TiXmlDeclaration  )  [inline, virtual]

Visit a declaration.

Reimplemented in TiXmlPrinter.

Definition at line 149 of file tinyxml.h.

virtual bool TiXmlVisitor::Visit ( const TiXmlText  )  [inline, virtual]

Visit a text node.

Reimplemented in TiXmlPrinter.

Definition at line 151 of file tinyxml.h.

virtual bool TiXmlVisitor::Visit ( const TiXmlComment  )  [inline, virtual]

Visit a comment node.

Reimplemented in TiXmlPrinter.

Definition at line 153 of file tinyxml.h.

virtual bool TiXmlVisitor::Visit ( const TiXmlUnknown  )  [inline, virtual]

Visit an unknow node.

Reimplemented in TiXmlPrinter.

Definition at line 155 of file tinyxml.h.


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

The miarn project - written by Joao Xavier