classTiXmlHandle.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412
  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: TiXmlHandle 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&nbsp;Page</span></a></li>
  15. <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
  23. <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24. <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25. </ul>
  26. </div>
  27. </div>
  28. <div class="contents">
  29. <h1>TiXmlHandle Class Reference</h1><!-- doxytag: class="TiXmlHandle" -->
  30. <p>A <a class="el" href="classTiXmlHandle.html" title="A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly...">TiXmlHandle</a> is a class that wraps a node pointer with null checks; this is an incredibly useful thing.
  31. <a href="#_details">More...</a></p>
  32. <p><code>#include &lt;<a class="el" href="tinyxml_8h_source.html">tinyxml.h</a>&gt;</code></p>
  33. <p><a href="classTiXmlHandle-members.html">List of all members.</a></p>
  34. <table border="0" cellpadding="0" cellspacing="0">
  35. <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  36. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba18fd7bdefb942ecdea4bf4b8e29ec8"></a><!-- doxytag: member="TiXmlHandle::TiXmlHandle" ref="aba18fd7bdefb942ecdea4bf4b8e29ec8" args="(TiXmlNode *_node)" -->
  37. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#aba18fd7bdefb942ecdea4bf4b8e29ec8">TiXmlHandle</a> (<a class="el" href="classTiXmlNode.html">TiXmlNode</a> *_node)</td></tr>
  38. <tr><td class="mdescLeft">&nbsp;</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>
  39. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a236d7855e1e56ccc7b980630c48c7fd7"></a><!-- doxytag: member="TiXmlHandle::TiXmlHandle" ref="a236d7855e1e56ccc7b980630c48c7fd7" args="(const TiXmlHandle &amp;ref)" -->
  40. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a236d7855e1e56ccc7b980630c48c7fd7">TiXmlHandle</a> (const <a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> &amp;ref)</td></tr>
  41. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br/></td></tr>
  42. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdb1faaf88a700b40ca2c8d9aee21139"></a><!-- doxytag: member="TiXmlHandle::FirstChild" ref="acdb1faaf88a700b40ca2c8d9aee21139" args="() const " -->
  43. <a class="el" href="classTiXmlHandle.html">TiXmlHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#acdb1faaf88a700b40ca2c8d9aee21139">FirstChild</a> () const </td></tr>
  44. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the first child node. <br/></td></tr>
  45. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c61f64ae9365d89c264f289085541f8"></a><!-- doxytag: member="TiXmlHandle::FirstChild" ref="a8c61f64ae9365d89c264f289085541f8" args="(const char *value) const " -->
  46. <a class="el" href="classTiXmlHandle.html">TiXmlHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a8c61f64ae9365d89c264f289085541f8">FirstChild</a> (const char *value) const </td></tr>
  47. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the first child node with the given name. <br/></td></tr>
  48. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24d1112e995e937e4dddb202d4113d4a"></a><!-- doxytag: member="TiXmlHandle::FirstChildElement" ref="a24d1112e995e937e4dddb202d4113d4a" args="() const " -->
  49. <a class="el" href="classTiXmlHandle.html">TiXmlHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a24d1112e995e937e4dddb202d4113d4a">FirstChildElement</a> () const </td></tr>
  50. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the first child element. <br/></td></tr>
  51. <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0aea751320f5e430fac6f8fff3b8dd4"></a><!-- doxytag: member="TiXmlHandle::FirstChildElement" ref="af0aea751320f5e430fac6f8fff3b8dd4" args="(const char *value) const " -->
  52. <a class="el" href="classTiXmlHandle.html">TiXmlHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#af0aea751320f5e430fac6f8fff3b8dd4">FirstChildElement</a> (const char *value) const </td></tr>
  53. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the first child element with the given name. <br/></td></tr>
  54. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a072492b4be1acdb0db2d03cd8f71ccc4">Child</a> (const char *value, int index) const </td></tr>
  55. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the "index" child with the given name. <a href="#a072492b4be1acdb0db2d03cd8f71ccc4"></a><br/></td></tr>
  56. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#af9cf6a7d08a5da94a8924425ad0cd5ac">Child</a> (int index) const </td></tr>
  57. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the "index" child. <a href="#af9cf6a7d08a5da94a8924425ad0cd5ac"></a><br/></td></tr>
  58. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a979a3f850984a176ee884e394c7eed2d">ChildElement</a> (const char *value, int index) const </td></tr>
  59. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the "index" child element with the given name. <a href="#a979a3f850984a176ee884e394c7eed2d"></a><br/></td></tr>
  60. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a8786475b9d1f1518492e3a46704c7ef0">ChildElement</a> (int index) const </td></tr>
  61. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the "index" child element. <a href="#a8786475b9d1f1518492e3a46704c7ef0"></a><br/></td></tr>
  62. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlNode.html">TiXmlNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#af678e5088e83be67baf76f699756f2c3">ToNode</a> () const </td></tr>
  63. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the handle as a <a class="el" href="classTiXmlNode.html" title="The parent class for everything in the Document Object Model.">TiXmlNode</a>. <a href="#af678e5088e83be67baf76f699756f2c3"></a><br/></td></tr>
  64. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlElement.html">TiXmlElement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#abc6e7ed383a5fe1e52b0c0004b457b9e">ToElement</a> () const </td></tr>
  65. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the handle as a <a class="el" href="classTiXmlElement.html" title="The element is a container class.">TiXmlElement</a>. <a href="#abc6e7ed383a5fe1e52b0c0004b457b9e"></a><br/></td></tr>
  66. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlText.html">TiXmlText</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a4ac53a652296203a5b5e13854d923586">ToText</a> () const </td></tr>
  67. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the handle as a <a class="el" href="classTiXmlText.html" title="XML text.">TiXmlText</a>. <a href="#a4ac53a652296203a5b5e13854d923586"></a><br/></td></tr>
  68. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlUnknown.html">TiXmlUnknown</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a1381c17507a130767b1e23afc93b3674">ToUnknown</a> () const </td></tr>
  69. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the handle as a <a class="el" href="classTiXmlUnknown.html" title="Any tag that tinyXml doesn&#39;t recognize is saved as an unknown.">TiXmlUnknown</a>. <a href="#a1381c17507a130767b1e23afc93b3674"></a><br/></td></tr>
  70. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlNode.html">TiXmlNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#ab44b723a8dc9af72838a303c079d0376">Node</a> () const </td></tr>
  71. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlElement.html">TiXmlElement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#acb5fe8388a526289ea65e817a51e05e7">Element</a> () const </td></tr>
  72. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlText.html">TiXmlText</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a9fc739c8a18d160006f82572fc143d13">Text</a> () const </td></tr>
  73. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTiXmlUnknown.html">TiXmlUnknown</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlHandle.html#a49675b74357ba2aae124657a9a1ef465">Unknown</a> () const </td></tr>
  74. </table>
  75. <hr/><a name="_details"></a><h2>Detailed Description</h2>
  76. <p>A <a class="el" href="classTiXmlHandle.html" title="A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly...">TiXmlHandle</a> is a class that wraps a node pointer with null checks; this is an incredibly useful thing. </p>
  77. <p>Note that <a class="el" href="classTiXmlHandle.html" title="A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly...">TiXmlHandle</a> is not part of the TinyXml DOM structure. It is a separate utility class.</p>
  78. <p>Take an example: </p>
  79. <div class="fragment"><pre class="fragment">
  80. &lt;Document&gt;
  81. &lt;Element attributeA = "valueA"&gt;
  82. &lt;Child attributeB = "value1" /&gt;
  83. &lt;Child attributeB = "value2" /&gt;
  84. &lt;/Element&gt;
  85. &lt;Document&gt;
  86. </pre></div><p>Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very easy to write a *lot* of code that looks like:</p>
  87. <div class="fragment"><pre class="fragment">
  88. TiXmlElement* root = document.FirstChildElement( "Document" );
  89. if ( root )
  90. {
  91. TiXmlElement* element = root-&gt;FirstChildElement( "Element" );
  92. if ( element )
  93. {
  94. TiXmlElement* child = element-&gt;FirstChildElement( "Child" );
  95. if ( child )
  96. {
  97. TiXmlElement* child2 = child-&gt;NextSiblingElement( "Child" );
  98. if ( child2 )
  99. {
  100. // Finally do something useful.
  101. </pre></div><p>And that doesn't even cover "else" cases. <a class="el" href="classTiXmlHandle.html" title="A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly...">TiXmlHandle</a> addresses the verbosity of such code. A <a class="el" href="classTiXmlHandle.html" title="A TiXmlHandle is a class that wraps a node pointer with null checks; this is an incredibly...">TiXmlHandle</a> checks for null pointers so it is perfectly safe and correct to use:</p>
  102. <div class="fragment"><pre class="fragment">
  103. TiXmlHandle docHandle( &amp;document );
  104. TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).ToElement();
  105. if ( child2 )
  106. {
  107. // do something useful
  108. </pre></div><p>Which is MUCH more concise and useful.</p>
  109. <p>It is also safe to copy handles - internally they are nothing more than node pointers. </p>
  110. <div class="fragment"><pre class="fragment">
  111. TiXmlHandle handleCopy = handle;
  112. </pre></div><p>What they should not be used for is iteration:</p>
  113. <div class="fragment"><pre class="fragment">
  114. int i=0;
  115. while ( true )
  116. {
  117. TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", i ).ToElement();
  118. if ( !child )
  119. break;
  120. // do something
  121. ++i;
  122. }
  123. </pre></div><p>It seems reasonable, but it is in fact two embedded while loops. The Child method is a linear walk to find the element, so this code would iterate much more than it needs to. Instead, prefer:</p>
  124. <div class="fragment"><pre class="fragment">
  125. TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild( "Child" ).ToElement();
  126. for( child; child; child=child-&gt;NextSiblingElement() )
  127. {
  128. // do something
  129. }
  130. </pre></div> <hr/><h2>Member Function Documentation</h2>
  131. <a class="anchor" id="af9cf6a7d08a5da94a8924425ad0cd5ac"></a><!-- doxytag: member="TiXmlHandle::Child" ref="af9cf6a7d08a5da94a8924425ad0cd5ac" args="(int index) const " -->
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> TiXmlHandle::Child </td>
  137. <td>(</td>
  138. <td class="paramtype">int&nbsp;</td>
  139. <td class="paramname"> <em>index</em></td>
  140. <td>&nbsp;)&nbsp;</td>
  141. <td> const</td>
  142. </tr>
  143. </table>
  144. </div>
  145. <div class="memdoc">
  146. <p>Return a handle to the "index" child. </p>
  147. <p>The first child is 0, the second 1, etc. </p>
  148. </div>
  149. </div>
  150. <a class="anchor" id="a072492b4be1acdb0db2d03cd8f71ccc4"></a><!-- doxytag: member="TiXmlHandle::Child" ref="a072492b4be1acdb0db2d03cd8f71ccc4" args="(const char *value, int index) const " -->
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> TiXmlHandle::Child </td>
  156. <td>(</td>
  157. <td class="paramtype">const char *&nbsp;</td>
  158. <td class="paramname"> <em>value</em>, </td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey"></td>
  162. <td></td>
  163. <td class="paramtype">int&nbsp;</td>
  164. <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
  165. </tr>
  166. <tr>
  167. <td></td>
  168. <td>)</td>
  169. <td></td><td></td><td> const</td>
  170. </tr>
  171. </table>
  172. </div>
  173. <div class="memdoc">
  174. <p>Return a handle to the "index" child with the given name. </p>
  175. <p>The first child is 0, the second 1, etc. </p>
  176. </div>
  177. </div>
  178. <a class="anchor" id="a8786475b9d1f1518492e3a46704c7ef0"></a><!-- doxytag: member="TiXmlHandle::ChildElement" ref="a8786475b9d1f1518492e3a46704c7ef0" args="(int index) const " -->
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> TiXmlHandle::ChildElement </td>
  184. <td>(</td>
  185. <td class="paramtype">int&nbsp;</td>
  186. <td class="paramname"> <em>index</em></td>
  187. <td>&nbsp;)&nbsp;</td>
  188. <td> const</td>
  189. </tr>
  190. </table>
  191. </div>
  192. <div class="memdoc">
  193. <p>Return a handle to the "index" child element. </p>
  194. <p>The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted. </p>
  195. </div>
  196. </div>
  197. <a class="anchor" id="a979a3f850984a176ee884e394c7eed2d"></a><!-- doxytag: member="TiXmlHandle::ChildElement" ref="a979a3f850984a176ee884e394c7eed2d" args="(const char *value, int index) const " -->
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> TiXmlHandle::ChildElement </td>
  203. <td>(</td>
  204. <td class="paramtype">const char *&nbsp;</td>
  205. <td class="paramname"> <em>value</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype">int&nbsp;</td>
  211. <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
  212. </tr>
  213. <tr>
  214. <td></td>
  215. <td>)</td>
  216. <td></td><td></td><td> const</td>
  217. </tr>
  218. </table>
  219. </div>
  220. <div class="memdoc">
  221. <p>Return a handle to the "index" child element with the given name. </p>
  222. <p>The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted. </p>
  223. </div>
  224. </div>
  225. <a class="anchor" id="acb5fe8388a526289ea65e817a51e05e7"></a><!-- doxytag: member="TiXmlHandle::Element" ref="acb5fe8388a526289ea65e817a51e05e7" args="() const " -->
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="memname">
  229. <tr>
  230. <td class="memname"><a class="el" href="classTiXmlElement.html">TiXmlElement</a>* TiXmlHandle::Element </td>
  231. <td>(</td>
  232. <td class="paramname"></td>
  233. <td>&nbsp;)&nbsp;</td>
  234. <td> const<code> [inline]</code></td>
  235. </tr>
  236. </table>
  237. </div>
  238. <div class="memdoc">
  239. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>use ToElement. Return the handle as a <a class="el" href="classTiXmlElement.html" title="The element is a container class.">TiXmlElement</a>. This may return null. </dd></dl>
  240. <p>References <a class="el" href="tinyxml_8h_source.html#l01688">ToElement()</a>.</p>
  241. </div>
  242. </div>
  243. <a class="anchor" id="ab44b723a8dc9af72838a303c079d0376"></a><!-- doxytag: member="TiXmlHandle::Node" ref="ab44b723a8dc9af72838a303c079d0376" args="() const " -->
  244. <div class="memitem">
  245. <div class="memproto">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname"><a class="el" href="classTiXmlNode.html">TiXmlNode</a>* TiXmlHandle::Node </td>
  249. <td>(</td>
  250. <td class="paramname"></td>
  251. <td>&nbsp;)&nbsp;</td>
  252. <td> const<code> [inline]</code></td>
  253. </tr>
  254. </table>
  255. </div>
  256. <div class="memdoc">
  257. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>use ToNode. Return the handle as a <a class="el" href="classTiXmlNode.html" title="The parent class for everything in the Document Object Model.">TiXmlNode</a>. This may return null. </dd></dl>
  258. <p>References <a class="el" href="tinyxml_8h_source.html#l01685">ToNode()</a>.</p>
  259. </div>
  260. </div>
  261. <a class="anchor" id="a9fc739c8a18d160006f82572fc143d13"></a><!-- doxytag: member="TiXmlHandle::Text" ref="a9fc739c8a18d160006f82572fc143d13" args="() const " -->
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname"><a class="el" href="classTiXmlText.html">TiXmlText</a>* TiXmlHandle::Text </td>
  267. <td>(</td>
  268. <td class="paramname"></td>
  269. <td>&nbsp;)&nbsp;</td>
  270. <td> const<code> [inline]</code></td>
  271. </tr>
  272. </table>
  273. </div>
  274. <div class="memdoc">
  275. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>use <a class="el" href="classTiXmlHandle.html#a4ac53a652296203a5b5e13854d923586" title="Return the handle as a TiXmlText.">ToText()</a> Return the handle as a <a class="el" href="classTiXmlText.html" title="XML text.">TiXmlText</a>. This may return null. </dd></dl>
  276. <p>References <a class="el" href="tinyxml_8h_source.html#l01691">ToText()</a>.</p>
  277. </div>
  278. </div>
  279. <a class="anchor" id="abc6e7ed383a5fe1e52b0c0004b457b9e"></a><!-- doxytag: member="TiXmlHandle::ToElement" ref="abc6e7ed383a5fe1e52b0c0004b457b9e" args="() const " -->
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname"><a class="el" href="classTiXmlElement.html">TiXmlElement</a>* TiXmlHandle::ToElement </td>
  285. <td>(</td>
  286. <td class="paramname"></td>
  287. <td>&nbsp;)&nbsp;</td>
  288. <td> const<code> [inline]</code></td>
  289. </tr>
  290. </table>
  291. </div>
  292. <div class="memdoc">
  293. <p>Return the handle as a <a class="el" href="classTiXmlElement.html" title="The element is a container class.">TiXmlElement</a>. </p>
  294. <p>This may return null. </p>
  295. <p>Referenced by <a class="el" href="tinyxml_8h_source.html#l01703">Element()</a>.</p>
  296. </div>
  297. </div>
  298. <a class="anchor" id="af678e5088e83be67baf76f699756f2c3"></a><!-- doxytag: member="TiXmlHandle::ToNode" ref="af678e5088e83be67baf76f699756f2c3" args="() const " -->
  299. <div class="memitem">
  300. <div class="memproto">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname"><a class="el" href="classTiXmlNode.html">TiXmlNode</a>* TiXmlHandle::ToNode </td>
  304. <td>(</td>
  305. <td class="paramname"></td>
  306. <td>&nbsp;)&nbsp;</td>
  307. <td> const<code> [inline]</code></td>
  308. </tr>
  309. </table>
  310. </div>
  311. <div class="memdoc">
  312. <p>Return the handle as a <a class="el" href="classTiXmlNode.html" title="The parent class for everything in the Document Object Model.">TiXmlNode</a>. </p>
  313. <p>This may return null. </p>
  314. <p>Referenced by <a class="el" href="tinyxml_8h_source.html#l01699">Node()</a>.</p>
  315. </div>
  316. </div>
  317. <a class="anchor" id="a4ac53a652296203a5b5e13854d923586"></a><!-- doxytag: member="TiXmlHandle::ToText" ref="a4ac53a652296203a5b5e13854d923586" args="() const " -->
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname"><a class="el" href="classTiXmlText.html">TiXmlText</a>* TiXmlHandle::ToText </td>
  323. <td>(</td>
  324. <td class="paramname"></td>
  325. <td>&nbsp;)&nbsp;</td>
  326. <td> const<code> [inline]</code></td>
  327. </tr>
  328. </table>
  329. </div>
  330. <div class="memdoc">
  331. <p>Return the handle as a <a class="el" href="classTiXmlText.html" title="XML text.">TiXmlText</a>. </p>
  332. <p>This may return null. </p>
  333. <p>Referenced by <a class="el" href="tinyxml_8h_source.html#l01707">Text()</a>.</p>
  334. </div>
  335. </div>
  336. <a class="anchor" id="a1381c17507a130767b1e23afc93b3674"></a><!-- doxytag: member="TiXmlHandle::ToUnknown" ref="a1381c17507a130767b1e23afc93b3674" args="() const " -->
  337. <div class="memitem">
  338. <div class="memproto">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname"><a class="el" href="classTiXmlUnknown.html">TiXmlUnknown</a>* TiXmlHandle::ToUnknown </td>
  342. <td>(</td>
  343. <td class="paramname"></td>
  344. <td>&nbsp;)&nbsp;</td>
  345. <td> const<code> [inline]</code></td>
  346. </tr>
  347. </table>
  348. </div>
  349. <div class="memdoc">
  350. <p>Return the handle as a <a class="el" href="classTiXmlUnknown.html" title="Any tag that tinyXml doesn&#39;t recognize is saved as an unknown.">TiXmlUnknown</a>. </p>
  351. <p>This may return null. </p>
  352. <p>Referenced by <a class="el" href="tinyxml_8h_source.html#l01711">Unknown()</a>.</p>
  353. </div>
  354. </div>
  355. <a class="anchor" id="a49675b74357ba2aae124657a9a1ef465"></a><!-- doxytag: member="TiXmlHandle::Unknown" ref="a49675b74357ba2aae124657a9a1ef465" args="() const " -->
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname"><a class="el" href="classTiXmlUnknown.html">TiXmlUnknown</a>* TiXmlHandle::Unknown </td>
  361. <td>(</td>
  362. <td class="paramname"></td>
  363. <td>&nbsp;)&nbsp;</td>
  364. <td> const<code> [inline]</code></td>
  365. </tr>
  366. </table>
  367. </div>
  368. <div class="memdoc">
  369. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>use <a class="el" href="classTiXmlHandle.html#a1381c17507a130767b1e23afc93b3674" title="Return the handle as a TiXmlUnknown.">ToUnknown()</a> Return the handle as a <a class="el" href="classTiXmlUnknown.html" title="Any tag that tinyXml doesn&#39;t recognize is saved as an unknown.">TiXmlUnknown</a>. This may return null. </dd></dl>
  370. <p>References <a class="el" href="tinyxml_8h_source.html#l01694">ToUnknown()</a>.</p>
  371. </div>
  372. </div>
  373. <hr/>The documentation for this class was generated from the following file:<ul>
  374. <li><a class="el" href="tinyxml_8h_source.html">tinyxml.h</a></li>
  375. </ul>
  376. </div>
  377. <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
  378. <a href="http://www.doxygen.org/index.html">
  379. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
  380. </body>
  381. </html>