<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <!-- qtextcodecplugin.cpp --> <head> <title>Qt 4.6: QTextCodecPlugin Class Reference</title> <link href="classic.css" rel="stylesheet" type="text/css" /> </head> <body> <a name="//apple_ref/cpp/cl//QTextCodecPlugin"></a> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td> <td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <a href="overviews.html"><font color="#004faf">Overviews</font></a></td></tr></table><h1 class="title">QTextCodecPlugin Class Reference<br /><span class="small-subtitle">[<a href="qtcore.html">QtCore</a> module]</span> </h1> <p>The QTextCodecPlugin class provides an abstract base for custom <a href="qtextcodec.html">QTextCodec</a> plugins. <a href="#details">More...</a></p> <pre> #include <QTextCodecPlugin></pre><p>Inherits <a href="qobject.html">QObject</a>.</p> <p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p> <ul> <li><a href="qtextcodecplugin-members.html">List of all members, including inherited members</a></li> </ul> <hr /> <a name="public-functions"></a> <h2>Public Functions</h2> <table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> <tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtextcodecplugin.html#QTextCodecPlugin">QTextCodecPlugin</a></b> ( QObject * <i>parent</i> = 0 )</td></tr> <tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qtextcodecplugin.html#dtor.QTextCodecPlugin">~QTextCodecPlugin</a></b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual QList<QByteArray> </td><td class="memItemRight" valign="bottom"><b><a href="qtextcodecplugin.html#aliases">aliases</a></b> () const = 0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual QTextCodec * </td><td class="memItemRight" valign="bottom"><b><a href="qtextcodecplugin.html#createForMib">createForMib</a></b> ( int <i>mib</i> ) = 0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual QTextCodec * </td><td class="memItemRight" valign="bottom"><b><a href="qtextcodecplugin.html#createForName">createForName</a></b> ( const QByteArray & <i>name</i> ) = 0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual QList<int> </td><td class="memItemRight" valign="bottom"><b><a href="qtextcodecplugin.html#mibEnums">mibEnums</a></b> () const = 0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual QList<QByteArray> </td><td class="memItemRight" valign="bottom"><b><a href="qtextcodecplugin.html#names">names</a></b> () const = 0</td></tr> </table> <ul> <li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li><div class="fn"></div>1 property inherited from <a href="qobject.html#properties">QObject</a></li> <li><div class="fn"></div>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li> <li><div class="fn"></div>1 signal inherited from <a href="qobject.html#signals">QObject</a></li> <li><div class="fn"></div>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li> <li><div class="fn"></div>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> </ul> <a name="details"></a> <hr /> <h2>Detailed Description</h2> <p>The QTextCodecPlugin class provides an abstract base for custom <a href="qtextcodec.html">QTextCodec</a> plugins.</p> <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> <p>Writing a text codec plugin is achieved by subclassing this base class, reimplementing the pure virtual functions <a href="qtextcodecplugin.html#names">names</a>(), <a href="qtextcodecplugin.html#aliases">aliases</a>(), <a href="qtextcodecplugin.html#createForName">createForName</a>(), <a href="qtextcodecplugin.html#mibEnums">mibEnums</a>() and <a href="qtextcodecplugin.html#createForMib">createForMib</a>(), and exporting the class with the <a href="qtplugin.html#Q_EXPORT_PLUGIN2">Q_EXPORT_PLUGIN2</a>() macro. See <a href="plugins-howto.html">How to Create Qt Plugins</a> for details.</p> <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> <hr /> <h2>Member Function Documentation</h2> <a name="//apple_ref/cpp/instm/QTextCodecPlugin/QTextCodecPlugin"></a> <h3 class="fn"><a name="QTextCodecPlugin"></a>QTextCodecPlugin::QTextCodecPlugin ( <a href="qobject.html">QObject</a> * <i>parent</i> = 0 )</h3> <p>Constructs a text codec plugin with the given <i>parent</i>. This is invoked automatically by the <a href="qtplugin.html#Q_EXPORT_PLUGIN2">Q_EXPORT_PLUGIN2</a>() macro.</p> <a name="//apple_ref/cpp/instm/QTextCodecPlugin/~QTextCodecPlugin"></a> <h3 class="fn"><a name="dtor.QTextCodecPlugin"></a>QTextCodecPlugin::~QTextCodecPlugin ()</h3> <p>Destroys the text codec plugin.</p> <p>You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used.</p> <a name="//apple_ref/cpp/instm/QTextCodecPlugin/aliases"></a> <h3 class="fn"><a name="aliases"></a><a href="qlist.html">QList</a><<a href="qbytearray.html">QByteArray</a>> QTextCodecPlugin::aliases () const <tt> [pure virtual]</tt></h3> <p>Returns the list of aliases supported by this plugin.</p> <a name="//apple_ref/cpp/instm/QTextCodecPlugin/createForMib"></a> <h3 class="fn"><a name="createForMib"></a><a href="qtextcodec.html">QTextCodec</a> * QTextCodecPlugin::createForMib ( int <i>mib</i> ) <tt> [pure virtual]</tt></h3> <p>Creates a <a href="qtextcodec.html">QTextCodec</a> object for the mib enum <i>mib</i>.</p> <p>See <a href="http://www.iana.org/assignments/character-sets">the IANA character-sets encoding file</a> for more information.</p> <p>See also <a href="qtextcodecplugin.html#mibEnums">mibEnums</a>().</p> <a name="//apple_ref/cpp/instm/QTextCodecPlugin/createForName"></a> <h3 class="fn"><a name="createForName"></a><a href="qtextcodec.html">QTextCodec</a> * QTextCodecPlugin::createForName ( const <a href="qbytearray.html">QByteArray</a> & <i>name</i> ) <tt> [pure virtual]</tt></h3> <p>Creates a <a href="qtextcodec.html">QTextCodec</a> object for the codec called <i>name</i>. The <i>name</i> must come from the list of encodings returned by <a href="qtextcodecplugin.html#names">names</a>(). Encoding names are case sensitive.</p> <p>Example:</p> <pre> QList<QByteArray> MyCodecPlugin::names() const { return QList<QByteArray> << "IBM01140" << "hp15-tw"; } QTextCodec *MyCodecPlugin::createForName(const QByteArray &name) { if (name == "IBM01140") { return new Ibm01140Codec; } else if (name == "hp15-tw") { return new Hp15TwCodec; } return 0; }</pre> <p>See also <a href="qtextcodecplugin.html#names">names</a>().</p> <a name="//apple_ref/cpp/instm/QTextCodecPlugin/mibEnums"></a> <h3 class="fn"><a name="mibEnums"></a><a href="qlist.html">QList</a><int> 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="qtextcodecplugin.html#createForMib">createForMib</a>().</p> <a name="//apple_ref/cpp/instm/QTextCodecPlugin/names"></a> <h3 class="fn"><a name="names"></a><a href="qlist.html">QList</a><<a href="qbytearray.html">QByteArray</a>> QTextCodecPlugin::names () const <tt> [pure virtual]</tt></h3> <p>Returns the list of MIME names supported by this plugin.</p> <p>If a codec has several names, the extra names are returned by <a href="qtextcodecplugin.html#aliases">aliases</a>().</p> <p>See also <a href="qtextcodecplugin.html#createForName">createForName</a>() and <a href="qtextcodecplugin.html#aliases">aliases</a>().</p> <p /><address><hr /><div align="center"> <table width="100%" cellspacing="0" border="0"><tr class="address"> <td width="40%" align="left">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies)</td> <td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td> <td width="40%" align="right"><div align="right">Qt 4.6.3</div></td> </tr></table></div></address></body> </html>