qtextcodecplugin(3qt)

1QTextCodecPlugin(3qt)                                    QTextCodecPlugin(3qt)
2
3
4

NAME

6       QTextCodecPlugin - Abstract base for custom QTextCodec plugins
7

SYNOPSIS

9       All the functions in this class are reentrant when Qt is built with
10       thread support.</p>
11
12       #include <qtextcodecplugin.h>
13
14   Public Members
15       QTextCodecPlugin ()
16       ~QTextCodecPlugin ()
17       virtual QStringList names () const = 0
18       virtual QTextCodec * createForName ( const QString & name ) = 0
19       virtual QValueList<int> mibEnums () const = 0
20       virtual QTextCodec * createForMib ( int mib ) = 0
21

DESCRIPTION

23       The QTextCodecPlugin class provides an abstract base for custom
24       QTextCodec plugins.
25
26       The text codec plugin is a simple plugin interface that makes it easy
27       to create custom text codecs that can be loaded dynamically into
28       applications.
29
30       Writing a text codec plugin is achieved by subclassing this base class,
31       reimplementing the pure virtual functions names(), createForName(),
32       mibEnums() and createForMib(), and exporting the class with the
33       Q_EXPORT_PLUGIN macro. See the Qt Plugins documentation for details.
34
35       See the IANA character-sets encoding file for more information on mime
36       names and mib enums.
37
38       See also Plugins.
39

MEMBER FUNCTION DOCUMENTATION

QTextCodecPlugin::QTextCodecPlugin ()

42       Constructs a text codec plugin. This is invoked automatically by the
43       Q_EXPORT_PLUGIN macro.
44

QTextCodecPlugin::~QTextCodecPlugin ()

46       Destroys the text codec plugin.
47
48       You never have to call this explicitly. Qt destroys a plugin
49       automatically when it is no longer used.
50

QTextCodec * QTextCodecPlugin::createForMib ( int mib ) [pure virtual]

52       Creates a QTextCodec object for the mib enum mib.
53
54       (See the IANA character-sets encoding file for more information)
55
56       See also mibEnums().
57

QTextCodec * QTextCodecPlugin::createForName ( const QString & name ) [pure

59       virtual]
60       Creates a QTextCodec object for the codec called name.
61
62       See also names().
63

QValueList<int> QTextCodecPlugin::mibEnums () const [pure virtual]

65       Returns the list of mib enums supported by this plugin.
66
67       See also createForMib().
68

QStringList QTextCodecPlugin::names () const [pure virtual]

70       Returns the list of mime names supported by this plugin.
71
72       See also createForName().
73
74

COPYRIGHT

80       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
81       license file included in the distribution for a complete license
82       statement.
83

AUTHOR

85       Generated automatically from the source code.
86

BUGS

88       If you find a bug in Qt, please report it as described in
89       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
90       help you. Thank you.
91
92       The definitive Qt documentation is provided in HTML format; it is
93       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
94       web browser. This man page is provided as a convenience for those users
95       who prefer man pages, although this format is not officially supported
96       by Trolltech.
97
98       If you find errors in this manual page, please report them to qt-
99       bugs@trolltech.com.  Please include the name of the manual page
100       (qtextcodecplugin.3qt) and the Qt version (3.3.8).
101
102
103
104Trolltech AS                    2 February 2007          QTextCodecPlugin(3qt)