source: trunk/doc/html/qtextcodecplugin.html@ 203

Last change on this file since 203 was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 5.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/codecs/qtextcodecplugin.cpp:42 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QTextCodecPlugin Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QTextCodecPlugin Class Reference</h1>
33
34<p>The QTextCodecPlugin class provides an abstract base for custom QTextCodec plugins.
35<a href="#details">More...</a>
36<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when Qt is built with thread support.</p>
37<p><tt>#include &lt;<a href="qtextcodecplugin-h.html">qtextcodecplugin.h</a>&gt;</tt>
38<p><a href="qtextcodecplugin-members.html">List of all member functions.</a>
39<h2>Public Members</h2>
40<ul>
41<li class=fn><a href="#QTextCodecPlugin"><b>QTextCodecPlugin</b></a> ()</li>
42<li class=fn><a href="#~QTextCodecPlugin"><b>~QTextCodecPlugin</b></a> ()</li>
43<li class=fn>virtual QStringList <a href="#names"><b>names</b></a> () const = 0</li>
44<li class=fn>virtual QTextCodec * <a href="#createForName"><b>createForName</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;name ) = 0</li>
45<li class=fn>virtual QValueList&lt;int&gt; <a href="#mibEnums"><b>mibEnums</b></a> () const = 0</li>
46<li class=fn>virtual QTextCodec * <a href="#createForMib"><b>createForMib</b></a> ( int&nbsp;mib ) = 0</li>
47</ul>
48<hr><a name="details"></a><h2>Detailed Description</h2>
49
50
51The QTextCodecPlugin class provides an abstract base for custom <a href="qtextcodec.html">QTextCodec</a> plugins.
52
53
54<p> The text codec plugin is a simple plugin interface that makes it
55easy to create custom text codecs that can be loaded dynamically
56into applications.
57<p> Writing a text codec plugin is achieved by subclassing this base
58class, reimplementing the pure virtual functions <a href="#names">names</a>(),
59<a href="#createForName">createForName</a>(), <a href="#mibEnums">mibEnums</a>() and <a href="#createForMib">createForMib</a>(), and exporting the
60class with the <tt>Q_EXPORT_PLUGIN</tt> macro. See the <a href="plugins-howto.html">Qt Plugins documentation</a> for details.
61<p> See the <a href="http://www.iana.org/assignments/character-sets">IANA
62 character-sets encoding file</a> for more information on mime
63names and mib enums.
64<p>See also <a href="plugins.html">Plugins</a>.
65
66<hr><h2>Member Function Documentation</h2>
67<h3 class=fn><a name="QTextCodecPlugin"></a>QTextCodecPlugin::QTextCodecPlugin ()
68</h3>
69Constructs a text codec plugin. This is invoked automatically by
70the <tt>Q_EXPORT_PLUGIN</tt> macro.
71
72<h3 class=fn><a name="~QTextCodecPlugin"></a>QTextCodecPlugin::~QTextCodecPlugin ()
73</h3>
74Destroys the text codec plugin.
75<p> You never have to call this explicitly. Qt destroys a plugin
76automatically when it is no longer used.
77
78<h3 class=fn><a href="qtextcodec.html">QTextCodec</a>&nbsp;* <a name="createForMib"></a>QTextCodecPlugin::createForMib ( int&nbsp;mib )<tt> [pure virtual]</tt>
79</h3>
80
81<p> Creates a <a href="qtextcodec.html">QTextCodec</a> object for the mib enum <em>mib</em>.
82<p> (See <a href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">the
83 IANA character-sets encoding file</a> for more information)
84<p> <p>See also <a href="#mibEnums">mibEnums</a>().
85
86<h3 class=fn><a href="qtextcodec.html">QTextCodec</a>&nbsp;* <a name="createForName"></a>QTextCodecPlugin::createForName ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;name )<tt> [pure virtual]</tt>
87</h3>
88
89<p> Creates a <a href="qtextcodec.html">QTextCodec</a> object for the codec called <em>name</em>.
90<p> <p>See also <a href="#names">names</a>().
91
92<h3 class=fn><a href="qvaluelist.html">QValueList</a>&lt;int&gt; <a name="mibEnums"></a>QTextCodecPlugin::mibEnums () const<tt> [pure virtual]</tt>
93</h3>
94
95<p> Returns the list of mib enums supported by this plugin.
96<p> <p>See also <a href="#createForMib">createForMib</a>().
97
98<h3 class=fn><a href="qstringlist.html">QStringList</a> <a name="names"></a>QTextCodecPlugin::names () const<tt> [pure virtual]</tt>
99</h3>
100
101<p> Returns the list of mime names supported by this plugin.
102<p> <p>See also <a href="#createForName">createForName</a>().
103
104<!-- eof -->
105<hr><p>
106This file is part of the <a href="index.html">Qt toolkit</a>.
107Copyright &copy; 1995-2007
108<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
109<table width=100% cellspacing=0 border=0><tr>
110<td>Copyright &copy; 2007
111<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
112<td align=right><div align=right>Qt 3.3.8</div>
113</table></div></address></body>
114</html>
Note: See TracBrowser for help on using the repository browser.