<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>edelib: TiXmlBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">edelib
 <span id="projectnumber">2.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">TiXmlBase Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="TiXmlBase" -->
<p>Xml base class.
<a href="classTiXmlBase.html#details">More...</a></p>
<p><code>#include <<a class="el" href="TiXml_8h_source.html">edelib/TiXml.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TiXmlBase:</div>
<div class="dyncontent">
<div class="center">
<img src="classTiXmlBase.png" usemap="#TiXmlBase_map" alt=""/>
<map id="TiXmlBase_map" name="TiXmlBase_map">
<area href="classTiXmlAttribute.html" title="Name-value pair." alt="TiXmlAttribute" shape="rect" coords="0,56,108,80"/>
<area href="classTiXmlNode.html" title="Parent class for everything in DOM." alt="TiXmlNode" shape="rect" coords="295,56,403,80"/>
<area href="classTiXmlComment.html" title="A XML Comment." alt="TiXmlComment" shape="rect" coords="0,112,108,136"/>
<area href="classTiXmlDeclaration.html" title="XML declaration." alt="TiXmlDeclaration" shape="rect" coords="118,112,226,136"/>
<area href="classTiXmlDocument.html" title="Top level node." alt="TiXmlDocument" shape="rect" coords="236,112,344,136"/>
<area href="classTiXmlElement.html" title="Container xml class." alt="TiXmlElement" shape="rect" coords="354,112,462,136"/>
<area href="classTiXmlText.html" title="XML text." alt="TiXmlText" shape="rect" coords="472,112,580,136"/>
<area href="classTiXmlUnknown.html" title="Unknown XML element." alt="TiXmlUnknown" shape="rect" coords="590,112,698,136"/>
</map>
</div></div>
<p><a href="classTiXmlBase-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br/>
  <b>TIXML_NO_ERROR</b> = 0,
<b>TIXML_ERROR</b>,
<b>TIXML_ERROR_OPENING_FILE</b>,
<b>TIXML_ERROR_OUT_OF_MEMORY</b>,
<br/>
  <b>TIXML_ERROR_PARSING_ELEMENT</b>,
<b>TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME</b>,
<b>TIXML_ERROR_READING_ELEMENT_VALUE</b>,
<b>TIXML_ERROR_READING_ATTRIBUTES</b>,
<br/>
  <b>TIXML_ERROR_PARSING_EMPTY</b>,
<b>TIXML_ERROR_READING_END_TAG</b>,
<b>TIXML_ERROR_PARSING_UNKNOWN</b>,
<b>TIXML_ERROR_PARSING_COMMENT</b>,
<br/>
  <b>TIXML_ERROR_PARSING_DECLARATION</b>,
<b>TIXML_ERROR_DOCUMENT_EMPTY</b>,
<b>TIXML_ERROR_EMBEDDED_NULL</b>,
<b>TIXML_ERROR_PARSING_CDATA</b>,
<br/>
  <b>TIXML_ERROR_DOCUMENT_TOP_ONLY</b>,
