QQmlApplicationEngine Class

Documentation des fonctions membres

QQmlApplicationEngine::QQmlApplicationEngine(QObject *parent = nullptr)

Créez un nouveau QQmlApplicationEngine avec l'adresse parent. Vous devrez appeler load() ultérieurement pour charger un fichier QML.

QQmlApplicationEngine::QQmlApplicationEngine(const QString &filePath, QObject *parent = nullptr)

Crée un nouveau QQmlApplicationEngine et charge le fichier QML à l'adresse filePath, qui doit être un fichier local ou un chemin qrc. Si un chemin relatif est donné, il sera interprété comme étant relatif au répertoire de travail de l'application.

Ceci est fourni par commodité, et revient à utiliser le constructeur vide et à appeler load par la suite.

QQmlApplicationEngine::QQmlApplicationEngine(const QUrl &url, QObject *parent = nullptr)

Crée un nouveau QQmlApplicationEngine et charge le fichier QML à l'adresse url. Ceci est fourni à titre de commodité, et revient à utiliser le constructeur vide et à appeler load ensuite.

[explicit, since 6.5] QQmlApplicationEngine::QQmlApplicationEngine(QAnyStringView uri, QAnyStringView typeName, QObject *parent = nullptr)

Crée un nouveau QQmlApplicationEngine et charge le type QML spécifié par uri et typeName. Cette fonction est fournie par commodité et revient à utiliser le constructeur vide et à appeler loadFromModule par la suite.

Cette fonction a été introduite dans Qt 6.5.

[override virtual noexcept] QQmlApplicationEngine::~QQmlApplicationEngine()

Détruit le site QQmlApplicationEngine et tous les objets QML qu'il a chargés.

[slot] void QQmlApplicationEngine::load(const QString &filePath)

Charge le fichier QML racine situé à l'adresse filePath. filePath doit être un chemin d'accès à un fichier local ou un chemin d'accès à un fichier du système de fichiers de ressources. Si filePath est un chemin relatif, il est considéré comme relatif au répertoire de travail de l'application. L'arbre d'objets défini par le fichier est instancié immédiatement.

En cas d'erreur, les messages d'erreur sont imprimés avec qWarning.

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        qmlApplicationEngine, qOverload(&QQmlApplicationEngine::load));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        qmlApplicationEngine, [receiver = qmlApplicationEngine](const QString &filePath) { receiver->load(filePath); });

[slot] void QQmlApplicationEngine::load(const QUrl &url)

Charge le fichier QML racine situé à l'adresse url. L'arbre d'objets défini par le fichier est créé immédiatement pour les urls de fichiers locaux. Les URL distantes sont chargées de manière asynchrone ; il convient d'écouter le signal objectCreated pour déterminer si l'arbre d'objets est prêt.

En cas d'erreur, le signal objectCreated est émis avec un pointeur nul comme paramètre et les messages d'erreur sont imprimés avec qWarning.

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        qmlApplicationEngine, qOverload(&QQmlApplicationEngine::load));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        qmlApplicationEngine, [receiver = qmlApplicationEngine](const QUrl &url) { receiver->load(url); });

[slot] void QQmlApplicationEngine::loadData(const QByteArray &data, const QUrl &url = QUrl())

Charge le QML donné dans data. L'arbre d'objets défini par data est instancié immédiatement.

Si un url est spécifié, il est utilisé comme url de base du composant. Cela affecte les chemins relatifs dans les données et les messages d'erreur.

En cas d'erreur, les messages d'erreur sont imprimés avec qWarning.

[slot, since 6.5] void QQmlApplicationEngine::loadFromModule(QAnyStringView uri, QAnyStringView typeName)

Charge le type QML typeName à partir du module spécifié par uri. Si le type provient d'un fichier QML situé dans une url distante, le type sera chargé de manière asynchrone. Écoutez le signal objectCreated pour déterminer si l'arbre d'objets est prêt.

En cas d'erreur, le signal objectCreated est émis avec un pointeur nul comme paramètre et les messages d'erreur sont imprimés avec qWarning.

QQmlApplicationEngine engine;
engine.loadFromModule("QtQuick", "Rectangle");

Cette fonction a été introduite dans Qt 6.5.

Voir aussi QQmlComponent::loadFromModule.

[signal] void QQmlApplicationEngine::objectCreated(QObject *object, const QUrl &url)

Ce signal est émis lorsque le chargement d'un objet est terminé. Si le chargement a réussi, object contient un pointeur sur l'objet chargé, sinon le pointeur est NULL.

L'adresse url du composant d'où provient l'objet object est également fournie.

[signal, since 6.4] void QQmlApplicationEngine::objectCreationFailed(const QUrl &url)

Ce signal est émis lorsque le chargement se termine en raison d'une erreur.

L'adresse url du composant dont le chargement a échoué est fournie en argument.

QGuiApplication app(argc, argv);
QQmlApplicationEngine engine;

// exit on error
QObject::connect(&engine, &QQmlApplicationEngine::objectCreationFailed,
    &app, []() { QCoreApplication::exit(-1); }, Qt::QueuedConnection);
engine.load(QUrl());
return app.exec();

Voir également QQmlApplicationEngine::objectCreated, qui sera émis en plus de ce signal (même si la création a échoué).

Cette fonction a été introduite dans Qt 6.4.

QList<QObject *> QQmlApplicationEngine::rootObjects() const

Renvoie une liste de tous les objets racines instanciés par la fonction QQmlApplicationEngine. Cette liste ne contiendra que les objets chargés via load() ou un constructeur de commodité.

[slot, since 6.0] void QQmlApplicationEngine::setExtraFileSelectors(const QStringList &extraFileSelectors)

Définit l'adresse extraFileSelectors à transmettre à l'adresse interne QQmlFileSelector utilisée pour résoudre les URL des fichiers locaux. Les extraFileSelectors sont appliqués lors du chargement du premier fichier QML. Les définir par la suite n'a aucun effet.

Cette fonction a été introduite dans Qt 6.0.

Voir aussi QQmlFileSelector et QFileSelector::setExtraSelectors.

[slot] void QQmlApplicationEngine::setInitialProperties(const QVariantMap &initialProperties)

Définit le site initialProperties avec lequel le composant QML est initialisé après son chargement.

QQmlApplicationEngine engine;

EventDatabase eventDatabase;
EventMonitor eventMonitor;

engine.setInitialProperties({
    { "eventDatabase", QVariant::fromValue(&eventDatabase) },
    { "eventMonitor", QVariant::fromValue(&eventMonitor) }
});

Voir aussi QQmlComponent::setInitialProperties, QQmlApplicationEngine::load, et QQmlApplicationEngine::loadData.