\inmodule QtCore More...

#include <qgenericitemmodel.h>

Inheritance diagram for QGenericItemModel:

Collaboration diagram for QGenericItemModel:

Classes
class	MultiColumn
	Represents the wrapped type {T} as multiple columns in a QGenericItemModel. More...

Public Types
template<typename T>
using	SingleColumn = std::tuple<T>
	Use this type to disambiguate when using the type {T} as the row type in the range.

Public Types inherited from QAbstractItemModel
enum	LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
	This enum describes the way the model changes layout. More...

enum class	CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }

Public Member Functions
template<typename Range, QGenericItemModelDetails::if_is_table_range< Range > = true>
	QGenericItemModel (Range &&range, QObject *parent=nullptr)

template<typename Range, QGenericItemModelDetails::if_is_tree_range< Range > = true>
	QGenericItemModel (Range &&range, QObject *parent=nullptr)

template<typename Range, typename Protocol, QGenericItemModelDetails::if_is_tree_range< Range, Protocol > = true>
	QGenericItemModel (Range &&range, Protocol &&protocol, QObject *parent=nullptr)

	~QGenericItemModel () override
	Destroys the generic item model.

QModelIndex	index (int row, int column, const QModelIndex &parent={}) const override
	\reimp

QModelIndex	parent (const QModelIndex &child) const override
	\reimp

QModelIndex	sibling (int row, int column, const QModelIndex &index) const override
	\reimp

int	rowCount (const QModelIndex &parent={}) const override
	\reimp

int	columnCount (const QModelIndex &parent={}) const override
	\reimp

Qt::ItemFlags	flags (const QModelIndex &index) const override
	\reimp

QVariant	headerData (int section, Qt::Orientation orientation, int role) const override
	\reimp

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
	\reimp

bool	setData (const QModelIndex &index, const QVariant &data, int role=Qt::EditRole) override

QMap< int, QVariant >	itemData (const QModelIndex &index) const override
	\reimp

bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &data) override
	\reimp

bool	clearItemData (const QModelIndex &index) override
	\reimp

bool	insertColumns (int column, int count, const QModelIndex &parent={}) override
	\reimp

bool	removeColumns (int column, int count, const QModelIndex &parent={}) override
	\reimp

bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destParent, int destColumn) override
	\reimp

bool	insertRows (int row, int count, const QModelIndex &parent={}) override
	\reimp

bool	removeRows (int row, int count, const QModelIndex &parent={}) override
	\reimp

bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destParent, int destRow) override
	\reimp

bool	canFetchMore (const QModelIndex &parent) const override
	\reimp

void	fetchMore (const QModelIndex &parent) override
	\reimp

bool	hasChildren (const QModelIndex &parent=QModelIndex()) const override
	\reimp

QModelIndex	buddy (const QModelIndex &index) const override
	\reimp

bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const override
	\reimp

bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
	\reimp

QMimeData *	mimeData (const QModelIndexList &indexes) const override
	\reimp

QStringList	mimeTypes () const override
	\reimp

QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const override
	\reimp

void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const override
	\reimp

QHash< int, QByteArray >	roleNames () const override
	\reimp

void	sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override
	\reimp

QSize	span (const QModelIndex &index) const override
	\reimp

Qt::DropActions	supportedDragActions () const override
	\reimp

Qt::DropActions	supportedDropActions () const override
	\reimp

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent=nullptr)
	Constructs an abstract item model with the given parent.

virtual	~QAbstractItemModel ()
	Destroys the abstract item model.

