<!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: TiXmlComment 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">TiXmlComment Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="TiXmlComment" --><!-- doxytag: inherits="TiXmlNode" --> <p>A XML Comment. <a href="classTiXmlComment.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 TiXmlComment:</div> <div class="dyncontent"> <div class="center"> <img src="classTiXmlComment.png" usemap="#TiXmlComment_map" alt=""/> <map id="TiXmlComment_map" name="TiXmlComment_map"> <area href="classTiXmlNode.html" title="Parent class for everything in DOM." alt="TiXmlNode" shape="rect" coords="0,56,94,80"/> <area href="classTiXmlBase.html" title="Xml base class." alt="TiXmlBase" shape="rect" coords="0,0,94,24"/> </map> </div></div> <p><a href="classTiXmlComment-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="classTiXmlComment.html#ae41c277a90573c1dfa0f6dc84bd268a8">TiXmlComment</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a88aab2397b774cdf5857f7d05373e7bd">TiXmlComment</a> (const char *_value)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#ad917b3015fa085f14b6251119300bbf8">TiXmlComment</a> (const <a class="el" href="classTiXmlComment.html">TiXmlComment</a> &)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a0fb6af5eec1016174740f659e6ffa651">operator=</a> (const <a class="el" href="classTiXmlComment.html">TiXmlComment</a> &base)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a34a38fb9155072778824915ff34d779b">~TiXmlComment</a> ()</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="classTiXmlComment.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="classTiXmlComment.html#aa0c7ee41a4ae95253c321399cd995b9f">Print</a> (FILE *cfile, int depth) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a6c006d93730ee147d7bbc35c29033ad6">Parse</a> (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classTiXmlComment.html">TiXmlComment</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a1535d8f760996ff1a651cae2fcb62be3">ToComment</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classTiXmlComment.html">TiXmlComment</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a8dfc05132e237c72560d51ee2c725a5c">ToComment</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.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>A XML Comment. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ae41c277a90573c1dfa0f6dc84bd268a8"></a><!-- doxytag: member="TiXmlComment::TiXmlComment" ref="ae41c277a90573c1dfa0f6dc84bd268a8" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTiXmlComment.html">TiXmlComment</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructs an empty comment </p> </div> </div> <a class="anchor" id="a88aab2397b774cdf5857f7d05373e7bd"></a><!-- doxytag: member="TiXmlComment::TiXmlComment" ref="a88aab2397b774cdf5857f7d05373e7bd" args="(const char *_value)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTiXmlComment.html">TiXmlComment</a> </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>_value</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a comment from text </p> <p>References <a class="el" href="classTiXmlNode.html#aea82a06505184ef86f477ad405fbbef9">TiXmlNode::SetValue()</a>.</p> </div> </div> <a class="anchor" id="ad917b3015fa085f14b6251119300bbf8"></a><!-- doxytag: member="TiXmlComment::TiXmlComment" ref="ad917b3015fa085f14b6251119300bbf8" args="(const TiXmlComment &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classTiXmlComment.html">TiXmlComment</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classTiXmlComment.html">TiXmlComment</a> & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a comment from <a class="el" href="classTiXmlComment.html" title="A XML Comment.">TiXmlComment</a> </p> </div> </div> <a class="anchor" id="a34a38fb9155072778824915ff34d779b"></a><!-- doxytag: member="TiXmlComment::~TiXmlComment" ref="a34a38fb9155072778824915ff34d779b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ~<a class="el" href="classTiXmlComment.html">TiXmlComment</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Destructor </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ae145535b4ff6c0118a3ff443eda1f672"></a><!-- doxytag: member="TiXmlComment::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="classTiXmlComment.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="TiXmlComment::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="classTiXmlComment.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>Returns a copy of this Comment </p> <p>Implements <a class="el" href="classTiXmlNode.html#a5455583176e9a0389caa2f94ffb809fc">TiXmlNode</a>.</p> </div> </div> <a class="anchor" id="a0fb6af5eec1016174740f659e6ffa651"></a><!-- doxytag: member="TiXmlComment::operator=" ref="a0fb6af5eec1016174740f659e6ffa651" args="(const TiXmlComment &base)" --> <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="classTiXmlComment.html">TiXmlComment</a> & </td> <td class="paramname"><em>base</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a comment from <a class="el" href="classTiXmlComment.html" title="A XML Comment.">TiXmlComment</a> </p> </div> </div> <a class="anchor" id="a6c006d93730ee147d7bbc35c29033ad6"></a><!-- doxytag: member="TiXmlComment::Parse" ref="a6c006d93730ee147d7bbc35c29033ad6" args="(const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* <a class="el" href="classTiXmlComment.html#a6c006d93730ee147d7bbc35c29033ad6">Parse</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">TiXmlParsingData * </td> <td class="paramname"><em>data</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> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Attribtue parsing starts: at the ! of the !-- returns: next char past '>' </p> </div> </div> <a class="anchor" id="aa0c7ee41a4ae95253c321399cd995b9f"></a><!-- doxytag: member="TiXmlComment::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="classTiXmlComment.html#aa0c7ee41a4ae95253c321399cd995b9f">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> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Write this Comment to a FILE stream </p> <p>Implements <a class="el" href="classTiXmlBase.html#a953033a3c8ccb7404e67b0be72562391">TiXmlBase</a>.</p> </div> </div> <a class="anchor" id="a1535d8f760996ff1a651cae2fcb62be3"></a><!-- doxytag: member="TiXmlComment::ToComment" ref="a1535d8f760996ff1a651cae2fcb62be3" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="classTiXmlComment.html">TiXmlComment</a>* <a class="el" href="classTiXmlComment.html#a1535d8f760996ff1a651cae2fcb62be3">ToComment</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#a1535d8f760996ff1a651cae2fcb62be3">TiXmlNode</a>.</p> </div> </div> <a class="anchor" id="a8dfc05132e237c72560d51ee2c725a5c"></a><!-- doxytag: member="TiXmlComment::ToComment" ref="a8dfc05132e237c72560d51ee2c725a5c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classTiXmlComment.html">TiXmlComment</a>* <a class="el" href="classTiXmlComment.html#a1535d8f760996ff1a651cae2fcb62be3">ToComment</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#a8dfc05132e237c72560d51ee2c725a5c">TiXmlNode</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>