Spec-Zone.ru › Qt 5.14

Класс QQuickView

Класс QQuickView предоставляет окно для отображения пользовательского интерфейса Qt Quick. Подробнее...

Заголовок: #include <QQuickView>
qmake: QT += quick
С момента: Qt 5.0
Наследуется от: QQuickWindow

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

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

Типы публичного доступа

Перечисление ResizeMode { SizeViewToRootObject, SizeRootObjectToView }
Перечисление Status { Null, Ready, Loading, Error }

Свойства

  • resizeMode : ResizeMode
  • source : QUrl
  • status : const Status

Функции публичного доступа

QQuickView(const QUrl &source, QWindow *parent = nullptr)
QQuickView(QQmlEngine *engine, QWindow *parent)
QQuickView(QWindow *parent = nullptr)
virtual ~QQuickView() override
QQmlEngine * engine() const
QList<QQmlError> errors() const
QSize initialSize() const
QQuickView::ResizeMode resizeMode() const
QQmlContext * rootContext() const
QQuickItem * rootObject() const
void setResizeMode(QQuickView::ResizeMode)
QUrl source() const
QQuickView::Status status() const

Свойства-слоты публичного доступа

void setInitialProperties(const QVariantMap &initialProperties)
void setSource(const QUrl &url)

Сигналы

void statusChanged(QQuickView::Status status)

Переопределенные защищенные функции

virtual void keyPressEvent(QKeyEvent *e) override
virtual void keyReleaseEvent(QKeyEvent *e) override
virtual void mouseMoveEvent(QMouseEvent *e) override
virtual void mousePressEvent(QMouseEvent *e) override
virtual void mouseReleaseEvent(QMouseEvent *e) override

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

Это удобный подкласс QQuickWindow, который автоматически загрузит и отобразит сцену QML, если ему будет предоставлен URL основного исходного файла. В качестве альтернативы, вы можете создать собственные объекты, используя QQmlComponent, и разместить их в вручную настроенном QQuickWindow.

Типичное использование:

int main(int argc, char *argv[])
{
    QGuiApplication app(argc, argv);

    QQuickView *view = new QQuickView;
    view->setSource(QUrl::fromLocalFile("myqmlfile.qml"));
    view->show();
    return app.exec();
}

Для получения ошибок, связанных с загрузкой и выполнением QML с помощью QQuickView, вы можете подключиться к сигналу statusChanged() и следить за QQuickView::Error. Ошибки доступны через QQuickView::errors().

QQuickView также управляет размерами представления и корневого объекта. По умолчанию resizeMode равен SizeViewToRootObject, что загрузит компонент и изменит его размер до размера представления. В качестве альтернативы, resizeMode можно установить в SizeRootObjectToView, что изменит размер представления до размера корневого объекта.

См. также Размещение атрибутов C++ типов в QML и QQuickWidget.

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

Перечисление QQuickView::ResizeMode

Это перечисление определяет, как изменить размер представления.

Константа Значение Описание
QQuickView::SizeViewToRootObject 0 Представление изменяет размер вместе с корневым элементом в QML.
QQuickView::SizeRootObjectToView 1 Представление автоматически изменит размер корневого элемента до размера представления.

Перечисление QQuickView::Status

Определяет состояние загрузки QQuickView.

Константа Значение Описание
QQuickView::Null 0 У данного QQuickView нет установленного источника.
QQuickView::Ready 1 Данный QQuickView загрузил и создал компонент QML.
QQuickView::Loading 2 Данный QQuickView загружает данные из сети.
QQuickView::Error 3 Произошла одна или несколько ошибок. Вызовите errors(), чтобы получить список ошибок.

Документация свойств

resizeMode : ResizeMode

Это свойство определяет, нужно ли просматриваемому содержимому изменять размер.

Если это свойство установлено в SizeViewToRootObject (значение по умолчанию), просмотр изменяет размер содержимого до размера корневого элемента в QML.

Если это свойство установлено в SizeRootObjectToView, просмотр автоматически изменяет размер корневого элемента до размера самого просмотра.

Функции доступа:

QQuickView::ResizeMode resizeMode() const
void setResizeMode(QQuickView::ResizeMode)

См. также initialSize().

source : QUrl

Это свойство содержит URL-адрес источника компонента QML.

