<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::FXTextCodec Class Reference</h1>Abstract base class for a stateless coder/decoder. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="FXTextCodec_8h-source.html">FXTextCodec.h</a>></code> <p> <p>Inheritance diagram for FX::FXTextCodec: <p><center><img src="classFX_1_1FXTextCodec.png" usemap="#FX::FXTextCodec_map" border="0" alt=""></center> <map name="FX::FXTextCodec_map"> <area href="classFX_1_1FXUTF16Codec.html" alt="FX::FXUTF16Codec" shape="rect" coords="0,56,126,80"> <area href="classFX_1_1FXUTF32Codec.html" alt="FX::FXUTF32Codec" shape="rect" coords="136,56,262,80"> <area href="classFX_1_1FXUTF8Codec.html" alt="FX::FXUTF8Codec" shape="rect" coords="272,56,398,80"> </map> <a href="classFX_1_1FXTextCodec-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>virtual unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXTextCodec.html#a0">fromUnicode</a> (FXuchar *&dest, unsigned long m, const FXwchar *&src, unsigned long n)=0</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_1FXTextCodec.html#a1">toUnicode</a> (FXwchar *&dest, unsigned long m, const FXuchar *&src, unsigned long n)=0</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_1FXTextCodec.html#a2">mimeName</a> () const=0</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_1FXTextCodec.html#a3">mibEnum</a> () const=0</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXTextCodec.html#a4">~FXTextCodec</a> ()</td></tr> <tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXbool </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXTextCodec.html#e0">registerCodec</a> (const FXchar *name, <a class="el" href="classFX_1_1FXTextCodec.html">FXTextCodec</a> *codec)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classFX_1_1FXTextCodec.html">FXTextCodec</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXTextCodec.html#e1">codecForName</a> (const FXchar *name)</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Abstract base class for a stateless coder/decoder. <p> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a4" doxytag="FX::FXTextCodec::~FXTextCodec"></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::FXTextCodec::~<a class="el" href="classFX_1_1FXTextCodec.html">FXTextCodec</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="a0" doxytag="FX::FXTextCodec::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::FXTextCodec::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> [pure 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 the specified 8-bit encoding. <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> Implemented in <a class="el" href="classFX_1_1FXUTF16Codec.html#a1">FX::FXUTF16Codec</a>, <a class="el" href="classFX_1_1FXUTF32Codec.html#a1">FX::FXUTF32Codec</a>, and <a class="el" href="classFX_1_1FXUTF8Codec.html#a1">FX::FXUTF8Codec</a>. </td> </tr> </table> <a name="a1" doxytag="FX::FXTextCodec::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::FXTextCodec::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> [pure 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 some 8-bit 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> Implemented in <a class="el" href="classFX_1_1FXUTF16Codec.html#a3">FX::FXUTF16Codec</a>, <a class="el" href="classFX_1_1FXUTF32Codec.html#a2">FX::FXUTF32Codec</a>, and <a class="el" href="classFX_1_1FXUTF8Codec.html#a2">FX::FXUTF8Codec</a>. </td> </tr> </table> <a name="a2" doxytag="FX::FXTextCodec::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::FXTextCodec::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> [pure 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; this is used for example as "text/utf-8" in drag and drop protocols. <p> <p> Implemented in <a class="el" href="classFX_1_1FXUTF16Codec.html#a4">FX::FXUTF16Codec</a>, <a class="el" href="classFX_1_1FXUTF32Codec.html#a3">FX::FXUTF32Codec</a>, and <a class="el" href="classFX_1_1FXUTF8Codec.html#a3">FX::FXUTF8Codec</a>. </td> </tr> </table> <a name="a3" doxytag="FX::FXTextCodec::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::FXTextCodec::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> [pure 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> Implemented in <a class="el" href="classFX_1_1FXUTF16Codec.html#a5">FX::FXUTF16Codec</a>, <a class="el" href="classFX_1_1FXUTF32Codec.html#a4">FX::FXUTF32Codec</a>, and <a class="el" href="classFX_1_1FXUTF8Codec.html#a4">FX::FXUTF8Codec</a>. </td> </tr> </table> <a name="e0" doxytag="FX::FXTextCodec::registerCodec"></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"> FXbool FX::FXTextCodec::registerCodec </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const FXchar * </td> <td class="mdname" nowrap> <em>name</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classFX_1_1FXTextCodec.html">FXTextCodec</a> * </td> <td class="mdname" nowrap> <em>codec</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Register codec with this name. <p> Returns FALSE if a different codec has already been registered with this name, otherwise TRUE. </td> </tr> </table> <a name="e1" doxytag="FX::FXTextCodec::codecForName"></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"> <a class="el" href="classFX_1_1FXTextCodec.html">FXTextCodec</a>* FX::FXTextCodec::codecForName </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const FXchar * </td> <td class="mdname1" valign="top" nowrap> <em>name</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return the codec associated with this name (or NULL if no match is found). <p> </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>