Q_INVOKABLE bool	hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
	Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
	Sets the data for the given role and section in the header with the specified orientation to the value supplied.

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertRows(int row

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertColumns(int column

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeRows(int row

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeColumns(int column

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertRow(int row

Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertColumn(int column

Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeRow(int row

Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeColumn(int column

Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent

Q_INVOKABLE	Q_REVISION (6, 4) virtual void sort(int column

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const

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

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.

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

Protected Slots
void	resetInternalData () override
	\reimp

Protected Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()

Protected Member Functions
bool	event (QEvent *) override
	\reimp

bool	eventFilter (QObject , QEvent ) override
	\reimp

Protected Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)

QModelIndex	createIndex (int row, int column, const void *data=nullptr) const
	Creates a model index for the given row and column with the internal pointer ptr.

QModelIndex	createIndex (int row, int column, quintptr id) const
	Creates a model index for the given row and column with the internal identifier, id.

void	encodeData (const QModelIndexList &indexes, QDataStream &stream) const

bool	decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)

void	beginInsertRows (const QModelIndex &parent, int first, int last)
	Begins a row insertion operation.

void	endInsertRows ()
	Ends a row insertion operation.

void	beginRemoveRows (const QModelIndex &parent, int first, int last)
	Begins a row removal operation.

void	endRemoveRows ()
	Ends a row removal operation.

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)

void	endMoveRows ()
	Ends a row move operation.

void	beginInsertColumns (const QModelIndex &parent, int first, int last)
	Begins a column insertion operation.

void	endInsertColumns ()
	Ends a column insertion operation.

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)
	Begins a column removal operation.

void	endRemoveColumns ()
	Ends a column removal operation.

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
	Begins a column move operation.

void	endMoveColumns ()
	Ends a column move operation.

void	beginResetModel ()
	Begins a model reset operation.

void	endResetModel ()
	Completes a model reset operation.

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
	Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndexList	persistentIndexList () const

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)

Friends
class	QGenericItemModelImplBase

Additional Inherited Members
Public Slots inherited from QAbstractItemModel
virtual bool	submit ()
	Lets the model know that it should submit cached information to permanent storage.

virtual void	revert ()
	Lets the model know that it should discard cached information.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QAbstractItemModel
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
	This signal is emitted whenever the data in an existing item changes.

void	headerDataChanged (Qt::Orientation orientation, int first, int last)
	This signal is emitted whenever a header is changed.

void	layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)

void	rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are inserted into the model.

void	rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been inserted into the model.

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are removed from the model.

void	rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been removed from the model.

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are inserted into the model.

void	columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been inserted into the model.

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are removed from the model.

void	columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been removed from the model.

void	modelAboutToBeReset (QPrivateSignal)

void	modelReset (QPrivateSignal)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)

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.

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 inherited from QAbstractItemModel
Q_INVOKABLE int	count

Q_INVOKABLE int const QModelIndex &	parent = QModelIndex())
	Returns the parent of the model item with the given index.

Q_INVOKABLE int	sourceRow

Q_INVOKABLE int int	count

Q_INVOKABLE int int const QModelIndex &	destinationParent

Q_INVOKABLE int int const QModelIndex int	destinationChild

Q_INVOKABLE int	sourceColumn

Q_INVOKABLE const QModelIndex &	parent = QModelIndex())

Q_INVOKABLE int const QModelIndex &	destinationParent

Q_INVOKABLE int const QModelIndex int	destinationChild

Q_INVOKABLE Qt::SortOrder	order = Qt::AscendingOrder)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

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

\inmodule QtCore

Since: 6.10

QGenericItemModel implements QAbstractItemModel for any C++ range. \reentrant

QGenericItemModel can make the data in any sequentially iterable C++ type available to the \l{Model/View Programming}{model/view framework} of Qt. This makes it easy to display existing data structures in the Qt Widgets and Qt Quick item views, and to allow the user of the application to manipulate the data using a graphical user interface.

To use QGenericItemModel, instantiate it with a C++ range and set it as the model of one or more views:

std::array<int, 5> numbers = {1, 2, 3, 4, 5};
QGenericItemModel model(numbers);
listView.setModel(&model);

The range can be any C++ type for which the standard methods {std::cbegin} and {std::cend} are implemented, and for which the returned iterator type satisfies {std::forward_iterator}. Certain model operations will perform better if {std::size} is available, and if the iterator satisfies {std::random_access_iterator}.

Definition at line 11 of file qgenericitemmodel.h.

Member Typedef Documentation

◆ SingleColumn

template<typename T>

using QGenericItemModel::SingleColumn = std::tuple<T>

Use this type to disambiguate when using the type {T} as the row type in the range.

If {T} provides a metaobject, then the framework will by default represent the type as multiple columns, resulting in a table model.

