QQmlEngineExtensionPlugin Class
La clase `QQmlEngineExtensionPlugin` proporciona una base abstracta para los complementos de extensión QML personalizados. Más información...
| Encabezado: | #include <QQmlEngineExtensionPlugin> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Qml) target_link_libraries(mytarget PRIVATE Qt6::Qml) |
| qmake: | QT += qml |
| Heredado de: | QObject |
- Lista de todos los miembros, incluidos los heredados
- QQmlEngineExtensionPlugin forma parte de las clases de complementos.
Funciones públicas
| QQmlEngineExtensionPlugin(QObject *parent = nullptr) |
Funciones públicas reimplementadas
| virtual void | initializeEngine(QQmlEngine *engine, const char *uri) override |
Macros
(since 6.2) | Q_IMPORT_QML_PLUGIN(PluginName) |
Descripción detallada
QQmlEngineExtensionPlugin es una interfaz de complemento que permite crear extensiones QML que se pueden cargar dinámicamente en aplicaciones QML. Estas extensiones permiten que los tipos QML personalizados estén disponibles para el motor QML.
Para escribir un complemento de extensión QML:
- Crea una subclase de ` QQmlEngineExtensionPlugin ` y utiliza la macro ` Q_PLUGIN_METADATA()` para registrar el complemento en el sistema de metobjetos de Qt.
- Utiliza las macros ` QML_ELEMENT ` y ` QML_NAMED_ELEMENT()` para declarar tipos QML.
- 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> - Si utilizas qmake, crea un archivo qmldir para describir el complemento. Ten en cuenta que CMake, por defecto, generará automáticamente el archivo qmldir.
Los complementos de extensión QML están pensados para complementos específicos de una aplicación o similares a bibliotecas. Los complementos de biblioteca deben limitarse a registrar tipos, ya que cualquier manipulación del contexto raíz del motor puede provocar conflictos u otros problemas en el código del usuario de la biblioteca.
Nota: Al utilizar la API qt_add_qml_module de CMake, se generará automáticamente un complemento. Este se encargará del registro de tipos. Solo es necesario escribir un complemento personalizado si se tienen requisitos especiales, como registrar proveedores de imágenes personalizados. En ese caso, pasa NO_GENERATE_PLUGIN_SOURCE a la llamada a qt_add_qml_module para desactivar la generación del complemento predeterminado.
El enlazador podría eliminar por error la función de registro de tipos generada como medida de optimización. Puedes evitarlo declarando un puntero volátil sintético a la función en algún lugar de tu código. La función la genera qmltyperegistrar y se denomina qml_register_types_ concatenado con el URI del módulo, sustituyendo los puntos por guiones bajos.
Si tu módulo se llama «my.module», deberías añadir la declaración anticipada en el ámbito global:
void qml_register_types_my_module();A continuación, añade el siguiente fragmento de código en la implementación de cualquier función que forme parte del mismo binario que el registro:
volatile auto registration = &qml_register_types_my_module;
Q_UNUSED(registration);El tutorial «Escribir extensiones de QML con C++» también contiene un capítulo sobre la creación de complementos de QML.
Véase también Cómo crear complementos de Qt.
Documentación de funciones de miembro
[explicit] QQmlEngineExtensionPlugin::QQmlEngineExtensionPlugin(QObject *parent = nullptr)
Crea un complemento de extensión QML con el ` parent` especificado.
Ten en cuenta que este constructor es invocado automáticamente por la macro Q_PLUGIN_METADATA(), por lo que no es necesario llamarlo explícitamente.
[override virtual] void QQmlEngineExtensionPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
Inicializa la extensión desde uri utilizando engine. Aquí, un complemento de aplicación podría, por ejemplo, exponer algunos datos u objetos a QML, como propiedades de contexto en el contexto raíz del motor.
Documentación de macros
[since 6.2] Q_IMPORT_QML_PLUGIN(PluginName)
Garantiza que el complemento cuya clase de extensión de complemento que declara los metadatos se denomine « PluginName » se incluya en las compilaciones estáticas. En el caso de los módulos creados mediante «qt_add_qml_module», el nombre predeterminado de la clase de extensión del complemento se calcula a partir de la URI del módulo QML sustituyendo los puntos por guiones bajos, a menos que se especifique el argumento « CLASS_NAME ».
Por ejemplo:
qt_add_qml_module(myplugin
# The plugin extension class name in this case is my_Company_QmlComponents.
URI my.Company.QmlComponents
...
)Esta macro se introdujo en Qt 6.2.
Véase también Q_IMPORT_PLUGIN.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.