QQuickView#

The QQuickView class provides a window for displaying a Qt Quick user interface. More…

Synopsis#

Properties#

resizeMode - Whether the view should resize the window contents
source - URL of the source of the QML component
status

Functions#

def engine ()
def errors ()
def initialSize ()
def resizeMode ()
def rootContext ()
def rootObject ()
def setResizeMode (arg__1)
def sizeHint ()
def source ()
def status ()

Slots#

def setContent (url, component, item)
def setInitialProperties (initialProperties)
def setSource (arg__1)

Signals#

def statusChanged (arg__1)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

This is a convenience subclass of QQuickWindow which will automatically load and display a QML scene when given the URL of the main source file. Alternatively, you can instantiate your own objects using QQmlComponent and place them in a manually setup QQuickWindow .

Typical usage:

if __name__ == "__main__":

    app = QGuiApplication(argc, argv)
    view = QQuickView()
    view.setSource(QUrl.fromLocalFile("myqmlfile.qml"))
    view.show()
    sys.exit(app.exec())

To receive errors related to loading and executing QML with QQuickView , you can connect to the statusChanged() signal and monitor for Error . The errors are available via errors() .

QQuickView also manages sizing of the view and root object. By default, the resizeMode is SizeViewToRootObject , which will load the component and resize it to the size of the view. Alternatively the resizeMode may be set to SizeRootObjectToView which will resize the view to the size of the root object.

See also

Exposing Attributes of C++ Types to QML QQuickWidget

class PySide6.QtQuick.QQuickView(engine, parent)#

PySide6.QtQuick.QQuickView([parent=None])

PySide6.QtQuick.QQuickView(source, renderControl)

PySide6.QtQuick.QQuickView(source[, parent=None])

Parameters:

renderControl – PySide6.QtQuick.QQuickRenderControl
source – PySide6.QtCore.QUrl
engine – PySide6.QtQml.QQmlEngine
parent – PySide6.QtGui.QWindow

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 Error .

See also

Status status() errors()

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

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

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.QtQuick.QQuickView.resizeMode: ResizeMode#

This property holds whether the view should resize the window contents.

If this property is set to SizeViewToRootObject (the default), the view resizes to the size of the root item in the QML.

If this property is set to SizeRootObjectToView , the view will automatically resize the root item to the size of the view.

See also

initialSize()

Access functions:

resizeMode ()
setResizeMode (arg__1)

property PᅟySide6.QtQuick.QQuickView.source: PySide6.QtCore.QUrl#

This property holds The URL of the source of the QML component..

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

Note that setting a source URL will result in the QML component being instantiated, even if the URL is unchanged from the current value.

Access functions:

source ()
setSource (arg__1)

property PᅟySide6.QtQuick.QQuickView.status: Status#

The component’s current status .

Access functions:

status ()
Signal statusChanged (arg__1)

PySide6.QtQuick.QQuickView.ResizeMode#

This enum specifies how to resize the view.

Constant

Description

QQuickView.SizeViewToRootObject

The view resizes with the root item in the QML.

QQuickView.SizeRootObjectToView

The view will automatically resize the root item to the size of the view.

Constant	Description
QQuickView.SizeViewToRootObject	The view resizes with the root item in the QML.
QQuickView.SizeRootObjectToView	The view will automatically resize the root item to the size of the view.

PySide6.QtQuick.QQuickView.Status#

Specifies the loading status of the QQuickView .

Constant

Description

QQuickView.Null

This QQuickView has no source set.

QQuickView.Ready

This QQuickView has loaded and created the QML component.

QQuickView.Loading

This QQuickView is loading network data.

QQuickView.Error

One or more errors has occurred. Call errors() to retrieve a list of errors.

Constant	Description
QQuickView.Null	This `QQuickView` has no source set.
QQuickView.Ready	This `QQuickView` has loaded and created the QML component.
QQuickView.Loading	This `QQuickView` is loading network data.
QQuickView.Error	One or more errors has occurred. Call `errors()` to retrieve a list of errors.

PySide6.QtQuick.QQuickView.engine()#

Return type:: PySide6.QtQml.QQmlEngine

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

PySide6.QtQuick.QQuickView.errors()#

Return type:

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.

PySide6.QtQuick.QQuickView.initialSize()#

Return type:: PySide6.QtCore.QSize

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.

PySide6.QtQuick.QQuickView.resizeMode()#

Return type:: ResizeMode