<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qtextcodecplugin.cpp --> <title>Qt 4.8: QTextCodecPlugin Class Reference</title> <link rel="stylesheet" type="text/css" href="style/style.css" /> <script src="scripts/jquery.js" type="text/javascript"></script> <script src="scripts/functions.js" type="text/javascript"></script> <link rel="stylesheet" type="text/css" href="style/superfish.css" /> <link rel="stylesheet" type="text/css" href="style/narrow.css" /> <!--[if IE]> <meta name="MSSmartTagsPreventParsing" content="true"> <meta http-equiv="imagetoolbar" content="no"> <![endif]--> <!--[if lt IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie6.css"> <![endif]--> <!--[if IE 7]> <link rel="stylesheet" type="text/css" href="style/style_ie7.css"> <![endif]--> <!--[if IE 8]> <link rel="stylesheet" type="text/css" href="style/style_ie8.css"> <![endif]--> <script src="scripts/superfish.js" type="text/javascript"></script> <script src="scripts/narrow.js" type="text/javascript"></script> </head> <body class="" onload="CheckEmptyAndLoadList();"> <div class="header" id="qtdocheader"> <div class="content"> <div id="nav-logo"> <a href="index.html">Home</a></div> <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a> <div id="narrowsearch"></div> <div id="nav-topright"> <ul> <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li> <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li> <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/"> DOC</a></li> <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li> </ul> </div> <div id="shortCut"> <ul> <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li> <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li> </ul> </div> <ul class="sf-menu" id="narrowmenu"> <li><a href="#">API Lookup</a> <ul> <li><a href="classes.html">Class index</a></li> <li><a href="functions.html">Function index</a></li> <li><a href="modules.html">Modules</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="qtglobal.html">Global Declarations</a></li> <li><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </li> <li><a href="#">Qt Topics</a> <ul> <li><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li><a href="supported-platforms.html">Supported Platforms</a></li> <li><a href="technology-apis.html">Qt and Key Technologies</a></li> <li><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </li> <li><a href="#">Examples</a> <ul> <li><a href="all-examples.html">Examples</a></li> <li><a href="tutorials.html">Tutorials</a></li> <li><a href="demos.html">Demos</a></li> <li><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </li> </ul> </div> </div> <div class="wrapper"> <div class="hd"> <span></span> </div> <div class="bd group"> <div class="sidebar"> <div class="searchlabel"> Search index:</div> <div class="search" id="sidebarsearch"> <form id="qtdocsearch" action="" onsubmit="return false;"> <fieldset> <input type="text" name="searchstring" id="pageType" value="" /> <div id="resultdialog"> <a href="#" id="resultclose">Close</a> <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p> <ul id="resultlist" class="all"> </ul> </div> </fieldset> </form> </div> <div class="box first bottombar" id="lookup"> <h2 title="API Lookup"><span></span> API Lookup</h2> <div id="list001" class="list"> <ul id="ul001" > <li class="defaultLink"><a href="classes.html">Class index</a></li> <li class="defaultLink"><a href="functions.html">Function index</a></li> <li class="defaultLink"><a href="modules.html">Modules</a></li> <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li> <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li> <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li> </ul> </div> </div> <div class="box bottombar" id="topics"> <h2 title="Qt Topics"><span></span> Qt Topics</h2> <div id="list002" class="list"> <ul id="ul002" > <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> <li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li> <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li> <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> </ul> </div> </div> <div class="box" id="examples"> <h2 title="Examples"><span></span> Examples</h2> <div id="list003" class="list"> <ul id="ul003"> <li class="defaultLink"><a href="all-examples.html">Examples</a></li> <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li> <li class="defaultLink"><a href="demos.html">Demos</a></li> <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li> </ul> </div> </div> </div> <div class="wrap"> <div class="toolbar"> <div class="breadcrumb toolblock"> <ul> <li class="first"><a href="index.html">Home</a></li> <!-- Breadcrumbs go here --> <li><a href="modules.html">Modules</a></li> <li><a href="qtcore.html">QtCore</a></li> <li>QTextCodecPlugin</li> </ul> </div> <div class="toolbuttons toolblock"> <ul> <li id="smallA" class="t_button">A</li> <li id="medA" class="t_button active">A</li> <li id="bigA" class="t_button">A</li> <li id="print" class="t_button"><a href="javascript:this.print();"> <span>Print</span></a></li> </ul> </div> </div> <div class="content mainContent"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <h1 class="title">QTextCodecPlugin Class Reference</h1> <!-- $$$QTextCodecPlugin-brief --> <p>The QTextCodecPlugin class provides an abstract base for custom <a href="qtextcodec.html">QTextCodec</a> plugins. <a href="#details">More...</a></p> <!-- @@@QTextCodecPlugin --> <pre class="cpp"> <span class="preprocessor">#include <QTextCodecPlugin></span></pre><p><b>Inherits: </b><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> <a name="public-functions"></a> <h2>Public Functions</h2> <table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextcodecplugin.html#QTextCodecPlugin">QTextCodecPlugin</a></b> ( QObject * <i>parent</i> = 0 )</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextcodecplugin.html#dtor.QTextCodecPlugin">~QTextCodecPlugin</a></b> ()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QList<QByteArray> </td><td class="memItemRight bottomAlign"><b><a href="qtextcodecplugin.html#aliases">aliases</a></b> () const = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QTextCodec * </td><td class="memItemRight bottomAlign"><b><a href="qtextcodecplugin.html#createForMib">createForMib</a></b> ( int <i>mib</i> ) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QTextCodec * </td><td class="memItemRight bottomAlign"><b><a href="qtextcodecplugin.html#createForName">createForName</a></b> ( const QByteArray & <i>name</i> ) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QList<int> </td><td class="memItemRight bottomAlign"><b><a href="qtextcodecplugin.html#mibEnums">mibEnums</a></b> () const = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QList<QByteArray> </td><td class="memItemRight bottomAlign"><b><a href="qtextcodecplugin.html#names">names</a></b> () const = 0</td></tr> </table> <ul> <li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li> <li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li> <li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li> <li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li> <li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QTextCodecPlugin-description --> <div class="descr"> <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> </div> <!-- @@@QTextCodecPlugin --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QTextCodecPlugin[overload1]$$$QTextCodecPluginQObject* --> <h3 class="fn"><a name="QTextCodecPlugin"></a>QTextCodecPlugin::<span class="name">QTextCodecPlugin</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <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> <!-- @@@QTextCodecPlugin --> <!-- $$$~QTextCodecPlugin[overload1]$$$~QTextCodecPlugin --> <h3 class="fn"><a name="dtor.QTextCodecPlugin"></a>QTextCodecPlugin::<span class="name">~QTextCodecPlugin</span> ()</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> <!-- @@@~QTextCodecPlugin --> <!-- $$$aliases[overload1]$$$aliases --> <h3 class="fn"><a name="aliases"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qbytearray.html">QByteArray</a></span>> QTextCodecPlugin::<span class="name">aliases</span> () const<tt> [pure virtual]</tt></h3> <p>Returns the list of aliases supported by this plugin.</p> <!-- @@@aliases --> <!-- $$$createForMib[overload1]$$$createForMibint --> <h3 class="fn"><a name="createForMib"></a><span class="type"><a href="qtextcodec.html">QTextCodec</a></span> * QTextCodecPlugin::<span class="name">createForMib</span> ( <span class="type">int</span> <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><b>See also </b><a href="qtextcodecplugin.html#mibEnums">mibEnums</a>().</p> <!-- @@@createForMib --> <!-- $$$createForName[overload1]$$$createForNameconstQByteArray& --> <h3 class="fn"><a name="createForName"></a><span class="type"><a href="qtextcodec.html">QTextCodec</a></span> * QTextCodecPlugin::<span class="name">createForName</span> ( const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <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 class="cpp"> <span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span><span class="type"><a href="qbytearray.html">QByteArray</a></span><span class="operator">></span> MyCodecPlugin<span class="operator">::</span><a href="qtextcodecplugin.html#names">names</a>() <span class="keyword">const</span> { <span class="keyword">return</span> <span class="type"><a href="qlist.html">QList</a></span><span class="operator"><</span><span class="type"><a href="qbytearray.html">QByteArray</a></span><span class="operator">></span> <span class="operator"><</span><span class="operator"><</span> <span class="string">"IBM01140"</span> <span class="operator"><</span><span class="operator"><</span> <span class="string">"hp15-tw"</span>; } <span class="type"><a href="qtextcodec.html">QTextCodec</a></span> <span class="operator">*</span>MyCodecPlugin<span class="operator">::</span>createForName(<span class="keyword">const</span> <span class="type"><a href="qbytearray.html">QByteArray</a></span> <span class="operator">&</span>name) { <span class="keyword">if</span> (name <span class="operator">=</span><span class="operator">=</span> <span class="string">"IBM01140"</span>) { <span class="keyword">return</span> <span class="keyword">new</span> Ibm01140Codec; } <span class="keyword">else</span> <span class="keyword">if</span> (name <span class="operator">=</span><span class="operator">=</span> <span class="string">"hp15-tw"</span>) { <span class="keyword">return</span> <span class="keyword">new</span> Hp15TwCodec; } <span class="keyword">return</span> <span class="number">0</span>; }</pre> <p><b>See also </b><a href="qtextcodecplugin.html#names">names</a>().</p> <!-- @@@createForName --> <!-- $$$mibEnums[overload1]$$$mibEnums --> <h3 class="fn"><a name="mibEnums"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type">int</span>> QTextCodecPlugin::<span class="name">mibEnums</span> () const<tt> [pure virtual]</tt></h3> <p>Returns the list of mib enums supported by this plugin.</p> <p><b>See also </b><a href="qtextcodecplugin.html#createForMib">createForMib</a>().</p> <!-- @@@mibEnums --> <!-- $$$names[overload1]$$$names --> <h3 class="fn"><a name="names"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qbytearray.html">QByteArray</a></span>> QTextCodecPlugin::<span class="name">names</span> () 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><b>See also </b><a href="qtextcodecplugin.html#createForName">createForName</a>() and <a href="qtextcodecplugin.html#aliases">aliases</a>().</p> <!-- @@@names --> </div> </div> </div> </div> <div class="ft"> <span></span> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.</p> <br /> <p> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.</p> <p> Documentation sources may be obtained from <a href="http://www.qt-project.org"> www.qt-project.org</a>.</p> <br /> <p> Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. <a title="Privacy Policy" href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p> </div> <script src="scripts/functions.js" type="text/javascript"></script> </body> </html>