How to Create Qt Plugins

Qt provides two APIs for creating plugins:

• A higher-level API for writing extensions to Qt itself: custom database drivers, image formats, text codecs, custom styles, etc.
• A lower-level API for extending Qt applications.

For example, if you want to write a custom QStyle subclass and have Qt applications load it dynamically, you would use the higher-level API.

Since the higher-level API is built on top of the lower-level API, some issues are common to both.

If you want to provide plugins for use with Qt Designer, see the QtDesigner module documentation.

Topics:

The Higher-Level API: Writing Qt Extensions

Writing a plugin that extends Qt itself is achieved by subclassing the appropriate plugin base class, implementing a few functions, and adding a macro.

There are several plugin base classes. Derived plugins are stored by default in sub-directories of the standard plugin directory. Qt will not find plugins if they are not stored in the right directory.

Base Class	Directory Name	Key Case Sensitivity
QAccessibleBridgePlugin	accessiblebridge	Case Sensitive
QAccessiblePlugin	accessible	Case Sensitive
QDecorationPlugin	decorations	Case Insensitive
QFontEnginePlugin	fontengines	Case Insensitive
QIconEnginePlugin	iconengines	Case Insensitive
QImageIOPlugin	imageformats	Case Sensitive
QInputContextPlugin	inputmethods	Case Sensitive
QKbdDriverPlugin	kbddrivers	Case Insensitive
QMouseDriverPlugin	mousedrivers	Case Insensitive
QScreenDriverPlugin	gfxdrivers	Case Insensitive
QScriptExtensionPlugin	script	Case Sensitive
QSqlDriverPlugin	sqldrivers	Case Sensitive
QStylePlugin	styles	Case Insensitive
QTextCodecPlugin	codecs	Case Sensitive

Suppose that you have a new style class called MyStyle that you want to make available as a plugin. The required code is straightforward, here is the class definition (mystyleplugin.h):

 class MyStylePlugin : public QStylePlugin
 {
 public:
     QStringList keys() const;
     QStyle *create(const QString &key);
 };

Ensure that the class implementation is located in a .cpp file (including the class definition):

 #include "mystyleplugin.h"

 QStringList MyStylePlugin::keys() const
 {
     return QStringList() << "MyStyle";
 }

 QStyle *MyStylePlugin::create(const QString &key)
 {
     if (key.toLower() == "mystyle")
         return new MyStyle;
     return 0;
 }

 Q_EXPORT_PLUGIN2(pnp_mystyleplugin, MyStylePlugin)

(Note that QStylePlugin is case insensitive, and the lower-case version of the key is used in our create() implementation; most other plugins are case sensitive.)

For database drivers, image formats, text codecs, and most other plugin types, no explicit object creation is required. Qt will find and create them as required. Styles are an exception, since you might want to set a style explicitly in code. To apply a style, use code like this:

 QApplication::setStyle(QStyleFactory::create("MyStyle"));

Some plugin classes require additional functions to be implemented. See the class documentation for details of the virtual functions that must be reimplemented for each type of plugin.

The Style Plugin Example shows how to implement a plugin that extends the QStylePlugin base class.

The Lower-Level API: Extending Qt Applications

Not only Qt itself but also Qt application can be extended through plugins. This requires the application to detect and load plugins using QPluginLoader. In that context, plugins may provide arbitrary functionality and are not limited to database drivers, image formats, text codecs, styles, and the other types of plugin that extend Qt's functionality.

Making an application extensible through plugins involves the following steps:

1. Define a set of interfaces (classes with only pure virtual functions) used to talk to the plugins.
2. Use the Q_DECLARE_INTERFACE() macro to tell Qt's meta-object system about the interface.
3. Use QPluginLoader in the application to load the plugins.
4. Use qobject_cast() to test whether a plugin implements a given interface.

Writing a plugin involves these steps:

1. Declare a plugin class that inherits from QObject and from the interfaces that the plugin wants to provide.
2. Use the Q_INTERFACES() macro to tell Qt's meta-object system about the interfaces.
3. Export the plugin using the Q_EXPORT_PLUGIN2() macro.
4. Build the plugin using a suitable .pro file.

For example, here's the definition of an interface class:

 class FilterInterface
 {
 public:
     virtual ~FilterInterface() {}

     virtual QStringList filters() const = 0;
     virtual QImage filterImage(const QString &filter, const QImage &image,
                                QWidget *parent) = 0;
 };

Here's the definition of a plugin class that implements that interface:

 #include <QObject>
 #include <QStringList>
 #include <QImage>

 #include <plugandpaint/interfaces.h>

 class ExtraFiltersPlugin : public QObject, public FilterInterface
 {
     Q_OBJECT
     Q_INTERFACES(FilterInterface)

 public:
     QStringList filters() const;
     QImage filterImage(const QString &filter, const QImage &image,
                        QWidget *parent);
 };

The Plug & Paint example documentation explains this process in detail. See also Creating Custom Widgets for Qt Designer for information about issues that are specific to Qt Designer. You can also take a look at the Echo Plugin Example is a more trivial example on how to implement a plugin that extends Qt applications. Please note that a QCoreApplication must have been initialized before plugins can be loaded.

