Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / classWriter.html
blob: 744c8f57ea45d8b77a30b1f4b77a9bce2fe5e28a [file] [log] [blame]
<!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"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;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="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<h1>Writer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Writer" -->
<p><code>#include &lt;<a class="el" href="Writer_8hpp_source.html">Writer.hpp</a>&gt;</code></p>
<p>Inherited by <a class="el" href="classPrintWriter.html">PrintWriter</a>.</p>
<p><a href="classWriter-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classWriter.html#aedc04cd5fb7b4b99d3ad906fef2116ce">Writer</a> ()
<li>virtual <a class="el" href="classWriter.html#ac1805972274066158c1a739a34b3428a">~Writer</a> ()
<li>virtual void <a class="el" href="classWriter.html#aa531636ea3f757ef031a520f0e66ca4d">close</a> ()=0
<dl class="el"><dd class="mdescRight">Close the stream. <a href="#aa531636ea3f757ef031a520f0e66ca4d"></a><br/></dl><li>virtual void <a class="el" href="classWriter.html#a02fcda6a8ca6cde7a6ab35fc44152ca3">flush</a> ()=0
<dl class="el"><dd class="mdescRight">Flush the stream. <a href="#a02fcda6a8ca6cde7a6ab35fc44152ca3"></a><br/></dl><li>virtual <a class="el" href="classXalanOutputStream.html">XalanOutputStream</a> * <a class="el" href="classWriter.html#af8c79d928f5776cba0521dac796deb05">getStream</a> ()
<dl class="el"><dd class="mdescRight">Get the stream associated with the writer... <a href="#af8c79d928f5776cba0521dac796deb05"></a><br/></dl><li>virtual const <a class="el" href="classXalanOutputStream.html">XalanOutputStream</a> * <a class="el" href="classWriter.html#a0a5afae717163c1e0d802421d85b2b57">getStream</a> () const
<dl class="el"><dd class="mdescRight">Get the stream associated with the writer... <a href="#a0a5afae717163c1e0d802421d85b2b57"></a><br/></dl><li>virtual void <a class="el" href="classWriter.html#ad6453f4514a9672ab5a0dbbb9d96872b">write</a> (const char *s, size_t theOffset=0, size_t theLength=<a class="el" href="classWriter.html#aab49e26418047b730b64ecfba5e71223">npos</a>)=0
<dl class="el"><dd class="mdescRight">Writes a string. <a href="#ad6453f4514a9672ab5a0dbbb9d96872b"></a><br/></dl><li>virtual void <a class="el" href="classWriter.html#a8b6d31495e13b7ff407f06d9b44f9806">write</a> (const XalanDOMChar *s, <a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theOffset=0, <a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theLength=XalanDOMString::npos)=0
<dl class="el"><dd class="mdescRight">Writes a string. <a href="#a8b6d31495e13b7ff407f06d9b44f9806"></a><br/></dl><li>virtual void <a class="el" href="classWriter.html#acea2eb5510b4f3e87e770a75f913668e">write</a> (XalanDOMChar c)=0
<dl class="el"><dd class="mdescRight">Writes a character. <a href="#acea2eb5510b4f3e87e770a75f913668e"></a><br/></dl><li>virtual void <a class="el" href="classWriter.html#a82ae65f5875eaeef77aaa31bab1d1ab3">write</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;s, <a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theOffset=0, <a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theLength=XalanDOMString::npos)=0
<dl class="el"><dd class="mdescRight">Writes a string. <a href="#a82ae65f5875eaeef77aaa31bab1d1ab3"></a><br/></dl></ul>
<h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2>
<ul>
<li>static const size_t <a class="el" href="classWriter.html#aab49e26418047b730b64ecfba5e71223">npos</a>
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="Writer_8hpp_source.html#l00044">44</a> of file <a class="el" href="Writer_8hpp_source.html">Writer.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aedc04cd5fb7b4b99d3ad906fef2116ce"></a><!-- doxytag: member="Writer::Writer" ref="aedc04cd5fb7b4b99d3ad906fef2116ce" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Writer::Writer </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac1805972274066158c1a739a34b3428a"></a><!-- doxytag: member="Writer::~Writer" ref="ac1805972274066158c1a739a34b3428a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Writer::~Writer </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa531636ea3f757ef031a520f0e66ca4d"></a><!-- doxytag: member="Writer::close" ref="aa531636ea3f757ef031a520f0e66ca4d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Writer::close </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the stream. </p>
<p>Implemented in <a class="el" href="classDOMStringPrintWriter.html#a25126f2ebcca97129e7bcf0d4f1300d6">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a0db547939411ae764d485e4f7daed3fe">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a885fd7af875c1d6d4fb997ca5b722780">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a8db118931875265cb03a18e975f7ba0a">XalanOutputStreamPrintWriter</a>.</p>
</div>
</div>
<a class="anchor" id="a02fcda6a8ca6cde7a6ab35fc44152ca3"></a><!-- doxytag: member="Writer::flush" ref="a02fcda6a8ca6cde7a6ab35fc44152ca3" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Writer::flush </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flush the stream. </p>
<p>Implemented in <a class="el" href="classDOMStringPrintWriter.html#a745039509f76533cb5f90090c86c3f80">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#ae01cf222bf227726a332bc4d3f9aeca3">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a3fa7814aff554a8f92023b3289ece305">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a5a415f7d3811838f6972c6a67b531283">XalanOutputStreamPrintWriter</a>.</p>
</div>
</div>
<a class="anchor" id="a0a5afae717163c1e0d802421d85b2b57"></a><!-- doxytag: member="Writer::getStream" ref="a0a5afae717163c1e0d802421d85b2b57" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classXalanOutputStream.html">XalanOutputStream</a>* Writer::getStream </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the stream associated with the writer... </p>
<p>Reimplemented in <a class="el" href="classXalanOutputStreamPrintWriter.html#a0a9200c875ee0696639eae29e8d99e9c">XalanOutputStreamPrintWriter</a>.</p>
</div>
</div>
<a class="anchor" id="af8c79d928f5776cba0521dac796deb05"></a><!-- doxytag: member="Writer::getStream" ref="af8c79d928f5776cba0521dac796deb05" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXalanOutputStream.html">XalanOutputStream</a>* Writer::getStream </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the stream associated with the writer... </p>
<p>Reimplemented in <a class="el" href="classXalanOutputStreamPrintWriter.html#a83b6c23fa1f532865a5641cdffe81987">XalanOutputStreamPrintWriter</a>.</p>
</div>
</div>
<a class="anchor" id="ad6453f4514a9672ab5a0dbbb9d96872b"></a><!-- doxytag: member="Writer::write" ref="ad6453f4514a9672ab5a0dbbb9d96872b" args="(const char *s, size_t theOffset=0, size_t theLength=npos)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Writer::write </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>theOffset</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&nbsp;</td>
<td class="paramname"> <em>theLength</em> = <code><a class="el" href="classWriter.html#aab49e26418047b730b64ecfba5e71223">npos</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>string to write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theOffset</em>&nbsp;</td><td>starting offset in string to begin writing, default 0 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theLength</em>&nbsp;</td><td>number of characters to write. If the length is npos, then the array is assumed to be null-terminated. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classDOMStringPrintWriter.html#ab04df62574f7931bfb2d3203cb207c3c">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a94ba808ee9f34b9cf0405d46ed393187">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#ae0fc02f7b9884ea85fdcd65ad504ee24">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a8708f7553e80db4ed59de3fad2174602">XalanOutputStreamPrintWriter</a>.</p>
</div>
</div>
<a class="anchor" id="a82ae65f5875eaeef77aaa31bab1d1ab3"></a><!-- doxytag: member="Writer::write" ref="a82ae65f5875eaeef77aaa31bab1d1ab3" args="(const XalanDOMString &amp;s, XalanDOMString::size_type theOffset=0, XalanDOMString::size_type theLength=XalanDOMString::npos)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Writer::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a>&nbsp;</td>
<td class="paramname"> <em>theOffset</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a>&nbsp;</td>
<td class="paramname"> <em>theLength</em> = <code>XalanDOMString::npos</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>string to write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theOffset</em>&nbsp;</td><td>starting offset in string to begin writing, default 0 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theLength</em>&nbsp;</td><td>number of characters to write. If the length is <a class="el" href="classXalanDOMString.html#a738c3684088f21a02e16a8a44e525063a79a8556da86ea1ccd6630e6221c1b424">XalanDOMString::npos</a>, then the entire string is printed. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classDOMStringPrintWriter.html#abf3d53b3bc09dd8ca15536fa67e3062c">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a1cd4940fade5be4df924b6da43e73d27">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#adc5fe13a58bf77ef5f117b918e7e11c4">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#ac6b7582a3dc2d0a03fca1075ba890558">XalanOutputStreamPrintWriter</a>.</p>
</div>
</div>
<a class="anchor" id="a8b6d31495e13b7ff407f06d9b44f9806"></a><!-- doxytag: member="Writer::write" ref="a8b6d31495e13b7ff407f06d9b44f9806" args="(const XalanDOMChar *s, XalanDOMString::size_type theOffset=0, XalanDOMString::size_type theLength=XalanDOMString::npos)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Writer::write </td>
<td>(</td>
<td class="paramtype">const XalanDOMChar *&nbsp;</td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a>&nbsp;</td>
<td class="paramname"> <em>theOffset</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a>&nbsp;</td>
<td class="paramname"> <em>theLength</em> = <code>XalanDOMString::npos</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>string to write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theOffset</em>&nbsp;</td><td>starting offset in string to begin writing, default 0 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theLength</em>&nbsp;</td><td>number of characters to write. If the length is <a class="el" href="classXalanDOMString.html#a738c3684088f21a02e16a8a44e525063a79a8556da86ea1ccd6630e6221c1b424">XalanDOMString::npos</a>, then the array is assumed to be null-terminated. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classDOMStringPrintWriter.html#a884705b3231094c218c249c974457edc">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a93f84afa6ff060e27f52f191a16c08ec">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a13a15b293d23ac04515684ee20b394b2">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a2b4bac1e934ffa5ec77e04c7427d63ec">XalanOutputStreamPrintWriter</a>.</p>
</div>
</div>
<a class="anchor" id="acea2eb5510b4f3e87e770a75f913668e"></a><!-- doxytag: member="Writer::write" ref="acea2eb5510b4f3e87e770a75f913668e" args="(XalanDOMChar c)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Writer::write </td>
<td>(</td>
<td class="paramtype">XalanDOMChar&nbsp;</td>
<td class="paramname"> <em>c</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a character. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>character to write </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classDOMStringPrintWriter.html#a67e76694e4027e7a47e88c8d28a3c63a">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a1a9e395fb0e9c8b1486b076e25773ef4">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a242f519186bcc87177f97c4a0103ba88">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a5362083195d009ecac37201f01ab19cc">XalanOutputStreamPrintWriter</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aab49e26418047b730b64ecfba5e71223"></a><!-- doxytag: member="Writer::npos" ref="aab49e26418047b730b64ecfba5e71223" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const size_t <a class="el" href="classWriter.html#aab49e26418047b730b64ecfba5e71223">Writer::npos</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="Writer_8hpp_source.html#l00083">83</a> of file <a class="el" href="Writer_8hpp_source.html">Writer.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Writer_8hpp_source.html">Writer.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">GraphViz</a> are
used to generate this API documentation from the Xalan-C header files.</i></font></p>
<table border="0" cellpadding="0" cellspacing="0" width="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>