<b>TIXML_ERROR_STRING_COUNT</b>
<br/>
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a953033a3c8ccb7404e67b0be72562391">Print</a> (FILE *cfile, int depth) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a8b8f21430c62433a48c592277a3bd7a2">Row</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ab01a75ed9853cd6e22f06a61d173f229">Column</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a52da991c3b0e2f0de483df38db787e4b">SetUserData</a> (void *user)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ab331e64cfdbe463ed51c2591d26f7564">GetUserData</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a5a80e350527f576950f2bc9c2596d14e">GetUserData</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#af8f2207f82d9add8ab6f375f5a5b9667">SetCondenseWhiteSpace</a> (bool condense)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a3b5c220f2933287671e650679746c08f">IsWhiteSpaceCondensed</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ab6c78439ac122bf1f9f0475f8dc65eb3">ReadName</a> (const char *p, <a class="el" href="classedelib_1_1String.html">edelib::String</a> *name, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ad0f4852fe129aa679f9e6e7a03aee88c">ReadText</a> (const char *in, <a class="el" href="classedelib_1_1String.html">edelib::String</a> *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a96887fa866b967049b20080b771de0dd">GetEntity</a> (const char *in, char *value, int *length, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#aa638ff772292abda05c03c0ae481bdcd">GetChar</a> (const char *p, char *_value, int *length, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a79d009a172b3446fc53d2ec824e052e2">PutString</a> (const <a class="el" href="classedelib_1_1String.html">edelib::String</a> &str, <a class="el" href="classedelib_1_1String.html">edelib::String</a> *out)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a69ce22b05a76723414b88817a54058f4">StringEqual</a> (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a7e5a7fa026ecb0f2d52bc7e08460aeab">IsAlpha</a> (unsigned char anyByte, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ab561fe2a6402715973d8d282f8cc6348">IsAlphaNum</a> (unsigned char anyByte, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#ad98aa67c2bd17629da1681c714f91548">ToLower</a> (int v, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a72afad56eb82af0449a54b9545ad0e2f">ConvertUTF32ToUTF8</a> (unsigned long input, char *output, int *length)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TiXmlCursor </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a4dc7805c3510e31912915af681ec22f4">location</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#a2e294dd14122c554baa0665072b4ca7a">userData</a></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlBase.html#acb68accfbcead3c93fcf29cdf8bdb4c4">errorString</a> [TIXML_ERROR_STRING_COUNT]</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a218872a0d985ae30e78c55adc4bdb196"></a><!-- doxytag: member="TiXmlBase::TiXmlNode" ref="a218872a0d985ae30e78c55adc4bdb196" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>TiXmlNode</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6592e32cb9132be517cc12a70564c4b"></a><!-- doxytag: member="TiXmlBase::TiXmlElement" ref="ab6592e32cb9132be517cc12a70564c4b" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>TiXmlElement</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a173617f6dfe902cf484ce5552b950475"></a><!-- doxytag: member="TiXmlBase::TiXmlDocument" ref="a173617f6dfe902cf484ce5552b950475" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>TiXmlDocument</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Xml base class. </p>
<p><a class="el" href="classTiXmlBase.html" title="Xml base class.">TiXmlBase</a> is a base class for every class in TinyXml. It does little except to establish that TinyXml classes can be printed and provide some utility functions.</p>
<p>In XML, the document and elements can contain other elements and other types of nodes.</p>
<div class="fragment"><pre class="fragment">
* A Document can contain:
* Element (container or leaf)
* Comment (leaf)
* Unknown (leaf)
* Declaration( leaf )
*
* An Element can contain:
* Element (container or leaf)
* Text (leaf)
* Attributes (not on tree)
* Comment (leaf)
* Unknown (leaf)
*
* A Decleration contains:
* Attributes (not on tree)
* </pre></div> </div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab01a75ed9853cd6e22f06a61d173f229"></a><!-- doxytag: member="TiXmlBase::Column" ref="ab01a75ed9853cd6e22f06a61d173f229" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classTiXmlBase.html#ab01a75ed9853cd6e22f06a61d173f229">Column</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <a class="el" href="classTiXmlBase.html#a8b8f21430c62433a48c592277a3bd7a2">Row()</a> </p>
<p>References <a class="el" href="classTiXmlBase.html#a4dc7805c3510e31912915af681ec22f4">location</a>.</p>
</div>
</div>
<a class="anchor" id="a72afad56eb82af0449a54b9545ad0e2f"></a><!-- doxytag: member="TiXmlBase::ConvertUTF32ToUTF8" ref="a72afad56eb82af0449a54b9545ad0e2f" args="(unsigned long input, char *output, int *length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="classTiXmlBase.html#a72afad56eb82af0449a54b9545ad0e2f">ConvertUTF32ToUTF8</a> </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert from UTF-32 to UTF-8 </p>
</div>
</div>
<a class="anchor" id="aa638ff772292abda05c03c0ae481bdcd"></a><!-- doxytag: member="TiXmlBase::GetChar" ref="aa638ff772292abda05c03c0ae481bdcd" args="(const char *p, char *_value, int *length, TiXmlEncoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* <a class="el" href="classTiXmlBase.html#aa638ff772292abda05c03c0ae481bdcd">GetChar</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a character, while interpreting entities. The length can be from 0 to 4 bytes. </p>
<p>References <a class="el" href="classTiXmlBase.html#a96887fa866b967049b20080b771de0dd">GetEntity()</a>.</p>
</div>
</div>
<a class="anchor" id="a96887fa866b967049b20080b771de0dd"></a><!-- doxytag: member="TiXmlBase::GetEntity" ref="a96887fa866b967049b20080b771de0dd" args="(const char *in, char *value, int *length, TiXmlEncoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* <a class="el" href="classTiXmlBase.html#a96887fa866b967049b20080b771de0dd">GetEntity</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If an entity has been found, transform it into a character </p>
<p>Referenced by <a class="el" href="classTiXmlBase.html#aa638ff772292abda05c03c0ae481bdcd">GetChar()</a>.</p>
</div>
</div>
<a class="anchor" id="ab331e64cfdbe463ed51c2591d26f7564"></a><!-- doxytag: member="TiXmlBase::GetUserData" ref="ab331e64cfdbe463ed51c2591d26f7564" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classTiXmlBase.html#ab331e64cfdbe463ed51c2591d26f7564">GetUserData</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to arbitrary user data. </p>
<p>References <a class="el" href="classTiXmlBase.html#a2e294dd14122c554baa0665072b4ca7a">userData</a>.</p>
</div>
</div>
<a class="anchor" id="a5a80e350527f576950f2bc9c2596d14e"></a><!-- doxytag: member="TiXmlBase::GetUserData" ref="a5a80e350527f576950f2bc9c2596d14e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* <a class="el" href="classTiXmlBase.html#ab331e64cfdbe463ed51c2591d26f7564">GetUserData</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to arbitrary user data. </p>
<p>References <a class="el" href="classTiXmlBase.html#a2e294dd14122c554baa0665072b4ca7a">userData</a>.</p>
</div>
</div>
<a class="anchor" id="a7e5a7fa026ecb0f2d52bc7e08460aeab"></a><!-- doxytag: member="TiXmlBase::IsAlpha" ref="a7e5a7fa026ecb0f2d52bc7e08460aeab" args="(unsigned char anyByte, TiXmlEncoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int <a class="el" href="classTiXmlBase.html#a7e5a7fa026ecb0f2d52bc7e08460aeab">IsAlpha</a> </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>anyByte</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>None of these methods are reliable for any language except English. Good for approximation, not great for accuracy. </p>
</div>
</div>
<a class="anchor" id="ab561fe2a6402715973d8d282f8cc6348"></a><!-- doxytag: member="TiXmlBase::IsAlphaNum" ref="ab561fe2a6402715973d8d282f8cc6348" args="(unsigned char anyByte, TiXmlEncoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int <a class="el" href="classTiXmlBase.html#ab561fe2a6402715973d8d282f8cc6348">IsAlphaNum</a> </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"><em>anyByte</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <a class="el" href="classTiXmlBase.html#a7e5a7fa026ecb0f2d52bc7e08460aeab">IsAlpha()</a> </p>
</div>
</div>
<a class="anchor" id="a3b5c220f2933287671e650679746c08f"></a><!-- doxytag: member="TiXmlBase::IsWhiteSpaceCondensed" ref="a3b5c220f2933287671e650679746c08f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classTiXmlBase.html#a3b5c220f2933287671e650679746c08f">IsWhiteSpaceCondensed</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current white space setting </p>
</div>
</div>
<a class="anchor" id="a953033a3c8ccb7404e67b0be72562391"></a><!-- doxytag: member="TiXmlBase::Print" ref="a953033a3c8ccb7404e67b0be72562391" args="(FILE *cfile, int depth) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classTiXmlBase.html#a953033a3c8ccb7404e67b0be72562391">Print</a> </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>cfile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>depth</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.</p>
<p>This is a formatted print, and will insert t abs and newlines.</p>
<p>(For an unformatted stream, use the << operator.) </p>
<p>Implemented in <a class="el" href="classTiXmlDocument.html#a7d9fe3cf302a6e37b9a49c37a3cfdf08">TiXmlDocument</a>, <a class="el" href="classTiXmlUnknown.html#aa0c7ee41a4ae95253c321399cd995b9f">TiXmlUnknown</a>, <a class="el" href="classTiXmlDeclaration.html#aa0c7ee41a4ae95253c321399cd995b9f">TiXmlDeclaration</a>, <a class="el" href="classTiXmlText.html#aa0c7ee41a4ae95253c321399cd995b9f">TiXmlText</a>, <a class="el" href="classTiXmlComment.html#aa0c7ee41a4ae95253c321399cd995b9f">TiXmlComment</a>, <a class="el" href="classTiXmlElement.html#aa0c7ee41a4ae95253c321399cd995b9f">TiXmlElement</a>, and <a class="el" href="classTiXmlAttribute.html#aa0c7ee41a4ae95253c321399cd995b9f">TiXmlAttribute</a>.</p>
<p>Referenced by <a class="el" href="classTiXmlAttribute.html#aa0c7ee41a4ae95253c321399cd995b9f">TiXmlAttribute::Print()</a>, and <a class="el" href="classTiXmlDeclaration.html#aa0c7ee41a4ae95253c321399cd995b9f">TiXmlDeclaration::Print()</a>.</p>
</div>
</div>
<a class="anchor" id="a79d009a172b3446fc53d2ec824e052e2"></a><!-- doxytag: member="TiXmlBase::PutString" ref="a79d009a172b3446fc53d2ec824e052e2" args="(const edelib::String &str, edelib::String *out)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="classTiXmlBase.html#a79d009a172b3446fc53d2ec824e052e2">PutString</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classedelib_1_1String.html">edelib::String</a> & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classedelib_1_1String.html">edelib::String</a> * </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Puts a string to a stream, expanding entities as it goes. Note this should not contian the '<', '>', etc, or they will be transformed into entities! </p>
</div>
</div>
<a class="anchor" id="ab6c78439ac122bf1f9f0475f8dc65eb3"></a><!-- doxytag: member="TiXmlBase::ReadName" ref="ab6c78439ac122bf1f9f0475f8dc65eb3" args="(const char *p, edelib::String *name, TiXmlEncoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* <a class="el" href="classTiXmlBase.html#ab6c78439ac122bf1f9f0475f8dc65eb3">ReadName</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classedelib_1_1String.html">edelib::String</a> * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an XML name into the string provided. Returns a pointer just past the last character of the name, or 0 if the function has an error. </p>
</div>
</div>
<a class="anchor" id="ad0f4852fe129aa679f9e6e7a03aee88c"></a><!-- doxytag: member="TiXmlBase::ReadText" ref="ad0f4852fe129aa679f9e6e7a03aee88c" args="(const char *in, edelib::String *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const char* <a class="el" href="classTiXmlBase.html#ad0f4852fe129aa679f9e6e7a03aee88c">ReadText</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classedelib_1_1String.html">edelib::String</a> * </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>ignoreWhiteSpace</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>endTag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>ignoreCase</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads text. Returns a pointer past the given end tag. Wickedly complex options, but it keeps the (sensitive) code in one place. </p>
</div>
</div>
<a class="anchor" id="a8b8f21430c62433a48c592277a3bd7a2"></a><!-- doxytag: member="TiXmlBase::Row" ref="a8b8f21430c62433a48c592277a3bd7a2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classTiXmlBase.html#a8b8f21430c62433a48c592277a3bd7a2">Row</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the position, in the original source file, of this node or attribute. 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>
<p>Generally, the row and column value will be set when the TiXmlDocument::Load(), <a class="el" href="classTiXmlDocument.html#a3853e4fa22d120447e98bcab934b2070">TiXmlDocument::LoadFile()</a>, or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>. 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>
<p>There is a minor performance cost to computing the row and column. Computation can be disabled if <a class="el" href="classTiXmlDocument.html#ae52c1e6d112677e7fce608a2de6201bd">TiXmlDocument::SetTabSize()</a> is called with 0 as the value.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTiXmlDocument.html#ae52c1e6d112677e7fce608a2de6201bd">TiXmlDocument::SetTabSize()</a> </dd></dl>
<p>References <a class="el" href="classTiXmlBase.html#a4dc7805c3510e31912915af681ec22f4">location</a>.</p>
</div>
</div>
<a class="anchor" id="af8f2207f82d9add8ab6f375f5a5b9667"></a><!-- doxytag: member="TiXmlBase::SetCondenseWhiteSpace" ref="af8f2207f82d9add8ab6f375f5a5b9667" args="(bool condense)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="classTiXmlBase.html#af8f2207f82d9add8ab6f375f5a5b9667">SetCondenseWhiteSpace</a> </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>condense</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The world does not agree on whether white space should be kept or not. 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>
</div>
</div>
<a class="anchor" id="a52da991c3b0e2f0de483df38db787e4b"></a><!-- doxytag: member="TiXmlBase::SetUserData" ref="a52da991c3b0e2f0de483df38db787e4b" args="(void *user)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classTiXmlBase.html#a52da991c3b0e2f0de483df38db787e4b">SetUserData</a> </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a pointer to arbitrary user data. </p>
<p>References <a class="el" href="classTiXmlBase.html#a2e294dd14122c554baa0665072b4ca7a">userData</a>.</p>
</div>
</div>
<a class="anchor" id="a69ce22b05a76723414b88817a54058f4"></a><!-- doxytag: member="TiXmlBase::StringEqual" ref="a69ce22b05a76723414b88817a54058f4" args="(const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="classTiXmlBase.html#a69ce22b05a76723414b88817a54058f4">StringEqual</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>endTag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>ignoreCase</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return true if the next characters in the stream are any of the endTag sequences. Ignore case only works for english, and should only be relied on when comparing to English words: StringEqual( p, "version", true ) is fine. </p>
</div>
</div>
<a class="anchor" id="ad98aa67c2bd17629da1681c714f91548"></a><!-- doxytag: member="TiXmlBase::ToLower" ref="ad98aa67c2bd17629da1681c714f91548" args="(int v, TiXmlEncoding encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int <a class="el" href="classTiXmlBase.html#ad98aa67c2bd17629da1681c714f91548">ToLower</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"><em>encoding</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See <a class="el" href="classTiXmlBase.html#a7e5a7fa026ecb0f2d52bc7e08460aeab">IsAlpha()</a> </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="acb68accfbcead3c93fcf29cdf8bdb4c4"></a><!-- doxytag: member="TiXmlBase::errorString" ref="acb68accfbcead3c93fcf29cdf8bdb4c4" args="[TIXML_ERROR_STRING_COUNT]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="classTiXmlBase.html#acb68accfbcead3c93fcf29cdf8bdb4c4">errorString</a>[TIXML_ERROR_STRING_COUNT]<code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>List of error strings </p>
</div>
</div>
<a class="anchor" id="a4dc7805c3510e31912915af681ec22f4"></a><!-- doxytag: member="TiXmlBase::location" ref="a4dc7805c3510e31912915af681ec22f4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TiXmlCursor <a class="el" href="classTiXmlBase.html#a4dc7805c3510e31912915af681ec22f4">location</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current location in parsing </p>
<p>Referenced by <a class="el" href="classTiXmlBase.html#ab01a75ed9853cd6e22f06a61d173f229">Column()</a>, and <a class="el" href="classTiXmlBase.html#a8b8f21430c62433a48c592277a3bd7a2">Row()</a>.</p>
</div>
</div>
<a class="anchor" id="a2e294dd14122c554baa0665072b4ca7a"></a><!-- doxytag: member="TiXmlBase::userData" ref="a2e294dd14122c554baa0665072b4ca7a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="classTiXmlBase.html#a2e294dd14122c554baa0665072b4ca7a">userData</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Field containing a generic user pointer </p>
<p>Referenced by <a class="el" href="classTiXmlBase.html#ab331e64cfdbe463ed51c2591d26f7564">GetUserData()</a>, and <a class="el" href="classTiXmlBase.html#a52da991c3b0e2f0de483df38db787e4b">SetUserData()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>edelib/<a class="el" href="TiXml_8h_source.html">TiXml.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 5 2012 17:49:02 for edelib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
