docs/reference/html/classxmlpp_1_1OutputBuffer.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.9.1"/>
   7 <title>libxml++: xmlpp::OutputBuffer Class Reference</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td style="padding-left: 0.5em;">
  21    <div id="projectname">libxml++
  22    &#160;<span id="projectnumber">2.91.2</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.9.1 -->
  31   <div id="navrow1" class="tabs">
  32     <ul class="tablist">
  33       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  34       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  35       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  36       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  37     </ul>
  38   </div>
  39   <div id="navrow2" class="tabs2">
  40     <ul class="tablist">
  41       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  42       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  43       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  44       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  45     </ul>
  46   </div>
  47 <div id="nav-path" class="navpath">
  48   <ul>
  49 <li class="navelem"><a class="el" href="namespacexmlpp.html">xmlpp</a></li><li class="navelem"><a class="el" href="classxmlpp_1_1OutputBuffer.html">OutputBuffer</a></li>  </ul>
  50 </div>
  51 </div><!-- top -->
  52 <div class="header">
  53   <div class="summary">
  54 <a href="#pub-methods">Public Member Functions</a> &#124;
  55 <a href="classxmlpp_1_1OutputBuffer-members.html">List of all members</a>  </div>
  56   <div class="headertitle">
  57 <div class="title">xmlpp::OutputBuffer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
  58 </div><!--header-->
  59 <div class="contents">
  60
  61 <p>Base class for xmlOutputBuffer wrapper.
  62  <a href="classxmlpp_1_1OutputBuffer.html#details">More...</a></p>
  63
  64 <p><code>#include &lt;libxml++/io/outputbuffer.h&gt;</code></p>
  65 <div class="dynheader">
  66 Inheritance diagram for xmlpp::OutputBuffer:</div>
  67 <div class="dyncontent">
  68 <div class="center"><img src="classxmlpp_1_1OutputBuffer__inherit__graph.png" border="0" usemap="#xmlpp_1_1OutputBuffer_inherit__map" alt="Inheritance graph"/></div>
  69 <map name="xmlpp_1_1OutputBuffer_inherit__map" id="xmlpp_1_1OutputBuffer_inherit__map">
  70 <area shape="rect" id="node3" href="classxmlpp_1_1OStreamOutputBuffer.html" title="An OutputBuffer implementation that send datas to a std::ostream. " alt="" coords="5,155,215,181"/><area shape="rect" id="node2" href="classxmlpp_1_1NonCopyable.html" title="A base for classes which cannot be copied. " alt="" coords="33,5,187,32"/></map>
  71 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  72 <table class="memberdecls">
  73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74 Public Member Functions</h2></td></tr>
  75 <tr class="memitem:a2e00dabdec3e40b837d2b9ecb1d9fbcd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1OutputBuffer.html#a2e00dabdec3e40b837d2b9ecb1d9fbcd">OutputBuffer</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>&amp; encoding=<a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>())</td></tr>
  76 <tr class="separator:a2e00dabdec3e40b837d2b9ecb1d9fbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 <tr class="memitem:a14b8d46202a8dcfc73da8093fc45fc99"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1OutputBuffer.html#a14b8d46202a8dcfc73da8093fc45fc99">~OutputBuffer</a> () override</td></tr>
  78 <tr class="separator:a14b8d46202a8dcfc73da8093fc45fc99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:a2de0e355037956329d70b990d7bc79f5"><td class="memItemLeft" align="right" valign="top">_xmlOutputBuffer*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1OutputBuffer.html#a2de0e355037956329d70b990d7bc79f5">cobj</a> ()</td></tr>
  80 <tr class="memdesc:a2de0e355037956329d70b990d7bc79f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">gives an access to the underlying libxml structure to the children  <a href="#a2de0e355037956329d70b990d7bc79f5">More...</a><br /></td></tr>
  81 <tr class="separator:a2de0e355037956329d70b990d7bc79f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:a6dbd7fc5ab8af66e751e0209aa3a0346"><td class="memItemLeft" align="right" valign="top">const _xmlOutputBuffer*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1OutputBuffer.html#a6dbd7fc5ab8af66e751e0209aa3a0346">cobj</a> () const </td></tr>
  83 <tr class="memdesc:a6dbd7fc5ab8af66e751e0209aa3a0346"><td class="mdescLeft">&#160;</td><td class="mdescRight">gives an access to the underlying libxml structure to the children  <a href="#a6dbd7fc5ab8af66e751e0209aa3a0346">More...</a><br /></td></tr>
  84 <tr class="separator:a6dbd7fc5ab8af66e751e0209aa3a0346"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 </table><table class="memberdecls">
  86 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  87 Additional Inherited Members</h2></td></tr>
  88 <tr class="inherit_header pro_methods_classxmlpp_1_1NonCopyable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classxmlpp_1_1NonCopyable')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classxmlpp_1_1NonCopyable.html">xmlpp::NonCopyable</a></td></tr>
  89 <tr class="memitem:a77c785ff1149642caa3058f49223f112 inherit pro_methods_classxmlpp_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1NonCopyable.html#a77c785ff1149642caa3058f49223f112">NonCopyable</a> ()</td></tr>
  90 <tr class="separator:a77c785ff1149642caa3058f49223f112 inherit pro_methods_classxmlpp_1_1NonCopyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:aded750a42a8acdd5ed63827c158f7763 inherit pro_methods_classxmlpp_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1NonCopyable.html#aded750a42a8acdd5ed63827c158f7763">NonCopyable</a> (const <a class="el" href="classxmlpp_1_1NonCopyable.html">NonCopyable</a>&amp;)=delete</td></tr>
  92 <tr class="separator:aded750a42a8acdd5ed63827c158f7763 inherit pro_methods_classxmlpp_1_1NonCopyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 <tr class="memitem:a14e2e0391beb4b8f20f5d51e8a253d63 inherit pro_methods_classxmlpp_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1NonCopyable.html#a14e2e0391beb4b8f20f5d51e8a253d63">~NonCopyable</a> ()</td></tr>
  94 <tr class="separator:a14e2e0391beb4b8f20f5d51e8a253d63 inherit pro_methods_classxmlpp_1_1NonCopyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95 <tr class="memitem:adef35c286da3c2b8c90da9bb50aaddf1 inherit pro_methods_classxmlpp_1_1NonCopyable"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxmlpp_1_1NonCopyable.html">NonCopyable</a>&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1NonCopyable.html#adef35c286da3c2b8c90da9bb50aaddf1">operator=</a> (const <a class="el" href="classxmlpp_1_1NonCopyable.html">NonCopyable</a>&amp;)=delete</td></tr>
  96 <tr class="separator:adef35c286da3c2b8c90da9bb50aaddf1 inherit pro_methods_classxmlpp_1_1NonCopyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 </table>
  98 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  99 <div class="textblock"><p>Base class for xmlOutputBuffer wrapper. </p>
 100 <p>It can be derived from to create a new output buffer. A child class has to override do_write(), and possibly do_close() if some actions are required before buffer closing. </p>
 101 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 102 <a class="anchor" id="a2e00dabdec3e40b837d2b9ecb1d9fbcd"></a>
 103 <div class="memitem">
 104 <div class="memproto">
 105       <table class="memname">
 106         <tr>
 107           <td class="memname">xmlpp::OutputBuffer::OutputBuffer </td>
 108           <td>(</td>
 109           <td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&#160;</td>
 110           <td class="paramname"><em>encoding</em> = <code><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>()</code></td><td>)</td>
 111           <td></td>
 112         </tr>
 113       </table>
 114 </div><div class="memdoc">
 115 <dl class="params"><dt>Parameters</dt><dd>
 116   <table class="params">
 117     <tr><td class="paramname">encoding</td><td>The encoding that the derived class waits for in do_write. If not provided, UTF-8 will be sent to do_write.</td></tr>
 118   </table>
 119   </dd>
 120 </dl>
 121 <dl class="section warning"><dt>Warning</dt><dd>The encoding is done by libxml. As a consequence, libxml must have a translator to the target encoding. </dd></dl>
 122
 123 </div>
 124 </div>
 125 <a class="anchor" id="a14b8d46202a8dcfc73da8093fc45fc99"></a>
 126 <div class="memitem">
 127 <div class="memproto">
 128 <table class="mlabels">
 129   <tr>
 130   <td class="mlabels-left">
 131       <table class="memname">
 132         <tr>
 133           <td class="memname">xmlpp::OutputBuffer::~OutputBuffer </td>
 134           <td>(</td>
 135           <td class="paramname"></td><td>)</td>
 136           <td></td>
 137         </tr>
 138       </table>
 139   </td>
 140   <td class="mlabels-right">
 141 <span class="mlabels"><span class="mlabel">override</span></span>  </td>
 142   </tr>
 143 </table>
 144 </div><div class="memdoc">
 145
 146 </div>
 147 </div>
 148 <h2 class="groupheader">Member Function Documentation</h2>
 149 <a class="anchor" id="a2de0e355037956329d70b990d7bc79f5"></a>
 150 <div class="memitem">
 151 <div class="memproto">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname">_xmlOutputBuffer* xmlpp::OutputBuffer::cobj </td>
 155           <td>(</td>
 156           <td class="paramname"></td><td>)</td>
 157           <td></td>
 158         </tr>
 159       </table>
 160 </div><div class="memdoc">
 161
 162 <p>gives an access to the underlying libxml structure to the children </p>
 163
 164 </div>
 165 </div>
 166 <a class="anchor" id="a6dbd7fc5ab8af66e751e0209aa3a0346"></a>
 167 <div class="memitem">
 168 <div class="memproto">
 169       <table class="memname">
 170         <tr>
 171           <td class="memname">const _xmlOutputBuffer* xmlpp::OutputBuffer::cobj </td>
 172           <td>(</td>
 173           <td class="paramname"></td><td>)</td>
 174           <td> const</td>
 175         </tr>
 176       </table>
 177 </div><div class="memdoc">
 178
 179 <p>gives an access to the underlying libxml structure to the children </p>
 180
 181 </div>
 182 </div>
 183 </div><!-- contents -->
 184 <!-- start footer part -->
 185 <hr class="footer"/><address class="footer"><small>
 186 Generated on Fri Oct 30 2015 10:48:49 for libxml++ by &#160;<a href="http://www.doxygen.org/index.html">
 187 <img class="footer" src="doxygen.png" alt="doxygen"/>
 188 </a> 1.8.9.1
 189 </small></address>
 190 </body>
 191 </html>