#include <qqmldelegatemodel_p.h>

Inheritance diagram for QQmlDelegateModel:

Collaboration diagram for QQmlDelegateModel:

Public Types
enum	DelegateModelAccess : quint8 { Qt5ReadWrite , ReadOnly , ReadWrite }
Public Types inherited from QQmlInstanceModel
enum	ReusableFlag { NotReusable , Reusable }
enum	ReleaseFlag { Referenced = 0x01 , Destroyed = 0x02 , Pooled = 0x04 }

Signals
void	filterGroupChanged ()
void	defaultGroupsChanged ()
void	rootIndexChanged ()
void	delegateChanged ()
	Q_REVISION (6, 10) void delegateModelAccessChanged()
	Q_REVISION (6, 10) void modelChanged()
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
	QQmlDelegateModel ()
	QQmlDelegateModel (QQmlContext , QObject parent=nullptr)
	~QQmlDelegateModel ()
void	classBegin () override
	Invoked after class creation, but before any properties have been set.
void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.
QVariant	model () const
	\qmlproperty model QtQml.Models::DelegateModel::model This property holds the model providing data for the DelegateModel.
void	setModel (const QVariant &)
QQmlComponent *	delegate () const
	\qmlproperty Component QtQml.Models::DelegateModel::delegate
void	setDelegate (QQmlComponent *)
QVariant	rootIndex () const
	\qmlproperty QModelIndex QtQml.Models::DelegateModel::rootIndex
void	setRootIndex (const QVariant &root)
DelegateModelAccess	delegateModelAccess () const
	\qmlproperty enumeration QtQml.Models::DelegateModel::delegateModelAccess
void	setDelegateModelAccess (DelegateModelAccess delegateModelAccess)
Q_INVOKABLE QVariant	modelIndex (int idx) const
	\qmlmethod QModelIndex QtQml.Models::DelegateModel::modelIndex(int index)
Q_INVOKABLE QVariant	parentModelIndex () const
	\qmlmethod QModelIndex QtQml.Models::DelegateModel::parentModelIndex()
int	count () const override
	\qmlproperty int QtQml.Models::DelegateModel::count
bool	isValid () const override
QObject *	object (int index, QQmlIncubator::IncubationMode incubationMode=QQmlIncubator::AsynchronousIfNested) override
ReleaseFlags	release (QObject *object, ReusableFlag reusableFlag=NotReusable) override
void	cancel (int index) override
QVariant	variantValue (int index, const QString &role) override
void	setWatchedRoles (const QList< QByteArray > &roles) override
QQmlIncubator::Status	incubationStatus (int index) override
void	drainReusableItemsPool (int maxPoolTime) override
int	poolSize () override
int	indexOf (QObject object, QObject objectContext) const override
QString	filterGroup () const
	\qmlproperty string QtQml.Models::DelegateModel::filterOnGroup
void	setFilterGroup (const QString &group)
void	resetFilterGroup ()
QQmlDelegateModelGroup *	items ()
QQmlDelegateModelGroup *	persistedItems ()
QQmlListProperty< QQmlDelegateModelGroup >	groups ()
QObject *	parts ()
const QAbstractItemModel *	abstractItemModel () const override
bool	event (QEvent *) override
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
Public Member Functions inherited from QQmlInstanceModel
QString	stringValue (int index, const QString &role)
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	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	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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 ()

Static Public Member Functions
static QQmlDelegateModelAttached *	qmlAttachedProperties (QObject *obj)
template<typename View, typename ViewPrivate>
static QQmlDelegateModel *	createForView (View q, ViewPrivate d)
template<typename View, typename ViewPrivate>
static void	applyDelegateModelAccessChangeOnView (View q, ViewPrivate d)
template<typename View, typename ViewPrivate>
static void	applyDelegateChangeOnView (View q, ViewPrivate d)
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)

Properties
QVariant	model
QQmlComponent *	delegate
QString	filterOnGroup
QQmlDelegateModelGroup *	items
	\qmlproperty DelegateModelGroup QtQml.Models::DelegateModel::items
QQmlDelegateModelGroup *	persistedItems
	\qmlproperty DelegateModelGroup QtQml.Models::DelegateModel::persistedItems
QQmlListProperty< QQmlDelegateModelGroup >	groups
	\qmlproperty list<DelegateModelGroup> QtQml.Models::DelegateModel::groups
QObject *	parts
	\qmlproperty object QtQml.Models::DelegateModel::parts
QVariant	rootIndex
DelegateModelAccess	delegateModelAccess
Properties inherited from QQmlInstanceModel
int	count
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Public Attributes inherited from QQmlInstanceModel
QObject *	object
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 38 of file qqmldelegatemodel_p.h.

