Twitch SDK (Internal)
Public Member Functions | List of all members
ttv::xml::XMLVisitor Class Reference

#include <tinyxml2.h>

Inheritance diagram for ttv::xml::XMLVisitor:
ttv::xml::XMLPrinter

Public Member Functions

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

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()

Constructor & Destructor Documentation

◆ ~XMLVisitor()

virtual ttv::xml::XMLVisitor::~XMLVisitor ( )
inlinevirtual

Member Function Documentation

◆ Visit() [1/4]

virtual bool ttv::xml::XMLVisitor::Visit ( const XMLDeclaration )
inlinevirtual

Visit a declaration.

Reimplemented in ttv::xml::XMLPrinter.

◆ Visit() [2/4]

virtual bool ttv::xml::XMLVisitor::Visit ( const XMLText )
inlinevirtual

Visit a text node.

Reimplemented in ttv::xml::XMLPrinter.

◆ Visit() [3/4]

virtual bool ttv::xml::XMLVisitor::Visit ( const XMLComment )
inlinevirtual

Visit a comment node.

Reimplemented in ttv::xml::XMLPrinter.

◆ Visit() [4/4]

virtual bool ttv::xml::XMLVisitor::Visit ( const XMLUnknown )
inlinevirtual

Visit an unknown node.

Reimplemented in ttv::xml::XMLPrinter.

◆ VisitEnter() [1/2]

virtual bool ttv::xml::XMLVisitor::VisitEnter ( const XMLDocument )
inlinevirtual

Visit a document.

Reimplemented in ttv::xml::XMLPrinter.

◆ VisitEnter() [2/2]

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

Visit an element.

Reimplemented in ttv::xml::XMLPrinter.

◆ VisitExit() [1/2]

virtual bool ttv::xml::XMLVisitor::VisitExit ( const XMLDocument )
inlinevirtual

Visit a document.

Reimplemented in ttv::xml::XMLPrinter.

◆ VisitExit() [2/2]

virtual bool ttv::xml::XMLVisitor::VisitExit ( const XMLElement )
inlinevirtual

Visit an element.

Reimplemented in ttv::xml::XMLPrinter.


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