QQmlApplicationEngine Class

Documentation des fonctions membres

QQmlApplicationEngine::QQmlApplicationEngine(QObject *parent = nullptr)

Créez un nouvel objet `QQmlApplicationEngine` avec l'parent` fournie. Vous devrez ensuite appeler la méthode ` load()` pour charger un fichier QML.

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

Crée un nouvel objet `QQmlApplicationEngine` et charge le fichier QML situé à l'filePath indiquée, qui doit être un fichier local ou un chemin qrc. Si un chemin relatif est fourni, il sera interprété comme relatif au répertoire de travail de l'application.

Cette fonctionnalité est fournie à titre de commodité et revient à utiliser le constructeur vide puis à appeler la méthode `load` par la suite.

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

Crée un nouvel objet `QQmlApplicationEngine` et charge le fichier QML à l'url indiquée. Cette fonctionnalité est fournie à titre de commodité et revient au même que d'utiliser le constructeur vide puis d'appeler la méthode `load` par la suite.

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

Crée un nouvel objet `QQmlApplicationEngine` et charge le type QML spécifié par ` uri ` et ` typeName `. Cette fonctionnalité est fournie à titre de commodité et revient à utiliser le constructeur vide puis à appeler ` loadFromModule `.

Cette fonction a été introduite dans Qt 6.5.

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

Supprime l'QQmlApplicationEngine e 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 fichier du système de ressources. Si filePath est un chemin relatif, il est considéré comme relatif au répertoire de travail de l'application. L'arborescence d'objets définie par le fichier est instanciée immédiatement.

En cas d’erreur, des messages d’erreur sont affichés à l’aide de ` 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'arborescence d'objets définie par le fichier est créée immédiatement pour les URL de fichiers locaux. Les URL distantes sont chargées de manière asynchrone ; surveillez le signal « objectCreated » pour déterminer quand l'arborescence d'objets est prête.

En cas d’erreur, le signal ` objectCreated ` est émis avec un pointeur nul comme paramètre et les messages d’erreur sont affichés via ` 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 code QML indiqué à l'adresse data. L'arborescence d'objets définie par data est instanciée immédiatement.

Si une URL url est spécifiée, elle est utilisée comme URL de base du composant. Cela affecte les chemins relatifs au sein des données et des messages d'erreur.

En cas d’erreur, les messages d’erreur sont affichés en utilisant 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é à une URL distante, il sera chargé de manière asynchrone. Écoutez le signal objectCreated pour déterminer quand l’arborescence d’objets est prête.

En cas d’erreur, le signal ` objectCreated ` est émis avec un pointeur nul comme paramètre et des messages d’erreur sont affichés via ` qWarning`.

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

Cette fonction a été introduite dans Qt 6.5.

Voir également QQmlComponent::loadFromModule.

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

Ce signal est émis lorsqu'un objet a fini de se charger. Si le chargement s'est déroulé avec succès, ` object ` contient un pointeur vers l'objet chargé ; dans le cas contraire, le pointeur est `NULL`.

L'url pointant vers le composant d'où provient l'object est également fourni.

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

Ce signal est émis lorsque le chargement s'achève en raison d'une erreur.

L'url e du composant dont le chargement a échoué est fourni en tant qu'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 racine instanciés par ` 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 les paramètres « extraFileSelectors » à transmettre à l'QQmlFileSelector interne utilisé pour la résolution des URL vers des fichiers locaux. Ces paramètres « 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 également QQmlFileSelector et QFileSelector::setExtraSelectors.

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

Définit l'initialProperties e avec laquelle 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 également QQmlComponent::setInitialProperties, QQmlApplicationEngine::load et QQmlApplicationEngine::loadData.