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"> 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&dn=expat.txt MIT */ 37var 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&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 58<!-- iframe showing the search results (closed by default) --> 59<div id="MSearchResultsWindow"> 60<div id="MSearchResults"> 61<div class="SRPage"> 62<div id="SRIndex"> 63<div id="SRResults"></div> 64<div class="SRStatus" id="Loading">Loading...</div> 65<div class="SRStatus" id="Searching">Searching...</div> 66<div class="SRStatus" id="NoMatches">No Matches</div> 67</div> 68</div> 69</div> 70</div> 71 72<div id="nav-path" class="navpath"> 73 <ul> 74<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> 75</div> 76</div><!-- top --> 77<div class="header"> 78 <div class="summary"> 79<a href="#pub-methods">Public Member Functions</a> | 80<a href="classtinyxml2_1_1_x_m_l_visitor-members.html">List of all members</a> </div> 81 <div class="headertitle"><div class="title">tinyxml2::XMLVisitor Class Reference</div></div> 82</div><!--header--> 83<div class="contents"> 84 85<p><code>#include <<a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a>></code></p> 86<div class="dynheader"> 87Inheritance diagram for tinyxml2::XMLVisitor:</div> 88<div class="dyncontent"> 89 <div class="center"> 90 <img src="classtinyxml2_1_1_x_m_l_visitor.png" usemap="#tinyxml2::XMLVisitor_map" alt=""/> 91 <map id="tinyxml2::XMLVisitor_map" name="tinyxml2::XMLVisitor_map"> 92<area href="classtinyxml2_1_1_x_m_l_printer.html" alt="tinyxml2::XMLPrinter" shape="rect" coords="0,56,128,80"/> 93 </map> 94</div></div> 95<table class="memberdecls"> 96<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> 97Public Member Functions</h2></td></tr> 98<tr class="memitem:acb3c22fc5f60eb9db98f533f2761f67d" id="r_acb3c22fc5f60eb9db98f533f2761f67d"><td class="memItemLeft" align="right" valign="top"><a id="acb3c22fc5f60eb9db98f533f2761f67d" name="acb3c22fc5f60eb9db98f533f2761f67d"></a> 99virtual bool </td><td class="memItemRight" valign="bottom"><b>VisitEnter</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_document.html">XMLDocument</a> &)</td></tr> 100<tr class="memdesc:acb3c22fc5f60eb9db98f533f2761f67d"><td class="mdescLeft"> </td><td class="mdescRight">Visit a document. <br /></td></tr> 101<tr class="separator:acb3c22fc5f60eb9db98f533f2761f67d"><td class="memSeparator" colspan="2"> </td></tr> 102<tr class="memitem:a170e9989cd046ba904f302d087e07086" id="r_a170e9989cd046ba904f302d087e07086"><td class="memItemLeft" align="right" valign="top"><a id="a170e9989cd046ba904f302d087e07086" name="a170e9989cd046ba904f302d087e07086"></a> 103virtual bool </td><td class="memItemRight" valign="bottom"><b>VisitExit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_document.html">XMLDocument</a> &)</td></tr> 104<tr class="memdesc:a170e9989cd046ba904f302d087e07086"><td class="mdescLeft"> </td><td class="mdescRight">Visit a document. <br /></td></tr> 105<tr class="separator:a170e9989cd046ba904f302d087e07086"><td class="memSeparator" colspan="2"> </td></tr> 106<tr class="memitem:af97980a17dd4e37448b181f5ddfa92b5" id="r_af97980a17dd4e37448b181f5ddfa92b5"><td class="memItemLeft" align="right" valign="top"><a id="af97980a17dd4e37448b181f5ddfa92b5" name="af97980a17dd4e37448b181f5ddfa92b5"></a> 107virtual bool </td><td class="memItemRight" valign="bottom"><b>VisitEnter</b> (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> 108<tr class="memdesc:af97980a17dd4e37448b181f5ddfa92b5"><td class="mdescLeft"> </td><td class="mdescRight">Visit an element. <br /></td></tr> 109<tr class="separator:af97980a17dd4e37448b181f5ddfa92b5"><td class="memSeparator" colspan="2"> </td></tr> 110<tr class="memitem:a772f10ddc83f881956d32628faa16eb6" id="r_a772f10ddc83f881956d32628faa16eb6"><td class="memItemLeft" align="right" valign="top"><a id="a772f10ddc83f881956d32628faa16eb6" name="a772f10ddc83f881956d32628faa16eb6"></a> 111virtual bool </td><td class="memItemRight" valign="bottom"><b>VisitExit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a> &)</td></tr> 112<tr class="memdesc:a772f10ddc83f881956d32628faa16eb6"><td class="mdescLeft"> </td><td class="mdescRight">Visit an element. <br /></td></tr> 113<tr class="separator:a772f10ddc83f881956d32628faa16eb6"><td class="memSeparator" colspan="2"> </td></tr> 114<tr class="memitem:adc75bd459fc7ba8223b50f0616767f9a" id="r_adc75bd459fc7ba8223b50f0616767f9a"><td class="memItemLeft" align="right" valign="top"><a id="adc75bd459fc7ba8223b50f0616767f9a" name="adc75bd459fc7ba8223b50f0616767f9a"></a> 115virtual bool </td><td class="memItemRight" valign="bottom"><b>Visit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_declaration.html">XMLDeclaration</a> &)</td></tr> 116<tr class="memdesc:adc75bd459fc7ba8223b50f0616767f9a"><td class="mdescLeft"> </td><td class="mdescRight">Visit a declaration. <br /></td></tr> 117<tr class="separator:adc75bd459fc7ba8223b50f0616767f9a"><td class="memSeparator" colspan="2"> </td></tr> 118<tr class="memitem:af30233565856480ea48b6fa0d6dec65b" id="r_af30233565856480ea48b6fa0d6dec65b"><td class="memItemLeft" align="right" valign="top"><a id="af30233565856480ea48b6fa0d6dec65b" name="af30233565856480ea48b6fa0d6dec65b"></a> 119virtual bool </td><td class="memItemRight" valign="bottom"><b>Visit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_text.html">XMLText</a> &)</td></tr> 120<tr class="memdesc:af30233565856480ea48b6fa0d6dec65b"><td class="mdescLeft"> </td><td class="mdescRight">Visit a text node. <br /></td></tr> 121<tr class="separator:af30233565856480ea48b6fa0d6dec65b"><td class="memSeparator" colspan="2"> </td></tr> 122<tr class="memitem:acc8147fb5a85f6c65721654e427752d7" id="r_acc8147fb5a85f6c65721654e427752d7"><td class="memItemLeft" align="right" valign="top"><a id="acc8147fb5a85f6c65721654e427752d7" name="acc8147fb5a85f6c65721654e427752d7"></a> 123virtual bool </td><td class="memItemRight" valign="bottom"><b>Visit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_comment.html">XMLComment</a> &)</td></tr> 124<tr class="memdesc:acc8147fb5a85f6c65721654e427752d7"><td class="mdescLeft"> </td><td class="mdescRight">Visit a comment node. <br /></td></tr> 125<tr class="separator:acc8147fb5a85f6c65721654e427752d7"><td class="memSeparator" colspan="2"> </td></tr> 126<tr class="memitem:a14e4748387c34bf53d24e8119bb1f292" id="r_a14e4748387c34bf53d24e8119bb1f292"><td class="memItemLeft" align="right" valign="top"><a id="a14e4748387c34bf53d24e8119bb1f292" name="a14e4748387c34bf53d24e8119bb1f292"></a> 127virtual bool </td><td class="memItemRight" valign="bottom"><b>Visit</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_unknown.html">XMLUnknown</a> &)</td></tr> 128<tr class="memdesc:a14e4748387c34bf53d24e8119bb1f292"><td class="mdescLeft"> </td><td class="mdescRight">Visit an unknown node. <br /></td></tr> 129<tr class="separator:a14e4748387c34bf53d24e8119bb1f292"><td class="memSeparator" colspan="2"> </td></tr> 130</table> 131<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 132<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> 133<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> 134<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> 135<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> 136<p>You should never change the document from a callback.</p> 137<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> 138</div><hr/>The documentation for this class was generated from the following file:<ul> 139<li><a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a></li> 140</ul> 141</div><!-- contents --> 142<!-- start footer part --> 143<hr class="footer"/><address class="footer"><small> 144Generated on Sat Dec 30 2023 18:02:36 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.10.0 145</small></address> 146</body> 147</html> 148
