classtinyxml2_1_1_x_m_l_handle.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  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::XMLHandle 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_handle.html">XMLHandle</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_handle-members.html">List of all members</a> </div>
  79. <div class="headertitle"><div class="title">tinyxml2::XMLHandle 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. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  85. Public Member Functions</h2></td></tr>
  86. <tr class="memitem:a9c240a35c18f053509b4b97ddccd9793" id="r_a9c240a35c18f053509b4b97ddccd9793"><td class="memItemLeft" align="right" valign="top"><a id="a9c240a35c18f053509b4b97ddccd9793" name="a9c240a35c18f053509b4b97ddccd9793"></a>
  87. &#160;</td><td class="memItemRight" valign="bottom"><b>XMLHandle</b> (<a class="el" href="classtinyxml2_1_1_x_m_l_node.html">XMLNode</a> *node)</td></tr>
  88. <tr class="memdesc:a9c240a35c18f053509b4b97ddccd9793"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a handle from any node (at any depth of the tree.) This can be a null pointer. <br /></td></tr>
  89. <tr class="separator:a9c240a35c18f053509b4b97ddccd9793"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:aa2edbc1c0d3e3e8259bd98de7f1cf500" id="r_aa2edbc1c0d3e3e8259bd98de7f1cf500"><td class="memItemLeft" align="right" valign="top"><a id="aa2edbc1c0d3e3e8259bd98de7f1cf500" name="aa2edbc1c0d3e3e8259bd98de7f1cf500"></a>
  91. &#160;</td><td class="memItemRight" valign="bottom"><b>XMLHandle</b> (<a class="el" href="classtinyxml2_1_1_x_m_l_node.html">XMLNode</a> &amp;node)</td></tr>
  92. <tr class="memdesc:aa2edbc1c0d3e3e8259bd98de7f1cf500"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a handle from a node. <br /></td></tr>
  93. <tr class="separator:aa2edbc1c0d3e3e8259bd98de7f1cf500"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:afd8e01e6018c07347b8e6d80272466aa" id="r_afd8e01e6018c07347b8e6d80272466aa"><td class="memItemLeft" align="right" valign="top"><a id="afd8e01e6018c07347b8e6d80272466aa" name="afd8e01e6018c07347b8e6d80272466aa"></a>
  95. &#160;</td><td class="memItemRight" valign="bottom"><b>XMLHandle</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> &amp;ref)</td></tr>
  96. <tr class="memdesc:afd8e01e6018c07347b8e6d80272466aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <br /></td></tr>
  97. <tr class="separator:afd8e01e6018c07347b8e6d80272466aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:aa07c9a53f78d7b2dc1018668641521d8" id="r_aa07c9a53f78d7b2dc1018668641521d8"><td class="memItemLeft" align="right" valign="top"><a id="aa07c9a53f78d7b2dc1018668641521d8" name="aa07c9a53f78d7b2dc1018668641521d8"></a>
  99. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> &amp;ref)</td></tr>
  100. <tr class="memdesc:aa07c9a53f78d7b2dc1018668641521d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment. <br /></td></tr>
  101. <tr class="separator:aa07c9a53f78d7b2dc1018668641521d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a536447dc7f54c0cd11e031dad94795ae" id="r_a536447dc7f54c0cd11e031dad94795ae"><td class="memItemLeft" align="right" valign="top"><a id="a536447dc7f54c0cd11e031dad94795ae" name="a536447dc7f54c0cd11e031dad94795ae"></a>
  103. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><b>FirstChild</b> ()</td></tr>
  104. <tr class="memdesc:a536447dc7f54c0cd11e031dad94795ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the first child of this handle. <br /></td></tr>
  105. <tr class="separator:a536447dc7f54c0cd11e031dad94795ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a74b04dd0f15e0bf01860e282b840b6a3" id="r_a74b04dd0f15e0bf01860e282b840b6a3"><td class="memItemLeft" align="right" valign="top"><a id="a74b04dd0f15e0bf01860e282b840b6a3" name="a74b04dd0f15e0bf01860e282b840b6a3"></a>
  107. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><b>FirstChildElement</b> (const char *name=0)</td></tr>
  108. <tr class="memdesc:a74b04dd0f15e0bf01860e282b840b6a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the first child element of this handle. <br /></td></tr>
  109. <tr class="separator:a74b04dd0f15e0bf01860e282b840b6a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a9d09f04435f0f2f7d0816b0198d0517b" id="r_a9d09f04435f0f2f7d0816b0198d0517b"><td class="memItemLeft" align="right" valign="top"><a id="a9d09f04435f0f2f7d0816b0198d0517b" name="a9d09f04435f0f2f7d0816b0198d0517b"></a>
  111. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><b>LastChild</b> ()</td></tr>
  112. <tr class="memdesc:a9d09f04435f0f2f7d0816b0198d0517b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the last child of this handle. <br /></td></tr>
  113. <tr class="separator:a9d09f04435f0f2f7d0816b0198d0517b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a42cccd0ce8b1ce704f431025e9f19e0c" id="r_a42cccd0ce8b1ce704f431025e9f19e0c"><td class="memItemLeft" align="right" valign="top"><a id="a42cccd0ce8b1ce704f431025e9f19e0c" name="a42cccd0ce8b1ce704f431025e9f19e0c"></a>
  115. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><b>LastChildElement</b> (const char *name=0)</td></tr>
  116. <tr class="memdesc:a42cccd0ce8b1ce704f431025e9f19e0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the last child element of this handle. <br /></td></tr>
  117. <tr class="separator:a42cccd0ce8b1ce704f431025e9f19e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a428374e756f4db4cbc287fec64eae02c" id="r_a428374e756f4db4cbc287fec64eae02c"><td class="memItemLeft" align="right" valign="top"><a id="a428374e756f4db4cbc287fec64eae02c" name="a428374e756f4db4cbc287fec64eae02c"></a>
  119. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><b>PreviousSibling</b> ()</td></tr>
  120. <tr class="memdesc:a428374e756f4db4cbc287fec64eae02c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the previous sibling of this handle. <br /></td></tr>
  121. <tr class="separator:a428374e756f4db4cbc287fec64eae02c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a786957e498039554ed334cdc36612a7e" id="r_a786957e498039554ed334cdc36612a7e"><td class="memItemLeft" align="right" valign="top"><a id="a786957e498039554ed334cdc36612a7e" name="a786957e498039554ed334cdc36612a7e"></a>
  123. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><b>PreviousSiblingElement</b> (const char *name=0)</td></tr>
  124. <tr class="memdesc:a786957e498039554ed334cdc36612a7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the previous sibling element of this handle. <br /></td></tr>
  125. <tr class="separator:a786957e498039554ed334cdc36612a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:aad2eccc7c7c7b18145877c978c3850b5" id="r_aad2eccc7c7c7b18145877c978c3850b5"><td class="memItemLeft" align="right" valign="top"><a id="aad2eccc7c7c7b18145877c978c3850b5" name="aad2eccc7c7c7b18145877c978c3850b5"></a>
  127. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><b>NextSibling</b> ()</td></tr>
  128. <tr class="memdesc:aad2eccc7c7c7b18145877c978c3850b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the next sibling of this handle. <br /></td></tr>
  129. <tr class="separator:aad2eccc7c7c7b18145877c978c3850b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:ae41d88ee061f3c49a081630ff753b2c5" id="r_ae41d88ee061f3c49a081630ff753b2c5"><td class="memItemLeft" align="right" valign="top"><a id="ae41d88ee061f3c49a081630ff753b2c5" name="ae41d88ee061f3c49a081630ff753b2c5"></a>
  131. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><b>NextSiblingElement</b> (const char *name=0)</td></tr>
  132. <tr class="memdesc:ae41d88ee061f3c49a081630ff753b2c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the next sibling element of this handle. <br /></td></tr>
  133. <tr class="separator:ae41d88ee061f3c49a081630ff753b2c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a689453c96dd3d4016437d2298d1de691" id="r_a689453c96dd3d4016437d2298d1de691"><td class="memItemLeft" align="right" valign="top"><a id="a689453c96dd3d4016437d2298d1de691" name="a689453c96dd3d4016437d2298d1de691"></a>
  135. <a class="el" href="classtinyxml2_1_1_x_m_l_node.html">XMLNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ToNode</b> ()</td></tr>
  136. <tr class="memdesc:a689453c96dd3d4016437d2298d1de691"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_node.html">XMLNode</a>. This can return null. <br /></td></tr>
  137. <tr class="separator:a689453c96dd3d4016437d2298d1de691"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:ab2371c4adb8b04afe04ed216bf9b0676" id="r_ab2371c4adb8b04afe04ed216bf9b0676"><td class="memItemLeft" align="right" valign="top"><a id="ab2371c4adb8b04afe04ed216bf9b0676" name="ab2371c4adb8b04afe04ed216bf9b0676"></a>
  139. <a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ToElement</b> ()</td></tr>
  140. <tr class="memdesc:ab2371c4adb8b04afe04ed216bf9b0676"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a>. This can return null. <br /></td></tr>
  141. <tr class="separator:ab2371c4adb8b04afe04ed216bf9b0676"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:accc80bcbd81e816f13a23c172587c288" id="r_accc80bcbd81e816f13a23c172587c288"><td class="memItemLeft" align="right" valign="top"><a id="accc80bcbd81e816f13a23c172587c288" name="accc80bcbd81e816f13a23c172587c288"></a>
  143. <a class="el" href="classtinyxml2_1_1_x_m_l_text.html">XMLText</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ToText</b> ()</td></tr>
  144. <tr class="memdesc:accc80bcbd81e816f13a23c172587c288"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_text.html">XMLText</a>. This can return null. <br /></td></tr>
  145. <tr class="separator:accc80bcbd81e816f13a23c172587c288"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:add97784cbe14ef42bb36e158ad6e6082" id="r_add97784cbe14ef42bb36e158ad6e6082"><td class="memItemLeft" align="right" valign="top"><a id="add97784cbe14ef42bb36e158ad6e6082" name="add97784cbe14ef42bb36e158ad6e6082"></a>
  147. <a class="el" href="classtinyxml2_1_1_x_m_l_unknown.html">XMLUnknown</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ToUnknown</b> ()</td></tr>
  148. <tr class="memdesc:add97784cbe14ef42bb36e158ad6e6082"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_unknown.html">XMLUnknown</a>. This can return null. <br /></td></tr>
  149. <tr class="separator:add97784cbe14ef42bb36e158ad6e6082"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a85d0c76920a013ea2a29456dbf7d160d" id="r_a85d0c76920a013ea2a29456dbf7d160d"><td class="memItemLeft" align="right" valign="top"><a id="a85d0c76920a013ea2a29456dbf7d160d" name="a85d0c76920a013ea2a29456dbf7d160d"></a>
  151. <a class="el" href="classtinyxml2_1_1_x_m_l_declaration.html">XMLDeclaration</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ToDeclaration</b> ()</td></tr>
  152. <tr class="memdesc:a85d0c76920a013ea2a29456dbf7d160d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_declaration.html">XMLDeclaration</a>. This can return null. <br /></td></tr>
  153. <tr class="separator:a85d0c76920a013ea2a29456dbf7d160d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table>
  155. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  156. <div class="textblock"><p>A <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> is a class that wraps a node pointer with null checks; this is an incredibly useful thing. Note that <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> is not part of the TinyXML-2 DOM structure. It is a separate utility class.</p>
  157. <p>Take an example: </p><pre class="fragment">&lt;Document&gt;
  158. &lt;Element attributeA = "valueA"&gt;
  159. &lt;Child attributeB = "value1" /&gt;
  160. &lt;Child attributeB = "value2" /&gt;
  161. &lt;/Element&gt;
  162. &lt;/Document&gt;
  163. </pre><p>Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very easy to write a <em>lot</em> of code that looks like:</p>
  164. <pre class="fragment">XMLElement* root = document.FirstChildElement( "Document" );
  165. if ( root )
  166. {
  167. XMLElement* element = root-&gt;FirstChildElement( "Element" );
  168. if ( element )
  169. {
  170. XMLElement* child = element-&gt;FirstChildElement( "Child" );
  171. if ( child )
  172. {
  173. XMLElement* child2 = child-&gt;NextSiblingElement( "Child" );
  174. if ( child2 )
  175. {
  176. // Finally do something useful.
  177. </pre><p>And that doesn't even cover "else" cases. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> addresses the verbosity of such code. A <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> checks for null pointers so it is perfectly safe and correct to use:</p>
  178. <pre class="fragment">XMLHandle docHandle( &amp;document );
  179. XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement();
  180. if ( child2 )
  181. {
  182. // do something useful
  183. </pre><p>Which is MUCH more concise and useful.</p>
  184. <p>It is also safe to copy handles - internally they are nothing more than node pointers. </p><pre class="fragment">XMLHandle handleCopy = handle;
  185. </pre><p>See also <a class="el" href="classtinyxml2_1_1_x_m_l_const_handle.html">XMLConstHandle</a>, which is the same as <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>, but operates on const objects. </p>
  186. </div><hr/>The documentation for this class was generated from the following file:<ul>
  187. <li><a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a></li>
  188. </ul>
  189. </div><!-- contents -->
  190. <!-- start footer part -->
  191. <hr class="footer"/><address class="footer"><small>
  192. Generated on Sat Dec 30 2023 18:02:35 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
  193. </small></address>
  194. </body>
  195. </html>