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

Member Function Documentation

QQuickWidget::​QQuickWidget(QWidget * parent = 0)

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 = 0)

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

[virtual] QQuickWidget::​~QQuickWidget()

Destroys the QQuickWidget.

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.

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

Reimplemented from QObject::event().

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

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

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().

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.

[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- or fully transparent QQuickWidget, call this function with color set to Qt::transparent and set the Qt::WA_TranslucentBackground widget attribute.

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().

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

Reimplemented from QWidget::showEvent().

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

Reimplemented from QWidget::wheelEvent().