How to Create Qt Plugins

Qt provides two APIs for creating plugins:

• A high-level API for writing extensions to Qt itself, such as custom database drivers, image formats, text codecs, and custom styles.
• A low-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 Creating Custom Widget Plugins.

The High-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 appropriate directory.

The following table summarizes the plugin base classes. Some of the classes are private, and are therefore not documented. You can use them, but there is no compatibility promise with later Qt versions.

If you have a new document viewer class called JsonViewer that you want to make available as a plugin, the class needs to be defined as follows (jsonviewer.h):

 class JsonViewer : public ViewerInterface
 {
     Q_OBJECT
     Q_PLUGIN_METADATA(IID "org.qt-project.Qt.Examples.DocumentViewer.ViewerInterface/1.0" FILE "jsonviewer.json")
     Q_INTERFACES(ViewerInterface)
 public:
     JsonViewer();
     ~JsonViewer() override;
 private:
     bool openJsonFile();

     QTreeView *m_tree;
     QListWidget *m_toplevel = nullptr;
     QJsonDocument m_root;

     QPointer<QLineEdit> m_searchKey;
 };

Ensure that the class implementation is located in a .cpp file:

 JsonViewer::JsonViewer()
 {
     connect(this, &AbstractViewer::uiInitialized, this, &JsonViewer::setupJsonUi);
 }

 void JsonViewer::init(QFile *file, QWidget *parent, QMainWindow *mainWindow)
 {
     AbstractViewer::init(file, new QTreeView(parent), mainWindow);
     m_tree = qobject_cast<QTreeView *>(widget());
 }

In addition, a json file (jsonviewer.json) containing meta data describing the plugin is required for most plugins. For document viewer plugins it simply contains the name of the viewer plugin.

 { "Keys": [ "jsonviewer" ] }

The type of information that needs to be provided in the json file is plugin dependent. See the class documentation for details on the information that needs to be contained in the file.

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.

Plugin classes may 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 Document Viewer Demo shows how to implement a plugin that displayes structured contents of a file. Each plugin therefore reimplements virtual functions, which

• identify the plugin
• return the MIME types it supports
• inform whether there is content to display and
• how contents are presented

     QString viewerName() const override { return QLatin1StringView(staticMetaObject.className()); };
     QStringList supportedMimeTypes() const override;
     bool hasContent() const override;
     bool supportsOverview() const override { return true; }

The Low-Level API: Extending Qt Applications

In addition to Qt itself, Qt applications 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 other types of plugins 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_PLUGIN_METADATA() macro.

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

 class ViewerInterface : public AbstractViewer
 {
 public:
     virtual ~ViewerInterface() = default;
 };

Here's the interface declaration:

 #define ViewerInterface_iid "org.qt-project.Qt.Examples.DocumentViewer.ViewerInterface/1.0"
 Q_DECLARE_INTERFACE(ViewerInterface, ViewerInterface_iid)

See also Creating Custom Widgets for Qt Designer for information about issues that are specific to Qt Designer.

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, for example, 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, for example, by 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 (for example, styles) cannot be changed.

If you want the plugin to be loadable, 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 subdirectory under plugins where the plugin is located to your applications root folder (i.e., do not include the plugins directory).

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 into 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.

CMake and qmake automatically add the plugins that are typically needed by the Qt modules that are used, while more specialized plugins need to be added manually. The default list of automatically added plugins can be overridden per type.

The defaults are tuned towards an optimal out-of-the-box experience, but may unnecessarily bloat the application. It is recommended to inspect the linker command line and eliminate unnecessary plugins.

To cause static plugins actually being linked and instantiated, Q_IMPORT_PLUGIN() macros are also needed in application code, but those are automatically generated by the build system and added to your application project.

Importing Static Plugins in CMake

To statically link plugins in a CMake project, you need to call the qt_import_plugins command.

For example, the Linux libinput plugin is not imported by default. The following command imports it:

 qt_import_plugins(myapp INCLUDE Qt::QLibInputPlugin)

To link the minimal platform integration plugin instead of the default Qt platform adaptation plugin, use:

 qt_import_plugins(myapp
     INCLUDE_BY_TYPE platforms Qt::MinimalIntegrationPlugin
 )

Another typical use case is to link only a certain set of imageformats plugins:

 qt_import_plugins(myapp
     INCLUDE_BY_TYPE imageformats Qt::QJpegPlugin Qt::QGifPlugin
 )

If you want to prevent the linking of any imageformats plugin, use:

 qt_import_plugins(myapp
     EXCLUDE_BY_TYPE imageformats
 )

If you want to turn off the addition of any default plugin, use the NO_DEFAULT option of qt_import_plugins.

Importing Static Plugins in qmake

In a qmake project, you need to add the required plugins to your build using QTPLUGIN:

 QTPLUGIN += qlibinputplugin

For example, to link the minimal plugin instead of the default Qt platform adaptation plugin, use:

 QTPLUGIN.platforms = qminimal

If you want neither the default, nor the minimal QPA plugin to be linked automatically, use:

 QTPLUGIN.platforms = -

If you do not want all plugins added to QTPLUGIN to be automatically linked, remove import_plugins from the CONFIG variable:

 CONFIG -= import_plugins

Creating Static Plugins

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

1. Pass the STATIC option to the qt_add_plugin command in your CMakeLists.txt. For a qmake project, add CONFIG += static to your plugin's .pro file.
2. Use the Q_IMPORT_PLUGIN() macro in your application.
3. Use the Q_INIT_RESOURCE() macro in your application if the plugin ships qrc files.
4. Link your application with your plugin library using target_link_libraries in your CMakeLists.txt or LIBS in your .pro file.

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

Loading plugins

Plugin types (static or shared) and operating systems require specific approaches to locate and load plugins. It's useful to implement an abstraction for loading plugins.

 void ViewerFactory::loadViewerPlugins()
 {
     if (!m_viewers.isEmpty())
         return;

QPluginLoader::staticInstances() returns a QObjectList with a pointer to each statically linked plugin

     // Load static plugins
     const QObjectList &staticPlugins = QPluginLoader::staticInstances();
     for (auto *plugin : staticPlugins)
         addViewer(plugin);

Shared plugins reside in their deployment directories, which may require OS-specific handling.

     // Load shared plugins
     QDir pluginsDir = QDir(QApplication::applicationDirPath());

 #if defined(Q_OS_WINDOWS)
     pluginsDir.cd("app"_L1);
 #elif defined(Q_OS_DARWIN)
     if (pluginsDir.dirName() == "MacOS"_L1) {
         pluginsDir.cdUp();
         pluginsDir.cdUp();
         pluginsDir.cdUp();
     }
 #endif
     const auto entryList = pluginsDir.entryList(QDir::Files);
     for (const QString &fileName : entryList) {
         QPluginLoader loader(pluginsDir.absoluteFilePath(fileName));
         QObject *plugin = loader.instance();
         if (plugin)
             addViewer(plugin);
 #if 0
         else
             qDebug() << loader.errorString();
 #endif
     }
 }

Deploying and Debugging Plugins

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