Qx v0.5.8
Qt Extensions Library
Loading...
Searching...
No Matches
Qx::StandardItemModel Class Reference

The StandardItemModel class is a more robust variant of QStandardItemModel, which is a generic model for storing custom data. More...

#include <qx/widgets/qx-standarditemmodel.h>

Collaboration diagram for Qx::StandardItemModel:
[legend]

Public Member Functions

 StandardItemModel (int rows, int columns, QObject *parent=nullptr)
 
 StandardItemModel (QObject *parent=nullptr)
 
void forEachItem (std::function< void(QStandardItem *)> const &func, QModelIndex parent=QModelIndex())
 
bool isAutoTristate ()
 
void selectAll ()
 
void selectNone ()
 
void setAutoTristate (bool autoTristate)
 
virtual bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
 
- Public Member Functions inherited from QStandardItemModel
 QStandardItemModel (int rows, int columns, QObject *parent)
 
 QStandardItemModel (QObject *parent)
 
void appendColumn (const QList< QStandardItem * > &items)
 
void appendRow (const QList< QStandardItem * > &items)
 
void appendRow (QStandardItem *item)
 
QBindable< int > bindableSortRole ()
 
void clear ()
 
virtual bool clearItemData (const QModelIndex &index) override
 
virtual int columnCount (const QModelIndex &parent) const const override
 
virtual QVariant data (const QModelIndex &index, int role) const const override
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
 
QList< QStandardItem * > findItems (const QString &text, Qt::MatchFlags flags, int column) const const
 
virtual Qt::ItemFlags flags (const QModelIndex &index) const const override
 
virtual bool hasChildren (const QModelIndex &parent) const const override
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role) const const override
 
QStandardItemhorizontalHeaderItem (int column) const const
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) const const override
 
QModelIndex indexFromItem (const QStandardItem *item) const const
 
void insertColumn (int column, const QList< QStandardItem * > &items)
 
bool insertColumn (int column, const QModelIndex &parent)
 
virtual bool insertColumns (int column, int count, const QModelIndex &parent) override
 
void insertRow (int row, const QList< QStandardItem * > &items)
 
bool insertRow (int row, const QModelIndex &parent)
 
void insertRow (int row, QStandardItem *item)
 
virtual bool insertRows (int row, int count, const QModelIndex &parent) override
 
QStandardIteminvisibleRootItem () const const
 
QStandardItemitem (int row, int column) const const
 
void itemChanged (QStandardItem *item)
 
virtual QMap< int, QVariantitemData (const QModelIndex &index) const const override
 
QStandardItemitemFromIndex (const QModelIndex &index) const const
 
const QStandardItemitemPrototype () const const
 
virtual QMimeDatamimeData (const QModelIndexList &indexes) const const override
 
virtual QStringList mimeTypes () const const override
 
virtual void multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const override
 
virtual QModelIndex parent (const QModelIndex &child) const const override
 
virtual bool removeColumns (int column, int count, const QModelIndex &parent) override
 
virtual bool removeRows (int row, int count, const QModelIndex &parent) override
 
virtual QHash< int, QByteArrayroleNames () const const override
 
virtual int rowCount (const QModelIndex &parent) const const override
 
void setColumnCount (int columns)
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override
 
void setHorizontalHeaderItem (int column, QStandardItem *item)
 
void setHorizontalHeaderLabels (const QStringList &labels)
 
void setItem (int row, int column, QStandardItem *item)
 
void setItem (int row, QStandardItem *item)
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override
 
void setItemPrototype (const QStandardItem *item)
 
void setItemRoleNames (const QHash< int, QByteArray > &roleNames)
 
void setRowCount (int rows)
 
void setSortRole (int role)
 
void setVerticalHeaderItem (int row, QStandardItem *item)
 
void setVerticalHeaderLabels (const QStringList &labels)
 
virtual void sort (int column, Qt::SortOrder order) override
 
int sortRole () const const
 
virtual Qt::DropActions supportedDropActions () const const override
 
QList< QStandardItem * > takeColumn (int column)
 
QStandardItemtakeHorizontalHeaderItem (int column)
 
QStandardItemtakeItem (int row, int column)
 
QList< QStandardItem * > takeRow (int row)
 
QStandardItemtakeVerticalHeaderItem (int row)
 
QStandardItemverticalHeaderItem (int row) const const
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent)
 
virtual QModelIndex buddy (const QModelIndex &index) const const
 
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const
 
virtual bool canFetchMore (const QModelIndex &parent) const const
 
bool checkIndex (const QModelIndex &index, QAbstractItemModel::CheckIndexOptions options) const const
 
void columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)
 
void columnsInserted (const QModelIndex &parent, int first, int last)
 
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsRemoved (const QModelIndex &parent, int first, int last)
 
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)
 