class ColorEntry
{
    Q_GADGET
    Q_PROPERTY(QString display MEMBER m_colorName)
    Q_PROPERTY(QColor decoration READ decoration)
    Q_PROPERTY(QString toolTip READ toolTip)
public:
    ColorEntry(const QString &color = {})
        : m_colorName(color)
    {}
 
    QColor decoration() const
    {
        return QColor::fromString(m_colorName);
    }
    QString toolTip() const
    {
        return QColor::fromString(m_colorName).name();
    }
 
private:
    QString m_colorName;
};

When stored in a sequential range, this type will be interpreted as multi-column rows with each property being one column. The range will be represented as a table.

QList<ColorEntry> colors = {
    // ...
};
QGenericItemModel tableModel(colors); // columnCount() == 3

When wrapped into QGenericItemModel::SingleColumn, the model will be a list, with each instance of {T} represented as an item with multiple roles.

QList<QGenericItemModel::SingleColumn<ColorEntry>> colors = {
    // ...
};
QGenericItemModel listModel(colors); // columnCount() == 1

See also: QGenericItemModel::MultiColumn

Definition at line 16 of file qgenericitemmodel.h.

Constructor & Destructor Documentation

◆ QGenericItemModel() [1/3]

template<typename Range, QGenericItemModelDetails::if_is_tree_range< Range >>

QGenericItemModel::QGenericItemModel	(	Range &&	range,
		QObject *	parent = nullptr )

explicit

Definition at line 194 of file qgenericitemmodel.h.

◆ QGenericItemModel() [2/3]

template<typename Range, QGenericItemModelDetails::if_is_tree_range< Range > = true>

QGenericItemModel::QGenericItemModel	(	Range &&	range,
		QObject *	parent = nullptr )

explicit

◆ QGenericItemModel() [3/3]

template<typename Range, typename Protocol, QGenericItemModelDetails::if_is_tree_range< Range, Protocol >>

QGenericItemModel::QGenericItemModel	(	Range &&	range,
		Protocol &&	protocol,
		QObject *	parent = nullptr )

explicit

Definition at line 208 of file qgenericitemmodel.h.

◆ ~QGenericItemModel()

QGenericItemModel::~QGenericItemModel ( )

overridedefault

Destroys the generic item model.

The range that the model was constructed from is not destroyed.

Member Function Documentation

◆ buddy()

QModelIndex QGenericItemModel::buddy ( const QModelIndex & index ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 839 of file qgenericitemmodel.cpp.

◆ canDropMimeData()

bool QGenericItemModel::canDropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 847 of file qgenericitemmodel.cpp.

◆ canFetchMore()

bool QGenericItemModel::canFetchMore ( const QModelIndex & parent ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 815 of file qgenericitemmodel.cpp.

◆ clearItemData()

bool QGenericItemModel::clearItemData ( const QModelIndex & index )

overridevirtual

\reimp

Replaces the value stored in the range at index with a default- constructed value.

read-only-setData

Reimplemented from QAbstractItemModel.

Definition at line 694 of file qgenericitemmodel.cpp.

◆ columnCount()

int QGenericItemModel::columnCount ( const QModelIndex & parent = {} ) const

overridevirtual

\reimp

Returns the number of columns of the model. This function returns the same value for all parent indexes.

For models operating on a statically sized row type, this returned value is always the same throughout the lifetime of the model. For models operating on dynamically sized row type, the model returns the number of items in the first row, or 0 if the model has no rows.

See also: rowCount, insertColumns()

Implements QAbstractItemModel.

Definition at line 545 of file qgenericitemmodel.cpp.

◆ data()

QVariant QGenericItemModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole ) const

overridevirtual

\reimp

Returns the data stored under the given role for the value in the range referred to by the index.

If the item type for that index is an associative container that maps from either {int}, Qt::ItemDataRole, or QString to a QVariant, then the role data is looked up in that container and returned.

Otherwise, the implementation returns a QVariant constructed from the item via {QVariant::fromValue()} for {Qt::DisplayRole} or {Qt::EditRole}. For other roles, the implementation returns an invalid (default-constructed) QVariant.

See also: Qt::ItemDataRole, setData(), headerData()

Implements QAbstractItemModel.

Definition at line 602 of file qgenericitemmodel.cpp.

◆ dropMimeData()

bool QGenericItemModel::dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent )

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 856 of file qgenericitemmodel.cpp.

