2013-03-13 08:00:12 +00:00
<!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" / >
2012-09-19 15:15:01 +00:00
< title > TinyXml: TiXmlComment Class Reference< / title >
2013-03-13 08:00:12 +00:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
<!-- Generated by Doxygen 1.6.2 -->
< div class = "navigation" id = "top" >
< div class = "tabs" >
< ul >
< li > < a href = "index.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Related Pages< / 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 class = "tabs" >
< ul >
< 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 = "contents" >
< h1 > TiXmlComment Class Reference< / h1 > <!-- doxytag: class="TiXmlComment" --> <!-- doxytag: inherits="TiXmlNode" -->
< p > An XML comment.
< a href = "#_details" > More...< / a > < / p >
2012-09-19 15:15:01 +00:00
2013-03-13 08:00:12 +00:00
< p > < code > #include < < a class = "el" href = "tinyxml_8h_source.html" > tinyxml.h< / a > > < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for TiXmlComment:< / div >
< div class = "dynsection" >
< div class = "center" >
< img src = "classTiXmlComment.png" usemap = "#TiXmlComment_map" alt = "" / >
< map id = "TiXmlComment_map" name = "TiXmlComment_map" >
< area href = "classTiXmlNode.html" alt = "TiXmlNode" shape = "rect" coords = "0,56,94,80" / >
< area href = "classTiXmlBase.html" alt = "TiXmlBase" shape = "rect" coords = "0,0,94,24" / >
< / map >
< / div >
< / div >
2012-09-19 15:15:01 +00:00
2013-03-13 08:00:12 +00:00
< p > < a href = "classTiXmlComment-members.html" > List of all members.< / a > < / p >
< table border = "0" cellpadding = "0" cellspacing = "0" >
< tr > < td colspan = "2" > < h2 > Public Member Functions< / h2 > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aaa3252031d3e8bd3a2bf51a1c61201b7" > < / a > <!-- doxytag: member="TiXmlComment::TiXmlComment" ref="aaa3252031d3e8bd3a2bf51a1c61201b7" args="()" -->
< / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlComment.html#aaa3252031d3e8bd3a2bf51a1c61201b7" > TiXmlComment< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Constructs an empty comment. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a37e7802ef17bc03ebe5ae79bf0713d47" > < / a > <!-- doxytag: member="TiXmlComment::TiXmlComment" ref="a37e7802ef17bc03ebe5ae79bf0713d47" args="(const char *_value)" -->
< / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlComment.html#a37e7802ef17bc03ebe5ae79bf0713d47" > TiXmlComment< / a > (const char *_value)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Construct a comment from text. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a0d6662bdc52488b9e12b3c7a0453d028" > < / a > <!-- doxytag: member="TiXmlComment::Clone" ref="a0d6662bdc52488b9e12b3c7a0453d028" args="() const " -->
virtual < a class = "el" href = "classTiXmlNode.html" > TiXmlNode< / a > * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlComment.html#a0d6662bdc52488b9e12b3c7a0453d028" > Clone< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Returns a copy of this Comment. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > virtual void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlComment.html#a6b316527aaa8da0370cd68c22a5a0f5f" > Print< / a > (FILE *cfile, int depth) const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / 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 = "#a6b316527aaa8da0370cd68c22a5a0f5f" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a00fb4215c20a2399ea05ac9b9e7e68a0" > < / a > <!-- doxytag: member="TiXmlComment::ToComment" ref="a00fb4215c20a2399ea05ac9b9e7e68a0" args="() const " -->
virtual const < a class = "el" href = "classTiXmlComment.html" > TiXmlComment< / a > * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlComment.html#a00fb4215c20a2399ea05ac9b9e7e68a0" > ToComment< / a > () const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Cast to a more defined type. Will return null not of the requested type. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "acc7c7e07e13c23f17797d642981511df" > < / a > <!-- doxytag: member="TiXmlComment::ToComment" ref="acc7c7e07e13c23f17797d642981511df" args="()" -->
virtual < a class = "el" href = "classTiXmlComment.html" > TiXmlComment< / a > * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlComment.html#acc7c7e07e13c23f17797d642981511df" > ToComment< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Cast to a more defined type. Will return null not of the requested type. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "af3ac1b99fbbe9ea4fb6e14146156e43e" > < / a > <!-- doxytag: member="TiXmlComment::Accept" ref="af3ac1b99fbbe9ea4fb6e14146156e43e" args="(TiXmlVisitor *visitor) const " -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlComment.html#af3ac1b99fbbe9ea4fb6e14146156e43e" > Accept< / a > (< a class = "el" href = "classTiXmlVisitor.html" > TiXmlVisitor< / a > *visitor) const < / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Walk the XML tree visiting this node and all of its children. < br / > < / td > < / tr >
2012-09-19 15:15:01 +00:00
< / table >
2013-03-13 08:00:12 +00:00
< hr / > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
< p > An XML comment. < / p >
< hr / > < h2 > Member Function Documentation< / h2 >
< a class = "anchor" id = "a6b316527aaa8da0370cd68c22a5a0f5f" > < / a > <!-- doxytag: member="TiXmlComment::Print" ref="a6b316527aaa8da0370cd68c22a5a0f5f" args="(FILE *cfile, int depth) const " -->
2012-09-19 15:15:01 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2013-03-13 08:00:12 +00:00
< td class = "memname" > virtual void TiXmlComment::Print < / td >
2012-09-19 15:15:01 +00:00
< 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 > < td > < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
2013-03-13 08:00:12 +00:00
< td > < / td > < td > < / td > < td > const< code > [virtual]< / code > < / td >
2012-09-19 15:15:01 +00:00
< / tr >
< / table >
< / div >
< div class = "memdoc" >
2013-03-13 08:00:12 +00:00
< 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 >
< p > ) Either or both cfile and str can be null.< / p >
< p > This is a formatted print, and will insert tabs and newlines.< / p >
< p > (For an unformatted stream, use the < < operator.) < / p >
< p > Implements < a class = "el" href = "classTiXmlBase.html#a0de56b3f2ef14c65091a3b916437b512" > TiXmlBase< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following file:< ul >
< li > < a class = "el" href = "tinyxml_8h_source.html" > tinyxml.h< / a > < / li >
< / ul >
2012-09-19 15:15:01 +00:00
< / div >
2013-03-13 08:00:12 +00:00
< hr size = "1" / > < address style = "text-align: right;" > < small > Generated by
2012-09-19 15:15:01 +00:00
< a href = "http://www.doxygen.org/index.html" >
2013-03-13 08:00:12 +00:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.6.2 < / small > < / address >
2012-09-19 15:15:01 +00:00
< / body >
< / html >
