OBT::TiXmlVisitor Class Reference

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

#include <OBTtinyxml.h>

Inheritance diagram for OBT::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.
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 137 of file OBTtinyxml.h.


Constructor & Destructor Documentation

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

Definition at line 140 of file OBTtinyxml.h.

00140 {}

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

Definition at line 139 of file tiny/OBTtinyxml.h.

00139 {}


Member Function Documentation

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

Visit a document.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 143 of file OBTtinyxml.h.

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

00143 { return true; }

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

Visit a document.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 145 of file OBTtinyxml.h.

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

00145 { return true; }

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

Visit an element.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 148 of file OBTtinyxml.h.

00148 { return true; }

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

Visit an element.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 150 of file OBTtinyxml.h.

00150 { return true; }

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

Visit a declaration.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 153 of file OBTtinyxml.h.

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

00153 { return true; }

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

Visit a text node.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 155 of file OBTtinyxml.h.

00155 { return true; }

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

Visit a comment node.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 157 of file OBTtinyxml.h.

00157 { return true; }

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

Visit an unknow node.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 159 of file OBTtinyxml.h.

00159 { return true; }

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

Visit a document.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 142 of file tiny/OBTtinyxml.h.

00142 { return true; }

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

Visit a document.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 144 of file tiny/OBTtinyxml.h.

00144 { return true; }

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

Visit an element.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 147 of file tiny/OBTtinyxml.h.

00147 { return true; }

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

Visit an element.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 149 of file tiny/OBTtinyxml.h.

00149 { return true; }

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

Visit a declaration.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 152 of file tiny/OBTtinyxml.h.

00152 { return true; }

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

Visit a text node.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 154 of file tiny/OBTtinyxml.h.

00154 { return true; }

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

Visit a comment node.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 156 of file tiny/OBTtinyxml.h.

00156 { return true; }

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

Visit an unknow node.

Reimplemented in OBT::TiXmlPrinter, and OBT::TiXmlPrinter.

Definition at line 158 of file tiny/OBTtinyxml.h.

00158 { return true; }


Generated on Wed Oct 1 11:34:19 2008 for OBT by  doxygen 1.5.3