◆ event()

bool QGenericItemModel::event ( QEvent * event )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 946 of file qgenericitemmodel.cpp.

◆ eventFilter()

bool QGenericItemModel::eventFilter	(	QObject *	object,
		QEvent *	event )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 954 of file qgenericitemmodel.cpp.

◆ fetchMore()

void QGenericItemModel::fetchMore ( const QModelIndex & parent )

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 823 of file qgenericitemmodel.cpp.

◆ flags()

Qt::ItemFlags QGenericItemModel::flags ( const QModelIndex & index ) const

overridevirtual

\reimp

Returns the item flags for the given index.

The implementation returns a combination of flags that enables the item (ItemIsEnabled) and allows it to be selected (ItemIsSelectable). For models operating on a range with mutable data, it also sets the flag that allows the item to be editable (ItemIsEditable).

See also: Qt::ItemFlags

Reimplemented from QAbstractItemModel.

Definition at line 562 of file qgenericitemmodel.cpp.

◆ hasChildren()

bool QGenericItemModel::hasChildren ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 831 of file qgenericitemmodel.cpp.

◆ headerData()

QVariant QGenericItemModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role ) const

overridevirtual

\reimp

Returns the data for the given role and section in the header with the specified orientation.

For horizontal headers, the section number corresponds to the column number. Similarly, for vertical headers, the section number corresponds to the row number.

See also: Qt::ItemDataRole, setHeaderData(), QHeaderView

Reimplemented from QAbstractItemModel.

Definition at line 579 of file qgenericitemmodel.cpp.

◆ index()

QModelIndex QGenericItemModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = {} ) const

overridevirtual

\reimp

Returns the index of the model item at row and column in parent.

Passing a valid parent produces an invalid index for models that operate on list and table ranges.

See also: parent()

Implements QAbstractItemModel.

Definition at line 476 of file qgenericitemmodel.cpp.

◆ insertColumns()

bool QGenericItemModel::insertColumns	(	int	column,
		int	count,
		const QModelIndex &	parent = {} )

override

\reimp

Inserts count empty columns before the item at column in all rows of the range at parent. Returns {true} if successful; otherwise returns {false}.

{column-change-requirement} {insert(const_iterator, size_t, value_type)}

Definition at line 719 of file qgenericitemmodel.cpp.

◆ insertRows()

bool QGenericItemModel::insertRows	(	int	row,
		int	count,
		const QModelIndex &	parent = {} )

override

\reimp

Inserts count empty rows before the given row into the range at parent. Returns {true} if successful; otherwise returns {false}.

{row-change-requirement} {insert(const_iterator, size_t, value_type)}

Note: For ranges with a dynamically sized column type, the column needs to provide a {resize(size_t)} member function.

Definition at line 777 of file qgenericitemmodel.cpp.

◆ itemData()

QMap< int, QVariant > QGenericItemModel::itemData ( const QModelIndex & index ) const

overridevirtual

\reimp

Returns a map with values for all predefined roles in the model for the item at the given index.

If the item type for that index is an associative container that maps from either {int}, Qt::ItemDataRole, or QString to a QVariant, then the data from that container is returned.

If the item type is a gadget or QObject subclass, then the values of those properties that match a \l{roleNames()}{role name} are returned.

If the item is not an associative container, gadget, or QObject subclass, then this calls the base class implementation.

See also: setItemData(), Qt::ItemDataRole, data()

Reimplemented from QAbstractItemModel.

Definition at line 650 of file qgenericitemmodel.cpp.

◆ match()

