PySide6.QtQml.QQmlIncubator

class QQmlIncubator

The QQmlIncubator class allows QML objects to be created asynchronously. More…

Synopsis

Methods

Virtual methods

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

Creating QML objects - like delegates in a view, or a new page in an application - can take a noticeable amount of time, especially on resource constrained mobile devices. When an application uses create() directly, the QML object instance is created synchronously which, depending on the complexity of the object, can cause noticeable pauses or stutters in the application.

The use of QQmlIncubator gives more control over the creation of a QML object, including allowing it to be created asynchronously using application idle time. The following example shows a simple use of QQmlIncubator .

// Initialize the incubator
QQmlIncubator incubator;
component->create(incubator);

Let the incubator run for a while (normally by returning control to the event loop), then poll it. There are a number of ways to get back to the incubator later. You may want to connect to one of the signals sent by QQuickWindow, or you may want to run a QTimer especially for that. You may also need the object for some specific purpose and poll the incubator when that purpose arises.

// Poll the incubator
if (incubator.isReady()) {
    QObject *object = incubator.object();
    // Use created object
}

Asynchronous incubators are controlled by a QQmlIncubationController that is set on the QQmlEngine , which lets the engine know when the application is idle and incubating objects should be processed. If an incubation controller is not set on the QQmlEngine , QQmlIncubator creates objects synchronously regardless of the specified IncubationMode . By default, no incubation controller is set. However, QQuickView, QQuickWindow and QQuickWidget all set incubation controllers on their respective QQmlEngine s. These incubation controllers space out incubations across multiple frames while the view is being rendered.

QQmlIncubator supports three incubation modes:

  • Synchronous The creation occurs synchronously. That is, once the create() call returns, the incubator will already be in either the Error or Ready state. A synchronous incubator has no real advantage compared to using the synchronous creation methods on QQmlComponent directly, but it may simplify an application’s implementation to use the same API for both synchronous and asynchronous creations.

  • Asynchronous (default) The creation occurs asynchronously, assuming a QQmlIncubatorController is set on the QQmlEngine .

    The incubator will remain in the Loading state until either the creation is complete or an error occurs. The statusChanged() callback can be used to be notified of status changes.

    Applications should use the Asynchronous incubation mode to create objects that are not needed immediately. For example, the ListView type uses Asynchronous incubation to create objects that are slightly off screen while the list is being scrolled. If, during asynchronous creation, the object is needed immediately the forceCompletion() method can be called to complete the creation process synchronously.

  • AsynchronousIfNested The creation will occur asynchronously if part of a nested asynchronous creation, or synchronously if not.

    In most scenarios where a QML component wants the appearance of a synchronous instantiation, it should use this mode.

    This mode is best explained with an example. When the ListView type is first created, it needs to populate itself with an initial set of delegates to show. If the ListView was 400 pixels high, and each delegate was 100 pixels high, it would need to create four initial delegate instances. If the ListView used the Asynchronous incubation mode, the ListView would always be created empty and then, sometime later, the four initial items would appear.

    Conversely, if the ListView was to use the Synchronous incubation mode it would behave correctly but it may introduce stutters into the application. As QML would have to stop and instantiate the ListView’s delegates synchronously, if the ListView was part of a QML component that was being instantiated asynchronously this would undo much of the benefit of asynchronous instantiation.

    The AsynchronousIfNested mode reconciles this problem. By using AsynchronousIfNested , the ListView delegates are instantiated asynchronously if the ListView itself is already part of an asynchronous instantiation, and synchronously otherwise. In the case of a nested asynchronous instantiation, the outer asynchronous instantiation will not complete until after all the nested instantiations have also completed. This ensures that by the time the outer asynchronous instantitation completes, inner items like ListView have already completed loading their initial delegates.

    It is almost always incorrect to use the Synchronous incubation mode - elements or components that want the appearance of synchronous instantiation, but without the downsides of introducing freezes or stutters into the application, should use the AsynchronousIfNested incubation mode.

class IncubationMode

Specifies the mode the incubator operates in. Regardless of the incubation mode, a QQmlIncubator will behave synchronously if the QQmlEngine does not have a QQmlIncubationController set.

Constant

Description

QQmlIncubator.Asynchronous

The object will be created asynchronously.

QQmlIncubator.AsynchronousIfNested

If the object is being created in a context that is already part of an asynchronous creation, this incubator will join that existing incubation and execute asynchronously. The existing incubation will not become Ready until both it and this incubation have completed. Otherwise, the incubation will execute synchronously.

QQmlIncubator.Synchronous

The object will be created synchronously.
class Status

Specifies the status of the QQmlIncubator .

Constant

Description

QQmlIncubator.Null

Incubation is not in progress. Call create() to begin incubating.

QQmlIncubator.Ready

The object is fully created and can be accessed by calling object() .

QQmlIncubator.Loading

The object is in the process of being created.

QQmlIncubator.Error

An error occurred. The errors can be access by calling errors() .
__init__([mode=QQmlIncubator.IncubationMode.Asynchronous])
Parameters:

mode – IncubationMode

Create a new incubator with the specified mode

clear()

Clears the incubator. Any in-progress incubation is aborted. If the incubator is in the Ready state, the created object is not deleted.

errors()
Return type:

.list of QQmlError

Return the list of errors encountered while incubating the object.

forceCompletion()

Force any in-progress incubation to finish synchronously. Once this call returns, the incubator will not be in the Loading state.

incubationMode()
Return type:

IncubationMode

Return the incubation mode passed to the QQmlIncubator constructor.

isError()
Return type:

bool

Returns true if the incubator’s status() is Error.

isLoading()
Return type:

bool

Returns true if the incubator’s status() is Loading.

isNull()
Return type:

bool

Returns true if the incubator’s status() is Null.

isReady()
Return type:

bool

Returns true if the incubator’s status() is Ready.

object()
Return type:

QObject

Return the incubated object if the status is Ready, otherwise 0.

setInitialProperties(initialProperties)
Parameters:

initialProperties – Dictionary with keys of type .QString and values of type QVariant.

Stores a mapping from property names to initial values, contained in initialProperties, with which the incubated component will be initialized.

setInitialState(object)
Parameters:

object – QObject

Called after the object is first created, but before complex property bindings are evaluated and, if applicable, componentComplete() is called. This is equivalent to the point between beginCreate() and completeCreate() , and can be used to assign initial values to the object’s properties.

The default implementation does nothing.

Note

Simple bindings such as numeric literals are evaluated before setInitialState() is called. The categorization of bindings into simple and complex ones is intentionally unspecified and may change between versions of Qt and depending on whether and how you are using qmlcachegen . You should not rely on any particular binding to be evaluated either before or after setInitialState() is called. For example, a constant expression like MyType.EnumValue may be recognized as such at compile time or deferred to be executed as binding. The same holds for constant expressions like -(5) or “a” + “ constant string”.

status()
Return type:

Status

Return the current status of the incubator.

statusChanged(status)
Parameters:

status – Status

Called when the status of the incubator changes. status is the new status.

The default implementation does nothing.