Google Git
Sign in
apache / xalan-site / fc63e1a05362d8a54765634eed15aec345e1ef1d / . / content / old / xalan-c / apiDocs / classWriter.html
blob: 3667b1836c4290cd475bd9fcd233fd33e22449b1 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>Writer Class Reference</h1><code>#include &lt;<a class="el" href="Writer_8hpp-source.html">Writer.hpp</a>&gt;</code>
<p>
Inheritance diagram for Writer:<p><center><img src="classWriter__inherit__graph.gif" border="0" usemap="#Writer_inherit_map" alt="Inheritance graph"></center>
<map name="Writer_inherit_map">
<area href="classPrintWriter.html" shape="rect" coords="189,117,269,93">
<area href="classDOMStringPrintWriter.html" shape="rect" coords="7,192,153,168">
<area href="classNullPrintWriter.html" shape="rect" coords="177,192,281,168">
<area href="classXalanOutputStreamPrintWriter.html" shape="rect" coords="305,192,502,168">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classWriter-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classWriter.html#a0">Writer</a> ()
<li>virtual <a class="el" href="classWriter.html#a1">~Writer</a> ()
<li>virtual void <a class="el" href="classWriter.html#a2">close</a> ()=0
<dl class="el"><dd><font size=-1><em>Close the stream.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classWriter.html#a3">flush</a> ()=0
<dl class="el"><dd><font size=-1><em>Flush the stream.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXalanOutputStream.html">XalanOutputStream</a>* <a class="el" href="classWriter.html#a4">getStream</a> ()
<dl class="el"><dd><font size=-1><em>Get the stream associated with the writer...</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>virtual const <a class="el" href="classXalanOutputStream.html">XalanOutputStream</a>* <a class="el" href="classWriter.html#a5">getStream</a> () const
<dl class="el"><dd><font size=-1><em>Get the stream associated with the writer...</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classWriter.html#a6">write</a> (const char *s, size_t theOffset=0, size_t theLength=<a class="el" href="classWriter.html#p0">npos</a>)=0
<dl class="el"><dd><font size=-1><em>Writes a string.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classWriter.html#a7">write</a> (const XalanDOMChar *s, <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> theOffset=0, <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> theLength=XalanDOMString::npos)=0
<dl class="el"><dd><font size=-1><em>Writes a string.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classWriter.html#a8">write</a> (XalanDOMChar c)=0
<dl class="el"><dd><font size=-1><em>Writes a character.</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classWriter.html#a9">write</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;s, <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> theOffset=0, <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> theLength=XalanDOMString::npos)=0
<dl class="el"><dd><font size=-1><em>Writes a string.</em> <a href="#a9">More...</a><em><br><br></em></font></dl></ul>
<h2>Static Public Attributes</h2>
<ul>
<li>const size_t <a class="el" href="classWriter.html#p0">npos</a>
</ul>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="Writer::Writer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Writer::Writer (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="Writer::~Writer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
Writer::~Writer (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="Writer::close"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void Writer::close (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Close the stream.
<p>
<p>
Reimplemented in <a class="el" href="classDOMStringPrintWriter.html#a5">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a3">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a4">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a3">XalanOutputStreamPrintWriter</a>. </td>
</tr>
</table>
<a name="a3" doxytag="Writer::flush"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void Writer::flush (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Flush the stream.
<p>
<p>
Reimplemented in <a class="el" href="classDOMStringPrintWriter.html#a6">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a4">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a5">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a4">XalanOutputStreamPrintWriter</a>. </td>
</tr>
</table>
<a name="a5" doxytag="Writer::getStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanOutputStream.html">XalanOutputStream</a> * Writer::getStream (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the stream associated with the writer...
<p>
<p>
Reimplemented in <a class="el" href="classXalanOutputStreamPrintWriter.html#a6">XalanOutputStreamPrintWriter</a>. </td>
</tr>
</table>
<a name="a4" doxytag="Writer::getStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="classXalanOutputStream.html">XalanOutputStream</a> * Writer::getStream (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the stream associated with the writer...
<p>
<p>
Reimplemented in <a class="el" href="classXalanOutputStreamPrintWriter.html#a5">XalanOutputStreamPrintWriter</a>. </td>
</tr>
</table>
<a name="a9" doxytag="Writer::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void Writer::write (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>s</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <em>theOffset</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <em>theLength</em> = XalanDOMString::npos&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Writes a string.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>s</em>
&nbsp;</td><td>
string to write </td></tr>
<tr><td valign=top><em>theOffset</em>
&nbsp;</td><td>
starting offset in string to begin writing, default 0 </td></tr>
<tr><td valign=top><em>theLength</em>
&nbsp;</td><td>
number of characters to write. If the length is <a class="el" href="classXalanDOMString.html#s12s11">XalanDOMString::npos</a>, then the entire string is printed. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classDOMStringPrintWriter.html#a10">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a8">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a9">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a10">XalanOutputStreamPrintWriter</a>. </td>
</tr>
</table>
<a name="a8" doxytag="Writer::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void Writer::write (
</b></td>
<td valign="bottom"><b>
XalanDOMChar <em>c</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Writes a character.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>c</em>
&nbsp;</td><td>
character to write </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classDOMStringPrintWriter.html#a9">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a7">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a8">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a9">XalanOutputStreamPrintWriter</a>. </td>
</tr>
</table>
<a name="a7" doxytag="Writer::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void Writer::write (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>s</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <em>theOffset</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <em>theLength</em> = XalanDOMString::npos&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Writes a string.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>s</em>
&nbsp;</td><td>
string to write </td></tr>
<tr><td valign=top><em>theOffset</em>
&nbsp;</td><td>
starting offset in string to begin writing, default 0 </td></tr>
<tr><td valign=top><em>theLength</em>
&nbsp;</td><td>
number of characters to write. If the length is <a class="el" href="classXalanDOMString.html#s12s11">XalanDOMString::npos</a>, then the array is assumed to be null-terminated. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classDOMStringPrintWriter.html#a8">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a6">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a7">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a8">XalanOutputStreamPrintWriter</a>. </td>
</tr>
</table>
<a name="a6" doxytag="Writer::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void Writer::write (
</b></td>
<td valign="bottom"><b>
const char * <em>s</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
size_t <em>theOffset</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
size_t <em>theLength</em> = <a class="el" href="classWriter.html#p0">npos</a>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Writes a string.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>s</em>
&nbsp;</td><td>
string to write </td></tr>
<tr><td valign=top><em>theOffset</em>
&nbsp;</td><td>
starting offset in string to begin writing, default 0 </td></tr>
<tr><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>
</dl>
<p>
Reimplemented in <a class="el" href="classDOMStringPrintWriter.html#a7">DOMStringPrintWriter</a>, <a class="el" href="classNullPrintWriter.html#a5">NullPrintWriter</a>, <a class="el" href="classPrintWriter.html#a6">PrintWriter</a>, and <a class="el" href="classXalanOutputStreamPrintWriter.html#a7">XalanOutputStreamPrintWriter</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="p0" doxytag="Writer::npos"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const size_t Writer::npos<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<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></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">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="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<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.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>