QModelIndexList QGenericItemModel::match	(	const QModelIndex &	start,
		int	role,
		const QVariant &	value,
		int	hits,
		Qt::MatchFlags	flags ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 881 of file qgenericitemmodel.cpp.

◆ mimeData()

QMimeData * QGenericItemModel::mimeData ( const QModelIndexList & indexes ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 865 of file qgenericitemmodel.cpp.

◆ mimeTypes()

QStringList QGenericItemModel::mimeTypes ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 873 of file qgenericitemmodel.cpp.

◆ moveColumns()

bool QGenericItemModel::moveColumns	(	const QModelIndex &	sourceParent,
		int	sourceColumn,
		int	count,
		const QModelIndex &	destinationParent,
		int	destinationColumn )

override

\reimp

Moves count columns starting with the given sourceColumn under parent sourceParent to column destinationColumn under parent destinationParent.

Returns {true} if the columns were successfully moved; otherwise returns {false}.

Definition at line 747 of file qgenericitemmodel.cpp.

◆ moveRows()

bool QGenericItemModel::moveRows	(	const QModelIndex &	sourceParent,
		int	sourceRow,
		int	count,
		const QModelIndex &	destinationParent,
		int	destinationRow )

override

\reimp

Moves count rows starting with the given sourceRow under parent sourceParent to row destinationRow under parent destinationParent.

Returns {true} if the rows were successfully moved; otherwise returns {false}.

Definition at line 804 of file qgenericitemmodel.cpp.

◆ multiData()

void QGenericItemModel::multiData	(	const QModelIndex &	index,
		QModelRoleDataSpan	roleDataSpan ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 890 of file qgenericitemmodel.cpp.

◆ parent()

QModelIndex QGenericItemModel::parent ( const QModelIndex & child ) const

overridevirtual

\reimp

Returns the parent of the item at the child index.

This function always produces an invalid index for models that operate on list and table ranges. For models operation on a tree, this function returns the index for the row item returned by the parent() implementation of the tree traversal protocol.

See also: index(), hasChildren()

Implements QAbstractItemModel.

Definition at line 493 of file qgenericitemmodel.cpp.

◆ removeColumns()

bool QGenericItemModel::removeColumns	(	int	column,
		int	count,
		const QModelIndex &	parent = {} )

override

\reimp

Removes count columns from the item at column on in all rows of the range at parent. Returns {true} if successful, otherwise returns {false}.

{column-change-requirement} {erase(const_iterator, size_t)}

Definition at line 733 of file qgenericitemmodel.cpp.

◆ removeRows()

bool QGenericItemModel::removeRows	(	int	row,
		int	count,
		const QModelIndex &	parent = {} )

override

\reimp

Removes count rows from the range at parent, starting with the given row. Returns {true} if successful, otherwise returns {false}.

{row-change-requirement} {erase(const_iterator, size_t)}

Definition at line 790 of file qgenericitemmodel.cpp.

◆ resetInternalData

void QGenericItemModel::resetInternalData ( )

overrideprotectedslot

\reimp

Definition at line 938 of file qgenericitemmodel.cpp.

◆ roleNames()

QHash< int, QByteArray > QGenericItemModel::roleNames ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 898 of file qgenericitemmodel.cpp.

◆ rowCount()

int QGenericItemModel::rowCount ( const QModelIndex & parent = {} ) const

overridevirtual

\reimp

Returns the number of rows under the given parent. This is the number of items in the root range for an invalid parent index.

If the parent index is valid, then this function always returns 0 for models that operate on list and table ranges. For trees, this returns the size of the range returned by the childRows() implementation of the tree traversal protocol.

See also: columnCount(), insertRows(), hasChildren()

Implements QAbstractItemModel.

Definition at line 527 of file qgenericitemmodel.cpp.

◆ setData()

bool QGenericItemModel::setData	(	const QModelIndex &	index,
		const QVariant &	data,
		int	role = Qt::EditRole )

overridevirtual

\reimp

Sets the \a role data for the item at \a index to \a data.

If the item type for that \a index is an associative container that maps
from either \c{int}, Qt::ItemDataRole, or QString to a QVariant, then
\a data is stored in that container for the key specified by \a role.

Otherwise, this implementation assigns the value in \a data to the item at
the \a index in the range for \c{Qt::DisplayRole} and \c{Qt::EditRole},
and returns \c{true}. For other roles, the implementation returns
\c{false}.

! [read-only-setData] For models operating on a read-only range, or on a read-only column in a row type that implements \l{the C++ tuple protocol}, this implementation returns {false} immediately. ! [read-only-setData]

Reimplemented from QAbstractItemModel.

Definition at line 627 of file qgenericitemmodel.cpp.

◆ setItemData()

bool QGenericItemModel::setItemData	(	const QModelIndex &	index,
		const QMap< int, QVariant > &	data )

overridevirtual

\reimp

If the item type for that index is an associative container that maps from either {int} or Qt::ItemDataRole to a QVariant, then the entries in data are stored in that container. If the associative container maps from QString to QVariant, then only those values in data are stored for which there is a mapping in the \l{roleNames()}{role names} table.

If the item type is a gadget or QObject subclass, then those properties that match a \l{roleNames()}{role name} are set to the corresponding value in data.

Roles for which there is no entry in data are not modified.

For item types that can be copied, this implementation is transactional, and returns true if all the entries from data could be stored. If any entry could not be updated, then the original container is not modified at all, and the function returns false.

If the item is not an associative container, gadget, or QObject subclass, then this calls the base class implementation, which calls setData() for each entry in data.

See also: itemData(), setData(), Qt::ItemDataRole

Reimplemented from QAbstractItemModel.

Definition at line 681 of file qgenericitemmodel.cpp.

◆ sibling()

QModelIndex QGenericItemModel::sibling	(	int	row,
		int	column,
		const QModelIndex &	index ) const

overridevirtual

\reimp

Returns the sibling at row and column for the item at index, or an invalid QModelIndex if there is no sibling at that location.

This implementation is significantly faster than going through the parent() of the index.

See also: index(), QModelIndex::row(), QModelIndex::column()

Reimplemented from QAbstractItemModel.

Definition at line 509 of file qgenericitemmodel.cpp.

◆ sort()

void QGenericItemModel::sort	(	int	column,
		Qt::SortOrder	order = Qt::AscendingOrder )

override

\reimp

Definition at line 906 of file qgenericitemmodel.cpp.

◆ span()

QSize QGenericItemModel::span ( const QModelIndex & index ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 914 of file qgenericitemmodel.cpp.

◆ supportedDragActions()

Qt::DropActions QGenericItemModel::supportedDragActions ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 922 of file qgenericitemmodel.cpp.

◆ supportedDropActions()

Qt::DropActions QGenericItemModel::supportedDropActions ( ) const

overridevirtual

\reimp

Reimplemented from QAbstractItemModel.

Definition at line 930 of file qgenericitemmodel.cpp.

Friends And Related Symbol Documentation

◆ QGenericItemModelImplBase

friend class QGenericItemModelImplBase

friend

Definition at line 105 of file qgenericitemmodel.h.

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

qtbase/src/corelib/itemmodels/qgenericitemmodel.h (546192a6fe0530530c2cca1e9d162648c8faf427)
qtbase/src/corelib/itemmodels/qgenericitemmodel.cpp (d139d22f7e70c8f1842eb2befccb9772d92458e1)

Classes

Public Types

Public Member Functions

Protected Slots

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SingleColumn

Constructor & Destructor Documentation

◆ QGenericItemModel() [1/3]

◆ QGenericItemModel() [2/3]

◆ QGenericItemModel() [3/3]

◆ ~QGenericItemModel()

Member Function Documentation

◆ buddy()

◆ canDropMimeData()

◆ canFetchMore()

◆ clearItemData()

◆ columnCount()

◆ data()

◆ dropMimeData()

◆ event()

◆ eventFilter()

◆ fetchMore()

◆ flags()

◆ hasChildren()

◆ headerData()

◆ index()

◆ insertColumns()

◆ insertRows()

◆ itemData()

◆ match()

◆ mimeData()

◆ mimeTypes()

◆ moveColumns()

◆ moveRows()

◆ multiData()

◆ parent()

◆ removeColumns()

◆ removeRows()

◆ resetInternalData

◆ roleNames()

◆ rowCount()

◆ setData()

◆ setItemData()

◆ sibling()

◆ sort()

◆ span()

◆ supportedDragActions()

◆ supportedDropActions()

Friends And Related Symbol Documentation

◆ QGenericItemModelImplBase