Home · All Classes · Modules

QDeclarativeExtensionPlugin Class Reference
^{[QtDeclarative module]}

The QDeclarativeExtensionPlugin class provides an abstract base for custom QML extension plugins. More...

Inherits QObject.

Methods

• __init__ (self, QObject parent = None)
• initializeEngine (self, QDeclarativeEngine engine, str uri)
• registerTypes (self, str uri)

• Subclass QDeclarativeExtensionPlugin, implement registerTypes() method to register types using qmlRegisterType(), and export the class using the Q_EXPORT_PLUGIN2() macro
• Write an appropriate project file for the plugin
• Create a qmldir file to describe the plugin

QML extension plugins can be used to provide either application-specific or library-like plugins. Library plugins should limit themselves to registering types, as any manipulation of the engine's root context may cause conflicts or other issues in the library user's code.

 class TimeModel : public QObject
 {
     Q_OBJECT
     Q_PROPERTY(int hour READ hour NOTIFY timeChanged)
     Q_PROPERTY(int minute READ minute NOTIFY timeChanged)
     ...

To make this class available as a QML type, create a plugin that registers this type with a specific module using qmlRegisterType(). For this example the plugin module will be named com.nokia.TimeExample (as defined in the project file further below).

 class QExampleQmlPlugin : public QDeclarativeExtensionPlugin
 {
     Q_OBJECT
 public:
     void registerTypes(const char *uri)
     {
         Q_ASSERT(uri == QLatin1String("com.nokia.TimeExample"));
         qmlRegisterType<TimeModel>(uri, 1, 0, "Time");
     }
 };

 Q_EXPORT_PLUGIN2(qmlqtimeexampleplugin, QExampleQmlPlugin);

This registers the TimeModel class with the 1.0 version of this plugin library, as a QML type called Time. The Q_ASSERT statement ensures the module is imported correctly by any QML components that use this plugin.

The project file defines the project as a plugin library and specifies it should be built into the com/nokia/TimeExample directory:

 TEMPLATE = lib
 CONFIG += qt plugin
 QT += declarative

 DESTDIR = com/nokia/TimeExample
 TARGET = qmlqtimeexampleplugin
 ...

Finally, a qmldir file is required in the com/nokia/TimeExample directory that describes the plugin. This directory includes a Clock.qml file that should be bundled with the plugin, so it needs to be specified in the qmldir file:

 Clock 1.0 Clock.qml
 plugin qmlqtimeexampleplugin

Once the project is built and installed, the new Time element can be used by any QML component that imports the com.nokia.TimeExample module:

 import com.nokia.TimeExample 1.0 // import types from the plugin

 Clock { // this class is defined in QML (com/nokia/TimeExample/Clock.qml)

     Time { // this class is defined in C++ (plugin.cpp)
         id: time
     }

     hours: time.hour
     minutes: time.minute
 }

The full source code is available in the plugins example.

The Tutorial: Writing QML extensions with C++ also contains a chapter on creating QML plugins.

Method Documentation

QDeclarativeExtensionPlugin.__init__ (self, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a QML extension plugin with the given parent.

Note that this constructor is invoked automatically by the Q_EXPORT_PLUGIN2() macro, so there is no need for calling it explicitly.

QDeclarativeExtensionPlugin.initializeEngine (self, QDeclarativeEngine engine, str uri)

Initializes the extension from the uri using the engine. Here an application plugin might, for example, expose some data or objects to QML, as context properties on the engine's root context.

QDeclarativeExtensionPlugin.registerTypes (self, str uri)

This method is abstract and should be reimplemented in any sub-class.

Registers the QML types in the given uri. Subclasses should implement this to call qmlRegisterType() for all types which are provided by the extension plugin.

The uri is an identifier for the plugin generated by the QML engine based on the name and path of the extension's plugin library.