Creación de plugins de C++ para QML

Creación de un plugin

La página QML engine carga plugins C++ para QML. Dichos plugins se proporcionan normalmente en un módulo de extensión de QML, y pueden proporcionar tipos para su uso por los clientes en documentos QML que importen el módulo. Un módulo requiere al menos un tipo registrado para considerarse válido.

QQmlEngineExtensionPlugin es una interfaz de plugins que permite crear extensiones QML que pueden cargarse dinámicamente en aplicaciones QML. Estas extensiones permiten poner tipos QML personalizados a disposición del motor QML.

Para escribir un plugin de extensión QML:

1. Subclase QQmlEngineExtensionPlugin y utilice la macro Q_PLUGIN_METADATA() para registrar el plugin con el sistema de metaobjetos Qt.
2. Utilice las macros QML_ELEMENT y QML_NAMED_ELEMENT() para declarar los tipos QML.
3. Configura tu archivo de compilación.

   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 estás usando qmake, crea un archivo qmldir para describir el plugin. Tenga en cuenta que CMake, por defecto, generará automáticamente el archivo qmldir.

Los plugins de extensión QML son para plugins específicos de aplicaciones o de bibliotecas. Los plugins de biblioteca deben limitarse a registrar tipos, ya que cualquier manipulación del contexto raíz del motor puede causar conflictos u otros problemas en el código del usuario de la biblioteca.

El enlazador puede eliminar erróneamente la función de registro de tipos generada como una optimización. Puede evitarlo declarando un puntero sintético volátil a la función en algún lugar de su código. La función es generada por qmltyperegistrar, y se llama qml_register_types_ concatenada con el URI del módulo, con los puntos sustituidos por guiones bajos.

Si tu módulo se llama "mi.módulo", añadirías la declaración forward en el ámbito global:

void qml_register_types_my_module();

A continuación, añada el siguiente fragmento de código en la implementación de cualquier función que forme parte del mismo binario que la registración:

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

Referencia

• Writing QML Extensions with C++ - contiene un capítulo sobre la creación de plugins QML.
• Definiendo tipos QML desde C++ - información sobre el registro de tipos C++ en el runtime.
• Cómo crear plugins Qt - información sobre plugins Qt