Класс QQuickWidget

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

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

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

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

Свойства

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

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

Общедоступные слоты

Сигналы

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

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

Это удобная обертка для 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 и QQuickView.

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

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

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

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

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

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

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

Создаёт QQuickWidget с заданным QML-источником и родительским виджетом. Значение по умолчанию для родительского виджета — 0.

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

Создаёт QQuickWidget с заданным QML-движком и родительским виджетом.

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

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

QQuickWidget::QQuickWidget(QWidget *parent = nullptr)

Создаёт QQuickWidget с заданным родительским виджетом. Значение по умолчанию для родительского виджета — 0.

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

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

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

Этот сигнал будет испускаться из потока GUI.

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

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

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

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

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

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

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

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

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

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

[override virtual] QQuickWidget::~QQuickWidget()

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

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

Переопределяет: QWidget::dragEnterEvent(QDragEnterEvent *event).

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

Переопределяет: QWidget::dragLeaveEvent(QDragLeaveEvent *event).

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

Переопределяет: QWidget::dragMoveEvent(QDragMoveEvent *event).

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

Переопределяет: QWidget::dropEvent(QDropEvent *event).

QQmlEngine *QQuickWidget::engine() const

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

QList<QQmlError> QQuickWidget::errors() const

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

См. также status.

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

Переопределяет: QWidget::event(QEvent *event).

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

Переопределяет: QWidget::focusInEvent(QFocusEvent *event).

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

Переопределяет: QWidget::focusNextPrevChild(bool next).

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

Переопределяет: QWidget::focusOutEvent(QFocusEvent *event).

QSurfaceFormat QQuickWidget::format() const

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

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

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

QImage QQuickWidget::grabFramebuffer() const

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

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

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

Переопределяет: QWidget::hideEvent(QHideEvent *event).

QSize QQuickWidget::initialSize() const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Переопределяет: QWidget::paintEvent(QPaintEvent *event).

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 создаётся.

void QQuickWidget::setClearColor(const QColor &color)

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

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

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

void QQuickWidget::setFormat(const QSurfaceFormat &format)

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

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

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

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

Переопределяет: QWidget::showEvent(QShowEvent *event).

QUrl QQuickWidget::source() const

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

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

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

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

Переопределяет: QWidget::wheelEvent(QWheelEvent *event).