Member Enumeration Documentation

◆ DelegateModelAccess

enum QQmlDelegateModel::DelegateModelAccess : quint8

Enumerator
Qt5ReadWrite
ReadOnly
ReadWrite

Definition at line 60 of file qqmldelegatemodel_p.h.

Constructor & Destructor Documentation

◆ QQmlDelegateModel() [1/2]

QQmlDelegateModel::QQmlDelegateModel ( )

Definition at line 218 of file qqmldelegatemodel.cpp.

◆ QQmlDelegateModel() [2/2]

QQmlDelegateModel::QQmlDelegateModel	(	QQmlContext *	ctxt,
		QObject *	parent = nullptr )

Definition at line 223 of file qqmldelegatemodel.cpp.

◆ ~QQmlDelegateModel()

QQmlDelegateModel::~QQmlDelegateModel ( )

Definition at line 230 of file qqmldelegatemodel.cpp.

Member Function Documentation

◆ abstractItemModel()

const QAbstractItemModel * QQmlDelegateModel::abstractItemModel ( ) const

overridevirtual

Reimplemented from QQmlInstanceModel.

Definition at line 919 of file qqmldelegatemodel.cpp.

◆ applyDelegateChangeOnView()

template<typename View, typename ViewPrivate>

void QQmlDelegateModel::applyDelegateChangeOnView	(	View *	q,
		ViewPrivate *	d )

inlinestatic

Definition at line 142 of file qqmldelegatemodel_p.h.

◆ applyDelegateModelAccessChangeOnView()

template<typename View, typename ViewPrivate>

void QQmlDelegateModel::applyDelegateModelAccessChangeOnView	(	View *	q,
		ViewPrivate *	d )

inlinestatic

Definition at line 131 of file qqmldelegatemodel_p.h.

◆ cancel()

void QQmlDelegateModel::cancel ( int index )

overridevirtual

Reimplemented from QQmlInstanceModel.

Definition at line 669 of file qqmldelegatemodel.cpp.

◆ classBegin()

void QQmlDelegateModel::classBegin ( )

overridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 264 of file qqmldelegatemodel.cpp.

◆ componentComplete()

void QQmlDelegateModel::componentComplete ( )

overridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 271 of file qqmldelegatemodel.cpp.

◆ count()

int QQmlDelegateModel::count ( ) const

overridevirtual

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

Implements QQmlInstanceModel.

Definition at line 617 of file qqmldelegatemodel.cpp.

◆ createForView()

template<typename View, typename ViewPrivate>

QQmlDelegateModel * QQmlDelegateModel::createForView	(	View *	q,
		ViewPrivate *	d )

inlinestatic

Definition at line 119 of file qqmldelegatemodel_p.h.

◆ defaultGroupsChanged

void QQmlDelegateModel::defaultGroupsChanged ( )

signal

◆ delegate()

QQmlComponent * QQmlDelegateModel::delegate ( ) const

\qmlproperty Component QtQml.Models::DelegateModel::delegate

The delegate provides a template defining each item instantiated by a view. The index is exposed as an accessible index property. Properties of the model are also available depending upon the type of \l {qml-data-models}{Data Model}.

Definition at line 439 of file qqmldelegatemodel.cpp.

◆ delegateChanged

void QQmlDelegateModel::delegateChanged ( )

signal

◆ delegateModelAccess()

QQmlDelegateModel::DelegateModelAccess QQmlDelegateModel::delegateModelAccess ( ) const

\qmlproperty enumeration QtQml.Models::DelegateModel::delegateModelAccess

Definition at line 546 of file qqmldelegatemodel.cpp.

◆ drainReusableItemsPool()

void QQmlDelegateModel::drainReusableItemsPool ( int maxPoolTime )

overridevirtual

Reimplemented from QQmlInstanceModel.

Definition at line 1160 of file qqmldelegatemodel.cpp.

◆ event()

bool QQmlDelegateModel::event ( QEvent * e )

overridevirtual

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

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
    Q_OBJECT
 
public:
    MyClass(QWidget *parent = nullptr);
    ~MyClass();
 
    bool event(QEvent* ev) override
    {
        if (ev->type() == QEvent::PolishRequest) {
            // overwrite handling of PolishRequest if any
            doThings();
            return true;
        } else  if (ev->type() == QEvent::Show) {
            // complement handling of Show if any
            doThings2();
            QWidget::event(ev);
            return true;
        }
        // Make sure the rest of events are handled
        return QWidget::event(ev);
    }
};

See also: installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 1515 of file qqmldelegatemodel.cpp.

