Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / tinyxml / c3bbea3c3cfee4908189a57b3fc54f105b78c59b / . / docs / classTiXmlHandle.html
blob: 59ee217c3fbb54e8c1b4646b28e18b6519e190c9 [file] [log] [blame]
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]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"/>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]5<title>TinyXml: TiXmlHandle Class Reference</title>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]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>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]32
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]33<p><code>#include &lt;<a class="el" href="tinyxml_8h_source.html">tinyxml.h</a>&gt;</code></p>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]34
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]35<p><a href="classTiXmlHandle-members.html">List of all members.</a></p>
36<table border="0" cellpadding="0" cellspacing="0">
37<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
38<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba18fd7bdefb942ecdea4bf4b8e29ec8"></a><!-- doxytag: member="TiXmlHandle::TiXmlHandle" ref="aba18fd7bdefb942ecdea4bf4b8e29ec8" args="(TiXmlNode *_node)" -->
39&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>
40<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>
41<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)" -->
42&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>
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor. <br/></td></tr>
44<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdb1faaf88a700b40ca2c8d9aee21139"></a><!-- doxytag: member="TiXmlHandle::FirstChild" ref="acdb1faaf88a700b40ca2c8d9aee21139" args="() const " -->
45<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>
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the first child node. <br/></td></tr>
47<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 " -->
48<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>
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the first child node with the given name. <br/></td></tr>
50<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24d1112e995e937e4dddb202d4113d4a"></a><!-- doxytag: member="TiXmlHandle::FirstChildElement" ref="a24d1112e995e937e4dddb202d4113d4a" args="() const " -->
51<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>
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the first child element. <br/></td></tr>
53<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 " -->
54<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>
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the first child element with the given name. <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#a072492b4be1acdb0db2d03cd8f71ccc4">Child</a> (const char *value, int index) const </td></tr>
57<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>
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#af9cf6a7d08a5da94a8924425ad0cd5ac">Child</a> (int index) const </td></tr>
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the "index" child. <a href="#af9cf6a7d08a5da94a8924425ad0cd5ac"></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#a979a3f850984a176ee884e394c7eed2d">ChildElement</a> (const char *value, int index) const </td></tr>
61<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>
62<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>
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a handle to the "index" child element. <a href="#a8786475b9d1f1518492e3a46704c7ef0"></a><br/></td></tr>
64<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>
65<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>
66<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>
67<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>
68<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>
69<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>
70<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>
71<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>
72<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>
73<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>
74<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>
75<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>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]76</table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]77<hr/><a name="_details"></a><h2>Detailed Description</h2>
78<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>
79<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>
80<p>Take an example: </p>
81<div class="fragment"><pre class="fragment">
82 &lt;Document&gt;
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]83 &lt;Element attributeA = "valueA"&gt;
84 &lt;Child attributeB = "value1" /&gt;
85 &lt;Child attributeB = "value2" /&gt;
86 &lt;/Element&gt;
87 &lt;Document&gt;
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]88 </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>
89<div class="fragment"><pre class="fragment">
90 TiXmlElement* root = document.FirstChildElement( "Document" );
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]91 if ( root )
92 {
93 TiXmlElement* element = root-&gt;FirstChildElement( "Element" );
94 if ( element )
95 {
96 TiXmlElement* child = element-&gt;FirstChildElement( "Child" );
97 if ( child )
98 {
99 TiXmlElement* child2 = child-&gt;NextSiblingElement( "Child" );
100 if ( child2 )
101 {
102 // Finally do something useful.
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]103 </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>
104<div class="fragment"><pre class="fragment">
105 TiXmlHandle docHandle( &amp;document );
106 TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).ToElement();
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]107 if ( child2 )
108 {
109 // do something useful
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]110 </pre></div><p>Which is MUCH more concise and useful.</p>
111<p>It is also safe to copy handles - internally they are nothing more than node pointers. </p>
112<div class="fragment"><pre class="fragment">
113 TiXmlHandle handleCopy = handle;
114 </pre></div><p>What they should not be used for is iteration:</p>
115<div class="fragment"><pre class="fragment">
116 int i=0;
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]117 while ( true )
118 {
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]119 TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", i ).ToElement();
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]120 if ( !child )
121 break;
122 // do something
123 ++i;
124 }
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]125 </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>
126<div class="fragment"><pre class="fragment">
127 TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild( "Child" ).ToElement();
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]128
129 for( child; child; child=child-&gt;NextSiblingElement() )
130 {
131 // do something
132 }
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]133 </pre></div> <hr/><h2>Member Function Documentation</h2>
134<a class="anchor" id="af9cf6a7d08a5da94a8924425ad0cd5ac"></a><!-- doxytag: member="TiXmlHandle::Child" ref="af9cf6a7d08a5da94a8924425ad0cd5ac" args="(int index) const " -->
135<div class="memitem">
136<div class="memproto">
137 <table class="memname">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]138 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]139 <td class="memname"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> TiXmlHandle::Child </td>
140 <td>(</td>
141 <td class="paramtype">int&nbsp;</td>
142 <td class="paramname"> <em>index</em></td>
143 <td>&nbsp;)&nbsp;</td>
144 <td> const</td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]145 </tr>
146 </table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]147</div>
148<div class="memdoc">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]149
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]150<p>Return a handle to the "index" child. </p>
151<p>The first child is 0, the second 1, etc. </p>
152
153</div>
154</div>
155<a class="anchor" id="a072492b4be1acdb0db2d03cd8f71ccc4"></a><!-- doxytag: member="TiXmlHandle::Child" ref="a072492b4be1acdb0db2d03cd8f71ccc4" args="(const char *value, int index) const " -->
156<div class="memitem">
157<div class="memproto">
158 <table class="memname">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]159 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]160 <td class="memname"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> TiXmlHandle::Child </td>
161 <td>(</td>
162 <td class="paramtype">const char *&nbsp;</td>
163 <td class="paramname"> <em>value</em>, </td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]164 </tr>
165 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]166 <td class="paramkey"></td>
167 <td></td>
168 <td class="paramtype">int&nbsp;</td>
169 <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]170 </tr>
171 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]172 <td></td>
173 <td>)</td>
174 <td></td><td></td><td> const</td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]175 </tr>
176 </table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]177</div>
178<div class="memdoc">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]179
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]180<p>Return a handle to the "index" child with the given name. </p>
181<p>The first child is 0, the second 1, etc. </p>
182
183</div>
184</div>
185<a class="anchor" id="a8786475b9d1f1518492e3a46704c7ef0"></a><!-- doxytag: member="TiXmlHandle::ChildElement" ref="a8786475b9d1f1518492e3a46704c7ef0" args="(int index) const " -->
186<div class="memitem">
187<div class="memproto">
188 <table class="memname">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]189 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]190 <td class="memname"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> TiXmlHandle::ChildElement </td>
191 <td>(</td>
192 <td class="paramtype">int&nbsp;</td>
193 <td class="paramname"> <em>index</em></td>
194 <td>&nbsp;)&nbsp;</td>
195 <td> const</td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]196 </tr>
197 </table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]198</div>
199<div class="memdoc">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]200
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]201<p>Return a handle to the "index" child element. </p>
202<p>The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted. </p>
203
204</div>
205</div>
206<a class="anchor" id="a979a3f850984a176ee884e394c7eed2d"></a><!-- doxytag: member="TiXmlHandle::ChildElement" ref="a979a3f850984a176ee884e394c7eed2d" args="(const char *value, int index) const " -->
207<div class="memitem">
208<div class="memproto">
209 <table class="memname">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]210 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]211 <td class="memname"><a class="el" href="classTiXmlHandle.html">TiXmlHandle</a> TiXmlHandle::ChildElement </td>
212 <td>(</td>
213 <td class="paramtype">const char *&nbsp;</td>
214 <td class="paramname"> <em>value</em>, </td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]215 </tr>
216 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]217 <td class="paramkey"></td>
218 <td></td>
219 <td class="paramtype">int&nbsp;</td>
220 <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]221 </tr>
222 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]223 <td></td>
224 <td>)</td>
225 <td></td><td></td><td> const</td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]226 </tr>
227 </table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]228</div>
229<div class="memdoc">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]230
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]231<p>Return a handle to the "index" child element with the given name. </p>
232<p>The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted. </p>
233
234</div>
235</div>
236<a class="anchor" id="acb5fe8388a526289ea65e817a51e05e7"></a><!-- doxytag: member="TiXmlHandle::Element" ref="acb5fe8388a526289ea65e817a51e05e7" args="() const " -->
237<div class="memitem">
238<div class="memproto">
239 <table class="memname">
240 <tr>
241 <td class="memname"><a class="el" href="classTiXmlElement.html">TiXmlElement</a>* TiXmlHandle::Element </td>
242 <td>(</td>
243 <td class="paramname"></td>
244 <td>&nbsp;)&nbsp;</td>
245 <td> const<code> [inline]</code></td>
246 </tr>
247 </table>
248</div>
249<div class="memdoc">
250<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>
251
252<p>References <a class="el" href="tinyxml_8h_source.html#l01688">ToElement()</a>.</p>
253
254</div>
255</div>
256<a class="anchor" id="ab44b723a8dc9af72838a303c079d0376"></a><!-- doxytag: member="TiXmlHandle::Node" ref="ab44b723a8dc9af72838a303c079d0376" args="() const " -->
257<div class="memitem">
258<div class="memproto">
259 <table class="memname">
260 <tr>
261 <td class="memname"><a class="el" href="classTiXmlNode.html">TiXmlNode</a>* TiXmlHandle::Node </td>
262 <td>(</td>
263 <td class="paramname"></td>
264 <td>&nbsp;)&nbsp;</td>
265 <td> const<code> [inline]</code></td>
266 </tr>
267 </table>
268</div>
269<div class="memdoc">
270<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>
271
272<p>References <a class="el" href="tinyxml_8h_source.html#l01685">ToNode()</a>.</p>
273
274</div>
275</div>
276<a class="anchor" id="a9fc739c8a18d160006f82572fc143d13"></a><!-- doxytag: member="TiXmlHandle::Text" ref="a9fc739c8a18d160006f82572fc143d13" args="() const " -->
277<div class="memitem">
278<div class="memproto">
279 <table class="memname">
280 <tr>
281 <td class="memname"><a class="el" href="classTiXmlText.html">TiXmlText</a>* TiXmlHandle::Text </td>
282 <td>(</td>
283 <td class="paramname"></td>
284 <td>&nbsp;)&nbsp;</td>
285 <td> const<code> [inline]</code></td>
286 </tr>
287 </table>
288</div>
289<div class="memdoc">
290<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>
291
292<p>References <a class="el" href="tinyxml_8h_source.html#l01691">ToText()</a>.</p>
293
294</div>
295</div>
296<a class="anchor" id="abc6e7ed383a5fe1e52b0c0004b457b9e"></a><!-- doxytag: member="TiXmlHandle::ToElement" ref="abc6e7ed383a5fe1e52b0c0004b457b9e" args="() const " -->
297<div class="memitem">
298<div class="memproto">
299 <table class="memname">
300 <tr>
301 <td class="memname"><a class="el" href="classTiXmlElement.html">TiXmlElement</a>* TiXmlHandle::ToElement </td>
302 <td>(</td>
303 <td class="paramname"></td>
304 <td>&nbsp;)&nbsp;</td>
305 <td> const<code> [inline]</code></td>
306 </tr>
307 </table>
308</div>
309<div class="memdoc">
310
311<p>Return the handle as a <a class="el" href="classTiXmlElement.html" title="The element is a container class.">TiXmlElement</a>. </p>
312<p>This may return null. </p>
313
314<p>Referenced by <a class="el" href="tinyxml_8h_source.html#l01703">Element()</a>.</p>
315
316</div>
317</div>
318<a class="anchor" id="af678e5088e83be67baf76f699756f2c3"></a><!-- doxytag: member="TiXmlHandle::ToNode" ref="af678e5088e83be67baf76f699756f2c3" args="() const " -->
319<div class="memitem">
320<div class="memproto">
321 <table class="memname">
322 <tr>
323 <td class="memname"><a class="el" href="classTiXmlNode.html">TiXmlNode</a>* TiXmlHandle::ToNode </td>
324 <td>(</td>
325 <td class="paramname"></td>
326 <td>&nbsp;)&nbsp;</td>
327 <td> const<code> [inline]</code></td>
328 </tr>
329 </table>
330</div>
331<div class="memdoc">
332
333<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>
334<p>This may return null. </p>
335
336<p>Referenced by <a class="el" href="tinyxml_8h_source.html#l01699">Node()</a>.</p>
337
338</div>
339</div>
340<a class="anchor" id="a4ac53a652296203a5b5e13854d923586"></a><!-- doxytag: member="TiXmlHandle::ToText" ref="a4ac53a652296203a5b5e13854d923586" args="() const " -->
341<div class="memitem">
342<div class="memproto">
343 <table class="memname">
344 <tr>
345 <td class="memname"><a class="el" href="classTiXmlText.html">TiXmlText</a>* TiXmlHandle::ToText </td>
346 <td>(</td>
347 <td class="paramname"></td>
348 <td>&nbsp;)&nbsp;</td>
349 <td> const<code> [inline]</code></td>
350 </tr>
351 </table>
352</div>
353<div class="memdoc">
354
355<p>Return the handle as a <a class="el" href="classTiXmlText.html" title="XML text.">TiXmlText</a>. </p>
356<p>This may return null. </p>
357
358<p>Referenced by <a class="el" href="tinyxml_8h_source.html#l01707">Text()</a>.</p>
359
360</div>
361</div>
362<a class="anchor" id="a1381c17507a130767b1e23afc93b3674"></a><!-- doxytag: member="TiXmlHandle::ToUnknown" ref="a1381c17507a130767b1e23afc93b3674" args="() const " -->
363<div class="memitem">
364<div class="memproto">
365 <table class="memname">
366 <tr>
367 <td class="memname"><a class="el" href="classTiXmlUnknown.html">TiXmlUnknown</a>* TiXmlHandle::ToUnknown </td>
368 <td>(</td>
369 <td class="paramname"></td>
370 <td>&nbsp;)&nbsp;</td>
371 <td> const<code> [inline]</code></td>
372 </tr>
373 </table>
374</div>
375<div class="memdoc">
376
377<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>
378<p>This may return null. </p>
379
380<p>Referenced by <a class="el" href="tinyxml_8h_source.html#l01711">Unknown()</a>.</p>
381
382</div>
383</div>
384<a class="anchor" id="a49675b74357ba2aae124657a9a1ef465"></a><!-- doxytag: member="TiXmlHandle::Unknown" ref="a49675b74357ba2aae124657a9a1ef465" args="() const " -->
385<div class="memitem">
386<div class="memproto">
387 <table class="memname">
388 <tr>
389 <td class="memname"><a class="el" href="classTiXmlUnknown.html">TiXmlUnknown</a>* TiXmlHandle::Unknown </td>
390 <td>(</td>
391 <td class="paramname"></td>
392 <td>&nbsp;)&nbsp;</td>
393 <td> const<code> [inline]</code></td>
394 </tr>
395 </table>
396</div>
397<div class="memdoc">
398<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>
399
400<p>References <a class="el" href="tinyxml_8h_source.html#l01694">ToUnknown()</a>.</p>
401
402</div>
403</div>
404<hr/>The documentation for this class was generated from the following file:<ul>
405<li><a class="el" href="tinyxml_8h_source.html">tinyxml.h</a></li>
406</ul>
407</div>
408<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]409<a href="http://www.doxygen.org/index.html">
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]410<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]411</body>
412</html>