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: TiXmlPrinter 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 > TiXmlPrinter Class Reference< / h1 > <!-- doxytag: class="TiXmlPrinter" --> <!-- doxytag: inherits="TiXmlVisitor" -->
< p > Print to memory functionality.
< a href = "#_details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "tinyxml_8h_source.html" > tinyxml.h< / a > > < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for TiXmlPrinter:< / div >
< div class = "dynsection" >
< div class = "center" >
< img src = "classTiXmlPrinter.png" usemap = "#TiXmlPrinter_map" alt = "" / >
< map id = "TiXmlPrinter_map" name = "TiXmlPrinter_map" >
< area href = "classTiXmlVisitor.html" alt = "TiXmlVisitor" shape = "rect" coords = "0,0,81,24" / >
2012-09-19 15:15:01 +00:00
< / map >
2013-03-13 08:00:12 +00:00
< / div >
< / div >
2012-09-19 15:15:01 +00:00
2013-03-13 08:00:12 +00:00
< p > < a href = "classTiXmlPrinter-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 = "a799f4f0388570cbb54c0d3c345fef7c1" > < / a > <!-- doxytag: member="TiXmlPrinter::VisitEnter" ref="a799f4f0388570cbb54c0d3c345fef7c1" args="(const TiXmlDocument &doc)" -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a799f4f0388570cbb54c0d3c345fef7c1" > VisitEnter< / a > (const < a class = "el" href = "classTiXmlDocument.html" > TiXmlDocument< / a > & doc)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Visit a document. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a66b33edd76c538b462f789b797a4fdf2" > < / a > <!-- doxytag: member="TiXmlPrinter::VisitExit" ref="a66b33edd76c538b462f789b797a4fdf2" args="(const TiXmlDocument &doc)" -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a66b33edd76c538b462f789b797a4fdf2" > VisitExit< / a > (const < a class = "el" href = "classTiXmlDocument.html" > TiXmlDocument< / a > & doc)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Visit a document. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a0c5e7bf8622838417a0d0bfb8f433854" > < / a > <!-- doxytag: member="TiXmlPrinter::VisitEnter" ref="a0c5e7bf8622838417a0d0bfb8f433854" args="(const TiXmlElement &element, const TiXmlAttribute *firstAttribute)" -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a0c5e7bf8622838417a0d0bfb8f433854" > VisitEnter< / a > (const < a class = "el" href = "classTiXmlElement.html" > TiXmlElement< / a > & element, const < a class = "el" href = "classTiXmlAttribute.html" > TiXmlAttribute< / a > *firstAttribute)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Visit an element. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a1853cf2f6e63ad4b4232b4835e0acaf0" > < / a > <!-- doxytag: member="TiXmlPrinter::VisitExit" ref="a1853cf2f6e63ad4b4232b4835e0acaf0" args="(const TiXmlElement &element)" -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a1853cf2f6e63ad4b4232b4835e0acaf0" > VisitExit< / a > (const < a class = "el" href = "classTiXmlElement.html" > TiXmlElement< / a > & element)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Visit an element. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ace1b14d33eede2575c0743e2350f6a38" > < / a > <!-- doxytag: member="TiXmlPrinter::Visit" ref="ace1b14d33eede2575c0743e2350f6a38" args="(const TiXmlDeclaration &declaration)" -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#ace1b14d33eede2575c0743e2350f6a38" > Visit< / a > (const < a class = "el" href = "classTiXmlDeclaration.html" > TiXmlDeclaration< / a > & declaration)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Visit a declaration. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a711e7d65d4af9ec70977568d2451fb1c" > < / a > <!-- doxytag: member="TiXmlPrinter::Visit" ref="a711e7d65d4af9ec70977568d2451fb1c" args="(const TiXmlText &text)" -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a711e7d65d4af9ec70977568d2451fb1c" > Visit< / a > (const < a class = "el" href = "classTiXmlText.html" > TiXmlText< / a > & text)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Visit a text node. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a83c13d6b980064b30f989f9a35498979" > < / a > <!-- doxytag: member="TiXmlPrinter::Visit" ref="a83c13d6b980064b30f989f9a35498979" args="(const TiXmlComment &comment)" -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a83c13d6b980064b30f989f9a35498979" > Visit< / a > (const < a class = "el" href = "classTiXmlComment.html" > TiXmlComment< / a > & comment)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Visit a comment node. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ad2dca6dd106e8982fd3c7db1f3330970" > < / a > <!-- doxytag: member="TiXmlPrinter::Visit" ref="ad2dca6dd106e8982fd3c7db1f3330970" args="(const TiXmlUnknown &unknown)" -->
virtual bool < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#ad2dca6dd106e8982fd3c7db1f3330970" > Visit< / a > (const < a class = "el" href = "classTiXmlUnknown.html" > TiXmlUnknown< / a > & unknown)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Visit an unknown node. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a213377a4070c7e625bae59716b089e5e" > SetIndent< / a > (const char *_indent)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Set the indent characters for printing. < a href = "#a213377a4070c7e625bae59716b089e5e" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "abb33ec7d4bad6aaeb57f4304394b133d" > < / a > <!-- doxytag: member="TiXmlPrinter::Indent" ref="abb33ec7d4bad6aaeb57f4304394b133d" args="()" -->
const char * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#abb33ec7d4bad6aaeb57f4304394b133d" > Indent< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Query the indention string. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a4be1e37e69e3858c59635aa947174fe6" > SetLineBreak< / a > (const char *_lineBreak)< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Set the line breaking string. < a href = "#a4be1e37e69e3858c59635aa947174fe6" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a11f1b4804a460b175ec244eb5724d96d" > < / a > <!-- doxytag: member="TiXmlPrinter::LineBreak" ref="a11f1b4804a460b175ec244eb5724d96d" args="()" -->
const char * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a11f1b4804a460b175ec244eb5724d96d" > LineBreak< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Query the current line breaking string. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#ab23a90629e374cb1cadca090468bbd19" > SetStreamPrinting< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Switch over to "stream printing" which is the most dense formatting without linebreaks. < a href = "#ab23a90629e374cb1cadca090468bbd19" > < / a > < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a859eede9597d3e0355b77757be48735e" > < / a > <!-- doxytag: member="TiXmlPrinter::CStr" ref="a859eede9597d3e0355b77757be48735e" args="()" -->
const char * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a859eede9597d3e0355b77757be48735e" > CStr< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Return the result. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ad01375ae9199bd2f48252eaddce3039d" > < / a > <!-- doxytag: member="TiXmlPrinter::Size" ref="ad01375ae9199bd2f48252eaddce3039d" args="()" -->
size_t < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#ad01375ae9199bd2f48252eaddce3039d" > Size< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Return the length of the result string. < br / > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a3bd4daf44309b41f5813a833caa0d1c9" > < / a > <!-- doxytag: member="TiXmlPrinter::Str" ref="a3bd4daf44309b41f5813a833caa0d1c9" args="()" -->
const std::string & < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classTiXmlPrinter.html#a3bd4daf44309b41f5813a833caa0d1c9" > Str< / a > ()< / td > < / tr >
< tr > < td class = "mdescLeft" > < / td > < td class = "mdescRight" > Return the result. < 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 > Print to memory functionality. < / p >
< p > The < a class = "el" href = "classTiXmlPrinter.html" title = "Print to memory functionality." > TiXmlPrinter< / a > is useful when you need to:< / p >
< ol type = "1" >
< li > Print to memory (especially in non-STL mode)< / li >
< li > Control formatting (line endings, etc.)< / li >
< / ol >
< p > When constructed, the < a class = "el" href = "classTiXmlPrinter.html" title = "Print to memory functionality." > TiXmlPrinter< / a > is in its default "pretty printing" mode. Before calling Accept() you can call methods to control the printing of the XML document. After < a class = "el" href = "classTiXmlNode.html#acc0f88b7462c6cb73809d410a4f5bb86" title = "Accept a hierchical visit the nodes in the TinyXML DOM." > TiXmlNode::Accept()< / a > is called, the printed document can be accessed via the < a class = "el" href = "classTiXmlPrinter.html#a859eede9597d3e0355b77757be48735e" title = "Return the result." > CStr()< / a > , < a class = "el" href = "classTiXmlPrinter.html#a3bd4daf44309b41f5813a833caa0d1c9" title = "Return the result." > Str()< / a > , and < a class = "el" href = "classTiXmlPrinter.html#ad01375ae9199bd2f48252eaddce3039d" title = "Return the length of the result string." > Size()< / a > methods.< / p >
< p > < a class = "el" href = "classTiXmlPrinter.html" title = "Print to memory functionality." > TiXmlPrinter< / a > uses the Visitor API. < / p >
< div class = "fragment" > < pre class = "fragment" >
TiXmlPrinter printer;
2012-09-19 15:15:01 +00:00
printer.SetIndent( "\t" );
doc.Accept( & printer );
fprintf( stdout, "%s", printer.CStr() );
2013-03-13 08:00:12 +00:00
< / pre > < / div > < hr / > < h2 > Member Function Documentation< / h2 >
< a class = "anchor" id = "a213377a4070c7e625bae59716b089e5e" > < / a > <!-- doxytag: member="TiXmlPrinter::SetIndent" ref="a213377a4070c7e625bae59716b089e5e" args="(const char *_indent)" -->
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" > void TiXmlPrinter::SetIndent < / td >
2012-09-19 15:15:01 +00:00
< td > (< / td >
< td class = "paramtype" > const char * < / td >
2013-03-13 08:00:12 +00:00
< td class = "paramname" > < em > _indent< / em > < / td >
2012-09-19 15:15:01 +00:00
< td > ) < / td >
2013-03-13 08:00:12 +00:00
< td > < code > [inline]< / 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 > Set the indent characters for printing. < / p >
< p > By default 4 spaces but tab () is also useful, or null/empty string for no indentation. < / p >
2012-09-19 15:15:01 +00:00
< / div >
2013-03-13 08:00:12 +00:00
< / div >
< a class = "anchor" id = "a4be1e37e69e3858c59635aa947174fe6" > < / a > <!-- doxytag: member="TiXmlPrinter::SetLineBreak" ref="a4be1e37e69e3858c59635aa947174fe6" args="(const char *_lineBreak)" -->
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" > void TiXmlPrinter::SetLineBreak < / td >
2012-09-19 15:15:01 +00:00
< td > (< / td >
< td class = "paramtype" > const char * < / td >
2013-03-13 08:00:12 +00:00
< td class = "paramname" > < em > _lineBreak< / em > < / td >
2012-09-19 15:15:01 +00:00
< td > ) < / td >
2013-03-13 08:00:12 +00:00
< td > < code > [inline]< / 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 > Set the line breaking string. < / p >
< p > By default set to newline (< br / >
). Some operating systems prefer other characters, or can be set to the null/empty string for no indenation. < / p >
< / div >
2012-09-19 15:15:01 +00:00
< / div >
2013-03-13 08:00:12 +00:00
< a class = "anchor" id = "ab23a90629e374cb1cadca090468bbd19" > < / a > <!-- doxytag: member="TiXmlPrinter::SetStreamPrinting" ref="ab23a90629e374cb1cadca090468bbd19" args="()" -->
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" > void TiXmlPrinter::SetStreamPrinting < / td >
2012-09-19 15:15:01 +00:00
< td > (< / td >
2013-03-13 08:00:12 +00:00
< td class = "paramname" > < / td >
2012-09-19 15:15:01 +00:00
< td > ) < / td >
2013-03-13 08:00:12 +00:00
< td > < code > [inline]< / 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 > Switch over to "stream printing" which is the most dense formatting without linebreaks. < / p >
< p > Common when the XML is needed for network transmission. < / 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 >
