Intégrer des objets C++ dans QML avec des propriétés de contexte

Lors du chargement d'un objet QML dans une application C++, il peut être utile d'incorporer directement certaines données C++ qui peuvent être utilisées à partir du code QML. Cela permet, par exemple, d'invoquer une méthode C++ sur l'objet intégré ou d'utiliser une instance d'objet C++ comme modèle de données pour une vue QML.

La possibilité d'injecter des données C++ dans un objet QML est rendue possible par la classe QQmlContext. Cette classe expose les données au contexte d'un objet QML, de sorte que les données peuvent être référencées directement à partir de la portée du code QML.

Définition d'une propriété de contexte simple

Par exemple, voici un élément QML qui fait référence à une valeur currentDateTime qui n'existe pas dans le champ d'application actuel :

// MyItem.qml
import QtQuick

Text { text: currentDateTime }

Cette valeur currentDateTime peut être définie directement par l'application C++ qui charge le composant QML, à l'aide de QQmlContext::setContextProperty() :

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

Définition d'un objet en tant que propriété de contexte

Les propriétés de contexte peuvent contenir des valeurs QVariant ou QObject*. Cela signifie que des objets C++ personnalisés peuvent également être injectés en utilisant cette approche, et que ces objets peuvent être modifiés et lus directement dans QML. Ici, nous modifions l'exemple ci-dessus pour intégrer une instance QObject au lieu d'une valeur QDateTime, et le code QML invoque une méthode sur l'instance de l'objet :

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() }

(Notez que les valeurs de date et d'heure renvoyées de C++ vers QML peuvent être formatées via Qt.formatDateTime() et les fonctions associées).

Si l'élément QML doit recevoir des signaux de la propriété de contexte, il peut s'y connecter en utilisant le type Connections. Par exemple, si ApplicationData a un signal nommé dataChanged(), ce signal peut être connecté à l'aide d'un gestionnaire onDataChanged dans un objet Connections:

Text {
    text: applicationData.getCurrentDateTime()

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

Les propriétés de contexte peuvent être utiles pour utiliser des modèles de données basés sur C++ dans une vue QML. Voir les exemples suivants :

• String ListModel
• Objet ListModel
• AbstractItemModel

démontrant l'utilisation des modèles basés sur QStringList, QList<QObject*> et QAbstractItemModel dans les vues QML.

Pour plus d'informations, consultez également la documentation de QQmlContext.