Public Member Functions | List of all members
tinyxml2::XMLVisitor Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLVisitor:
Inheritance graph
[legend]

Public Member Functions

virtual bool Visit (const XMLComment &)
 Visit a comment node. More...
 
virtual bool Visit (const XMLDeclaration &)
 Visit a declaration. More...
 
virtual bool Visit (const XMLText &)
 Visit a text node. More...
 
virtual bool Visit (const XMLUnknown &)
 Visit an unknown node. More...
 
virtual bool VisitEnter (const XMLDocument &)
 Visit a document. More...
 
virtual bool VisitEnter (const XMLElement &, const XMLAttribute *)
 Visit an element. More...
 
virtual bool VisitExit (const XMLDocument &)
 Visit a document. More...
 
virtual bool VisitExit (const XMLElement &)
 Visit an element. More...
 
virtual ~XMLVisitor ()
 

Detailed Description

Implements the interface to the "Visitor pattern" (see the Accept() method.) If you call the Accept() method, it requires being passed a XMLVisitor 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 leafs are simply 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 siblings 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 XMLDocument, although all nodes support visiting.

You should never change the document from a callback.

See also
XMLNode::Accept()

Definition at line 481 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ ~XMLVisitor()

virtual tinyxml2::XMLVisitor::~XMLVisitor ( )
inlinevirtual

Definition at line 484 of file tinyxml2.h.

Member Function Documentation

◆ Visit() [1/4]

virtual bool tinyxml2::XMLVisitor::Visit ( const XMLComment )
inlinevirtual

Visit a comment node.

Reimplemented in tinyxml2::XMLPrinter.

Definition at line 513 of file tinyxml2.h.

◆ Visit() [2/4]

virtual bool tinyxml2::XMLVisitor::Visit ( const XMLDeclaration )
inlinevirtual

Visit a declaration.

Reimplemented in tinyxml2::XMLPrinter.

Definition at line 505 of file tinyxml2.h.

◆ Visit() [3/4]

virtual bool tinyxml2::XMLVisitor::Visit ( const XMLText )
inlinevirtual

Visit a text node.

Reimplemented in tinyxml2::XMLPrinter.

Definition at line 509 of file tinyxml2.h.

◆ Visit() [4/4]

virtual bool tinyxml2::XMLVisitor::Visit ( const XMLUnknown )
inlinevirtual

Visit an unknown node.

Reimplemented in tinyxml2::XMLPrinter.

Definition at line 517 of file tinyxml2.h.

◆ VisitEnter() [1/2]

virtual bool tinyxml2::XMLVisitor::VisitEnter ( const XMLDocument )
inlinevirtual

Visit a document.

Reimplemented in tinyxml2::XMLPrinter.

Definition at line 487 of file tinyxml2.h.

◆ VisitEnter() [2/2]

virtual bool tinyxml2::XMLVisitor::VisitEnter ( const XMLElement ,
const XMLAttribute  
)
inlinevirtual

Visit an element.

Reimplemented in tinyxml2::XMLPrinter.

Definition at line 496 of file tinyxml2.h.

◆ VisitExit() [1/2]

virtual bool tinyxml2::XMLVisitor::VisitExit ( const XMLDocument )
inlinevirtual

Visit a document.

Reimplemented in tinyxml2::XMLPrinter.

Definition at line 491 of file tinyxml2.h.

◆ VisitExit() [2/2]

virtual bool tinyxml2::XMLVisitor::VisitExit ( const XMLElement )
inlinevirtual

Visit an element.

Reimplemented in tinyxml2::XMLPrinter.

Definition at line 500 of file tinyxml2.h.


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


behaviortree_cpp_v4
Author(s): Davide Faconti
autogenerated on Fri Jun 28 2024 02:20:10