<!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: TiXmlDeclaration 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-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">TiXmlDeclaration Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="TiXmlDeclaration" --><!-- doxytag: inherits="TiXmlNode" --> <p>XML declaration. <a href="classTiXmlDeclaration.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 TiXmlDeclaration:</div> <div class="dyncontent"> <div class="center"> <img src="classTiXmlDeclaration.png" usemap="#TiXmlDeclaration_map" alt=""/> <map id="TiXmlDeclaration_map" name="TiXmlDeclaration_map"> <area href="classTiXmlNode.html" title="Parent class for everything in DOM." alt="TiXmlNode" shape="rect" coords="0,56,108,80"/> <area href="classTiXmlBase.html" title="Xml base class." alt="TiXmlBase" shape="rect" coords="0,0,108,24"/> </map> </div></div> <p><a href="classTiXmlDeclaration-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#adde340cc8cfbc11ea427a162d65c1d3d">TiXmlDeclaration</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#a302306dca1044ac14ffb34cbdad99dab">TiXmlDeclaration</a> (const char *_version, const char *_encoding, const char *_standalone)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#aab289ad099bfbe05bf0bb9ce73642bcc">TiXmlDeclaration</a> (const <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> &copy)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#a60e17853b2d0ab6f33e7e617f81b433d">operator=</a> (const <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> &copy)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#a1abac6487c56161794e2cba656e51e82">Version</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#a21cf43021714cb3938bfd5dee8586e0f">Encoding</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#a8d9819c5680aeba23cfd31c2365054ec">Standalone</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classTiXmlNode.html">TiXmlNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#a842a98f3a31af4a808cee9d8842e5072">Clone</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#a502c4ac25a44c46ed4c5f8bc03b242b9">Print</a> (FILE *cfile, int depth, <a class="el" href="classedelib_1_1String.html">edelib::String</a> *str) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#aa0c7ee41a4ae95253c321399cd995b9f">Print</a> (FILE *cfile, int depth) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#aee135ea9d6486ec118898e3ac8a293cf">ToDeclaration</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#ab07aa982d62f5beba098e5a285c75e67">ToDeclaration</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlDeclaration.html#ae145535b4ff6c0118a3ff443eda1f672">Accept</a> (<a class="el" href="classTiXmlVisitor.html">TiXmlVisitor</a> *visitor) const </td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>XML declaration. </p> <p>In correct XML the declaration is the first entry in the file. </p> <div class="fragment"><pre class="fragment"> * <?xml version="1.0" standalone="yes"?> * </pre></div><p>TinyXml will happily read or write files without a declaration, however. There are 3 possible attributes to the declaration: version, encoding, and standalone.</p> <p>Note: In this version of the code, the attributes are handled as special cases, not generic attributes, simply because there can only be at most 3 and they are always the same. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="adde340cc8cfbc11ea427a162d65c1d3d"></a><!-- doxytag: member="TiXmlDeclaration::TiXmlDeclaration" ref="adde340cc8cfbc11ea427a162d65c1d3d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct an empty declaration </p> </div> </div> <a class="anchor" id="a302306dca1044ac14ffb34cbdad99dab"></a><!-- doxytag: member="TiXmlDeclaration::TiXmlDeclaration" ref="a302306dca1044ac14ffb34cbdad99dab" args="(const char *_version, const char *_encoding, const char *_standalone)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>_version</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>_encoding</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>_standalone</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor </p> </div> </div> <a class="anchor" id="aab289ad099bfbe05bf0bb9ce73642bcc"></a><!-- doxytag: member="TiXmlDeclaration::TiXmlDeclaration" ref="aab289ad099bfbe05bf0bb9ce73642bcc" args="(const TiXmlDeclaration &copy)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> & </td> <td class="paramname"><em>copy</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ae145535b4ff6c0118a3ff443eda1f672"></a><!-- doxytag: member="TiXmlDeclaration::Accept" ref="ae145535b4ff6c0118a3ff443eda1f672" args="(TiXmlVisitor *visitor) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool <a class="el" href="classTiXmlDeclaration.html#ae145535b4ff6c0118a3ff443eda1f672">Accept</a> </td> <td>(</td> <td class="paramtype"><a class="el" href="classTiXmlVisitor.html">TiXmlVisitor</a> * </td> <td class="paramname"><em>visitor</em></td><td>)</td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Walk the XML tree visiting this node and all of its children. </p> <p>Implements <a class="el" href="classTiXmlNode.html#a3da2314556d60c86be93bcef3bcf8893">TiXmlNode</a>.</p> </div> </div> <a class="anchor" id="a842a98f3a31af4a808cee9d8842e5072"></a><!-- doxytag: member="TiXmlDeclaration::Clone" ref="a842a98f3a31af4a808cee9d8842e5072" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classTiXmlNode.html">TiXmlNode</a>* <a class="el" href="classTiXmlDeclaration.html#a842a98f3a31af4a808cee9d8842e5072">Clone</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Creates a copy of this Declaration and returns it. </p> <p>Implements <a class="el" href="classTiXmlNode.html#a5455583176e9a0389caa2f94ffb809fc">TiXmlNode</a>.</p> </div> </div> <a class="anchor" id="a21cf43021714cb3938bfd5dee8586e0f"></a><!-- doxytag: member="TiXmlDeclaration::Encoding" ref="a21cf43021714cb3938bfd5dee8586e0f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="classTiXmlDeclaration.html#a21cf43021714cb3938bfd5dee8586e0f">Encoding</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Encoding. Will return an empty string if none was found. </p> </div> </div> <a class="anchor" id="a60e17853b2d0ab6f33e7e617f81b433d"></a><!-- doxytag: member="TiXmlDeclaration::operator=" ref="a60e17853b2d0ab6f33e7e617f81b433d" args="(const TiXmlDeclaration &copy)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a> & </td> <td class="paramname"><em>copy</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Assignement from other <a class="el" href="classTiXmlDeclaration.html" title="XML declaration.">TiXmlDeclaration</a> </p> </div> </div> <a class="anchor" id="a502c4ac25a44c46ed4c5f8bc03b242b9"></a><!-- doxytag: member="TiXmlDeclaration::Print" ref="a502c4ac25a44c46ed4c5f8bc03b242b9" args="(FILE *cfile, int depth, edelib::String *str) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void <a class="el" href="classTiXmlDeclaration.html#a502c4ac25a44c46ed4c5f8bc03b242b9">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 class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classedelib_1_1String.html">edelib::String</a> * </td> <td class="paramname"><em>str</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Print this declaration to a FILE stream. </p> </div> </div> <a class="anchor" id="aa0c7ee41a4ae95253c321399cd995b9f"></a><!-- doxytag: member="TiXmlDeclaration::Print" ref="aa0c7ee41a4ae95253c321399cd995b9f" args="(FILE *cfile, int depth) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void <a class="el" href="classTiXmlDeclaration.html#a502c4ac25a44c46ed4c5f8bc03b242b9">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> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Print this declaration to a FILE stream. </p> <p>Implements <a class="el" href="classTiXmlBase.html#a953033a3c8ccb7404e67b0be72562391">TiXmlBase</a>.</p> <p>References <a class="el" href="classTiXmlBase.html#a953033a3c8ccb7404e67b0be72562391">TiXmlBase::Print()</a>.</p> </div> </div> <a class="anchor" id="a8d9819c5680aeba23cfd31c2365054ec"></a><!-- doxytag: member="TiXmlDeclaration::Standalone" ref="a8d9819c5680aeba23cfd31c2365054ec" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="classTiXmlDeclaration.html#a8d9819c5680aeba23cfd31c2365054ec">Standalone</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Is this a standalone document? </p> </div> </div> <a class="anchor" id="aee135ea9d6486ec118898e3ac8a293cf"></a><!-- doxytag: member="TiXmlDeclaration::ToDeclaration" ref="aee135ea9d6486ec118898e3ac8a293cf" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a>* <a class="el" href="classTiXmlDeclaration.html#aee135ea9d6486ec118898e3ac8a293cf">ToDeclaration</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Cast to a more defined type. Will return null not of the requested type. </p> <p>Reimplemented from <a class="el" href="classTiXmlNode.html#aee135ea9d6486ec118898e3ac8a293cf">TiXmlNode</a>.</p> </div> </div> <a class="anchor" id="ab07aa982d62f5beba098e5a285c75e67"></a><!-- doxytag: member="TiXmlDeclaration::ToDeclaration" ref="ab07aa982d62f5beba098e5a285c75e67" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classTiXmlDeclaration.html">TiXmlDeclaration</a>* <a class="el" href="classTiXmlDeclaration.html#aee135ea9d6486ec118898e3ac8a293cf">ToDeclaration</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Cast to a more defined type. Will return null not of the requested type. </p> <p>Reimplemented from <a class="el" href="classTiXmlNode.html#ab07aa982d62f5beba098e5a285c75e67">TiXmlNode</a>.</p> </div> </div> <a class="anchor" id="a1abac6487c56161794e2cba656e51e82"></a><!-- doxytag: member="TiXmlDeclaration::Version" ref="a1abac6487c56161794e2cba656e51e82" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="classTiXmlDeclaration.html#a1abac6487c56161794e2cba656e51e82">Version</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Version. Will return an empty string if none was found. </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>