◆ filterGroup()

QString QQmlDelegateModel::filterGroup ( ) const

\qmlproperty string QtQml.Models::DelegateModel::filterOnGroup

This property holds name of the group that is used to filter the delegate model.

Only items that belong to this group are visible to a view.

By default this is the \l items group.

Definition at line 820 of file qqmldelegatemodel.cpp.

◆ filterGroupChanged

void QQmlDelegateModel::filterGroupChanged ( )

signal

◆ groups()

QQmlListProperty< QQmlDelegateModelGroup > QQmlDelegateModel::groups ( )

◆ incubationStatus()

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

overridevirtual

Implements QQmlInstanceModel.

Definition at line 1416 of file qqmldelegatemodel.cpp.

◆ indexOf()

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

overridevirtual

Implements QQmlInstanceModel.

Definition at line 1466 of file qqmldelegatemodel.cpp.

◆ isValid()

bool QQmlDelegateModel::isValid ( ) const

inlineoverridevirtual

Implements QQmlInstanceModel.

Definition at line 90 of file qqmldelegatemodel_p.h.

◆ items()

QQmlDelegateModelGroup * QQmlDelegateModel::items ( )

◆ model()

QVariant QQmlDelegateModel::model ( ) const

\qmlproperty model QtQml.Models::DelegateModel::model This property holds the model providing data for the DelegateModel.

The model provides a set of data that is used to create the items for a view. For large or dynamic datasets the model is usually provided by a C++ model object. The C++ model object must be a \l {QAbstractItemModel} subclass or a simple list.

Models can also be created directly in QML, for example using ListModel.

See also: {qml-data-models}{Data Models} \keyword dm-model-property

Definition at line 343 of file qqmldelegatemodel.cpp.

◆ modelIndex()

QVariant QQmlDelegateModel::modelIndex ( int idx ) const

\qmlmethod QModelIndex QtQml.Models::DelegateModel::modelIndex(int index)

QAbstractItemModel provides a hierarchical tree of data, whereas QML only operates on list data. This function assists in using tree models in QML.

Returns a QModelIndex for the specified index. This value can be assigned to rootIndex.

See also: rootIndex

Definition at line 589 of file qqmldelegatemodel.cpp.

◆ object()

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

overridevirtual

Implements QQmlInstanceModel.

Definition at line 1405 of file qqmldelegatemodel.cpp.

◆ parentModelIndex()

QVariant QQmlDelegateModel::parentModelIndex ( ) const

\qmlmethod QModelIndex QtQml.Models::DelegateModel::parentModelIndex()

QAbstractItemModel provides a hierarchical tree of data, whereas QML only operates on list data. This function assists in using tree models in QML.

Returns a QModelIndex for the parent of the current rootIndex. This value can be assigned to rootIndex.

See also: rootIndex

Definition at line 607 of file qqmldelegatemodel.cpp.

◆ parts()

QObject * QQmlDelegateModel::parts ( )

◆ persistedItems()

QQmlDelegateModelGroup * QQmlDelegateModel::persistedItems ( )

◆ poolSize()

int QQmlDelegateModel::poolSize ( )

overridevirtual

Reimplemented from QQmlInstanceModel.

Definition at line 1165 of file qqmldelegatemodel.cpp.

◆ Q_REVISION [1/2]

QQmlDelegateModel::Q_REVISION	(	6	,
		10	)

signal

◆ Q_REVISION [2/2]

QQmlDelegateModel::Q_REVISION	(	6	,
		10	)

signal

◆ qmlAttachedProperties()

QQmlDelegateModelAttached * QQmlDelegateModel::qmlAttachedProperties ( QObject * obj )

static

Definition at line 2196 of file qqmldelegatemodel.cpp.

◆ release()

QQmlDelegateModel::ReleaseFlags QQmlDelegateModel::release	(	QObject *	object,
		QQmlInstanceModel::ReusableFlag	reusableFlag = NotReusable )

overridevirtual

Implements QQmlInstanceModel.

Definition at line 661 of file qqmldelegatemodel.cpp.

◆ resetFilterGroup()

void QQmlDelegateModel::resetFilterGroup ( )

Definition at line 842 of file qqmldelegatemodel.cpp.

◆ rootIndex()

QVariant QQmlDelegateModel::rootIndex ( ) const

\qmlproperty QModelIndex QtQml.Models::DelegateModel::rootIndex

QAbstractItemModel provides a hierarchical tree of data, whereas QML only operates on list data. rootIndex allows the children of any node in a QAbstractItemModel to be provided by this model.

This property only affects models of type QAbstractItemModel that are hierarchical (e.g, a tree model).

