Класс QQuickWidget

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

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

Общие типы

Свойства

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

• 59 свойств унаследовано от QWidget
• 1 свойство унаследовано от QObject

Общедоступные функции

• 216 общедоступных функций унаследовано от QWidget
• 31 общедоступная функция унаследовано от QObject
• 14 общедоступных функций унаследовано от QPaintDevice

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

• 19 открытых слотов унаследовано от QWidget
• 1 открытый слот унаследовано от QObject

Сигналы

• 3 сигнала унаследовано от QWidget
• 2 сигнала унаследовано от QObject

Статические общедоступные члены

• 5 статических общедоступных членов унаследовано от QWidget
• 9 статических общедоступных членов унаследовано от QObject

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

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

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

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

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

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

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

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

QQuickWidget *view = new QQuickWidget;
view->setSource(QUrl::fromLocalFile("myqmlfile.qml"));
view->show();

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

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

Примечание: QQuickWidget — альтернатива использованию QQuickView и QWidget::createWindowContainer(). Ограничения по порядку стека не применяются, что делает QQuickWidget более гибким вариантом, который ведет себя как обычный виджет. Это происходит за счет производительности. В отличие от QQuickWindow и QQuickView, QQuickWidget включает рендеринг в объекты буфера кадра OpenGL. Это неизбежно приведет к небольшой потере производительности.

Примечание: Использование QQuickWidget отключает потоковый цикл рендеринга на всех платформах. Это означает, что некоторые преимущества потокового рендеринга, например, классы Animator и анимации, управляемые vsync, недоступны.

Примечание: Избегайте вызова winId() для QQuickWidget. Эта функция запускает создание нативного окна, что приводит к снижению производительности и, возможно, проблемам с рендерингом. Цель QQuickWidget — рендерить сцены Quick без отдельного нативного окна, поэтому избегайте создания нативного виджета.

Персистентность графа сцены и контекста

QQuickWidget учитывает QQuickWindow::isPersistentSceneGraph(), что означает, что приложения могут принять решение — вызвав QQuickWindow::setPersistentSceneGraph() для окна, возвращенного функцией quickWindow() — разрешить выпуск узлов графа сцены и других ресурсов Qt Quick, связанных со сценой, когда виджет становится скрытым. По умолчанию персистентность включена, как и в QQuickWindow.

При работе с OpenGL-бекендом графа сцены QQuickWindow предлагает возможность отключить персистентные контексты OpenGL. Эта настройка в настоящее время игнорируется QQuickWidget, и контекст всегда персистентен. Таким образом, контекст OpenGL не уничтожается при скрытии виджета. Контекст уничтожается только при уничтожении виджета или при его переродительстве в качестве дочернего элемента другого виджета верхнего уровня. Однако некоторые приложения, особенно те, которые имеют собственные графические ресурсы из-за выполнения пользовательского рендеринга OpenGL в сцене Qt Quick, могут захотеть отключить последнее, поскольку они могут не быть готовы обрабатывать потерю контекста при перемещении QQuickWidget в другое окно. Такие приложения могут установить атрибут QCoreApplication::AA_ShareOpenGLContexts. Для обсуждения деталей инициализации и очистки ресурсов см. документацию по QOpenGLWidget.

Примечание: QQuickWidget предоставляет менее подробный контроль над его внутренним контекстом OpenGL по сравнению с QOpenGLWidget, и есть тонкие различия, в частности, что отключение персистентного графа сцены приведет к уничтожению контекста при изменении окна независимо от наличия QCoreApplication::AA_ShareOpenGLContexts.

Ограничения

Размещение других виджетов под QQuickWidget и придание ему прозрачности не приведет к ожидаемым результатам: виджеты под ним не будут видны. Это связано с тем, что на практике QQuickWidget отрисовывается перед всеми другими обычными, не-OpenGL виджетами, поэтому прозрачные решения невозможны. Другие типы макетов, например, расположение виджетов поверх QQuickWidget, будут работать как ожидается.

В случае крайней необходимости это ограничение можно обойти, установив атрибут Qt::WA_AlwaysStackOnTop для QQuickWidget. Имейте в виду, что это нарушает порядок стека. Например, другие виджеты не смогут расположиться сверху QQuickWidget, поэтому его следует использовать только в ситуациях, когда требуется полупрозрачный QQuickWidget с видимыми виджетами под ним.

Это ограничение действует только при наличии других виджетов под QQuickWidget в одном окне. Для придания полупрозрачности окну с другими приложениями и рабочим столом на фоне используется традиционный подход: установите Qt::WA_TranslucentBackground для окна верхнего уровня, запросите альфа-канал и измените цвет очистки графа сцены Qt Quick на Qt::transparent с помощью setClearColor().

Поддержка при отсутствии OpenGL

Помимо OpenGL, бекенд Qt Quick также поддерживает QQuickWidget. Однако другие бекенды, например, Direct 3D 12, несовместимы, и попытка создать QQuickWidget приведет к проблемам.

Обработка клавиши Tab

При нажатии клавиши [TAB] фокус получает элемент внутри QQuickWidget. Если этот элемент может обработать нажатие клавиши [TAB], фокус изменится внутри элемента, в противном случае фокус получит следующий виджет в цепочке фокуса.

См. также Экспонирование атрибутов типов C++ в QML, Пример Qt Quick Widgets и QQuickView.

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

перечисление QQuickWidget::ResizeMode

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

перечисление QQuickWidget::Status