virtual void fetchMore (const QModelIndex &parent)
 
bool hasIndex (int row, int column, const QModelIndex &parent) const const
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 
bool insertColumn (int column, const QModelIndex &parent)
 
bool insertRow (int row, const QModelIndex &parent)
 
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
 
void layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const
 
void modelAboutToBeReset ()
 
void modelReset ()
 
bool moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)
 
virtual bool moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)
 
bool moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)
 
virtual bool moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)
 
bool removeColumn (int column, const QModelIndex &parent)
 
bool removeRow (int row, const QModelIndex &parent)
 
virtual void revert ()
 
void rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)
 
void rowsInserted (const QModelIndex &parent, int first, int last)
 
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsRemoved (const QModelIndex &parent, int first, int last)
 
virtual QModelIndex sibling (int row, int column, const QModelIndex &index) const const
 
virtual QSize span (const QModelIndex &index) const const
 
virtual bool submit ()
 
virtual Qt::DropActions supportedDragActions () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (QAnyStringView name, Qt::FindChildOptions options) const const
 
findChild (Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (QAnyStringView name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
bool moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Public Types inherited from QAbstractItemModel
enum  CheckIndexOption
 
enum  LayoutChangeHint
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QAbstractItemModel
typedef CheckIndexOptions
 
 DoNotUseParent
 
 HorizontalSortHint
 
 IndexIsValid
 
 NoLayoutChangeHint
 
 NoOption
 
 ParentIsInvalid
 
 VerticalSortHint
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QAbstractItemModel
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 
void beginInsertRows (const QModelIndex &parent, int first, int last)
 
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 
void beginResetModel ()
 
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
 
QModelIndex createIndex (int row, int column, const void *ptr) const const
 
QModelIndex createIndex (int row, int column, quintptr id) const const
 
void endInsertColumns ()
 
void endInsertRows ()
 
void endMoveColumns ()
 
void endMoveRows ()
 
void endRemoveColumns ()
 
void endRemoveRows ()
 
void endResetModel ()
 
QModelIndexList persistentIndexList () const const
 
virtual void resetInternalData ()
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QStandardItemModel
 sortRole
 
- Properties inherited from QObject
 objectName
 

Detailed Description

StandardItemModel derives from QStandardItemModel and therefore shares all of its functionality, but this Qx variant provides additional functionality and mechanisms that are missing from its base class.

Note
One significant functional difference from the base class version to be aware of is that the Qt::ItemIsAutoTristate flag of any item managed by this model will always be respected, regardless of which view it is attached to. In base Qt the auto tristate flag only functions for items behind a QTreeWidget.

Constructor & Destructor Documentation

◆ StandardItemModel() [1/2]

Qx::StandardItemModel::StandardItemModel ( int rows,
int columns,
QObject * parent = nullptr )

Constructs a new item model that initially has rows rows and columns columns, and that has the given parent.

◆ StandardItemModel() [2/2]

Qx::StandardItemModel::StandardItemModel ( QObject * parent = nullptr)

Constructs a new item model with the given parent.

Member Function Documentation

◆ forEachItem()

void Qx::StandardItemModel::forEachItem ( std::function< void(QStandardItem *)> const & func,
QModelIndex parent = QModelIndex() )

Calls a user-defined routine on multiple items within the model.

Parameters
funcThe function to call on each item. It must take a single argument of type QStandardItem* and return void.
parentA model index pointing to the item for processing to start at. A null index causes processing to start at the root item of the model, thereby calling the routine on all items.

◆ isAutoTristate()

bool Qx::StandardItemModel::isAutoTristate ( )

Returns true if the item model is set to auto tristate mode; otherwise returns false.

See also
setAutoTristate().

◆ selectAll()

void Qx::StandardItemModel::selectAll ( )

Sets the check state of all checkable items that are managed by the model to Qt::Checked.

See also
setAutoTristate().

◆ selectNone()

void Qx::StandardItemModel::selectNone ( )

Sets the check state of all checkable items that are managed by the model to Qt::Unchecked.

See also
setAutoTristate().

◆ setAutoTristate()

void Qx::StandardItemModel::setAutoTristate ( bool autoTristate)

Enables treatment of all checkable child items as tristate if autoTristate is true

This enables model-wide automatic management of the state of parent items in the model (checked if all children are checked, unchecked if all children are unchecked, or partially checked if only some children are checked).

Note
Even if this option is false, items handled by the model that have the flag Qt::ItemIsAutoTristate will still be treated as such.

◆ setData()

bool Qx::StandardItemModel::setData ( const QModelIndex & index,
const QVariant & value,
int role = Qt::EditRole )
virtual

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