QQuickWidget Class

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

Member Function Documentation

QQuickWidget::QQuickWidget(QWidget *parent = Q_NULLPTR)

Constructs a QQuickWidget with the given parent. The default value of parent is 0.

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

Constructs a QQuickWidget with the given QML engine and parent.

Note: In this case, the QQuickWidget does not own the given engine object; it is the caller's responsibility to destroy the engine. If the engine is deleted before the view, status() will return QQuickWidget::Error.

See also Status, status(), and errors().

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

Constructs a QQuickWidget with the given QML source and parent. The default value of parent is 0.

[virtual] QQuickWidget::~QQuickWidget()

Destroys the QQuickWidget.

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

Reimplemented from QWidget::dragEnterEvent().

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

Reimplemented from QWidget::dragLeaveEvent().

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

Reimplemented from QWidget::dragMoveEvent().

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

Reimplemented from QWidget::dropEvent().

QQmlEngine *QQuickWidget::engine() const

Returns a pointer to the QQmlEngine used for instantiating QML Components.

QList<QQmlError> QQuickWidget::errors() const

Return the list of errors that occurred during the last compile or create operation. When the status is not Error, an empty list is returned.

See also status.

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

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

Reimplemented from QWidget::focusInEvent().

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

Reimplemented from QWidget::focusOutEvent().

QSurfaceFormat QQuickWidget::format() const

Returns the actual surface format.

If the widget has not yet been shown, the requested format is returned.

See also setFormat().

QImage QQuickWidget::grabFramebuffer() const

Renders a frame and reads it back into an image.

Note: This is a potentially expensive operation.

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

Reimplemented from QWidget::hideEvent().

QSize QQuickWidget::initialSize() const

Returns the initial size of the root object.

If resizeMode is SizeRootObjectToView, the root object will be resized to the size of the view. This function returns the size of the root object before it was resized.

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

Reimplemented from QWidget::keyPressEvent().

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

Reimplemented from QWidget::keyReleaseEvent().

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

Reimplemented from QWidget::mouseDoubleClickEvent().

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

Reimplemented from QWidget::mouseMoveEvent().

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

Reimplemented from QWidget::mousePressEvent().

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

Reimplemented from QWidget::mouseReleaseEvent().

QQuickWindow *QQuickWidget::quickWindow() const

Returns the offscreen QQuickWindow which is used by this widget to drive the Qt Quick rendering. This is useful if you want to use QQuickWindow APIs that are not currently exposed by QQuickWidget, for instance connecting to the QQuickWindow::beforeRendering() signal in order to draw native OpenGL content below Qt Quick's own rendering.

Warning: Use the return value of this function with caution. In particular, do not ever attempt to show the QQuickWindow, and be very careful when using other QWindow-only APIs.

This function was introduced in Qt 5.5.

QQmlContext *QQuickWidget::rootContext() const

This function returns the root of the context hierarchy. Each QML component is instantiated in a QQmlContext. QQmlContext's are essential for passing data to QML components. In QML, contexts are arranged hierarchically and this hierarchy is managed by the QQmlEngine.

QQuickItem *QQuickWidget::rootObject() const

Returns the view's root item. Can be null when setContents/setSource has not been called, if they were called with broken QtQuick code or while the QtQuick contents are being created.

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

This signal is emitted when an error occurred during scene graph initialization.

Applications should connect to this signal if they wish to handle errors, like OpenGL context creation failures, in a custom way. When no slot is connected to the signal, the behavior will be different: Quick will print the message, or show a message box, and terminate the application.

This signal will be emitted from the gui thread.

See also QQuickWindow::sceneGraphError().

void QQuickWidget::setClearColor(const QColor &color)

Sets the clear color. By default this is an opaque color.

To get a semi-transparent QQuickWidget, call this function with color set to Qt::transparent, set the Qt::WA_TranslucentBackground widget attribute on the top-level window, and request an alpha channel via setFormat().

See also QQuickWindow::setColor().

void QQuickWidget::setFormat(const QSurfaceFormat &format)

Sets the surface format for the context and offscreen surface used by this widget.

Call this function when there is a need to request a context for a given OpenGL version or profile. The sizes for depth, stencil and alpha buffers are taken care of automatically and there is no need to request those explicitly.

See also QWindow::setFormat(), QWindow::format(), and format().

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

Sets the source to the url, loads the QML component and instantiates it.

Ensure that the URL provided is full and correct, in particular, use QUrl::fromLocalFile() when loading a file from the local filesystem.

Calling this method multiple times with the same URL will result in the QML component being reinstantiated.

Note: Setter function for property source.

See also source().

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

Reimplemented from QWidget::showEvent().

QUrl QQuickWidget::source() const

Returns the source URL, if set.

Note: Getter function for property source.

See also setSource().

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

This signal is emitted when the component's current status changes.

Note: Notifier signal for property status.

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

Reimplemented from QWidget::wheelEvent().