summaryrefslogtreecommitdiffstats
path: root/doc/html/qtextcodecplugin.html
blob: 4b8c1e8ac75c38deb7a8b25c5671afb2d94a0216 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/codecs/qtextcodecplugin.cpp:42 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QTextCodecPlugin Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<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>

<p>The QTextCodecPlugin class provides an abstract base for custom QTextCodec plugins.
<a href="#details">More...</a>
<p>All the functions in this class are <a href="threads.html#reentrant">reentrant</a> when Qt is built with thread support.</p>
<p><tt>#include &lt;<a href="qtextcodecplugin-h.html">qtextcodecplugin.h</a>&gt;</tt>
<p><a href="qtextcodecplugin-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QTextCodecPlugin"><b>QTextCodecPlugin</b></a> ()</li>
<li class=fn><a href="#~QTextCodecPlugin"><b>~QTextCodecPlugin</b></a> ()</li>
<li class=fn>virtual QStringList <a href="#names"><b>names</b></a> () const = 0</li>
<li class=fn>virtual QTextCodec * <a href="#createForName"><b>createForName</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;name ) = 0</li>
<li class=fn>virtual QValueList&lt;int&gt; <a href="#mibEnums"><b>mibEnums</b></a> () const = 0</li>
<li class=fn>virtual QTextCodec * <a href="#createForMib"><b>createForMib</b></a> ( int&nbsp;mib ) = 0</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QTextCodecPlugin class provides an abstract base for custom <a href="qtextcodec.html">QTextCodec</a> plugins.


<p> The text codec plugin is a simple plugin interface that makes it
easy to create custom text codecs that can be loaded dynamically
into applications.
<p> Writing a text codec plugin is achieved by subclassing this base
class, reimplementing the pure virtual functions <a href="#names">names</a>(),
<a href="#createForName">createForName</a>(), <a href="#mibEnums">mibEnums</a>() and <a href="#createForMib">createForMib</a>(), and exporting the
class with the <tt>Q_EXPORT_PLUGIN</tt> macro. See the <a href="plugins-howto.html">Qt Plugins documentation</a> for details.
<p> See the <a href="http://www.iana.org/assignments/character-sets">IANA
    character-sets encoding file</a> for more information on mime
names and mib enums.
<p>See also <a href="plugins.html">Plugins</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QTextCodecPlugin"></a>QTextCodecPlugin::QTextCodecPlugin ()
</h3>
Constructs a text codec plugin. This is invoked automatically by
the <tt>Q_EXPORT_PLUGIN</tt> macro.

<h3 class=fn><a name="~QTextCodecPlugin"></a>QTextCodecPlugin::~QTextCodecPlugin ()
</h3>
Destroys the text codec plugin.
<p> You never have to call this explicitly. Qt destroys a plugin
automatically when it is no longer used.

<h3 class=fn><a href="qtextcodec.html">QTextCodec</a>&nbsp;* <a name="createForMib"></a>QTextCodecPlugin::createForMib ( int&nbsp;mib )<tt> [pure virtual]</tt>
</h3>

<p> Creates a <a href="qtextcodec.html">QTextCodec</a> object for the mib enum <em>mib</em>.
<p> (See <a href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">the
    IANA character-sets encoding file</a> for more information)
<p> <p>See also <a href="#mibEnums">mibEnums</a>().

<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>
</h3>

<p> Creates a <a href="qtextcodec.html">QTextCodec</a> object for the codec called <em>name</em>.
<p> <p>See also <a href="#names">names</a>().

<h3 class=fn><a href="qvaluelist.html">QValueList</a>&lt;int&gt; <a name="mibEnums"></a>QTextCodecPlugin::mibEnums () const<tt> [pure virtual]</tt>
</h3>

<p> Returns the list of mib enums supported by this plugin.
<p> <p>See also <a href="#createForMib">createForMib</a>().

<h3 class=fn><a href="qstringlist.html">QStringList</a> <a name="names"></a>QTextCodecPlugin::names () const<tt> [pure virtual]</tt>
</h3>

<p> Returns the list of mime names supported by this plugin.
<p> <p>See also <a href="#createForName">createForName</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>