Spec-Zone.ru › Qt 5.13

Класс QQmlApplicationEngine

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

Заголовок: #include <QQmlApplicationEngine>
qmake: QT += qml
С тех пор: Qt 5.1
Наследует: QQmlEngine

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

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

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

QQmlApplicationEngine(const QString &filePath, QObject *parent = nullptr)
QQmlApplicationEngine(const QUrl &url, QObject *parent = nullptr)
QQmlApplicationEngine(QObject *parent = nullptr)
virtual ~QQmlApplicationEngine() override
QList<QObject *> rootObjects() const

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

void load(const QString &filePath)
void load(const QUrl &url)
void loadData(const QByteArray &data, const QUrl &url = QUrl())

Сигналы

void objectCreated(QObject *object, const QUrl &url)

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

Этот класс объединяет 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 будет содержать полностью разрешённый путь к файлу.

[override virtual] QQmlApplicationEngine::~QQmlApplicationEngine()

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

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

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

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.13/qqmlapplicationengine.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API