Убедитесь, что предоставленный URL-адрес полный и правильный, в частности, используйте QUrl::fromLocalFile(), когда загружаете файл из локальной файловой системы.

Обратите внимание, что установка URL-адреса источника приведет к созданию компонента QML, даже если URL-адрес не изменен по сравнению со значением текущего.

Функции доступа:

QUrl source() const
void setSource(const QUrl &url)

status : const Status

Текущий статус компонента.

Функции доступа:

QQuickView::Status status() const

Сигнал уведомления:

void statusChanged(QQuickView::Status status)

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

QQuickView::QQuickView(const QUrl &source, QWindow *parent = nullptr)

Создаёт QQuickView с заданным QML source и parent. Значение по умолчанию для parent — 0.

QQuickView::QQuickView(QQmlEngine *engine, QWindow *parent)

Создаёт QQuickView с заданным QML engine и parent.

Примечание: в этом случае QQuickView не владеет объектом engine; за его уничтожение отвечает вызывающий код. Если engine будет удалён до просмотра, status() вернёт QQuickView::Error.

См. также Status, status() и errors().

QQuickView::QQuickView(QWindow *parent = nullptr)

Создаёт QQuickView с заданным parent. Значение по умолчанию для parent — 0.

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

Устанавливает начальные свойства initialProperties, с которыми компонент QML инициализируется после вызова QQuickView::setSource().

Примечание: Вы можете использовать эту функцию только для инициализации свойств верхнего уровня.

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

См. также QQmlComponent::createWithInitialProperties().

[slot] void QQuickView::setSource(const QUrl &url)

Устанавливает источник на url, загружает компонент QML и создаёт его экземпляр.

Убедитесь, что предоставленный URL-адрес полный и правильный, в частности, используйте QUrl::fromLocalFile() при загрузке файла из локальной файловой системы.

Многократный вызов этого метода с тем же URL-адресом приведет к повторной инициализации компонента QML.

Примечание: Функция-сеттер для свойства source.

См. также source().

[signal] void QQuickView::statusChanged(QQuickView::Status status)

Этот сигнал излучается, когда изменяется текущий статус компонента.

Примечание: Сигнал уведомления для свойства status.

[override virtual] QQuickView::~QQuickView()

Уничтожает QQuickView.

QQmlEngine *QQuickView::engine() const

Возвращает указатель на QQmlEngine, используемый для создания экземпляров компонентов QML.

QList<QQmlError> QQuickView::errors() const

Возвращает список ошибок, возникших во время последней компиляции или операции создания. Когда статус не Error, возвращается пустой список.

QSize QQuickView::initialSize() const

Возвращает начальный размер корневого объекта.

Если resizeMode равен QQuickItem::SizeRootObjectToView, корневой объект будет изменён до размера окна просмотра. initialSize содержит размер корневого объекта до его изменения.

[override virtual protected] void QQuickView::keyPressEvent(QKeyEvent *e)

Переопределяет: QQuickWindow::keyPressEvent(QKeyEvent *e).

[override virtual protected] void QQuickView::keyReleaseEvent(QKeyEvent *e)

Переопределяет: QQuickWindow::keyReleaseEvent(QKeyEvent *e).

[override virtual protected] void QQuickView::mouseMoveEvent(QMouseEvent *e)

Переопределяет: QQuickWindow::mouseMoveEvent(QMouseEvent *event).

[override virtual protected] void QQuickView::mousePressEvent(QMouseEvent *e)

Переопределяет: QQuickWindow::mousePressEvent(QMouseEvent *event).

[override virtual protected] void QQuickView::mouseReleaseEvent(QMouseEvent *e)

Переопределяет: QQuickWindow::mouseReleaseEvent(QMouseEvent *event).

QQmlContext *QQuickView::rootContext() const

Эта функция возвращает корень иерархии контекстов. Каждый компонент QML создаётся в QQmlContext. QQmlContext необходимы для передачи данных в компоненты QML. В QML контексты организованы иерархически, и эта иерархия управляется QQmlEngine.

QQuickItem *QQuickView::rootObject() const

Возвращает корневой элемент просмотра.

QUrl QQuickView::source() const

Возвращает URL-адрес источника, если он задан.

Примечание: Функция-геттер для свойства source.

См. также setSource().

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

Spec-Zone.ru

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