#include <qqmlinstantiator_p.h>

Inheritance diagram for QQmlInstantiator:

Collaboration diagram for QQmlInstantiator:

Signals
void	modelChanged ()

void	delegateChanged ()

void	countChanged ()

void	objectChanged ()

void	activeChanged ()

void	asynchronousChanged ()

void	objectAdded (int index, QObject *object)

void	objectRemoved (int index, QObject *object)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQmlInstantiator (QObject *parent=nullptr)
	\qmltype Instantiator \nativetype QQmlInstantiator \inqmlmodule QtQml.Models

	~QQmlInstantiator ()

bool	isActive () const
	\qmlsignal QtQml.Models::Instantiator::objectAdded(int index, QtObject object)

void	setActive (bool newVal)

bool	isAsync () const
	\qmlproperty bool QtQml.Models::Instantiator::asynchronous

void	setAsync (bool newVal)

int	count () const
	\qmlproperty int QtQml.Models::Instantiator::count

QQmlComponent *	delegate ()

void	setDelegate (QQmlComponent *c)

QVariant	model () const
	\qmlproperty variant QtQml.Models::Instantiator::model

void	setModel (const QVariant &v)

QObject *	object () const
	\qmlproperty QtObject QtQml.Models::Instantiator::object

Q_INVOKABLE QObject *	objectAt (int index) const
	\qmlmethod QtObject QtQml.Models::Instantiator::objectAt(int index)

void	classBegin () override

void	componentComplete () override

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Properties
bool	active

bool	asynchronous

QVariant	model

int	count

QQmlComponent *	delegate
	\qmlproperty QtQml::Component QtQml.Models::Instantiator::delegate \qmldefault

QObject *	object

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 27 of file qqmlinstantiator_p.h.

Constructor & Destructor Documentation

◆ QQmlInstantiator()

QQmlInstantiator::QQmlInstantiator ( QObject * parent = nullptr )

\qmltype Instantiator \nativetype QQmlInstantiator \inqmlmodule QtQml.Models

Dynamically creates objects.

A Instantiator can be used to control the dynamic creation of objects, or to dynamically create multiple objects from a template.

The Instantiator element will manage the objects it creates. Those objects are parented to the Instantiator and can also be deleted by the Instantiator if the Instantiator's properties change. Objects can also be destroyed dynamically through other means, and the Instantiator will not recreate them unless the properties of the Instantiator change.

Note: Instantiator is part of QtQml.Models since version 2.14 and part of QtQml since version 2.1. Importing Instantiator via QtQml is deprecated since Qt 5.14.

Definition at line 203 of file qqmlinstantiator.cpp.

◆ ~QQmlInstantiator()

QQmlInstantiator::~QQmlInstantiator ( )

Definition at line 208 of file qqmlinstantiator.cpp.

Member Function Documentation

◆ activeChanged

void QQmlInstantiator::activeChanged ( )

signal

◆ asynchronousChanged

void QQmlInstantiator::asynchronousChanged ( )

signal

◆ classBegin()

void QQmlInstantiator::classBegin ( )

overridevirtual

Implements QQmlParserStatus.

Definition at line 446 of file qqmlinstantiator.cpp.

◆ componentComplete()

void QQmlInstantiator::componentComplete ( )

overridevirtual

Implements QQmlParserStatus.

Definition at line 455 of file qqmlinstantiator.cpp.

◆ count()

int QQmlInstantiator::count ( ) const

\qmlproperty int QtQml.Models::Instantiator::count

The number of objects the Instantiator is currently managing.

Definition at line 290 of file qqmlinstantiator.cpp.

◆ countChanged

void QQmlInstantiator::countChanged ( )

signal

◆ delegate()

QQmlComponent * QQmlInstantiator::delegate ( )

◆ delegateChanged

void QQmlInstantiator::delegateChanged ( )

signal

◆ isActive()

bool QQmlInstantiator::isActive ( ) const

\qmlsignal QtQml.Models::Instantiator::objectAdded(int index, QtObject object)

This signal is emitted when an object is added to the Instantiator. The index parameter holds the index which the object has been given, and the object parameter holds the \l QtObject that has been added.

\qmlsignal QtQml.Models::Instantiator::objectRemoved(int index, QtObject object)

This signal is emitted when an object is removed from the Instantiator. The index parameter holds the index which the object had been given, and the object parameter holds the \l QtObject that has been removed.

Do not keep a reference to object if it was created by this Instantiator, as in these cases it will be deleted shortly after the signal is handled.

\qmlproperty bool QtQml.Models::Instantiator::active

When active is true, and the delegate component is ready, the Instantiator will create objects according to the model. When active is false, no objects will be created and any previously created objects will be destroyed.

Default is true.

Definition at line 241 of file qqmlinstantiator.cpp.

◆ isAsync()

bool QQmlInstantiator::isAsync ( ) const

\qmlproperty bool QtQml.Models::Instantiator::asynchronous

When asynchronous is true the Instantiator will attempt to create objects asynchronously. This means that objects may not be available immediately, even if active is set to true.

You can use the objectAdded signal to respond to items being created.

Default is false.

Definition at line 268 of file qqmlinstantiator.cpp.

◆ model()

QVariant QQmlInstantiator::model ( ) const

\qmlproperty variant QtQml.Models::Instantiator::model

This property can be set to any of the supported \l {qml-data-models}{data models}:

\list

A number that indicates the number of delegates to be created by the repeater
A model (e.g. a ListModel item, or a QAbstractItemModel subclass)
A string list
An object list \endlist

The type of model affects the properties that are exposed to the \l delegate.

Default value is 1, which creates a single delegate instance.

See also: {qml-data-models}{Data Models}

Definition at line 354 of file qqmlinstantiator.cpp.

◆ modelChanged

void QQmlInstantiator::modelChanged ( )

signal

◆ object()

QObject * QQmlInstantiator::object ( ) const

\qmlproperty QtObject QtQml.Models::Instantiator::object

This is a reference to the first created object, intended as a convenience for the case where only one object has been created.

Definition at line 422 of file qqmlinstantiator.cpp.

◆ objectAdded

void QQmlInstantiator::objectAdded	(	int	index,
		QObject *	object )

signal

◆ objectAt()

QObject * QQmlInstantiator::objectAt ( int index ) const

\qmlmethod QtObject QtQml.Models::Instantiator::objectAt(int index)

Returns a reference to the object with the given index.

Definition at line 435 of file qqmlinstantiator.cpp.

◆ objectChanged

void QQmlInstantiator::objectChanged ( )

signal

◆ objectRemoved

void QQmlInstantiator::objectRemoved	(	int	index,
		QObject *	object )

signal

◆ setActive()

void QQmlInstantiator::setActive ( bool newVal )

Definition at line 247 of file qqmlinstantiator.cpp.

◆ setAsync()

void QQmlInstantiator::setAsync ( bool newVal )

Definition at line 274 of file qqmlinstantiator.cpp.

◆ setDelegate()

void QQmlInstantiator::setDelegate ( QQmlComponent * c )

Definition at line 315 of file qqmlinstantiator.cpp.

◆ setModel()

void QQmlInstantiator::setModel ( const QVariant & v )

Definition at line 360 of file qqmlinstantiator.cpp.

Property Documentation

◆ active

bool QQmlInstantiator::active

readwrite

Definition at line 32 of file qqmlinstantiator_p.h.

◆ asynchronous

bool QQmlInstantiator::asynchronous

readwrite

Definition at line 33 of file qqmlinstantiator_p.h.

◆ count

int QQmlInstantiator::count

read

Definition at line 35 of file qqmlinstantiator_p.h.

◆ delegate

QQmlComponent * QQmlInstantiator::delegate

readwrite

\qmlproperty QtQml::Component QtQml.Models::Instantiator::delegate \qmldefault

The component used to create all objects.

Note that an extra variable, index, will be available inside instances of the delegate. This variable refers to the index of the instance inside the Instantiator, and can be used to obtain the object through the objectAt method of the Instantiator.

If this property is changed, all instances using the old delegate will be destroyed and new instances will be created using the new delegate.

Definition at line 36 of file qqmlinstantiator_p.h.

◆ model

QVariant QQmlInstantiator::model

readwrite

Definition at line 34 of file qqmlinstantiator_p.h.

◆ object

QObject * QQmlInstantiator::object

read

Definition at line 37 of file qqmlinstantiator_p.h.

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

qtdeclarative/src/qmlmodels/qqmlinstantiator_p.h (7cc3d8af146878c051baebe1342a84384d299583)
qtdeclarative/src/qmlmodels/qqmlinstantiator.cpp (a464ff5bfa15201de64d05121dc192dbd4655890)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQmlInstantiator()

◆ ~QQmlInstantiator()

Member Function Documentation

◆ activeChanged

◆ asynchronousChanged

◆ classBegin()

◆ componentComplete()

◆ count()

◆ countChanged

◆ delegate()

◆ delegateChanged

◆ isActive()

◆ isAsync()

◆ model()

◆ modelChanged

◆ object()

◆ objectAdded

◆ objectAt()

◆ objectChanged

◆ objectRemoved

◆ setActive()

◆ setAsync()

◆ setDelegate()

◆ setModel()

Property Documentation

◆ active

◆ asynchronous

◆ count

◆ delegate

◆ model

◆ object