C++-Objekte mit Kontexteigenschaften in QML einbetten

Beim Laden eines QML-Objekts in eine C++-Anwendung kann es nützlich sein, einige C++-Daten direkt einzubetten, die aus dem QML-Code heraus verwendet werden können. Dadurch ist es zum Beispiel möglich, eine C++-Methode auf dem eingebetteten Objekt aufzurufen oder eine C++-Objektinstanz als Datenmodell für eine QML-Ansicht zu verwenden.

Die Fähigkeit, C++-Daten in ein QML-Objekt zu injizieren, wird durch die Klasse QQmlContext ermöglicht. Diese Klasse stellt Daten dem Kontext eines QML-Objekts zur Verfügung, so dass die Daten direkt aus dem Bereich des QML-Codes referenziert werden können.

Einstellen einer einfachen Kontexteigenschaft

Hier ein Beispiel für ein QML-Element, das auf einen currentDateTime -Wert verweist, der im aktuellen Bereich nicht vorhanden ist:

// MyItem.qml
import QtQuick

Text { text: currentDateTime }

Dieser currentDateTime -Wert kann direkt von der C++-Anwendung, die die QML-Komponente lädt, mit QQmlContext::setContextProperty() gesetzt werden:

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

Festlegen eines Objekts als Kontexteigenschaft

Kontexteigenschaften können entweder QVariant oder QObject* Werte enthalten. Das bedeutet, dass auch benutzerdefinierte C++-Objekte mit diesem Ansatz injiziert werden können, und diese Objekte können direkt in QML geändert und gelesen werden. Hier wird das obige Beispiel geändert, um eine QObject Instanz anstelle eines QDateTime Wertes einzubetten, und der QML-Code ruft eine Methode auf der Objektinstanz auf:

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

(Beachten Sie, dass Datums-/Zeitwerte, die von C++ an QML zurückgegeben werden, durch Qt.formatDateTime() und zugehörige Funktionen formatiert werden können).

Wenn das QML-Element Signale von der Kontexteigenschaft empfangen muss, kann es sich mit ihnen über den Typ Connections verbinden. Wenn zum Beispiel ApplicationData ein Signal mit dem Namen dataChanged() hat, kann dieses Signal über einen onDataChanged Handler innerhalb eines Connections Objekts verbunden werden:

Text {
    text: applicationData.getCurrentDateTime()

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

Kontexteigenschaften können für die Verwendung von C++-basierten Datenmodellen in einer QML-Ansicht nützlich sein. Siehe die folgenden Beispiele:

• String ListModel
• Objekt ListModel
• AbstractItemModel

zur Demonstration der Verwendung von QStringList, QList<QObject*>-basierten Modellen und QAbstractItemModel in QML-Ansichten.

Weitere Informationen finden Sie auch in der Dokumentation QQmlContext.