Dan Albert | c3bbea3 | 2014-08-21 15:48:37 -0700 | [diff] [blame^] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | <head> |
| 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | <title>TinyXml: TiXmlVisitor Class Reference</title> |
| 6 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 7 | <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| 8 | </head> |
| 9 | <body> |
| 10 | <!-- Generated by Doxygen 1.6.2 --> |
| 11 | <div class="navigation" id="top"> |
| 12 | <div class="tabs"> |
| 13 | <ul> |
| 14 | <li><a href="index.html"><span>Main Page</span></a></li> |
| 15 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
| 16 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| 17 | <li><a href="files.html"><span>Files</span></a></li> |
| 18 | </ul> |
| 19 | </div> |
| 20 | <div class="tabs"> |
| 21 | <ul> |
| 22 | <li><a href="annotated.html"><span>Class List</span></a></li> |
| 23 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| 24 | <li><a href="functions.html"><span>Class Members</span></a></li> |
| 25 | </ul> |
| 26 | </div> |
| 27 | </div> |
| 28 | <div class="contents"> |
| 29 | <h1>TiXmlVisitor Class Reference</h1><!-- doxytag: class="TiXmlVisitor" --> |
| 30 | <p>Implements the interface to the "Visitor pattern" (see the Accept() method. |
| 31 | <a href="#_details">More...</a></p> |
| 32 | |
| 33 | <p><code>#include <<a class="el" href="tinyxml_8h_source.html">tinyxml.h</a>></code></p> |
| 34 | <div class="dynheader"> |
| 35 | Inheritance diagram for TiXmlVisitor:</div> |
| 36 | <div class="dynsection"> |
| 37 | <div class="center"> |
| 38 | <img src="classTiXmlVisitor.png" usemap="#TiXmlVisitor_map" alt=""/> |
| 39 | <map id="TiXmlVisitor_map" name="TiXmlVisitor_map"> |
| 40 | <area href="classTiXmlPrinter.html" alt="TiXmlPrinter" shape="rect" coords="0,56,81,80"/> |
| 41 | </map> |
| 42 | </div> |
| 43 | </div> |
| 44 | |
| 45 | <p><a href="classTiXmlVisitor-members.html">List of all members.</a></p> |
| 46 | <table border="0" cellpadding="0" cellspacing="0"> |
| 47 | <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> |
| 48 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07baecb52dd7d8716ae2a48ad0956ee0"></a><!-- doxytag: member="TiXmlVisitor::VisitEnter" ref="a07baecb52dd7d8716ae2a48ad0956ee0" args="(const TiXmlDocument &)" --> |
| 49 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlVisitor.html#a07baecb52dd7d8716ae2a48ad0956ee0">VisitEnter</a> (const <a class="el" href="classTiXmlDocument.html">TiXmlDocument</a> &)</td></tr> |
| 50 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Visit a document. <br/></td></tr> |
| 51 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0ade4f27087447e93974e975c3246ad"></a><!-- doxytag: member="TiXmlVisitor::VisitExit" ref="aa0ade4f27087447e93974e975c3246ad" args="(const TiXmlDocument &)" --> |
| 52 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlVisitor.html#aa0ade4f27087447e93974e975c3246ad">VisitExit</a> (const <a class="el" href="classTiXmlDocument.html">TiXmlDocument</a> &)</td></tr> |
| 53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Visit a document. <br/></td></tr> |
| 54 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6c6178ffa517bbdba95d70490875fff"></a><!-- doxytag: member="TiXmlVisitor::VisitEnter" ref="af6c6178ffa517bbdba95d70490875fff" args="(const TiXmlElement &, const TiXmlAttribute *)" --> |
| 55 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlVisitor.html#af6c6178ffa517bbdba95d70490875fff">VisitEnter</a> (const <a class="el" href="classTiXmlElement.html">TiXmlElement</a> &, const <a class="el" href="classTiXmlAttribute.html">TiXmlAttribute</a> *)</td></tr> |
| 56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Visit an element. <br/></td></tr> |
| 57 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec2b1f8116226d52f3a1b95dafd3a32c"></a><!-- doxytag: member="TiXmlVisitor::VisitExit" ref="aec2b1f8116226d52f3a1b95dafd3a32c" args="(const TiXmlElement &)" --> |
| 58 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlVisitor.html#aec2b1f8116226d52f3a1b95dafd3a32c">VisitExit</a> (const <a class="el" href="classTiXmlElement.html">TiXmlElement</a> &)</td></tr> |
| 59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Visit an element. <br/></td></tr> |
| 60 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afad71c71ce6473fb9b4b64cd92de4a19"></a><!-- doxytag: member="TiXmlVisitor::Visit" ref="afad71c71ce6473fb9b4b64cd92de4a19" args="(const TiXmlDeclaration &)" --> |
| 61 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlVisitor.html#afad71c71ce6473fb9b4b64cd92de4a19">Visit</a> (const <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> &)</td></tr> |
| 62 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Visit a declaration. <br/></td></tr> |
| 63 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a399b8ebca5cd14664974a32d2ce029e5"></a><!-- doxytag: member="TiXmlVisitor::Visit" ref="a399b8ebca5cd14664974a32d2ce029e5" args="(const TiXmlText &)" --> |
| 64 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlVisitor.html#a399b8ebca5cd14664974a32d2ce029e5">Visit</a> (const <a class="el" href="classTiXmlText.html">TiXmlText</a> &)</td></tr> |
| 65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Visit a text node. <br/></td></tr> |
| 66 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53a60e7a528627b31af3161972cc7fa2"></a><!-- doxytag: member="TiXmlVisitor::Visit" ref="a53a60e7a528627b31af3161972cc7fa2" args="(const TiXmlComment &)" --> |
| 67 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlVisitor.html#a53a60e7a528627b31af3161972cc7fa2">Visit</a> (const <a class="el" href="classTiXmlComment.html">TiXmlComment</a> &)</td></tr> |
| 68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Visit a comment node. <br/></td></tr> |
| 69 | <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e284d607d275c51dac1adb58159ce28"></a><!-- doxytag: member="TiXmlVisitor::Visit" ref="a7e284d607d275c51dac1adb58159ce28" args="(const TiXmlUnknown &)" --> |
| 70 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlVisitor.html#a7e284d607d275c51dac1adb58159ce28">Visit</a> (const <a class="el" href="classTiXmlUnknown.html">TiXmlUnknown</a> &)</td></tr> |
| 71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Visit an unknown node. <br/></td></tr> |
| 72 | </table> |
| 73 | <hr/><a name="_details"></a><h2>Detailed Description</h2> |
| 74 | <p>Implements the interface to the "Visitor pattern" (see the Accept() method. </p> |
| 75 | <p>) If you call the Accept() method, it requires being passed a <a class="el" href="classTiXmlVisitor.html" title="Implements the interface to the "Visitor pattern" (see the Accept() method...">TiXmlVisitor</a> 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 simply called with <a class="el" href="classTiXmlVisitor.html#afad71c71ce6473fb9b4b64cd92de4a19" title="Visit a declaration.">Visit()</a>.</p> |
| 76 | <p>If you return 'true' from a Visit method, recursive parsing will continue. If you return false, <b>no children of this node or its sibilings</b> will be Visited.</p> |
| 77 | <p>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.</p> |
| 78 | <p>Generally Accept() is called on the <a class="el" href="classTiXmlDocument.html" title="Always the top level node.">TiXmlDocument</a>, although all nodes suppert Visiting.</p> |
| 79 | <p>You should never change the document from a callback.</p> |
| 80 | <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTiXmlNode.html#acc0f88b7462c6cb73809d410a4f5bb86" title="Accept a hierchical visit the nodes in the TinyXML DOM.">TiXmlNode::Accept()</a> </dd></dl> |
| 81 | <hr/>The documentation for this class was generated from the following file:<ul> |
| 82 | <li><a class="el" href="tinyxml_8h_source.html">tinyxml.h</a></li> |
| 83 | </ul> |
| 84 | </div> |
| 85 | <hr size="1"/><address style="text-align: right;"><small>Generated by |
| 86 | <a href="http://www.doxygen.org/index.html"> |
| 87 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
| 88 | </body> |
| 89 | </html> |