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:

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

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

Constructor & Destructor Documentation

~TiXmlVisitor()

virtual TiXmlVisitor::~TiXmlVisitor ( )

inlinevirtual

Definition at line 146 of file tinyxml.h.

{}

Member Function Documentation

Visit() [1/5]

virtual bool TiXmlVisitor::Visit ( const TiXmlDeclaration &  )

inlinevirtual

Visit a declaration.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 162 of file tinyxml.h.

Referenced by TiXmlDeclaration::Accept().

{ return true; }

Here is the caller graph for this function:

Visit() [2/5]

virtual bool TiXmlVisitor::Visit ( const TiXmlStylesheetReference &  )

inlinevirtual

Visit a stylesheet reference.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 164 of file tinyxml.h.

Referenced by TiXmlStylesheetReference::Accept().

                                                        {
    return true;
  }

Here is the caller graph for this function:

Visit() [3/5]

virtual bool TiXmlVisitor::Visit ( const TiXmlText &  )

inlinevirtual

Visit a text node.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 168 of file tinyxml.h.

Referenced by TiXmlText::Accept().

{ return true; }

Here is the caller graph for this function:

Visit() [4/5]

virtual bool TiXmlVisitor::Visit ( const TiXmlComment &  )

inlinevirtual

Visit a comment node.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 170 of file tinyxml.h.

Referenced by TiXmlComment::Accept().

{ return true; }

Here is the caller graph for this function:

Visit() [5/5]

virtual bool TiXmlVisitor::Visit ( const TiXmlUnknown &  )

inlinevirtual

Visit an unknow node.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 172 of file tinyxml.h.

Referenced by TiXmlUnknown::Accept(), and ticpp::Visitor::Visit().

{ return true; }

Here is the caller graph for this function:

VisitEnter() [1/2]

virtual bool TiXmlVisitor::VisitEnter ( const TiXmlDocument &  )

inlinevirtual

Visit a document.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 149 of file tinyxml.h.

{ return true; }

VisitEnter() [2/2]

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

inlinevirtual

Visit an element.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 154 of file tinyxml.h.

                                                   {
    return true;
  }

VisitExit() [1/2]

virtual bool TiXmlVisitor::VisitExit ( const TiXmlDocument &  )

inlinevirtual

Visit a document.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 151 of file tinyxml.h.

{ return true; }

VisitExit() [2/2]

virtual bool TiXmlVisitor::VisitExit ( const TiXmlElement &  )

inlinevirtual

Visit an element.

Reimplemented in TiXmlPrinter, and ticpp::Visitor.

Definition at line 159 of file tinyxml.h.

Referenced by TiXmlElement::Accept().

{ return true; }

Here is the caller graph for this function:

---

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

• agrum/tools/external/tinyxml/ticpp/tinyxml.h