Incrustación de objetos C++ en QML con propiedades de contexto

Al cargar un objeto QML en una aplicación C++, puede resultar útil incrustar directamente algunos datos C++ que pueden utilizarse desde el código QML. Esto permite, por ejemplo, invocar un método C++ en el objeto incrustado, o utilizar una instancia de objeto C++ como modelo de datos para una vista QML.

La posibilidad de inyectar datos C++ en un objeto QML es posible gracias a la clase QQmlContext. Esta clase expone datos al contexto de un objeto QML para que se pueda hacer referencia a los datos directamente desde el ámbito del código QML.

Configuración de una propiedad de contexto simple

Por ejemplo, a continuación se muestra un elemento QML que hace referencia a un valor currentDateTime que no existe en el ámbito actual:

// MyItem.qml
import QtQuick

Text { text: currentDateTime }

Este valor currentDateTime puede ser establecido directamente por la aplicación C++ que carga el componente QML, utilizando QQmlContext::setContextProperty():

QQuickView view;
view.rootContext()->setContextProperty("currentDateTime", QDateTime::currentDateTime());
view.setSource(QUrl::fromLocalFile("MyItem.qml"));
view.show();

Establecer un objeto como propiedad de contexto

Las propiedades de contexto pueden contener valores QVariant o QObject*. Esto significa que también se pueden inyectar objetos C++ personalizados utilizando este método, y que estos objetos se pueden modificar y leer directamente en QML. A continuación, modificamos el ejemplo anterior para incrustar una instancia de QObject en lugar de un valor de QDateTime, y el código QML invoca un método en la instancia del objeto:

class ApplicationData : public QObject
{
    Q_OBJECT
public:
    Q_INVOKABLE QDateTime getCurrentDateTime() const {
        return QDateTime::currentDateTime();
    }
};

int main(int argc, char *argv[]) {
    QGuiApplication app(argc, argv);

    QQuickView view;

    ApplicationData data;
    view.rootContext()->setContextProperty("applicationData", &data);

    view.setSource(QUrl::fromLocalFile("MyItem.qml"));
    view.show();

    return app.exec();
}

// MyItem.qml
import QtQuick

Text { text: applicationData.getCurrentDateTime() }

(Tenga en cuenta que los valores de fecha/hora devueltos desde C++ a QML pueden formatearse mediante Qt.formatDateTime() y las funciones asociadas).

Si el elemento QML necesita recibir señales de la propiedad de contexto, puede conectarse a ellas utilizando el tipo Connections. Por ejemplo, si ApplicationData tiene una señal denominada dataChanged(), se puede conectar a esta señal utilizando un manejador onDataChanged dentro de un objeto Connections:

Text {
    text: applicationData.getCurrentDateTime()

    Connections {
        target: applicationData
        onDataChanged: console.log("The application data changed!")
    }
}

Las propiedades de contexto pueden ser útiles para utilizar modelos de datos basados en C++ en una vista QML. Véanse los siguientes ejemplos:

• String ListModel
• Objeto ListModel
• AbstractItemModel

que demuestran el uso de modelos basados en QStringList, QList<QObject*> y QAbstractItemModel en vistas QML.

Consulte también la documentación de QQmlContext para obtener más información.