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"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.9.1"/> 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<link href="search/search.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="search/searchdata.js"></script> 14<script type="text/javascript" src="search/search.js"></script> 15<link href="doxygen.css" rel="stylesheet" type="text/css" /> 16</head> 17<body> 18<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 19<div id="titlearea"> 20<table cellspacing="0" cellpadding="0"> 21 <tbody> 22 <tr style="height: 56px;"> 23 <td id="projectalign" style="padding-left: 0.5em;"> 24 <div id="projectname">TinyXML-2 25  <span id="projectnumber">9.0.0</span> 26 </div> 27 </td> 28 </tr> 29 </tbody> 30</table> 31</div> 32<!-- end header part --> 33<!-- Generated by Doxygen 1.9.1 --> 34<script type="text/javascript"> 35/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 36var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); 37/* @license-end */ 38</script> 39<script type="text/javascript" src="menudata.js"></script> 40<script type="text/javascript" src="menu.js"></script> 41<script type="text/javascript"> 42/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 43$(function() { 44 initMenu('',true,false,'search.php','Search'); 45 $(document).ready(function() { init_search(); }); 46}); 47/* @license-end */</script> 48<div id="main-nav"></div> 49<!-- window showing the filter options --> 50<div id="MSearchSelectWindow" 51 onmouseover="return searchBox.OnSearchSelectShow()" 52 onmouseout="return searchBox.OnSearchSelectHide()" 53 onkeydown="return searchBox.OnSearchSelectKey(event)"> 54</div> 55 56<!-- iframe showing the search results (closed by default) --> 57<div id="MSearchResultsWindow"> 58<iframe src="javascript:void(0)" frameborder="0" 59 name="MSearchResults" id="MSearchResults"> 60</iframe> 61</div> 62 63<div id="nav-path" class="navpath"> 64 <ul> 65<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> 66</div> 67</div><!-- top --> 68<div class="header"> 69 <div class="summary"> 70<a href="#pub-methods">Public Member Functions</a> | 71<a href="classtinyxml2_1_1_x_m_l_visitor-members.html">List of all members</a> </div> 72 <div class="headertitle"> 73<div class="title">tinyxml2::XMLVisitor Class Reference</div> </div> 74</div><!--header--> 75<div class="contents"> 76 77<p><code>#include <<a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a>></code></p> 78<div class="dynheader"> 79Inheritance diagram for tinyxml2::XMLVisitor:</div> 80<div class="dyncontent"> 81 <div class="center"> 82 <img src="classtinyxml2_1_1_x_m_l_visitor.png" usemap="#tinyxml2::XMLVisitor_map" alt=""/> 83 <map id="tinyxml2::XMLVisitor_map" name="tinyxml2::XMLVisitor_map"> 84<area href="classtinyxml2_1_1_x_m_l_printer.html" alt="tinyxml2::XMLPrinter" shape="rect" coords="0,56,128,80"/> 85 </map> 86</div></div> 87<table class="memberdecls"> 88<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> 89Public Member Functions</h2></td></tr> 90<tr class="memitem:acb3c22fc5f60eb9db98f533f2761f67d"><td class="memItemLeft" align="right" valign="top"><a id="acb3c22fc5f60eb9db98f533f2761f67d"></a> 91virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html#acb3c22fc5f60eb9db98f533f2761f67d">VisitEnter</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_document.html">XMLDocument</a> &)</td></tr> 92<tr class="memdesc:acb3c22fc5f60eb9db98f533f2761f67d"><td class="mdescLeft"> </td><td class="mdescRight">Visit a document. <br /></td></tr> 93<tr class="separator:acb3c22fc5f60eb9db98f533f2761f67d"><td class="memSeparator" colspan="2"> </td></tr> 94<tr class="memitem:a170e9989cd046ba904f302d087e07086"><td class="memItemLeft" align="right" valign="top"><a id="a170e9989cd046ba904f302d087e07086"></a> 95virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html#a170e9989cd046ba904f302d087e07086">VisitExit</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_document.html">XMLDocument</a> &)</td></tr> 96<tr class="memdesc:a170e9989cd046ba904f302d087e07086"><td class="mdescLeft"> </td><td class="mdescRight">Visit a document. <br /></td></tr> 97<tr class="separator:a170e9989cd046ba904f302d087e07086"><td class="memSeparator" colspan="2"> </td></tr> 98<tr class="memitem:af97980a17dd4e37448b181f5ddfa92b5"><td class="memItemLeft" align="right" valign="top"><a id="af97980a17dd4e37448b181f5ddfa92b5"></a> 99virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html#af97980a17dd4e37448b181f5ddfa92b5">VisitEnter</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a> &, const <a class="el" href="classtinyxml2_1_1_x_m_l_attribute.html">XMLAttribute</a> *)</td></tr> 100<tr class="memdesc:af97980a17dd4e37448b181f5ddfa92b5"><td class="mdescLeft"> </td><td class="mdescRight">Visit an element. <br /></td></tr> 101<tr class="separator:af97980a17dd4e37448b181f5ddfa92b5"><td class="memSeparator" colspan="2"> </td></tr> 102<tr class="memitem:a772f10ddc83f881956d32628faa16eb6"><td class="memItemLeft" align="right" valign="top"><a id="a772f10ddc83f881956d32628faa16eb6"></a> 103virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html#a772f10ddc83f881956d32628faa16eb6">VisitExit</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a> &)</td></tr> 104<tr class="memdesc:a772f10ddc83f881956d32628faa16eb6"><td class="mdescLeft"> </td><td class="mdescRight">Visit an element. <br /></td></tr> 105<tr class="separator:a772f10ddc83f881956d32628faa16eb6"><td class="memSeparator" colspan="2"> </td></tr> 106<tr class="memitem:adc75bd459fc7ba8223b50f0616767f9a"><td class="memItemLeft" align="right" valign="top"><a id="adc75bd459fc7ba8223b50f0616767f9a"></a> 107virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html#adc75bd459fc7ba8223b50f0616767f9a">Visit</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_declaration.html">XMLDeclaration</a> &)</td></tr> 108<tr class="memdesc:adc75bd459fc7ba8223b50f0616767f9a"><td class="mdescLeft"> </td><td class="mdescRight">Visit a declaration. <br /></td></tr> 109<tr class="separator:adc75bd459fc7ba8223b50f0616767f9a"><td class="memSeparator" colspan="2"> </td></tr> 110<tr class="memitem:af30233565856480ea48b6fa0d6dec65b"><td class="memItemLeft" align="right" valign="top"><a id="af30233565856480ea48b6fa0d6dec65b"></a> 111virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html#af30233565856480ea48b6fa0d6dec65b">Visit</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_text.html">XMLText</a> &)</td></tr> 112<tr class="memdesc:af30233565856480ea48b6fa0d6dec65b"><td class="mdescLeft"> </td><td class="mdescRight">Visit a text node. <br /></td></tr> 113<tr class="separator:af30233565856480ea48b6fa0d6dec65b"><td class="memSeparator" colspan="2"> </td></tr> 114<tr class="memitem:acc8147fb5a85f6c65721654e427752d7"><td class="memItemLeft" align="right" valign="top"><a id="acc8147fb5a85f6c65721654e427752d7"></a> 115virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html#acc8147fb5a85f6c65721654e427752d7">Visit</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_comment.html">XMLComment</a> &)</td></tr> 116<tr class="memdesc:acc8147fb5a85f6c65721654e427752d7"><td class="mdescLeft"> </td><td class="mdescRight">Visit a comment node. <br /></td></tr> 117<tr class="separator:acc8147fb5a85f6c65721654e427752d7"><td class="memSeparator" colspan="2"> </td></tr> 118<tr class="memitem:a14e4748387c34bf53d24e8119bb1f292"><td class="memItemLeft" align="right" valign="top"><a id="a14e4748387c34bf53d24e8119bb1f292"></a> 119virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_visitor.html#a14e4748387c34bf53d24e8119bb1f292">Visit</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_unknown.html">XMLUnknown</a> &)</td></tr> 120<tr class="memdesc:a14e4748387c34bf53d24e8119bb1f292"><td class="mdescLeft"> </td><td class="mdescRight">Visit an unknown node. <br /></td></tr> 121<tr class="separator:a14e4748387c34bf53d24e8119bb1f292"><td class="memSeparator" colspan="2"> </td></tr> 122</table> 123<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 124<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="classtinyxml2_1_1_x_m_l_visitor.html#adc75bd459fc7ba8223b50f0616767f9a" title="Visit a declaration.">Visit()</a>.</p> 125<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> 126<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> 127<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> 128<p>You should never change the document from a callback.</p> 129<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> 130</div><hr/>The documentation for this class was generated from the following file:<ul> 131<li><a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a></li> 132</ul> 133</div><!-- contents --> 134<!-- start footer part --> 135<hr class="footer"/><address class="footer"><small> 136Generated on Sun Jun 6 2021 17:10:05 for TinyXML-2 by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 137</small></address> 138</body> 139</html> 140
