Класс QQmlApplicationEngine

Класс QQmlApplicationEngine предоставляет удобный способ загрузки приложения из одного файла QML. Подробнее...

Этот класс был представлен в Qt 5.1.

• Список всех членов, включая унаследованные

Открытые функции

Открытые слоты

Сигналы

Подробное описание

Этот класс объединяет QQmlEngine и QQmlComponent для удобной загрузки одного файла QML. Он также предоставляет некоторые центральные функции приложения для QML, которые гибридное приложение C++/QML обычно контролирует из C++.

Его можно использовать так:

#include <QGuiApplication>
#include <QQmlApplicationEngine>

int main(int argc, char *argv[])
{
    QGuiApplication app(argc, argv);
    QQmlApplicationEngine engine("main.qml");
    return app.exec();
}

В отличие от QQuickView, QQmlApplicationEngine не автоматически создает корневое окно. Если вы используете визуальные элементы из Qt Quick, вам нужно разместить их внутри Window.

Вы также можете использовать QCoreApplication с QQmlApplicationEngine, если вы не используете какие-либо модули QML, которые требуют QGuiApplication (например, QtQuick).

Список изменений конфигурации по умолчанию QQmlEngine:

• Подключение Qt.quit() к QCoreApplication::quit()
• Автоматически загружает файлы переводов из каталога i18n, расположенного рядом с основным файлом QML.
  • Файлы переводов должны иметь префикс "qml_", например, qml_ja_JP.qm.
• Автоматически устанавливает контроллер инкубации, если сцена содержит QQuickWindow.
• Автоматически устанавливает QQmlFileSelector в качестве интерцептора URL, применяя селекторы файлов ко всем файлам QML и ресурсам.

Поведение движка можно дополнительно настроить, используя унаследованные методы из QQmlEngine.

Документация по членам-функциям

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

Создаёт новый QQmlApplicationEngine и загружает файл QML по указанному пути filePath, который должен быть локальным путем к файлу. Если указан относительный путь, он будет интерпретирован как относительный к рабочей директории приложения.

Это предоставлено для удобства и эквивалентно использованию конструктора без параметров и вызову load после этого.

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

Создаёт новый QQmlApplicationEngine и загружает файл QML по заданному url. Это предоставлено для удобства и эквивалентно использованию пустого конструктора и последующего вызова load.

QQmlApplicationEngine::QQmlApplicationEngine(QObject *parent = nullptr)

Создаёт новый QQmlApplicationEngine с заданным parent. Вам нужно будет вызвать load() позже, чтобы загрузить файл QML.

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

Загружает корневой файл QML, расположенный по пути filePath. filePath должен быть путем к локальному файлу. Если filePath — относительный путь, он рассматривается как относительный к рабочей директории приложения. Дерево объектов, определённое в файле, инициализируется немедленно.

Если произошла ошибка, сообщения об ошибке выводятся с помощью qWarning.

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

Загружает корневой файл QML, расположенный по адресу url. Дерево объектов, определённое в файле, создаётся немедленно для локальных URL-адресов файлов. Дистанционные URL-адреса загружаются асинхронно, следите за сигналом objectCreated, чтобы определить, когда дерево объектов готово.

Если произошла ошибка, сигнал objectCreated отправляется с указателем null в качестве параметра, и сообщения об ошибках выводятся с помощью qWarning.

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

Загружает QML, заданный в data. Дерево объектов, определённое в data, инициализируется немедленно.

Если указан url, он используется в качестве базового URL-адреса компонента. Это влияет на относительные пути внутри данных и сообщения об ошибках.

Если произошла ошибка, сообщения об ошибках выводятся с помощью qWarning.

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

Этот сигнал отправляется, когда объект завершает загрузку. Если загрузка прошла успешно, object содержит указатель на загруженный объект, в противном случае указатель — NULL.

Также предоставляется url компонента, из которого был получен object.

Примечание: Если путь к компоненту был предоставлен в виде QString с относительным путём, url будет содержать полностью разрешённый путь к файлу.

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

Устанавливает initialProperties, с помощью которых компонент QML инициализируется после загрузки.

Эта функция была представлена в Qt 5.14.

См. также QQmlComponent::setInitialProperties, QQmlApplicationEngine::load и QQmlApplicationEngine::loadData.

[override virtual] QQmlApplicationEngine::~QQmlApplicationEngine()

Уничтожает QQmlApplicationEngine и все объекты QML, которые он загрузил.

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

Возвращает список всех корневых объектов, созданных QQmlApplicationEngine. Он будет содержать только объекты, загруженные через load() или удобные конструкторы.

Примечание: В версиях Qt до 5.9 эта функция помечена как не-const.