For example, here is a simple interactive file system browser. When a directory name is clicked, the view's rootIndex is set to the QModelIndex node of the clicked directory, thus updating the view to show the new directory's contents.

main.cpp:

int main(int argc, char ** argv)
{
    QGuiApplication app(argc, argv);
 
    QQuickView view;
 
    QFileSystemModel model;
    // start populating the model (doesn't change the model's root)
    model.setRootPath(QDir::currentPath());
 
    qmlRegisterSingletonInstance("FileSystemModule", 1, 0, "FileSystemModel", &model);
    view.setSource(QUrl::fromLocalFile("view.qml"));
    view.show();
 
    return app.exec();
}

view.qml:

import QtQuick
import QtQml.Models
import FileSystemModule
 
pragma ComponentBehavior: Bound
 
ListView {
    id: view
    width: 300
    height: 400
 
    model: DelegateModel {
        id: delegateModel
        model: FileSystemModel // singleton
 
        delegate: Rectangle {
            id: delegate
            required property int index
            required property string filePath
            required property bool hasModelChildren
 
            width: 300; height: 25
            color: index % 2 ? palette.alternateBase : palette.base
 
            Text {
                anchors.verticalCenter: parent.verticalCenter
                color: palette.text
                text: delegate.filePath
            }
 
            TapHandler {
                onTapped: if (delegate.hasModelChildren)
                              delegateModel.rootIndex = delegateModel.modelIndex(delegate.index)
            }
        }
    }
}

If the \l {dm-model-property}{model} is a QAbstractItemModel subclass, the delegate can also reference a hasModelChildren property (optionally qualified by a model. prefix) that indicates whether the delegate's model item has any child nodes.

See also: modelIndex(), parentModelIndex()

Definition at line 506 of file qqmldelegatemodel.cpp.

◆ rootIndexChanged

void QQmlDelegateModel::rootIndexChanged ( )

signal

◆ setDelegate()

void QQmlDelegateModel::setDelegate ( QQmlComponent * delegate )

Definition at line 445 of file qqmldelegatemodel.cpp.

◆ setDelegateModelAccess()

void QQmlDelegateModel::setDelegateModelAccess ( QQmlDelegateModel::DelegateModelAccess delegateModelAccess )

Definition at line 552 of file qqmldelegatemodel.cpp.

◆ setFilterGroup()

void QQmlDelegateModel::setFilterGroup ( const QString & group )

Definition at line 826 of file qqmldelegatemodel.cpp.

◆ setModel()

void QQmlDelegateModel::setModel ( const QVariant & model )

Definition at line 389 of file qqmldelegatemodel.cpp.

◆ setRootIndex()

void QQmlDelegateModel::setRootIndex ( const QVariant & root )

Definition at line 512 of file qqmldelegatemodel.cpp.

◆ setWatchedRoles()

void QQmlDelegateModel::setWatchedRoles ( const QList< QByteArray > & roles )

overridevirtual

Implements QQmlInstanceModel.

Definition at line 1474 of file qqmldelegatemodel.cpp.

◆ variantValue()

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

overridevirtual

Implements QQmlInstanceModel.

Reimplemented in QQuickComboBoxDelegateModel, and QQuickComboBoxDelegateModel.

Definition at line 1460 of file qqmldelegatemodel.cpp.

Property Documentation

◆ delegate

QQmlComponent * QQmlDelegateModel::delegate

readwrite

Definition at line 44 of file qqmldelegatemodel_p.h.

◆ delegateModelAccess

DelegateModelAccess QQmlDelegateModel::delegateModelAccess

readwrite

Definition at line 51 of file qqmldelegatemodel_p.h.

◆ filterOnGroup

QString QQmlDelegateModel::filterOnGroup

readwrite

Definition at line 45 of file qqmldelegatemodel_p.h.

◆ groups

QQmlListProperty< QQmlDelegateModelGroup > QQmlDelegateModel::groups

read

\qmlproperty list<DelegateModelGroup> QtQml.Models::DelegateModel::groups

This property holds a delegate model's group definitions.

Groups define a sub-set of the items in a delegate model and can be used to filter a model.

For every group defined in a DelegateModel two attached pseudo-properties are added to each delegate item. The first of the form DelegateModel.in{GroupName} holds whether the item belongs to the group and the second DelegateModel.{groupName}Index holds the index of the item in that group.

The following example illustrates using groups to select items in a model.

import QtQuick
import QtQml.Models
 
