xmlTiny::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 xmlTiny::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 135 of file tiny/tmp/OBTtinyxml.h.


Constructor & Destructor Documentation

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

Definition at line 138 of file tiny/tmp/OBTtinyxml.h.

00138 {}


Member Function Documentation

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

Visit a document.

Reimplemented in xmlTiny::TiXmlPrinter.

Definition at line 141 of file tiny/tmp/OBTtinyxml.h.

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

00141 { return true; }

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

Visit a document.

Reimplemented in xmlTiny::TiXmlPrinter.

Definition at line 143 of file tiny/tmp/OBTtinyxml.h.

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

00143 { return true; }

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

Visit an element.

Reimplemented in xmlTiny::TiXmlPrinter.

Definition at line 146 of file tiny/tmp/OBTtinyxml.h.

00146 { return true; }

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

Visit an element.

Reimplemented in xmlTiny::TiXmlPrinter.

Definition at line 148 of file tiny/tmp/OBTtinyxml.h.

00148 { return true; }

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

Visit a declaration.

Reimplemented in xmlTiny::TiXmlPrinter.

Definition at line 151 of file tiny/tmp/OBTtinyxml.h.

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

00151 { return true; }

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

Visit a text node.

Reimplemented in xmlTiny::TiXmlPrinter.

Definition at line 153 of file tiny/tmp/OBTtinyxml.h.

00153 { return true; }

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

Visit a comment node.

Reimplemented in xmlTiny::TiXmlPrinter.

Definition at line 155 of file tiny/tmp/OBTtinyxml.h.

00155 { return true; }

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

Visit an unknow node.

Reimplemented in xmlTiny::TiXmlPrinter.

Definition at line 157 of file tiny/tmp/OBTtinyxml.h.

00157 { return true; }


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