Qt 5.11 | Qt QML | C++ Classes | QQmlIncubator

Qt 5.11.3 Reference Documentation

# QQmlIncubator Class

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

Header: | #include <QQmlIncubator>
qmake: | QT += qml

- List of all members, including inherited members

## Public Types

enum | IncubationMode { Asynchronous, AsynchronousIfNested, Synchronous }
enum | Status { Null, Ready, Loading, Error }

## Public Functions

| QQmlIncubator(QQmlIncubator::IncubationMode mode = Asynchronous)
void | clear()
QList<QQmlError> | errors() const
void | forceCompletion()
QQmlIncubator::IncubationMode | incubationMode() const
bool | isError() const
bool | isLoading() const
bool | isNull() const
bool | isReady() const
QObject * | object() const
QQmlIncubator::Status | status() const

## Protected Functions

virtual void | setInitialState(QObject *object)
virtual void | statusChanged(QQmlIncubator::Status status)

## Detailed Description

The QQmlIncubator class allows QML objects to be created asynchronously.

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 QQmlComponent::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.

      QQmlIncubator incubator;
      component->create(incubator);

      while (!incubator.isReady()) {
          QCoreApplication::processEvents(QEventLoop::AllEvents, 50);
      }

      QObject *object = incubator.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.

QQmlIncubator supports three incubation modes:

- Synchronous The creation occurs synchronously. That is, once the QQmlComponent::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 QQmlIncubator::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.

## Member Type Documentation

### enum QQmlIncubator::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 | Value | Description
--- | --- | ---
`QQmlIncubator::Asynchronous` | `0` | The object will be created asynchronously.
`QQmlIncubator::AsynchronousIfNested` | `1` | 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` | `2` | The object will be created synchronously.

### enum QQmlIncubator::Status

Specifies the status of the QQmlIncubator.

Constant | Value | Description
--- | --- | ---
`QQmlIncubator::Null` | `0` | Incubation is not in progress. Call QQmlComponent::create() to begin incubating.
`QQmlIncubator::Ready` | `1` | The object is fully created and can be accessed by calling object().
`QQmlIncubator::Loading` | `2` | The object is in the process of being created.
`QQmlIncubator::Error` | `3` | An error occurred. The errors can be access by calling errors().

## Member Function Documentation

### QQmlIncubator::QQmlIncubator(QQmlIncubator::IncubationMode mode = Asynchronous)

Create a new incubator with the specified mode

### void QQmlIncubator::clear()

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

### QList<QQmlError> QQmlIncubator::errors() const

Return the list of errors encountered while incubating the object.

### void QQmlIncubator::forceCompletion()

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

### QQmlIncubator::IncubationMode QQmlIncubator::incubationMode() const

Return the incubation mode passed to the QQmlIncubator constructor.

### bool QQmlIncubator::isError() const

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

### bool QQmlIncubator::isLoading() const

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

### bool QQmlIncubator::isNull() const

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

### bool QQmlIncubator::isReady() const

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

### QObject *QQmlIncubator::object() const

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

### `[virtual protected]` void QQmlIncubator::setInitialState(QObject *object)

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

The default implementation does nothing.

### QQmlIncubator::Status QQmlIncubator::status() const

Return the current status of the incubator.

### `[virtual protected]` void QQmlIncubator::statusChanged(QQmlIncubator::Status status)

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

The default implementation does nothing.