Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
QQuickLoaderIncubator Class Reference

#include <qquickloader_p_p.h>

+ Inheritance diagram for QQuickLoaderIncubator:
+ Collaboration diagram for QQuickLoaderIncubator:

Public Member Functions

 QQuickLoaderIncubator (QQuickLoaderPrivate *l, IncubationMode mode)
 
- Public Member Functions inherited from QQmlIncubator
 QQmlIncubator (IncubationMode=Asynchronous)
 Create a new incubator with the specified mode.
 
virtual ~QQmlIncubator ()
 
void clear ()
 Clears the incubator.
 
void forceCompletion ()
 Force any in-progress incubation to finish synchronously.
 
bool isNull () const
 Returns true if the incubator's status() is Null.
 
bool isReady () const
 Returns true if the incubator's status() is Ready.
 
bool isError () const
 Returns true if the incubator's status() is Error.
 
bool isLoading () const
 Returns true if the incubator's status() is Loading.
 
QList< QQmlError > errors () const
 Return the list of errors encountered while incubating the object.
 
IncubationMode incubationMode () const
 Return the incubation mode passed to the QQmlIncubator constructor.
 
Status status () const
 Return the current status of the incubator.
 
QObject * object () const
 Return the incubated object if the status is Ready, otherwise 0.
 
void setInitialProperties (const QVariantMap &initialProperties)
 Stores a mapping from property names to initial values, contained in initialProperties, with which the incubated component will be initialized.
 

Protected Member Functions

void statusChanged (Status) override
 Called when the status of the incubator changes.
 
void setInitialState (QObject *) override
 Called after the object is first created, but before complex property bindings are evaluated and, if applicable, QQmlParserStatus::componentComplete() is called.
 

Additional Inherited Members

- Public Types inherited from QQmlIncubator
enum  IncubationMode { Asynchronous , AsynchronousIfNested , Synchronous }
 Specifies the mode the incubator operates in. More...
 
enum  Status { Null , Ready , Loading , Error }
 Specifies the status of the QQmlIncubator. More...
 

Detailed Description

Definition at line 30 of file qquickloader_p_p.h.

Constructor & Destructor Documentation

◆ QQuickLoaderIncubator()

QQuickLoaderIncubator::QQuickLoaderIncubator ( QQuickLoaderPrivate * l,
IncubationMode mode )
inline

Definition at line 33 of file qquickloader_p_p.h.

Member Function Documentation

◆ setInitialState()

void QQuickLoaderIncubator::setInitialState ( QObject * object)
overrideprotectedvirtual

Called after the object is first created, but before complex 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.

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 \l{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"}.

Reimplemented from QQmlIncubator.

Definition at line 619 of file qquickloader.cpp.

◆ statusChanged()

void QQuickLoaderIncubator::statusChanged ( Status status)
overrideprotectedvirtual

Called when the status of the incubator changes.

status is the new status.

The default implementation does nothing.

Reimplemented from QQmlIncubator.

Definition at line 661 of file qquickloader.cpp.

The documentation for this class was generated from the following files: