#include <qqmlobjectmodel_p.h>

Inheritance diagram for QQmlObjectModel:

Collaboration diagram for QQmlObjectModel:

Public Slots
	Q_REVISION (2, 3) void clear()

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	childrenChanged ()

Signals inherited from QQmlInstanceModel
void	countChanged ()

void	modelUpdated (const QQmlChangeSet &changeSet, bool reset)

void	createdItem (int index, QObject *object)

void	initItem (int index, QObject *object)

void	destroyingItem (QObject *object)

	Q_REVISION (2, 15) void itemPooled(int index

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
	QQmlObjectModel (QObject *parent=nullptr)
	\qmltype ObjectModel \instantiates QQmlObjectModel \inqmlmodule QtQml.Models

	~QQmlObjectModel ()

int	count () const override
	\qmlproperty int QtQml.Models::ObjectModel::count

bool	isValid () const override

QObject *	object (int index, QQmlIncubator::IncubationMode incubationMode=QQmlIncubator::AsynchronousIfNested) override

ReleaseFlags	release (QObject *object, ReusableFlag reusable=NotReusable) override

QVariant	variantValue (int index, const QString &role) override

void	setWatchedRoles (const QList< QByteArray > &) override

QQmlIncubator::Status	incubationStatus (int index) override

int	indexOf (QObject object, QObject objectContext) const override

QQmlListProperty< QObject >	children ()

	Q_REVISION (2, 3) Q_INVOKABLE QObject *get(int index) const

	Q_REVISION (2, 3) Q_INVOKABLE void append(QObject *object)

	Q_REVISION (2, 3) Q_INVOKABLE void insert(int index

	Q_REVISION (2, 3) Q_INVOKABLE void move(int from

	Q_REVISION (2, 3) Q_INVOKABLE void remove(int index

Public Member Functions inherited from QQmlInstanceModel
virtual void	cancel (int)

QString	stringValue (int index, const QString &role)

virtual void	drainReusableItemsPool (int maxPoolTime)

virtual int	poolSize ()

virtual const QAbstractItemModel *	abstractItemModel () const

virtual bool	setRequiredProperty (int index, const QString &name, const QVariant &value)

	Q_REVISION (2, 15) void itemReused(int index

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`.

Static Public Member Functions
static QQmlObjectModelAttached *	qmlAttachedProperties (QObject *obj)

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)

Public Attributes
QObject *	object

int	to

int int	n = 1)

int	n = 1)

Public Attributes inherited from QQmlInstanceModel
QObject *	object

Properties
QQmlListProperty< QObject >	children
	\qmlattachedproperty int QtQml.Models::ObjectModel::index This attached property holds the index of this delegate's item within the model.

Properties inherited from QQmlInstanceModel
int	count

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Types inherited from QQmlInstanceModel
enum	ReusableFlag { NotReusable , Reusable }

enum	ReleaseFlag { Referenced = 0x01 , Destroyed = 0x02 , Pooled = 0x04 }

Protected Member Functions inherited from QQmlInstanceModel
	QQmlInstanceModel (QObjectPrivate &dd, QObject *parent=nullptr)

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 85 of file qqmlobjectmodel_p.h.

Constructor & Destructor Documentation

◆ QQmlObjectModel()

QQmlObjectModel::QQmlObjectModel ( QObject * parent = nullptr )

\qmltype ObjectModel \instantiates QQmlObjectModel \inqmlmodule QtQml.Models

Defines a set of items to be used as a model.

An ObjectModel contains the visual items to be used in a view. When an ObjectModel is used in a view, the view does not require a delegate since the ObjectModel already contains the visual delegate (items).

An item can determine its index within the model via the \l{ObjectModel::index}{index} attached property.

The example below places three colored rectangles in a ListView.

import QtQuick 2.0
import QtQml.Models 2.1
 
Rectangle {
    ObjectModel {
        id: itemModel
        Rectangle { height: 30; width: 80; color: "red" }
        Rectangle { height: 30; width: 80; color: "green" }
        Rectangle { height: 30; width: 80; color: "blue" }
    }
 
    ListView {
        anchors.fill: parent
        model: itemModel
    }
}

See also: {Qt Quick Examples - Views}

Definition at line 202 of file qqmlobjectmodel.cpp.

◆ ~QQmlObjectModel()

QQmlObjectModel::~QQmlObjectModel ( )

inline

Definition at line 98 of file qqmlobjectmodel_p.h.

Member Function Documentation

◆ children()

QQmlListProperty< QObject > QQmlObjectModel::children ( )

◆ childrenChanged

void QQmlObjectModel::childrenChanged ( )

signal

Referenced by QQuickContainerPrivate::cleanup(), and QQuickContainerPrivate::init().

Here is the caller graph for this function:

◆ count()

int QQmlObjectModel::count ( ) const

overridevirtual

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

The number of items in the model. This property is readonly.

Implements QQmlInstanceModel.

Definition at line 231 of file qqmlobjectmodel.cpp.

References d.

Referenced by QQuickMenuPrivate::activateNextItem(), QQuickMenuBarPrivate::activateNextItem(), QQuickMenuBarPrivate::activatePreviousItem(), QQuickContainerPrivate::cleanup(), QQuickSplitViewPrivate::createHandleItem(), QQuickSplitViewPrivate::createHandles(), QQuickMenuPrivate::firstEnabledMenuItem(), QQuickFolderBreadcrumbBarPrivate::getContentHeight(), QQuickDialogButtonBoxPrivate::getContentHeight(), QQuickMenuBarPrivate::getContentHeight(), QQuickTabBarPrivate::getContentHeight(), QQuickFolderBreadcrumbBarPrivate::getContentWidth(), QQuickDialogButtonBoxPrivate::getContentWidth(), QQuickMenuBarPrivate::getContentWidth(), QQuickTabBarPrivate::getContentWidth(), QQuickSplitViewPrivate::handleIndexForSplitIndex(), QQuickSplitViewPrivate::handlePress(), QQuickContainerPrivate::insertItem(), QQuickContainerPrivate::itemChildAdded(), QQuickMenuPrivate::itemChildAdded(), QQuickSplitViewPrivate::layout(), QQuickSplitViewPrivate::layoutPositionItems(), QQuickSplitViewPrivate::layoutResizeSplitItems(), QQuickSplitViewPrivate::limitAndApplySizes(), QQuickSplitViewPrivate::removeExcessHandles(), QQuickContainerPrivate::removeItem(), QQuickMenuPrivate::resizeItems(), QQuickSplitViewPrivate::updateHandleVisibilities(), QQuickDialogButtonBoxPrivate::updateLayout(), and QQuickTabBarPrivate::updateLayout().

Here is the caller graph for this function:

◆ incubationStatus()

QQmlIncubator::Status QQmlObjectModel::incubationStatus ( int index )

overridevirtual

Implements QQmlInstanceModel.

Definition at line 273 of file qqmlobjectmodel.cpp.

References QQmlIncubator::Ready.

◆ indexOf()

int QQmlObjectModel::indexOf	(	QObject *	object,
		QObject *	objectContext ) const

overridevirtual

Implements QQmlInstanceModel.

Definition at line 278 of file qqmlobjectmodel.cpp.

References d, and item.

Referenced by QQuickMenuBarPrivate::activateNextItem(), QQuickMenuBarPrivate::activatePreviousItem(), QQuickFolderBreadcrumbBarPrivate::crumbClicked(), QQuickContainerPrivate::itemDestroyed(), QQuickMenuPrivate::itemDestroyed(), QQuickContainerPrivate::itemParentChanged(), QQuickMenuPrivate::itemParentChanged(), QQuickMenuPrivate::itemSiblingOrderChanged(), QQuickSplitViewPrivate::itemVisibilityChanged(), QQuickMenuPrivate::onItemActiveFocusChanged(), QQuickMenuPrivate::onItemHovered(), QQuickContainerPrivate::reorderItems(), and QQuickTabBarPrivate::updateCurrentIndex().

Here is the caller graph for this function:

◆ isValid()

bool QQmlObjectModel::isValid ( ) const

overridevirtual

Implements QQmlInstanceModel.

Definition at line 237 of file qqmlobjectmodel.cpp.

◆ object()

QObject * QQmlObjectModel::object	(	int	index,
		QQmlIncubator::IncubationMode	incubationMode = QQmlIncubator::AsynchronousIfNested )

overridevirtual

Implements QQmlInstanceModel.

◆ Q_REVISION() [1/6]

QQmlObjectModel::Q_REVISION	(	2	,
		3	) const

◆ Q_REVISION() [2/6]

QQmlObjectModel::Q_REVISION	(	2	,
		3	)

◆ Q_REVISION() [3/6]

QQmlObjectModel::Q_REVISION	(	2	,
		3	)

◆ Q_REVISION() [4/6]

QQmlObjectModel::Q_REVISION	(	2	,
		3	)

◆ Q_REVISION() [5/6]

QQmlObjectModel::Q_REVISION	(	2	,
		3	)

◆ Q_REVISION [6/6]

QQmlObjectModel::Q_REVISION	(	2	,
		3	)

slot

◆ qmlAttachedProperties()

QQmlObjectModelAttached * QQmlObjectModel::qmlAttachedProperties ( QObject * obj )

static

Definition at line 284 of file qqmlobjectmodel.cpp.

References QQmlObjectModelAttached::properties().

Here is the call graph for this function:

◆ release()

QQmlInstanceModel::ReleaseFlags QQmlObjectModel::release	(	QObject *	object,
		ReusableFlag	reusable = NotReusable )

overridevirtual

Implements QQmlInstanceModel.

Definition at line 254 of file qqmlobjectmodel.cpp.

References d, item, and QQmlInstanceModel::Referenced.

◆ setWatchedRoles()

void QQmlObjectModel::setWatchedRoles ( const QList< QByteArray > & )

inlineoverridevirtual

Implements QQmlInstanceModel.

Definition at line 105 of file qqmlobjectmodel_p.h.

◆ variantValue()

QVariant QQmlObjectModel::variantValue	(	int	index,
		const QString &	role )

overridevirtual

Implements QQmlInstanceModel.

Definition at line 265 of file qqmlobjectmodel.cpp.

References QByteArray::constData(), d, and QString::toUtf8().

Here is the call graph for this function:

Member Data Documentation

◆ n [1/2]

int int QQmlObjectModel::n = 1)

Definition at line 117 of file qqmlobjectmodel_p.h.

◆ n [2/2]

int QQmlObjectModel::n = 1)

Definition at line 118 of file qqmlobjectmodel_p.h.

◆ object

QObject * QQmlObjectModel::object

Definition at line 116 of file qqmlobjectmodel_p.h.

Referenced by QQuickSplitViewPrivate::accumulatedSize(), QQuickSplitViewPrivate::handlePress(), QQuickSplitViewPrivate::layout(), QQuickSplitViewPrivate::layoutPositionItems(), QQuickSplitViewPrivate::layoutResizeSplitItems(), QQuickSplitViewPrivate::limitAndApplySizes(), and QQuickSplitViewPrivate::updateHandleVisibilities().

◆ to

int QQmlObjectModel::to

Definition at line 117 of file qqmlobjectmodel_p.h.

Property Documentation

◆ children

QQmlListProperty< QObject > QQmlObjectModel::children

read

\qmlattachedproperty int QtQml.Models::ObjectModel::index This attached property holds the index of this delegate's item within the model.

It is attached to each instance of the delegate.

Definition at line 90 of file qqmlobjectmodel_p.h.

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

qtdeclarative/src/qmlmodels/qqmlobjectmodel_p.h (7cc3d8af146878c051baebe1342a84384d299583)
qtdeclarative/src/qmlmodels/qqmlobjectmodel.cpp (534241f723161ab79d9a85b2c8145d571f0d99f9)

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQmlObjectModel()

◆ ~QQmlObjectModel()

Member Function Documentation

◆ children()

◆ childrenChanged

◆ count()

◆ incubationStatus()

◆ indexOf()

◆ isValid()

◆ object()

◆ Q_REVISION() [1/6]

◆ Q_REVISION() [2/6]

◆ Q_REVISION() [3/6]

◆ Q_REVISION() [4/6]

◆ Q_REVISION() [5/6]

◆ Q_REVISION [6/6]

◆ qmlAttachedProperties()

◆ release()

◆ setWatchedRoles()

◆ variantValue()

Member Data Documentation

◆ n [1/2]

◆ n [2/2]

◆ object

◆ to

Property Documentation

◆ children