Créer des plugins C++ pour QML

Création d'un plugin

Le site QML engine charge des plugins C++ pour QML. Ces plugins sont généralement fournis dans un module d'extension QML et peuvent fournir des types à utiliser par les clients dans les documents QML qui importent le module. Un module nécessite au moins un type enregistré pour être considéré comme valide.

QQmlEngineExtensionPlugin est une interface de plugin qui vous permet de créer des extensions QML qui peuvent être chargées dynamiquement dans des applications QML. Ces extensions permettent de mettre des types QML personnalisés à la disposition du moteur QML.

Pour écrire un plugin d'extension QML :

1. Sous-classez QQmlEngineExtensionPlugin et utilisez la macro Q_PLUGIN_METADATA() pour enregistrer le plugin avec le système de méta-objets de Qt.
2. Utilisez les macros QML_ELEMENT et QML_NAMED_ELEMENT() pour déclarer les types QML.
3. Configurez votre fichier de compilation.

   CMake :

   qt_add_qml_module(<target>
       URI <my.import.name>
       VERSION 1.0
       QML_FILES <app.qml>
       NO_RESOURCE_TARGET_PATH
   )

   qmake :

   CONFIG += qmltypes
   QML_IMPORT_NAME = <my.import.name>
   QML_IMPORT_MAJOR_VERSION = <version>

4. Si vous utilisez qmake, créez un fichier qmldir pour décrire le plugin. Notez que CMake génère automatiquement le fichier qmldir par défaut.

Les plugins d'extension QML sont destinés à des applications spécifiques ou à des bibliothèques. Les plugins de bibliothèque doivent se limiter à l'enregistrement des types, car toute manipulation du contexte racine du moteur peut entraîner des conflits ou d'autres problèmes dans le code de l'utilisateur de la bibliothèque.

L'éditeur de liens peut supprimer par erreur la fonction d'enregistrement de type générée à des fins d'optimisation. Vous pouvez éviter cela en déclarant un pointeur volatile synthétique vers la fonction quelque part dans votre code. La fonction est générée par qmltyperegistrar, et est nommée qml_register_types_ concaténée avec l'URI du module, les points étant remplacés par des traits de soulignement.

Si votre module s'appelle "my.module", vous devez ajouter la déclaration forward dans la portée globale :

void qml_register_types_my_module();

Ajoutez ensuite l'extrait de code suivant dans l'implémentation de toute fonction faisant partie du même binaire que l'enregistrement :

volatile auto registration = &qml_register_types_my_module;
Q_UNUSED(registration);

Référence

• Writing QML Extensions with C++ - contient un chapitre sur la création de plugins QML.
• Defining QML Types from C++ - Informations sur l'enregistrement des types C++ dans le Runtime.
• Comment créer des plugins Qt - informations sur les plugins Qt.