<html>
<head>
<link rel="stylesheet" href="page.css" type="text/css">
<title>fox-toolkit.org - Documentation</title>
</head>
<body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000>
<font face='verdana,sans-serif' size=2 >
<!---- TOPIC TITLE WITH LOGO--->
<table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a>
<br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table>
<p>
<!--- TOPIC TITLE WITH LOGO --->
<!-- Generated by Doxygen 1.3.3 -->
<h1>FX::FXUTF16Codec Class Reference</h1>Codec for UTF-16.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="FXUTF16Codec_8h-source.html">FXUTF16Codec.h</a>></code>
<p>
<p>Inheritance diagram for FX::FXUTF16Codec:
<p><center><img src="classFX_1_1FXUTF16Codec.png" usemap="#FX::FXUTF16Codec_map" border="0" alt=""></center>
<map name="FX::FXUTF16Codec_map">
<area href="classFX_1_1FXTextCodec.html" alt="FX::FXTextCodec" shape="rect" coords="0,0,126,24">
</map>
<a href="classFX_1_1FXUTF16Codec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXUTF16Codec.html#a0">FXUTF16Codec</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXUTF16Codec.html#a1">fromUnicode</a> (FXuchar *&dest, unsigned long m, const FXwchar *&src, unsigned long n)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXUTF16Codec.html#a2">insertBOM</a> (FXuchar *&dest, unsigned long m)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXUTF16Codec.html#a3">toUnicode</a> (FXwchar *&dest, unsigned long m, const FXuchar *&src, unsigned long n)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const FXchar * </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXUTF16Codec.html#a4">mimeName</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual FXint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXUTF16Codec.html#a5">mibEnum</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXUTF16Codec.html#a6">~FXUTF16Codec</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Codec for UTF-16.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="FX::FXUTF16Codec::FXUTF16Codec"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FX::FXUTF16Codec::FXUTF16Codec </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor.
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="FX::FXUTF16Codec::~FXUTF16Codec"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual FX::FXUTF16Codec::~<a class="el" href="classFX_1_1FXUTF16Codec.html">FXUTF16Codec</a> </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a1" doxytag="FX::FXUTF16Codec::fromUnicode"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual unsigned long FX::FXUTF16Codec::fromUnicode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">FXuchar *& </td>
<td class="mdname" nowrap> <em>dest</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned long </td>
<td class="mdname" nowrap> <em>m</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const FXwchar *& </td>
<td class="mdname" nowrap> <em>src</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned long </td>
<td class="mdname" nowrap> <em>n</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Convert a sequence of wide characters from Unicode to UTF-16.
<p>
Reads at most n wide characters from src and writes at most m bytes into dest. Returns the number of characters actually written into dest.<p>
On exit, the src and dest pointers are updated to point to the next available character (or byte) for reading (writing).
<p>
Implements <a class="el" href="classFX_1_1FXTextCodec.html#a0">FX::FXTextCodec</a>. </td>
</tr>
</table>
<a name="a2" doxytag="FX::FXUTF16Codec::insertBOM"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned long FX::FXUTF16Codec::insertBOM </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">FXuchar *& </td>
<td class="mdname" nowrap> <em>dest</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned long </td>
<td class="mdname" nowrap> <em>m</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Insert byte-order mark (BOM) into the stream.
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="FX::FXUTF16Codec::toUnicode"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual unsigned long FX::FXUTF16Codec::toUnicode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">FXwchar *& </td>
<td class="mdname" nowrap> <em>dest</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned long </td>
<td class="mdname" nowrap> <em>m</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const FXuchar *& </td>
<td class="mdname" nowrap> <em>src</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned long </td>
<td class="mdname" nowrap> <em>n</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Convert a sequence of bytes in UTF-16 encoding to a sequence of wide characters (Unicode).
<p>
Reads at most n bytes from src and writes at most m characters into dest. Returns the number of characters actually read from src.<p>
On exit, the src and dest pointers are updated to point to the next available byte (or character) for writing (reading).
<p>
Implements <a class="el" href="classFX_1_1FXTextCodec.html#a1">FX::FXTextCodec</a>. </td>
</tr>
</table>
<a name="a4" doxytag="FX::FXUTF16Codec::mimeName"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual const FXchar* FX::FXUTF16Codec::mimeName </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the IANA mime name for this codec.
<p>
<p>
Implements <a class="el" href="classFX_1_1FXTextCodec.html#a2">FX::FXTextCodec</a>. </td>
</tr>
</table>
<a name="a5" doxytag="FX::FXUTF16Codec::mibEnum"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual FXint FX::FXUTF16Codec::mibEnum </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the Management Information Base (MIBenum) for the character set.
<p>
<p>
Implements <a class="el" href="classFX_1_1FXTextCodec.html#a3">FX::FXTextCodec</a>. </td>
</tr>
</table>
</font>
<!--- COPYRIGHT -->
<p>
<table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right>
<img src='../art/line.gif' width=100% height=1><font size=-1>
Copyright © 1997-2004 Jeroen van der Zijp</font>
</td></tr></table>
</p>
<!--- COPYRIGHT -->
</body>
</html>
