classtinyxml2_1_1_x_m_l_visitor.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.10.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TinyXML-2: tinyxml2::XMLVisitor Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <script type="text/javascript" src="cookie.js"></script>
  14. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  15. <script type="text/javascript" src="search/searchdata.js"></script>
  16. <script type="text/javascript" src="search/search.js"></script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr id="projectrow">
  25. <td id="projectalign">
  26. <div id="projectname">TinyXML-2<span id="projectnumber">&#160;10.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.10.0 -->
  35. <script type="text/javascript">
  36. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  37. var searchBox = new SearchBox("searchBox", "search/",'.html');
  38. /* @license-end */
  39. </script>
  40. <script type="text/javascript" src="menudata.js"></script>
  41. <script type="text/javascript" src="menu.js"></script>
  42. <script type="text/javascript">
  43. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  44. $(function() {
  45. initMenu('',true,false,'search.php','Search');
  46. $(function() { init_search(); });
  47. });
  48. /* @license-end */
  49. </script>
  50. <div id="main-nav"></div>
  51. <!-- window showing the filter options -->
  52. <div id="MSearchSelectWindow"
  53. onmouseover="return searchBox.OnSearchSelectShow()"
  54. onmouseout="return searchBox.OnSearchSelectHide()"
  55. onkeydown="return searchBox.OnSearchSelectKey(event)">
  56. </div>
  57. <!-- iframe showing the search results (closed by default) -->
  58. <div id="MSearchResultsWindow">
  59. <div id="MSearchResults">
  60. <div class="SRPage">
  61. <div id="SRIndex">
  62. <div id="SRResults"></div>
  63. <div class="SRStatus" id="Loading">Loading...</div>
  64. <div class="SRStatus" id="Searching">Searching...</div>
  65. <div class="SRStatus" id="NoMatches">No Matches</div>
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. <div id="nav-path" class="navpath">
  71. <ul>
  72. <li class="navelem"><b>tinyxml2</b></li><li class="navelem"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html">XMLVisitor</a></li> </ul>
  73. </div>
  74. </div><!-- top -->
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#pub-methods">Public Member Functions</a> &#124;
  78. <a href="classtinyxml2_1_1_x_m_l_visitor-members.html">List of all members</a> </div>
  79. <div class="headertitle"><div class="title">tinyxml2::XMLVisitor Class Reference</div></div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p><code>#include &lt;<a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a>&gt;</code></p>
  83. <div class="dynheader">
  84. Inheritance diagram for tinyxml2::XMLVisitor:</div>
  85. <div class="dyncontent">
  86. <div class="center">
  87. <img src="classtinyxml2_1_1_x_m_l_visitor.png" usemap="#tinyxml2::XMLVisitor_map" alt=""/>
  88. <map id="tinyxml2::XMLVisitor_map" name="tinyxml2::XMLVisitor_map">
  89. <area href="classtinyxml2_1_1_x_m_l_printer.html" alt="tinyxml2::XMLPrinter" shape="rect" coords="0,56,128,80"/>
  90. </map>
  91. </div></div>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  94. Public Member Functions</h2></td></tr>
  95. <tr class="memitem:acb3c22fc5f60eb9db98f533f2761f67d" id="r_acb3c22fc5f60eb9db98f533f2761f67d"><td class="memItemLeft" align="right" valign="top"><a id="acb3c22fc5f60eb9db98f533f2761f67d" name="acb3c22fc5f60eb9db98f533f2761f67d"></a>
  96. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>VisitEnter</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_document.html">XMLDocument</a> &amp;)</td></tr>
  97. <tr class="memdesc:acb3c22fc5f60eb9db98f533f2761f67d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit a document. <br /></td></tr>
  98. <tr class="separator:acb3c22fc5f60eb9db98f533f2761f67d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a170e9989cd046ba904f302d087e07086" id="r_a170e9989cd046ba904f302d087e07086"><td class="memItemLeft" align="right" valign="top"><a id="a170e9989cd046ba904f302d087e07086" name="a170e9989cd046ba904f302d087e07086"></a>
  100. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>VisitExit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_document.html">XMLDocument</a> &amp;)</td></tr>
  101. <tr class="memdesc:a170e9989cd046ba904f302d087e07086"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit a document. <br /></td></tr>
  102. <tr class="separator:a170e9989cd046ba904f302d087e07086"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:af97980a17dd4e37448b181f5ddfa92b5" id="r_af97980a17dd4e37448b181f5ddfa92b5"><td class="memItemLeft" align="right" valign="top"><a id="af97980a17dd4e37448b181f5ddfa92b5" name="af97980a17dd4e37448b181f5ddfa92b5"></a>
  104. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>VisitEnter</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a> &amp;, const <a class="el" href="classtinyxml2_1_1_x_m_l_attribute.html">XMLAttribute</a> *)</td></tr>
  105. <tr class="memdesc:af97980a17dd4e37448b181f5ddfa92b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit an element. <br /></td></tr>
  106. <tr class="separator:af97980a17dd4e37448b181f5ddfa92b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a772f10ddc83f881956d32628faa16eb6" id="r_a772f10ddc83f881956d32628faa16eb6"><td class="memItemLeft" align="right" valign="top"><a id="a772f10ddc83f881956d32628faa16eb6" name="a772f10ddc83f881956d32628faa16eb6"></a>
  108. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>VisitExit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a> &amp;)</td></tr>
  109. <tr class="memdesc:a772f10ddc83f881956d32628faa16eb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit an element. <br /></td></tr>
  110. <tr class="separator:a772f10ddc83f881956d32628faa16eb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:adc75bd459fc7ba8223b50f0616767f9a" id="r_adc75bd459fc7ba8223b50f0616767f9a"><td class="memItemLeft" align="right" valign="top"><a id="adc75bd459fc7ba8223b50f0616767f9a" name="adc75bd459fc7ba8223b50f0616767f9a"></a>
  112. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>Visit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_declaration.html">XMLDeclaration</a> &amp;)</td></tr>
  113. <tr class="memdesc:adc75bd459fc7ba8223b50f0616767f9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit a declaration. <br /></td></tr>
  114. <tr class="separator:adc75bd459fc7ba8223b50f0616767f9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:af30233565856480ea48b6fa0d6dec65b" id="r_af30233565856480ea48b6fa0d6dec65b"><td class="memItemLeft" align="right" valign="top"><a id="af30233565856480ea48b6fa0d6dec65b" name="af30233565856480ea48b6fa0d6dec65b"></a>
  116. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>Visit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_text.html">XMLText</a> &amp;)</td></tr>
  117. <tr class="memdesc:af30233565856480ea48b6fa0d6dec65b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit a text node. <br /></td></tr>
  118. <tr class="separator:af30233565856480ea48b6fa0d6dec65b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:acc8147fb5a85f6c65721654e427752d7" id="r_acc8147fb5a85f6c65721654e427752d7"><td class="memItemLeft" align="right" valign="top"><a id="acc8147fb5a85f6c65721654e427752d7" name="acc8147fb5a85f6c65721654e427752d7"></a>
  120. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>Visit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_comment.html">XMLComment</a> &amp;)</td></tr>
  121. <tr class="memdesc:acc8147fb5a85f6c65721654e427752d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit a comment node. <br /></td></tr>
  122. <tr class="separator:acc8147fb5a85f6c65721654e427752d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a14e4748387c34bf53d24e8119bb1f292" id="r_a14e4748387c34bf53d24e8119bb1f292"><td class="memItemLeft" align="right" valign="top"><a id="a14e4748387c34bf53d24e8119bb1f292" name="a14e4748387c34bf53d24e8119bb1f292"></a>
  124. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>Visit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_unknown.html">XMLUnknown</a> &amp;)</td></tr>
  125. <tr class="memdesc:a14e4748387c34bf53d24e8119bb1f292"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visit an unknown node. <br /></td></tr>
  126. <tr class="separator:a14e4748387c34bf53d24e8119bb1f292"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table>
  128. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  129. <div class="textblock"><p>Implements the interface to the "Visitor pattern" (see the Accept() method.) If you call the Accept() method, it requires being passed a <a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html">XMLVisitor</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 leafs are simply called with <a class="el" href="#adc75bd459fc7ba8223b50f0616767f9a" title="Visit a declaration.">Visit()</a>.</p>
  130. <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 siblings</b> will be visited.</p>
  131. <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>
  132. <p>Generally Accept() is called on the <a class="el" href="classtinyxml2_1_1_x_m_l_document.html">XMLDocument</a>, although all nodes support visiting.</p>
  133. <p>You should never change the document from a callback.</p>
  134. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classtinyxml2_1_1_x_m_l_node.html#a81e66df0a44c67a7af17f3b77a152785">XMLNode::Accept()</a> </dd></dl>
  135. </div><hr/>The documentation for this class was generated from the following file:<ul>
  136. <li><a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a></li>
  137. </ul>
  138. </div><!-- contents -->
  139. <!-- start footer part -->
  140. <hr class="footer"/><address class="footer"><small>
  141. Generated on Sat Dec 30 2023 18:02:36 for TinyXML-2 by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
  142. </small></address>
  143. </body>
  144. </html>