Rectangle {
    width: 200; height: 100
 
    DelegateModel {
        id: visualModel
        model: ListModel {
            ListElement { name: "Apple" }
            ListElement { name: "Orange" }
        }
 
        groups: [
            DelegateModelGroup { name: "selected" }
        ]
 
        delegate: Rectangle {
            id: item
            height: 25
            width: 200
            Text {
                text: {
                    var text = "Name: " + name
                    if (item.DelegateModel.inSelected)
                        text += " (" + item.DelegateModel.selectedIndex + ")"
                    return text;
                }
            }
            MouseArea {
                anchors.fill: parent
                onClicked: item.DelegateModel.inSelected = !item.DelegateModel.inSelected
            }
        }
    }
 
    ListView {
        anchors.fill: parent
        model: visualModel
    }
}

\keyword dm-groups-property

Warning: In contrast to normal attached properties, those cannot be set in a declarative way. The following would result in an error: \badcode delegate: Rectangle { DelegateModel.inSelected: true }

Definition at line 48 of file qqmldelegatemodel_p.h.

◆ items

QQmlDelegateModelGroup * QQmlDelegateModel::items

read

\qmlproperty DelegateModelGroup QtQml.Models::DelegateModel::items

This property holds default group to which all new items are added.

Definition at line 46 of file qqmldelegatemodel_p.h.

◆ model

QVariant QQmlDelegateModel::model

readwrite

Definition at line 43 of file qqmldelegatemodel_p.h.

◆ parts

QObject * QQmlDelegateModel::parts

read

\qmlproperty object QtQml.Models::DelegateModel::parts

The parts property selects a DelegateModel which creates delegates from the part named. This is used in conjunction with the \l Package type.

For example, the code below selects a model which creates delegates named list from a \l Package:

DelegateModel {
    id: visualModel
    delegate: Package {
        Item { Package.name: "list" }
    }
    model: myModel
}
 
ListView {
    width: 200; height:200
    model: visualModel.parts.list
}

See also: Package

Definition at line 49 of file qqmldelegatemodel_p.h.

◆ persistedItems

QQmlDelegateModelGroup * QQmlDelegateModel::persistedItems

read

\qmlproperty DelegateModelGroup QtQml.Models::DelegateModel::persistedItems

This property holds delegate model's persisted items group.

Items in this group are not destroyed when released by a view, instead they are persisted until removed from the group.

An item can be removed from the persistedItems group by setting the DelegateModel.inPersistedItems property to false. If the item is not referenced by a view at that time it will be destroyed. Adding an item to this group will not create a new instance.

Items returned by the \l QtQml.Models::DelegateModelGroup::create() function are automatically added to this group.

Definition at line 47 of file qqmldelegatemodel_p.h.

◆ rootIndex

QVariant QQmlDelegateModel::rootIndex

readwrite

Definition at line 50 of file qqmldelegatemodel_p.h.

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

qtdeclarative/src/qmlmodels/qqmldelegatemodel_p.h (c86476db1fa845b9414e2a83191ed93c1c5a7936)
qtdeclarative/src/qmlmodels/qqmldelegatemodel.cpp (c86476db1fa845b9414e2a83191ed93c1c5a7936)

Public Types

Signals

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DelegateModelAccess

Constructor & Destructor Documentation

◆ QQmlDelegateModel() [1/2]

◆ QQmlDelegateModel() [2/2]

◆ ~QQmlDelegateModel()

Member Function Documentation

◆ abstractItemModel()

◆ applyDelegateChangeOnView()

◆ applyDelegateModelAccessChangeOnView()

◆ cancel()

◆ classBegin()

◆ componentComplete()

◆ count()

◆ createForView()

◆ defaultGroupsChanged

◆ delegate()

◆ delegateChanged

◆ delegateModelAccess()

◆ drainReusableItemsPool()

◆ event()

◆ filterGroup()

◆ filterGroupChanged

◆ groups()

◆ incubationStatus()

◆ indexOf()

◆ isValid()

◆ items()

◆ model()

◆ modelIndex()

◆ object()

◆ parentModelIndex()

◆ parts()

◆ persistedItems()

◆ poolSize()

◆ Q_REVISION [1/2]

◆ Q_REVISION [2/2]

◆ qmlAttachedProperties()

◆ release()

◆ resetFilterGroup()

◆ rootIndex()

◆ rootIndexChanged

◆ setDelegate()

◆ setDelegateModelAccess()

◆ setFilterGroup()

◆ setModel()

◆ setRootIndex()

◆ setWatchedRoles()

◆ variantValue()

Property Documentation

◆ delegate

◆ delegateModelAccess

◆ filterOnGroup

◆ groups

◆ items

◆ model

◆ parts

◆ persistedItems

◆ rootIndex