Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / tinyxml / c3bbea3c3cfee4908189a57b3fc54f105b78c59b / . / docs / classTiXmlBase.html
blob: 4d1ba67ef17b263797f7191aedeb499f08c5c0c9 [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: TiXmlBase 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>TiXmlBase Class Reference</h1><!-- doxytag: class="TiXmlBase" -->
30<p><a class="el" href="classTiXmlBase.html" title="TiXmlBase is a base class for every class in TinyXml.">TiXmlBase</a> is a base class for every class in TinyXml.
31<a href="#_details">More...</a></p>
32
33<p><code>#include &lt;<a class="el" href="tinyxml_8h_source.html">tinyxml.h</a>&gt;</code></p>
34<div class="dynheader">
35Inheritance diagram for TiXmlBase:</div>
36<div class="dynsection">
37 <div class="center">
38 <img src="classTiXmlBase.png" usemap="#TiXmlBase_map" alt=""/>
39 <map id="TiXmlBase_map" name="TiXmlBase_map">
40<area href="classTiXmlAttribute.html" alt="TiXmlAttribute" shape="rect" coords="0,56,108,80"/>
41<area href="classTiXmlNode.html" alt="TiXmlNode" shape="rect" coords="295,56,403,80"/>
42<area href="classTiXmlComment.html" alt="TiXmlComment" shape="rect" coords="0,112,108,136"/>
43<area href="classTiXmlDeclaration.html" alt="TiXmlDeclaration" shape="rect" coords="118,112,226,136"/>
44<area href="classTiXmlDocument.html" alt="TiXmlDocument" shape="rect" coords="236,112,344,136"/>
45<area href="classTiXmlElement.html" alt="TiXmlElement" shape="rect" coords="354,112,462,136"/>
46<area href="classTiXmlText.html" alt="TiXmlText" shape="rect" coords="472,112,580,136"/>
47<area href="classTiXmlUnknown.html" alt="TiXmlUnknown" shape="rect" coords="590,112,698,136"/>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]48</map>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]49 </div>
50</div>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]51
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]52<p><a href="classTiXmlBase-members.html">List of all members.</a></p>
53<table border="0" cellpadding="0" cellspacing="0">
54<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
55<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a0de56b3f2ef14c65091a3b916437b512">Print</a> (FILE *cfile, int depth) const =0</td></tr>
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. <a href="#a0de56b3f2ef14c65091a3b916437b512"></a><br/></td></tr>
57<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a024bceb070188df92c2a8d8852dd0853">Row</a> () const </td></tr>
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the position, in the original source file, of this node or attribute. <a href="#a024bceb070188df92c2a8d8852dd0853"></a><br/></td></tr>
59<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab54bfb9b70fe6dd276e7b279cab7f003"></a><!-- doxytag: member="TiXmlBase::Column" ref="ab54bfb9b70fe6dd276e7b279cab7f003" args="() const " -->
60int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ab54bfb9b70fe6dd276e7b279cab7f003">Column</a> () const </td></tr>
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classTiXmlBase.html#a024bceb070188df92c2a8d8852dd0853" title="Return the position, in the original source file, of this node or attribute.">Row()</a>. <br/></td></tr>
62<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6b3e0f790930d4970ec30764e937b5d"></a><!-- doxytag: member="TiXmlBase::SetUserData" ref="ac6b3e0f790930d4970ec30764e937b5d" args="(void *user)" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ac6b3e0f790930d4970ec30764e937b5d">SetUserData</a> (void *user)</td></tr>
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a pointer to arbitrary user data. <br/></td></tr>
65<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6559a530ca6763fc301a14d77ed28c17"></a><!-- doxytag: member="TiXmlBase::GetUserData" ref="a6559a530ca6763fc301a14d77ed28c17" args="()" -->
66void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a6559a530ca6763fc301a14d77ed28c17">GetUserData</a> ()</td></tr>
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to arbitrary user data. <br/></td></tr>
68<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0120210e4680ef2088601753ce0ede4"></a><!-- doxytag: member="TiXmlBase::GetUserData" ref="ad0120210e4680ef2088601753ce0ede4" args="() const " -->
69const void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ad0120210e4680ef2088601753ce0ede4">GetUserData</a> () const </td></tr>
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to arbitrary user data. <br/></td></tr>
71<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
72<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a0f799ec645bfb8d8a969e83478f379c1">SetCondenseWhiteSpace</a> (bool condense)</td></tr>
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The world does not agree on whether white space should be kept or not. <a href="#a0f799ec645bfb8d8a969e83478f379c1"></a><br/></td></tr>
74<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4b1472531c647a25b1840a87ae42438"></a><!-- doxytag: member="TiXmlBase::IsWhiteSpaceCondensed" ref="ad4b1472531c647a25b1840a87ae42438" args="()" -->
75static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ad4b1472531c647a25b1840a87ae42438">IsWhiteSpaceCondensed</a> ()</td></tr>
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the current white space setting. <br/></td></tr>
77<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a6bd8c315c1acb09e34107b8736505948">EncodeString</a> (const TIXML_STRING &amp;str, TIXML_STRING *out)</td></tr>
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Expands entities in a string. <a href="#a6bd8c315c1acb09e34107b8736505948"></a><br/></td></tr>
79<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
80<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab242c01590191f644569fa89a080d97c"></a><!-- doxytag: member="TiXmlBase::userData" ref="ab242c01590191f644569fa89a080d97c" args="" -->
81void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ab242c01590191f644569fa89a080d97c">userData</a></td></tr>
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Field containing a generic user pointer. <br/></td></tr>
83<tr><td colspan="2"><h2>Friends</h2></td></tr>
84<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a218872a0d985ae30e78c55adc4bdb196"></a><!-- doxytag: member="TiXmlBase::TiXmlNode" ref="a218872a0d985ae30e78c55adc4bdb196" args="" -->
85class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a218872a0d985ae30e78c55adc4bdb196">TiXmlNode</a></td></tr>
86<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6592e32cb9132be517cc12a70564c4b"></a><!-- doxytag: member="TiXmlBase::TiXmlElement" ref="ab6592e32cb9132be517cc12a70564c4b" args="" -->
87class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ab6592e32cb9132be517cc12a70564c4b">TiXmlElement</a></td></tr>
88<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a173617f6dfe902cf484ce5552b950475"></a><!-- doxytag: member="TiXmlBase::TiXmlDocument" ref="a173617f6dfe902cf484ce5552b950475" args="" -->
89class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a173617f6dfe902cf484ce5552b950475">TiXmlDocument</a></td></tr>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]90</table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]91<hr/><a name="_details"></a><h2>Detailed Description</h2>
92<p><a class="el" href="classTiXmlBase.html" title="TiXmlBase is a base class for every class in TinyXml.">TiXmlBase</a> is a base class for every class in TinyXml. </p>
93<p>It does little except to establish that TinyXml classes can be printed and provide some utility functions.</p>
94<p>In XML, the document and elements can contain other elements and other types of nodes.</p>
95<div class="fragment"><pre class="fragment">
96 A Document can contain: Element (container or leaf)
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]97 Comment (leaf)
98 Unknown (leaf)
99 Declaration( leaf )
100
101 An Element can contain: Element (container or leaf)
102 Text (leaf)
103 Attributes (not on tree)
104 Comment (leaf)
105 Unknown (leaf)
106
107 A Decleration contains: Attributes (not on tree)
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]108 </pre></div> <hr/><h2>Member Function Documentation</h2>
109<a class="anchor" id="a6bd8c315c1acb09e34107b8736505948"></a><!-- doxytag: member="TiXmlBase::EncodeString" ref="a6bd8c315c1acb09e34107b8736505948" args="(const TIXML_STRING &amp;str, TIXML_STRING *out)" -->
110<div class="memitem">
111<div class="memproto">
112 <table class="memname">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]113 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]114 <td class="memname">static void TiXmlBase::EncodeString </td>
115 <td>(</td>
116 <td class="paramtype">const TIXML_STRING &amp;&nbsp;</td>
117 <td class="paramname"> <em>str</em>, </td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]118 </tr>
119 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]120 <td class="paramkey"></td>
121 <td></td>
122 <td class="paramtype">TIXML_STRING *&nbsp;</td>
123 <td class="paramname"> <em>out</em></td><td>&nbsp;</td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]124 </tr>
125 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]126 <td></td>
127 <td>)</td>
128 <td></td><td></td><td><code> [static]</code></td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]129 </tr>
130 </table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]131</div>
132<div class="memdoc">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]133
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]134<p>Expands entities in a string. </p>
135<p>Note this should not contian the tag's '&lt;', '&gt;', etc, or they will be transformed into entities! </p>
136
137</div>
138</div>
139<a class="anchor" id="a0de56b3f2ef14c65091a3b916437b512"></a><!-- doxytag: member="TiXmlBase::Print" ref="a0de56b3f2ef14c65091a3b916437b512" args="(FILE *cfile, int depth) const =0" -->
140<div class="memitem">
141<div class="memproto">
142 <table class="memname">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]143 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]144 <td class="memname">virtual void TiXmlBase::Print </td>
145 <td>(</td>
146 <td class="paramtype">FILE *&nbsp;</td>
147 <td class="paramname"> <em>cfile</em>, </td>
148 </tr>
149 <tr>
150 <td class="paramkey"></td>
151 <td></td>
152 <td class="paramtype">int&nbsp;</td>
153 <td class="paramname"> <em>depth</em></td><td>&nbsp;</td>
154 </tr>
155 <tr>
156 <td></td>
157 <td>)</td>
158 <td></td><td></td><td> const<code> [pure virtual]</code></td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]159 </tr>
160 </table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]161</div>
162<div class="memdoc">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]163
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]164<p>All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. </p>
165<p>) Either or both cfile and str can be null.</p>
166<p>This is a formatted print, and will insert tabs and newlines.</p>
167<p>(For an unformatted stream, use the &lt;&lt; operator.) </p>
168
169<p>Implemented in <a class="el" href="classTiXmlAttribute.html#acc04956c1d5c4c31fe74f7a7528d109a">TiXmlAttribute</a>, <a class="el" href="classTiXmlElement.html#afbf52736e70fc91ec9d760721d6f4fd2">TiXmlElement</a>, <a class="el" href="classTiXmlComment.html#a6b316527aaa8da0370cd68c22a5a0f5f">TiXmlComment</a>, <a class="el" href="classTiXmlText.html#a0cafbf6f236c7f02d12b2bffc2b7976b">TiXmlText</a>, <a class="el" href="classTiXmlDeclaration.html#abf6303db4bd05b5be554036817ff1cb4">TiXmlDeclaration</a>, <a class="el" href="classTiXmlUnknown.html#a31ba089a40fb5a1869750fce09b0bacb">TiXmlUnknown</a>, and <a class="el" href="classTiXmlDocument.html#a8701fda1fa31b25abbc9c0df42da10e8">TiXmlDocument</a>.</p>
170
171</div>
172</div>
173<a class="anchor" id="a024bceb070188df92c2a8d8852dd0853"></a><!-- doxytag: member="TiXmlBase::Row" ref="a024bceb070188df92c2a8d8852dd0853" args="() const " -->
174<div class="memitem">
175<div class="memproto">
176 <table class="memname">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]177 <tr>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]178 <td class="memname">int TiXmlBase::Row </td>
179 <td>(</td>
180 <td class="paramname"></td>
181 <td>&nbsp;)&nbsp;</td>
182 <td> const<code> [inline]</code></td>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]183 </tr>
184 </table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]185</div>
186<div class="memdoc">
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]187
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]188<p>Return the position, in the original source file, of this node or attribute. </p>
189<p>The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.</p>
190<p>Generally, the row and column value will be set when the TiXmlDocument::Load(), <a class="el" href="classTiXmlDocument.html#a4c852a889c02cf251117fd1d9fe1845f" title="Load a file using the current document value.">TiXmlDocument::LoadFile()</a>, or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator&gt;&gt;.</p>
191<p>The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.</p>
192<p>There is a minor performance cost to computing the row and column. Computation can be disabled if <a class="el" href="classTiXmlDocument.html#a51dac56316f89b35bdb7d0d433ba988e" title="SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to...">TiXmlDocument::SetTabSize()</a> is called with 0 as the value.</p>
193<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTiXmlDocument.html#a51dac56316f89b35bdb7d0d433ba988e" title="SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to...">TiXmlDocument::SetTabSize()</a> </dd></dl>
194
195</div>
196</div>
197<a class="anchor" id="a0f799ec645bfb8d8a969e83478f379c1"></a><!-- doxytag: member="TiXmlBase::SetCondenseWhiteSpace" ref="a0f799ec645bfb8d8a969e83478f379c1" args="(bool condense)" -->
198<div class="memitem">
199<div class="memproto">
200 <table class="memname">
201 <tr>
202 <td class="memname">static void TiXmlBase::SetCondenseWhiteSpace </td>
203 <td>(</td>
204 <td class="paramtype">bool&nbsp;</td>
205 <td class="paramname"> <em>condense</em></td>
206 <td>&nbsp;)&nbsp;</td>
207 <td><code> [inline, static]</code></td>
208 </tr>
209 </table>
210</div>
211<div class="memdoc">
212
213<p>The world does not agree on whether white space should be kept or not. </p>
214<p>In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe. </p>
215
216</div>
217</div>
218<hr/>The documentation for this class was generated from the following file:<ul>
219<li><a class="el" href="tinyxml_8h_source.html">tinyxml.h</a></li>
220</ul>
221</div>
222<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]223<a href="http://www.doxygen.org/index.html">
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]224<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]225</body>
226</html>