Класс QQuickWidget

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

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

Открытые типы

Свойства

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

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

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

• 214 открытых функций, унаследованных от QWidget
• 32 открытых функций, унаследованных от QObject
• 14 открытых функций, унаследованных от QPaintDevice

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

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

Сигналы

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

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

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

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

• 5 статических открытых членов, унаследованных от QWidget
• 11 статических открытых членов, унаследованных от QObject
• 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 и анимации, управляемые синхронизацией кадров, будут недоступны.

Примечание: Избегайте вызова 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 приведёт к проблемам.

См. также Exposing Attributes of C++ Types to QML, Qt Quick Widgets Example, и QQuickView.

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

enum QQuickWidget::ResizeMode

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

enum QQuickWidget::Status

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

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

QQuickWidget::QQuickWidget(QWidget *parent = Q_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 = Q_NULLPTR)

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

[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)

Переопределяет QObject::event().

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

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

[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)

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

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

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

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

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

Вызовите эту функцию, когда необходимо запросить контекст для определённой версии 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.

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

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