Struct qt_qml::QQmlIncubationController

#[repr(C)]pub struct QQmlIncubationController { /* fields omitted */ }

In order to behave asynchronously and not introduce stutters or freezes in an application, the process of creating objects a QQmlIncubators must be driven only during the application's idle time. QQmlIncubationController allows the application to control exactly when, how often and for how long this processing occurs.

C++ class: QQmlIncubationController.

C++ documentation:

In order to behave asynchronously and not introduce stutters or freezes in an application, the process of creating objects a QQmlIncubators must be driven only during the application's idle time. QQmlIncubationController allows the application to control exactly when, how often and for how long this processing occurs.

A QQmlIncubationController derived instance should be created and set on a QQmlEngine by calling the QQmlEngine::setIncubationController() method. Processing is then controlled by calling the QQmlIncubationController::incubateFor() or QQmlIncubationController::incubateWhile() methods as dictated by the application's requirements.

For example, this is an example of a incubation controller that will incubate for a maximum of 5 milliseconds out of every 16 milliseconds.

class PeriodicIncubationController : public QObject,
                                       public QQmlIncubationController
{
public:
      PeriodicIncubationController() {
          startTimer(16);
      }
protected:
      void timerEvent(QTimerEvent *) override {
          incubateFor(5);
      }
};

Although the previous example would work, it is not optimal. Real world incubation controllers should try and maximize the amount of idle time they consume - rather than a static amount like 5 milliseconds - while not disturbing the application.

Methods

impl QQmlIncubationController

pub unsafe fn engine(&self) -> QPtr<QQmlEngine>

Return the QQmlEngine this incubation controller is set on, or 0 if it has not been set on any engine.

Calls C++ function: QQmlEngine* QQmlIncubationController::engine() const.

C++ documentation:

Return the QQmlEngine this incubation controller is set on, or 0 if it has not been set on any engine.

pub unsafe fn incubate_for(&self, msecs: c_int)

Incubate objects for msecs, or until there are no more objects to incubate.

Calls C++ function: void QQmlIncubationController::incubateFor(int msecs).

C++ documentation:

Incubate objects for msecs, or until there are no more objects to incubate.

pub unsafe fn incubating_object_count(&self) -> c_int

Return the number of objects currently incubating.

Calls C++ function: int QQmlIncubationController::incubatingObjectCount() const.

C++ documentation:

Return the number of objects currently incubating.

pub unsafe fn new() -> CppBox<QQmlIncubationController>

Create a new incubation controller.

Calls C++ function: [constructor] void QQmlIncubationController::QQmlIncubationController().

C++ documentation:

Create a new incubation controller.

Trait Implementations

impl CppDeletable for QQmlIncubationController

unsafe fn delete(&self)

Calls C++ function: virtual [destructor] void QQmlIncubationController::~QQmlIncubationController().