Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / classXalanOutputTranscoder.html
blob: 3048835f9aa55d7dc53904eaee5e65122116e611 [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>XalanOutputTranscoder Class Reference</h1><code>#include &lt;<a class="el" href="XalanTranscodingServices_8hpp-source.html">XalanTranscodingServices.hpp</a>&gt;</code>
<p>
Inheritance diagram for XalanOutputTranscoder:<p><center><img src="classXalanOutputTranscoder__inherit__graph.gif" border="0" usemap="#XalanOutputTranscoder_inherit_map" alt="Inheritance graph"></center>
<map name="XalanOutputTranscoder_inherit_map">
<area href="classXalanUTF16Transcoder.html" shape="rect" coords="6,117,164,93">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXalanOutputTranscoder-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef XalanTranscodingServices::XalanXMLByte <a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a>
<li>typedef XalanTranscodingServices::eCode <a class="el" href="classXalanOutputTranscoder.html#s1">eCode</a>
<li>typedef XalanTranscodingServices::size_type <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a>
<li>typedef XalanTranscodingServices::UnicodeCharType <a class="el" href="classXalanOutputTranscoder.html#s3">UnicodeCharType</a>
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXalanOutputTranscoder.html#a0">XalanOutputTranscoder</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager)
<li>virtual <a class="el" href="classXalanOutputTranscoder.html#a1">~XalanOutputTranscoder</a> ()
<li><a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a>&amp; <a class="el" href="classXalanOutputTranscoder.html#a2">getMemoryManager</a> ()
<li>virtual <a class="el" href="classXalanOutputTranscoder.html#s1">eCode</a> <a class="el" href="classXalanOutputTranscoder.html#a3">transcode</a> (const XalanDOMChar *theSourceData, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> theSourceCount, <a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a> *theTarget, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> theTargetSize, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp;theSourceCharsTranscoded, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp;theTargetBytesUsed)=0
<dl class="el"><dd><font size=-1><em>Transcode data from UTF-16 to the transcoder's encoding.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXalanOutputTranscoder.html#s1">eCode</a> <a class="el" href="classXalanOutputTranscoder.html#a4">transcode</a> (const <a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a> *theSourceData, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> theSourceCount, XalanDOMChar *theTarget, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> theTargetSize, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp;theSourceCharsTranscoded, <a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp;theTargetBytesUsed, unsigned char *theCharSizes)=0
<dl class="el"><dd><font size=-1><em>Transcode data from the transcoder's encoding to UTF-16.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classXalanOutputTranscoder.html#a5">canTranscodeTo</a> (<a class="el" href="classXalanOutputTranscoder.html#s3">UnicodeCharType</a> theChar) const=0
</ul>
<hr><h2>Member Typedef Documentation</h2>
<a name="s3" doxytag="XalanOutputTranscoder::UnicodeCharType"></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>
typedef XalanTranscodingServices::UnicodeCharType XalanOutputTranscoder::UnicodeCharType
</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="s0" doxytag="XalanOutputTranscoder::XalanXMLByte"></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>
typedef XalanTranscodingServices::XalanXMLByte XalanOutputTranscoder::XalanXMLByte
</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="s1" doxytag="XalanOutputTranscoder::eCode"></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>
typedef XalanTranscodingServices::eCode XalanOutputTranscoder::eCode
</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="s2" doxytag="XalanOutputTranscoder::size_type"></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>
typedef XalanTranscodingServices::size_type XalanOutputTranscoder::size_type
</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>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XalanOutputTranscoder::XalanOutputTranscoder"></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>
XalanOutputTranscoder::XalanOutputTranscoder (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>&nbsp;)<code> [explicit]</code>
</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="XalanOutputTranscoder::~XalanOutputTranscoder"></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>
XalanOutputTranscoder::~XalanOutputTranscoder (
</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="a5" doxytag="XalanOutputTranscoder::canTranscodeTo"></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>
bool XalanOutputTranscoder::canTranscodeTo (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanOutputTranscoder.html#s3">UnicodeCharType</a> <em>theChar</em>&nbsp;) const<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classXalanUTF16Transcoder.html#a4">XalanUTF16Transcoder</a>. </td>
</tr>
</table>
<a name="a2" doxytag="XalanOutputTranscoder::getMemoryManager"></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="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; XalanOutputTranscoder::getMemoryManager (
</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="a4" doxytag="XalanOutputTranscoder::transcode"></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="classXalanOutputTranscoder.html#s1">eCode</a> XalanOutputTranscoder::transcode (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a> * <em>theSourceData</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> <em>theSourceCount</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
XalanDOMChar * <em>theTarget</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> <em>theTargetSize</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp; <em>theSourceCharsTranscoded</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp; <em>theTargetBytesUsed</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned char * <em>theCharSizes</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>
Transcode data from the transcoder's encoding to UTF-16.
<p>
If successfull, theResult will be set to OK. If not, it will be set to one of the other codes.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theSourceData</em>
&nbsp;</td><td>
The source data to transcode </td></tr>
<tr><td valign=top><em>theSourceCount</em>
&nbsp;</td><td>
The length of the source data. </td></tr>
<tr><td valign=top><em>theTarget</em>
&nbsp;</td><td>
The target array for storing the transcoded data. </td></tr>
<tr><td valign=top><em>theTargetSize</em>
&nbsp;</td><td>
The number of characters that can be stored in the target. </td></tr>
<tr><td valign=top><em>theSourceCharsTranscoded</em>
&nbsp;</td><td>
The count of the source characters that were transcoded. </td></tr>
<tr><td valign=top><em>theTargetBytesUsed</em>
&nbsp;</td><td>
The number of characters stored in the target array </td></tr>
<tr><td valign=top><em>theCharSizes</em>
&nbsp;</td><td>
For each character in theTarget, the number of characters consumed from theSourceData. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
The result code. </dl>
<p>
Reimplemented in <a class="el" href="classXalanUTF16Transcoder.html#a3">XalanUTF16Transcoder</a>. </td>
</tr>
</table>
<a name="a3" doxytag="XalanOutputTranscoder::transcode"></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="classXalanOutputTranscoder.html#s1">eCode</a> XalanOutputTranscoder::transcode (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>theSourceData</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> <em>theSourceCount</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s0">XalanXMLByte</a> * <em>theTarget</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> <em>theTargetSize</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp; <em>theSourceCharsTranscoded</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputTranscoder.html#s2">size_type</a> &amp; <em>theTargetBytesUsed</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>
Transcode data from UTF-16 to the transcoder's encoding.
<p>
If successfull, theResult will be set to OK. If not, it will be set to one of the other codes.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theSourceData</em>
&nbsp;</td><td>
The source data to transcode </td></tr>
<tr><td valign=top><em>theSourceCount</em>
&nbsp;</td><td>
The length of the source data. </td></tr>
<tr><td valign=top><em>theTarget</em>
&nbsp;</td><td>
The target array for storing the transcoded data. </td></tr>
<tr><td valign=top><em>theTargetSize</em>
&nbsp;</td><td>
The number of characters that can be stored in the target. </td></tr>
<tr><td valign=top><em>theSourceCharsTranscoded</em>
&nbsp;</td><td>
The count of the source characters that were transcoded. </td></tr>
<tr><td valign=top><em>theTargetBytesUsed</em>
&nbsp;</td><td>
The number of characters stored in the target array </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
The result code. </dl>
<p>
Reimplemented in <a class="el" href="classXalanUTF16Transcoder.html#a2">XalanUTF16Transcoder</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanTranscodingServices_8hpp-source.html">XalanTranscodingServices.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>