Указывает состояние загрузки QQuickWidget.

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

QQuickWidget::QQuickWidget(QWidget *parent = nullptr)

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

QQuickWidget::QQuickWidget(QQmlEngine *engine, QWidget *parent)

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

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

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

QQuickWidget::QQuickWidget(const QUrl &source, QWidget *parent = nullptr)

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

[override virtual] QQuickWidget::~QQuickWidget()

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

[override virtual protected] void QQuickWidget::dragEnterEvent(QDragEnterEvent *e)

Переопределено из QWidget::dragEnterEvent().

[override virtual protected] void QQuickWidget::dragLeaveEvent(QDragLeaveEvent *e)

Переопределено из QWidget::dragLeaveEvent().

[override virtual protected] void QQuickWidget::dragMoveEvent(QDragMoveEvent *e)

Переопределено из QWidget::dragMoveEvent().

[override virtual protected] void QQuickWidget::dropEvent(QDropEvent *e)

Переопределено из QWidget::dropEvent().

QQmlEngine *QQuickWidget::engine() const

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

QList<QQmlError> QQuickWidget::errors() const

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

См. также status.

[override virtual protected] bool QQuickWidget::event(QEvent *e)

Переопределено из QWidget::event().

[override virtual protected] void QQuickWidget::focusInEvent(QFocusEvent *event)

Переопределено из QWidget::focusInEvent().

[override virtual protected] bool QQuickWidget::focusNextPrevChild(bool next)

Переопределено из QWidget::focusNextPrevChild().

[override virtual protected] void QQuickWidget::focusOutEvent(QFocusEvent *event)

Переопределено из QWidget::focusOutEvent().

QSurfaceFormat QQuickWidget::format() const

Возвращает фактический формат поверхности.

Если виджет ещё не отображен, возвращается запрошенный формат.

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

QImage QQuickWidget::grabFramebuffer() const

Отображает кадр и считывает его в изображение.

Примечание: Эта операция может быть ресурсоёмкой.

[override virtual protected] void QQuickWidget::hideEvent(QHideEvent *)

Переопределено из QWidget::hideEvent().

QSize QQuickWidget::initialSize() const

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

Если resizeMode равен SizeRootObjectToView, корневой объект будет изменён до размера виджета. Эта функция возвращает размер корневого объекта до изменения.

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

Переопределено из QWidget::keyPressEvent().

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

Переопределено из QWidget::keyReleaseEvent().

[override virtual protected] void QQuickWidget::mouseDoubleClickEvent(QMouseEvent *e)

Переопределено из QWidget::mouseDoubleClickEvent().

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

Переопределено из QWidget::mouseMoveEvent().

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

Переопределено из QWidget::mousePressEvent().

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

Переопределено из QWidget::mouseReleaseEvent().

[override virtual protected] void QQuickWidget::paintEvent(QPaintEvent *event)

Переопределено из QWidget::paintEvent().

QQuickWindow *QQuickWidget::quickWindow() const

Возвращает скрытое QQuickWindow, используемое этим виджетом для управления рендерингом Qt Quick. Это полезно, если вы хотите использовать API QQuickWindow, которые в данный момент не доступны через QQuickWidget, например, подключение к сигналу QQuickWindow::beforeRendering() для отрисовки нативного контента OpenGL под собственным рендерингом Qt Quick.

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

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

QQmlContext *QQuickWidget::rootContext() const

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

QQuickItem *QQuickWidget::rootObject() const

Возвращает корневой элемент (item) представления. Может быть нулевым, когда setSource() не был вызван, если он был вызван с некорректным кодом QtQuick или во время создания содержимого QtQuick.

[signal] void QQuickWidget::sceneGraphError(QQuickWindow::SceneGraphError error, const QString &message)

Этот сигнал подается, когда во время инициализации сцены графика произошла ошибка error.

Приложения должны подключаться к этому сигналу, если они хотят обрабатывать ошибки, такие как сбои создания контекста OpenGL, своим способом. Если к сигналу не подключен обработчик, поведение будет отличаться: Quick выведет message или отобразит сообщение в окне и завершит приложение.

Этот сигнал будет испускаться из потока графического интерфейса.

См. также QQuickWindow::sceneGraphError().

void QQuickWidget::setClearColor(const QColor &color)

Устанавливает цвет очистки color. По умолчанию это непрозрачный цвет.

Для получения полупрозрачного QQuickWidget вызовите эту функцию с color, установленным в Qt::transparent, установите атрибут виджета Qt::WA_TranslucentBackground для окна верхнего уровня и запросите альфа-канал с помощью setFormat().

См. также QQuickWindow::setColor().

void QQuickWidget::setFormat(const QSurfaceFormat &format)

Устанавливает формат поверхности format для контекста и offscreen-поверхности, используемых этим виджетом.

Вызывайте эту функцию, когда требуется запрос контекста для определённой версии или профиля OpenGL. Размеры буферов глубины, трафарета и альфа-канала обрабатываются автоматически, и нет необходимости запрашивать их явно.

См. также QWindow::setFormat(), QWindow::format(), и format().

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

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

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

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

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

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

[override virtual protected] void QQuickWidget::showEvent(QShowEvent *)

Переопределено из QWidget::showEvent().

QUrl QQuickWidget::source() const

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

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

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

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

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

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

[override virtual protected] void QQuickWidget::wheelEvent(QWheelEvent *e)

Переопределено из QWidget::wheelEvent().