<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>FXTextCodec.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* U n i c o d e T e x t C o d e c *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 2002,2004 by Lyle Johnson. All Rights Reserved. *</span>
00007 <span class="comment">*********************************************************************************</span>
00008 <span class="comment">* This library is free software; you can redistribute it and/or *</span>
00009 <span class="comment">* modify it under the terms of the GNU Lesser General Public *</span>
00010 <span class="comment">* License as published by the Free Software Foundation; either *</span>
00011 <span class="comment">* version 2.1 of the License, or (at your option) any later version. *</span>
00012 <span class="comment">* *</span>
00013 <span class="comment">* This library is distributed in the hope that it will be useful, *</span>
00014 <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
00015 <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span>
00016 <span class="comment">* Lesser General Public License for more details. *</span>
00017 <span class="comment">* *</span>
00018 <span class="comment">* You should have received a copy of the GNU Lesser General Public *</span>
00019 <span class="comment">* License along with this library; if not, write to the Free Software *</span>
00020 <span class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *</span>
00021 <span class="comment">*********************************************************************************</span>
00022 <span class="comment">* $Id: FXTextCodec.h,v 1.7 2004/02/08 17:17:34 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXTEXTCODEC_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXTEXTCODEC_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="comment"></span>
00028 <span class="comment">////////////////////////////// UNDER DEVELOPMENT //////////////////////////////</span>
00029 <span class="comment"></span>
00030
00031 <span class="keyword">namespace </span>FX {
00032
00033 <span class="keyword">class </span>FXTextCodecDict;
00034 <span class="comment"></span>
00035 <span class="comment">/**</span>
00036 <span class="comment"> * Abstract base class for a stateless coder/decoder.</span>
00037 <span class="comment"> */</span>
<a name="l00038"></a><a class="code" href="classFX_1_1FXTextCodec.html">00038</a> <span class="keyword">class </span><a class="code" href="classFX_1_1FXTextCodec.html">FXTextCodec</a> {
00039 <span class="keyword">protected</span>:
00040 <span class="keyword">static</span> FXTextCodecDict* codecs;
00041 <span class="keyword">protected</span>:
00042 <a class="code" href="classFX_1_1FXTextCodec.html">FXTextCodec</a>(){}
00043 <span class="keyword">public</span>:
00044 <span class="comment"></span>
00045 <span class="comment"> /**</span>
00046 <span class="comment"> * Convert a sequence of wide characters from Unicode to the specified</span>
00047 <span class="comment"> * 8-bit encoding. Reads at most n wide characters from src and writes</span>
00048 <span class="comment"> * at most m bytes into dest. Returns the number of characters actually</span>
00049 <span class="comment"> * written into dest.</span>
00050 <span class="comment"> *</span>
00051 <span class="comment"> * On exit, the src and dest pointers are updated to point to the next</span>
00052 <span class="comment"> * available character (or byte) for reading (writing).</span>
00053 <span class="comment"> */</span>
00054 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classFX_1_1FXTextCodec.html#a0">fromUnicode</a>(FXuchar*& dest,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m,<span class="keyword">const</span> FXwchar*& src,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n) = 0;
00055 <span class="comment"></span>
00056 <span class="comment"> /**</span>
00057 <span class="comment"> * Convert a sequence of bytes in some 8-bit encoding to a sequence</span>
00058 <span class="comment"> * of wide characters (Unicode). Reads at most n bytes from src and</span>
00059 <span class="comment"> * writes at most m characters into dest. Returns the number of characters</span>
00060 <span class="comment"> * actually read from src.</span>
00061 <span class="comment"> *</span>
00062 <span class="comment"> * On exit, the src and dest pointers are updated to point to the next</span>
00063 <span class="comment"> * available byte (or character) for writing (reading).</span>
00064 <span class="comment"> */</span>
00065 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classFX_1_1FXTextCodec.html#a1">toUnicode</a>(FXwchar*& dest,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m,<span class="keyword">const</span> FXuchar*& src,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n) = 0;
00066 <span class="comment"></span>
00067 <span class="comment"> /**</span>
00068 <span class="comment"> * Return the IANA mime name for this codec; this is used for example</span>
00069 <span class="comment"> * as "text/utf-8" in drag and drop protocols.</span>
00070 <span class="comment"> */</span>
00071 <span class="keyword">virtual</span> <span class="keyword">const</span> FXchar* <a class="code" href="classFX_1_1FXTextCodec.html#a2">mimeName</a>() <span class="keyword">const</span> = 0;
00072 <span class="comment"></span>
00073 <span class="comment"> /**</span>
00074 <span class="comment"> * Return the Management Information Base (MIBenum) for the character set.</span>
00075 <span class="comment"> */</span>
00076 <span class="keyword">virtual</span> FXint <a class="code" href="classFX_1_1FXTextCodec.html#a3">mibEnum</a>() <span class="keyword">const</span> = 0;
00077 <span class="comment"></span>
00078 <span class="comment"> /**</span>
00079 <span class="comment"> * Register codec with this name. Returns FALSE if a different codec</span>
00080 <span class="comment"> * has already been registered with this name, otherwise TRUE.</span>
00081 <span class="comment"> */</span>
00082 <span class="keyword">static</span> FXbool <a class="code" href="classFX_1_1FXTextCodec.html#e0">registerCodec</a>(<span class="keyword">const</span> FXchar* name,<a class="code" href="classFX_1_1FXTextCodec.html">FXTextCodec</a>* codec);
00083 <span class="comment"></span>
<a name="l00084"></a><a class="code" href="classFX_1_1FXTextCodec.html#a4">00084</a> <span class="comment"> /// Return the codec associated with this name (or NULL if no match is found)</span>
00085 <span class="comment"></span> <span class="keyword">static</span> <a class="code" href="classFX_1_1FXTextCodec.html">FXTextCodec</a>* <a class="code" href="classFX_1_1FXTextCodec.html#e1">codecForName</a>(<span class="keyword">const</span> FXchar* name);
00086 <span class="comment"></span>
00087 <span class="comment"> /// Destructor</span>
00088 <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classFX_1_1FXTextCodec.html#a4">~FXTextCodec</a>(){}
00089 };
00090
00091 }
00092
00093 <span class="preprocessor">#endif</span>
</pre></div></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>
