QQuickView Class

Member Function Documentation

QQuickView::QQuickView(const QUrl &source, QWindow *parent = nullptr)

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

QQuickView::QQuickView(QQmlEngine *engine, QWindow *parent)

Constructs a QQuickView with the given QML engine and parent.

Note: In this case, the QQuickView 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 QQuickView::Error.

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

QQuickView::QQuickView(QWindow *parent = nullptr)

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

[slot] void QQuickView::setInitialProperties(const QVariantMap &initialProperties)

Sets the initial properties initialProperties with which the QML component gets initialized after calling QQuickView::setSource().

    QScopedPointer<QQuickView> view { new QQuickView };
    view->setInitialProperties({"x, 100"}, {"width", 50});
    view->setSource(QUrl::fromLocalFile("myqmlfile.qml"));
    view->show();

This function was introduced in Qt 5.14.

See also QQmlComponent::createWithInitialProperties().

[slot] void QQuickView::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().

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

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

Note: Notifier signal for property status.

[override virtual] QQuickView::~QQuickView()

Destroys the QQuickView.

QQmlEngine *QQuickView::engine() const

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

QList<QQmlError> QQuickView::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.

QSize QQuickView::initialSize() const

Returns the initial size of the root object.

If resizeMode is QQuickItem::SizeRootObjectToView the root object will be resized to the size of the view. initialSize contains the size of the root object before it was resized.

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

Reimplements: QQuickWindow::keyPressEvent(QKeyEvent *e).

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

Reimplements: QQuickWindow::keyReleaseEvent(QKeyEvent *e).

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

Reimplements: QQuickWindow::mouseMoveEvent(QMouseEvent *event).

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

Reimplements: QQuickWindow::mousePressEvent(QMouseEvent *event).

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

Reimplements: QQuickWindow::mouseReleaseEvent(QMouseEvent *event).

QQmlContext *QQuickView::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 *QQuickView::rootObject() const

Returns the view's root item.

QUrl QQuickView::source() const

Returns the source URL, if set.

Note: Getter function for property source.

See also setSource().