Spec-Zone.ru › Qt 5.12

Класс QQmlApplicationEngine

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

Заголовок: #include <QQmlApplicationEngine>
qmake: QT += qml
С момента: Qt 5.1
Наследует: QQmlEngine
  • Список всех членов, включая унаследованные
  • Устаревшие члены

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

QQmlApplicationEngine(QObject *parent = nullptr)
QQmlApplicationEngine(const QUrl &url, QObject *parent = nullptr)
QQmlApplicationEngine(const QString &filePath, QObject *parent = nullptr)
virtual ~QQmlApplicationEngine() override
QList<QObject *> rootObjects() const
  • 26 открытых функций, унаследованных от QQmlEngine
  • 15 открытых функций, унаследованных от QJSEngine
  • 31 открытых функций, унаследованных от QObject

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

void load(const QUrl &url)
void load(const QString &filePath)
void loadData(const QByteArray &data, const QUrl &url = QUrl())
  • 1 открытый слот, унаследованный от QQmlEngine
  • 1 открытый слот, унаследованный от QObject

Сигналы

void objectCreated(QObject *object, const QUrl &url)
  • 3 сигнала, унаследованных от QQmlEngine
  • 2 сигнала, унаследованных от QObject

Статические открытые члены

const QMetaObject staticMetaObject
  • 4 статических открытых члена, унаследованных от QQmlEngine
  • 9 статических открытых членов, унаследованных от QObject

Дополнительные унаследованные члены

  • 1 свойство, унаследованное от QQmlEngine
  • 1 свойство, унаследованное от QObject
  • 1 защищённая функция, унаследованная от QQmlEngine
  • 9 защищённых функций, унаследованных от QObject

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

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

Этот класс объединяет 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.
  • Автоматически устанавливает контроллер инкубации, если сцена содержит QQuickWindow.
  • Автоматически устанавливает QQmlFileSelector в качестве интерцептора URL, применяющего селекторы файлов ко всем файлам QML и ресурсам.

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

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

QQmlApplicationEngine::QQmlApplicationEngine(QObject *parent = nullptr)

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

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

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

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

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

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

[override virtual] QQmlApplicationEngine::~QQmlApplicationEngine()

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

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

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

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

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

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

Если произошла ошибка, сообщения об ошибках выводятся с помощью 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 будет содержать полностью решенный путь к файлу.

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.12/qqmlapplicationengine.html

Spec-Zone.ru

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