Locating Plugins

Qt applications automatically know which plugins are available, because plugins are stored in the standard plugin subdirectories. Because of this applications don't require any code to find and load plugins, since Qt handles them automatically.

During development, the directory for plugins is QTDIR/plugins (where QTDIR is the directory where Qt is installed), with each type of plugin in a subdirectory for that type, e.g. styles. If you want your applications to use plugins and you don't want to use the standard plugins path, have your installation process determine the path you want to use for the plugins, and save the path, e.g. using QSettings, for the application to read when it runs. The application can then call QCoreApplication::addLibraryPath() with this path and your plugins will be available to the application. Note that the final part of the path (e.g., styles) cannot be changed.

If you want the plugin to be loadable then one approach is to create a subdirectory under the application and place the plugin in that directory. If you distribute any of the plugins that come with Qt (the ones located in the plugins directory), you must copy the sub-directory under plugins where the plugin is located to your applications root folder (i.e., do not include the plugins directory).

Note: In Symbian all binaries must be located in the directory \sys\bin, so each Qt plugin has a stub with the same basename as the plugin dll and suffix ".qtplugin" to make Qt extension plugins work similarly to other platforms. When trying to locate the plugin, Qt actually looks for the stub instead of the plugin binary. While plugin stub files have the suffix ".qtplugin", they can still be loaded also by specifying a filename with the normal library suffix ".dll" for QPluginLoader, so normally application developer doesn't need to care about the different suffix of the stub. Because of the way applications can be installed on ROM or various other drives in Symbian, Qt looks for the stub from the same directory on all available drives if it is not located in the given directory when loading a plugin.

For more information about deployment, see the Deploying Qt Applications and Deploying Plugins documentation.

Static Plugins

The normal and most flexible way to include a plugin with an application is to compile it into a dynamic library that is shipped separately, and detected and loaded at runtime.

Plugins can be linked statically against your application. If you build the static version of Qt, this is the only option for including Qt's predefined plugins. Using static plugins makes the deployment less error-prone, but has the disadvantage that no functionality from plugins can be added without a complete rebuild and redistribution of the application.

When compiled as a static library, Qt provides the following static plugins:

Plugin name	Type	Description
qtaccessiblecompatwidgets	Accessibility	Accessibility for Qt 3 support widgets
qtaccessiblewidgets	Accessibility	Accessibility for Qt widgets
qdecorationdefault	Decorations (Qt Extended)	Default style
qdecorationwindows	Decorations (Qt Extended)	Windows style
qgif	Image formats	GIF
qjpeg	Image formats	JPEG
qmng	Image formats	MNG
qico	Image formats	ICO
qsvg	Image formats	SVG
qtiff	Image formats	TIFF
qimsw_multi	Input methods (Qt Extended)	Input Method Switcher
qwstslibmousehandler	Mouse drivers (Qt Extended)	tslib mouse
qgfxtransformed	Graphic drivers (Qt Extended)	Transformed screen
qgfxvnc	Graphic drivers (Qt Extended)	VNC
qscreenvfb	Graphic drivers (Qt Extended)	Virtual frame buffer
qsqldb2	SQL driver	IBM DB2
qsqlibase	SQL driver	Borland InterBase
qsqlite	SQL driver	SQLite version 3
qsqlite2	SQL driver	SQLite version 2
qsqlmysql	SQL driver	MySQL
qsqloci	SQL driver	Oracle (OCI)
qsqlodbc	SQL driver	Open Database Connectivity (ODBC)
qsqlpsql	SQL driver	PostgreSQL
qsqltds	SQL driver	Sybase Adaptive Server (TDS)
qcncodecs	Text codecs	Simplified Chinese (People's Republic of China)
qjpcodecs	Text codecs	Japanese
qkrcodecs	Text codecs	Korean
qtwcodecs	Text codecs	Traditional Chinese (Taiwan)

To link statically against those plugins, you need to use the Q_IMPORT_PLUGIN() macro in your application and you need to add the required plugins to your build using QTPLUGIN. For example, in your main.cpp:

 #include <QApplication>
 #include <QtPlugin>

 Q_IMPORT_PLUGIN(qjpeg)
 Q_IMPORT_PLUGIN(qgif)
 Q_IMPORT_PLUGIN(qkrcodecs)

 int main(int argc, char *argv[])
 {
     QApplication app(argc, argv);
     ...
     return app.exec();
 }

In the .pro file for your application, you need the following entry:

 QTPLUGIN     += qjpeg \
                 qgif \
                 qkrcodecs

It is also possible to create your own static plugins, by following these steps:

1. Add CONFIG += static to your plugin's .pro file.
2. Use the Q_IMPORT_PLUGIN() macro in your application.
3. Link your application with your plugin library using LIBS in the .pro file.

See the Plug & Paint example and the associated Basic Tools plugin for details on how to do this.

Note: If you are not using qmake to build your application you need to make sure that the QT_STATICPLUGIN preprocessor macro is defined.

Deploying and Debugging Plugins

The Deploying Plugins document covers the process of deploying plugins with applications and debugging them when problems arise.