CopperSpice API  1.7.2
QStandardItemModel Class Reference

The QStandardItemModel class provides a generic model for storing custom data. More...

Inheritance diagram for QStandardItemModel:
QAbstractItemModel QObject

Public Signals

void itemChanged (QStandardItem *item)
 
- Public Signals inherited from QAbstractItemModel
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 QVector< int > &roles=QVector< int >())
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
 
void layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
 
void modelAboutToBeReset ()
 
void modelReset ()
 
void rowsAboutToBeInserted (const QModelIndex &parent, int first, int last)
 
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)
 
- Public Signals inherited from QObject
void destroyed (QObject *obj=nullptr)
 
void objectNameChanged (const QString &objectName)
 

Public Methods

 QStandardItemModel (int rows, int columns, QObject *parent=nullptr)
 
 QStandardItemModel (QObject *parent=nullptr)
 
 ~QStandardItemModel ()
 
void appendColumn (const QList< QStandardItem * > &items)
 
void appendRow (const QList< QStandardItem * > &items)
 
void appendRow (QStandardItem *item)
 
void clear ()
 
int columnCount (const QModelIndex &parent=QModelIndex ()) const override
 
QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const override
 
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=Qt::MatchExactly, int column=0) const
 
Qt::ItemFlags flags (const QModelIndex &index) const override
 
bool hasChildren (const QModelIndex &parent=QModelIndex ()) const override
 
QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
 
QStandardItemhorizontalHeaderItem (int column) const
 
QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex ()) const override
 
QModelIndex indexFromItem (const QStandardItem *item) const
 
void insertColumn (int column, const QList< QStandardItem * > &items)
 
bool insertColumn (int column, const QModelIndex &parent=QModelIndex ())
 
bool insertColumns (int column, int count, const QModelIndex &parent=QModelIndex ()) override
 
void insertRow (int row, const QList< QStandardItem * > &items)
 
bool insertRow (int row, const QModelIndex &parent=QModelIndex ())
 
void insertRow (int row, QStandardItem *item)
 
bool insertRows (int row, int count, const QModelIndex &parent=QModelIndex ()) override
 
QStandardIteminvisibleRootItem () const
 
QStandardItemitem (int row, int column=0) const
 
QMap< int, QVariantitemData (const QModelIndex &index) const override
 
QStandardItemitemFromIndex (const QModelIndex &index) const
 
const QStandardItemitemPrototype () const
 
QMimeDatamimeData (const QModelIndexList &indexes) const override
 
QStringList mimeTypes () const override
 
QObjectparent () const
 
QModelIndex parent (const QModelIndex &child) const override
 
bool removeColumns (int column, int count, const QModelIndex &parent=QModelIndex ()) override
 
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex ()) override
 
int rowCount (const QModelIndex &parent=QModelIndex ()) const override
 
void setColumnCount (int columns)
 
bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
 
bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole) 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)
 
bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override
 
void setItemPrototype (const QStandardItem *item)
 
void setItemRoleNames (const QMultiHash< int, QString > &roleNames)
 
void setRowCount (int rows)
 
void setSortRole (int role)
 
void setVerticalHeaderItem (int row, QStandardItem *item)
 
void setVerticalHeaderLabels (const QStringList &labels)
 
void sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override
 
int sortRole () const
 
Qt::DropActions supportedDropActions () const override
 
QList< QStandardItem * > takeColumn (int column)
 
QStandardItemtakeHorizontalHeaderItem (int column)
 
QStandardItemtakeItem (int row, int column=0)
 
QList< QStandardItem * > takeRow (int row)
 
QStandardItemtakeVerticalHeaderItem (int row)
 
QStandardItemverticalHeaderItem (int row) const
 
- Public Methods inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent=nullptr)
 
virtual ~QAbstractItemModel ()
 
virtual QModelIndex buddy (const QModelIndex &index) const
 
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
 
virtual bool canFetchMore (const QModelIndex &parent) const
 
virtual void fetchMore (const QModelIndex &parent)
 
bool hasIndex (int row, int column, const QModelIndex &parent=QModelIndex ()) const
 
bool insertColumn (int column, const QModelIndex &parent=QModelIndex ())
 
bool insertRow (int row, const QModelIndex &parent=QModelIndex ())
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags (Qt::MatchStartsWith|Qt::MatchWrap)) const
 
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)
 
QObjectparent () const
 
bool removeColumn (int column, const QModelIndex &parent=QModelIndex ())
 
bool removeRow (int row, const QModelIndex &parent=QModelIndex ())
 
virtual QMultiHash< int, QStringroleNames () const
 
virtual QModelIndex sibling (int row, int column, const QModelIndex &index) const
 
virtual QSize span (const QModelIndex &index) const
 
virtual Qt::DropActions supportedDragActions () const
 
- Public Methods inherited from QObject
 QObject (QObject *parent=nullptr)
 
 ~QObject ()
 
bool blockSignals (bool block)
 
const QList< QObject * > & children () const
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QStringdynamicPropertyNames () const
 
virtual bool event (QEvent *event)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
template<typename T >
findChild (const QString &childName=QString ()) const
 
template<class T >
QList< T > findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<class T >
QList< T > findChildren (const QString &objName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
bool inherits (const QString &className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
QObject * parent () const
 
template<class T = QVariant>
property (const QString &name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const QString &name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
QThreadthread () const
 

Properties

 sortRole
 
- Properties inherited from QObject
 objectName
 

Friends

class QStandardItem
 

Additional Inherited Members

- Public Slots inherited from QAbstractItemModel
virtual void revert ()
 
virtual bool submit ()
 
- Public Slots inherited from QObject
void deleteLater ()
 
- Static Public Methods inherited from QObject
static bool connect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())
 
static bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...))
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)
 
static QMetaObjectstaticMetaObject ()
 
static QString tr (const char *text, const char *comment=nullptr, std::optional< int > numArg=std::optional< int >())
 
- Protected Slots inherited from QAbstractItemModel
void resetInternalData ()
 
- Protected Methods 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 destinationColumn)
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)
 
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, quintptr id) const
 
QModelIndex createIndex (int row, int column, void *data=nullptr) const
 
void endInsertColumns ()
 
void endInsertRows ()
 
void endMoveColumns ()
 
void endMoveRows ()
 
void endRemoveColumns ()
 
void endRemoveRows ()
 
void endResetModel ()
 
QModelIndexList persistentIndexList () const
 
- Protected Methods inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signalMethod) const
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signalMethod) const
 
bool isSignalConnected (const QMetaMethod &signalMethod) const
 
int receivers (const QString &signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

The QStandardItemModel class provides a generic model for storing custom data.

QStandardItemModel can be used as a repository for standard CopperSpice data types. It is one of the Model/View Classes and is part of the CopperSpice Model/View Programming.

QStandardItemModel provides a classic item-based approach to working with the model. The items in a QStandardItemModel are provided by QStandardItem.

QStandardItemModel implements the QAbstractItemModel interface, which means that the model can be used to provide data in any view that supports that interface (such as QListView, QTableView and QTreeView, and your own custom views). For performance and flexibility, you may want to subclass QAbstractItemModel to provide support for different kinds of data repositories. For example, the QDirModel (obsolete) provides a model interface to the underlying file system.

When you want a list or tree, you typically create an empty QStandardItemModel and use appendRow() to add items to the model, and item() to access an item. If your model represents a table, you typically pass the dimensions of the table to the QStandardItemModel constructor and use setItem() to position items into the table. You can also use setRowCount() and setColumnCount() to alter the dimensions of the model. To insert items, use insertRow() or insertColumn(), and to remove items, use removeRow() or removeColumn().

You can set the header labels of your model with setHorizontalHeaderLabels() and setVerticalHeaderLabels().

You can search for items in the model with findItems(), and sort the model by calling sort().

Call clear() to remove all items from the model.

The following is an example usage of QStandardItemModel to create a table.

QStandardItemModel model(4, 4);
for (int row = 0; row < 4; ++row) {
for (int column = 0; column < 4; ++column) {
QStandardItem *item = new QStandardItem(QString("row %0, column %1").formatArg(row).formatArg(column));
model.setItem(row, column, item);
}
}

An example usage of QStandardItemModel to create a tree:

QStandardItem *parentItem = model.invisibleRootItem();
for (int i = 0; i < 4; ++i) {
QStandardItem *item = new QStandardItem(QString("item %0").formatArg(i));
parentItem->appendRow(item);
parentItem = item;
}

After setting the model on a view, you typically want to react to user actions, such as an item being clicked. Since a QAbstractItemView provides QModelIndex-based signals and functions, you need a way to obtain the QStandardItem that corresponds to a given QModelIndex, and vice versa. itemFromIndex() and indexFromItem() provide this mapping. Typical usage of itemFromIndex() includes obtaining the item at the current index in a view, and obtaining the item that corresponds to an index carried by a QAbstractItemView signal, such as QAbstractItemView::clicked(). First you connect the view's signal to a slot in your class:

QTreeView *treeView = new QTreeView(this);
treeView->setModel(myStandardItemModel);
connect(treeView, SIGNAL(clicked(QModelIndex)),
this, SLOT(clicked(QModelIndex)));

When you receive the signal, you call itemFromIndex() on the given model index to get a pointer to the item:

void MyWidget::clicked(const QModelIndex &index)
{
QStandardItem *item = myStandardItemModel->itemFromIndex(index);
// Do stuff with the item
}

Conversely, you must obtain the QModelIndex of an item when you want to invoke a model/view function that takes an index as argument. You can obtain the index either by using the model's indexFromItem() function, or, equivalently, by calling QStandardItem::index():

treeView->scrollTo(item->index());

You are not required to use the item-based approach. You can instead rely entirely on the QAbstractItemModel interface when working with the model or use a combination of the two as appropriate.

See also
QStandardItem, Model/View Programming, QAbstractItemModel, Item View Convenience Classes

Constructor & Destructor Documentation

QStandardItemModel::QStandardItemModel ( QObject parent = nullptr)
explicit

Constructs a new item model with the given parent.

QStandardItemModel::QStandardItemModel ( 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.

QStandardItemModel::~QStandardItemModel ( )

Destructs the model. The model destroys all its items.

Method Documentation

void QStandardItemModel::appendColumn ( const QList< QStandardItem * > &  items)

Appends a column containing items. If necessary, the row count is increased to the size of items.

See also
insertColumn(), appendRow()
void QStandardItemModel::appendRow ( const QList< QStandardItem * > &  items)

Appends a row containing items. If necessary, the column count is increased to the size of items.

See also
insertRow(), appendColumn()
void QStandardItemModel::appendRow ( QStandardItem item)
inline

When building a list or a tree that has only one column, this function provides a convenient way to append a single new item.

void QStandardItemModel::clear ( )

Removes all items (including header items) from the model and sets the number of rows and columns to zero.

See also
removeColumns(), removeRows()
int QStandardItemModel::columnCount ( const QModelIndex parent = QModelIndex()) const
overridevirtual
QVariant QStandardItemModel::data ( const QModelIndex index,
int  role = Qt::DisplayRole 
) const
overridevirtual

Reimplemented from QAbstractItemModel::data().

See also
setData()

Implements QAbstractItemModel.

bool QStandardItemModel::dropMimeData ( const QMimeData data,
Qt::DropAction  action,
int  row,
int  column,
const QModelIndex parent 
)
overridevirtual

Reimplemented from QAbstractItemModel::dropMimeData().

Reimplemented from QAbstractItemModel.

QList< QStandardItem * > QStandardItemModel::findItems ( const QString text,
Qt::MatchFlags  flags = Qt::MatchExactly,
int  column = 0 
) const

Returns a list of items that match the given text, using the given flags, in the given column.

Qt::ItemFlags QStandardItemModel::flags ( const QModelIndex index) const
overridevirtual

Reimplemented from QAbstractItemModel::flags().

Reimplemented from QAbstractItemModel.

bool QStandardItemModel::hasChildren ( const QModelIndex parent = QModelIndex()) const
overridevirtual

Reimplemented from QAbstractItemModel::hasChildren().

Reimplemented from QAbstractItemModel.

QVariant QStandardItemModel::headerData ( int  section,
Qt::Orientation  orientation,
int  role = Qt::DisplayRole 
) const
overridevirtual

Reimplemented from QAbstractItemModel::headerData().

See also
setHeaderData()

Reimplemented from QAbstractItemModel.

QStandardItem * QStandardItemModel::horizontalHeaderItem ( int  column) const

Returns the horizontal header item for column if one has been set, otherwise returns a nullptr.

See also
setHorizontalHeaderItem(), verticalHeaderItem()
QModelIndex QStandardItemModel::index ( int  row,
int  column,
const QModelIndex parent = QModelIndex() 
) const
overridevirtual

Reimplemented from QAbstractItemModel::index().

Implements QAbstractItemModel.

QModelIndex QStandardItemModel::indexFromItem ( const QStandardItem item) const

Returns the QModelIndex associated with the given item.

Use this function when you want to perform an operation that requires the QModelIndex of the item, such as QAbstractItemView::scrollTo(). QStandardItem::index() is provided as convenience; it is equivalent to calling this function.

See also
itemFromIndex(), QStandardItem::index()
void QStandardItemModel::insertColumn ( int  column,
const QList< QStandardItem * > &  items 
)

Inserts a column at column containing items. If necessary, the row count is increased to the size of items.

See also
takeColumn(), appendColumn(), insertRow()
bool QStandardItemModel::insertColumn ( int  column,
const QModelIndex parent = QModelIndex() 
)
inline

Inserts a single column before the given column in the child items of the parent specified. Returns true if the column is inserted, otherwise returns false.

See also
insertColumns(), insertRow(), removeColumn()
bool QStandardItemModel::insertColumns ( int  column,
int  count,
const QModelIndex parent = QModelIndex() 
)
overridevirtual

Reimplemented from QAbstractItemModel::insertColumns().

Reimplemented from QAbstractItemModel.

void QStandardItemModel::insertRow ( int  row,
const QList< QStandardItem * > &  items 
)

Inserts a row at row containing items. If necessary, the column count is increased to the size of items.

See also
takeRow(), appendRow(), insertColumn()
bool QStandardItemModel::insertRow ( int  row,
const QModelIndex parent = QModelIndex() 
)
inline

Inserts a single row before the given row in the child items of the parent specified. Returns true if the row is inserted, otherwise returns false.

See also
insertRows(), insertColumn(), removeRow()
void QStandardItemModel::insertRow ( int  row,
QStandardItem item 
)
inline

Inserts a row at row containing item. When building a list or a tree that has only one column, this function provides a convenient way to append a single new item.

bool QStandardItemModel::insertRows ( int  row,
int  count,
const QModelIndex parent = QModelIndex() 
)
overridevirtual

Reimplemented from QAbstractItemModel::insertRows().

Reimplemented from QAbstractItemModel.

QStandardItem * QStandardItemModel::invisibleRootItem ( ) const

Returns the model's invisible root item.

The invisible root item provides access to the model's top-level items through the QStandardItem API, making it possible to write functions that can treat top-level items and their children in a uniform way; for example, recursive functions involving a tree model.

Note
Calling index() on the QStandardItem object retrieved from this function is not valid.
QStandardItem * QStandardItemModel::item ( int  row,
int  column = 0 
) const

Returns the item for the given row and column if one has been set, otherwise returns a nullptr.

See also
setItem(), takeItem(), itemFromIndex()
void QStandardItemModel::itemChanged ( QStandardItem item)
signal

This signal is emitted whenever the data of item has changed.

QMap< int, QVariant > QStandardItemModel::itemData ( const QModelIndex index) const
overridevirtual

Reimplemented from QAbstractItemModel::itemData().

See also
setItemData()

Reimplemented from QAbstractItemModel.

QStandardItem * QStandardItemModel::itemFromIndex ( const QModelIndex index) const

Returns a pointer to the QStandardItem associated with the given index. If index is an invalid, this method a nullptr.

Calling this function is typically the initial step when processing QModelIndex-based signals from a view, such as QAbstractItemView::activated(). In your slot, you call itemFromIndex(), with the QModelIndex carried by the signal as argument, to obtain a pointer to the corresponding QStandardItem.

Note that this function will lazily create an item for the index (using itemPrototype()), and set it in the parent item's child table, if no item already exists at that index.

See also
indexFromItem()
const QStandardItem * QStandardItemModel::itemPrototype ( ) const

Returns the item prototype used by the model. The model uses the item prototype as an item factory when it needs to construct new items on demand (for instance, when a view or item delegate calls setData()).

See also
setItemPrototype()
QMimeData * QStandardItemModel::mimeData ( const QModelIndexList indexes) const
overridevirtual

Reimplemented from QAbstractItemModel::mimeData().

Reimplemented from QAbstractItemModel.

QStringList QStandardItemModel::mimeTypes ( ) const
overridevirtual

Reimplemented from QAbstractItemModel::mimeTypes().

Reimplemented from QAbstractItemModel.

QObject * QObject::parent ( ) const
using

Returns a pointer to the parent object.

See also
setParent(), children()
QModelIndex QStandardItemModel::parent ( const QModelIndex child) const
overridevirtual

Reimplemented from QAbstractItemModel::parent().

Implements QAbstractItemModel.

bool QStandardItemModel::removeColumns ( int  column,
int  count,
const QModelIndex parent = QModelIndex() 
)
overridevirtual

Reimplemented from QAbstractItemModel::removeColumns().

Reimplemented from QAbstractItemModel.

bool QStandardItemModel::removeRows ( int  row,
int  count,
const QModelIndex parent = QModelIndex() 
)
overridevirtual

Reimplemented from QAbstractItemModel::removeRows().

Reimplemented from QAbstractItemModel.

int QStandardItemModel::rowCount ( const QModelIndex parent = QModelIndex()) const
overridevirtual

Reimplemented from QAbstractItemModel::rowCount().

See also
setRowCount()

Implements QAbstractItemModel.

void QStandardItemModel::setColumnCount ( int  columns)

Sets the number of columns in this model to columns. If this is less than columnCount(), the data in the unwanted columns is discarded.

See also
columnCount(), setRowCount()
bool QStandardItemModel::setData ( const QModelIndex index,
const QVariant value,
int  role = Qt::EditRole 
)
overridevirtual

Reimplemented from QAbstractItemModel::setData().

See also
data()

Reimplemented from QAbstractItemModel.

bool QStandardItemModel::setHeaderData ( int  section,
Qt::Orientation  orientation,
const QVariant value,
int  role = Qt::EditRole 
)
overridevirtual

Reimplemented from QAbstractItemModel::setHeaderData().

See also
headerData()

Reimplemented from QAbstractItemModel.

void QStandardItemModel::setHorizontalHeaderItem ( int  column,
QStandardItem item 
)

Sets the horizontal header item for column to item. The model takes ownership of the item. If necessary, the column count is increased to fit the item. The previous header item (if there was one) is deleted.

See also
horizontalHeaderItem(), setHorizontalHeaderLabels(), setVerticalHeaderItem()
void QStandardItemModel::setHorizontalHeaderLabels ( const QStringList labels)

Sets the horizontal header labels using labels. If necessary, the column count is increased to the size of labels.

See also
setHorizontalHeaderItem()
void QStandardItemModel::setItem ( int  row,
int  column,
QStandardItem item 
)

Sets the item for the given row and column to item. The model takes ownership of the item. If necessary, the row count and column count are increased to fit the item. The previous item at the given location (if there was one) is deleted.

See also
item()
void QStandardItemModel::setItem ( int  row,
QStandardItem item 
)
inline

This is an overloaded function.

bool QStandardItemModel::setItemData ( const QModelIndex index,
const QMap< int, QVariant > &  roles 
)
overridevirtual

Reimplemented from QAbstractItemModel::setItemData().

See also
itemData()

Reimplemented from QAbstractItemModel.

void QStandardItemModel::setItemPrototype ( const QStandardItem item)

Sets the item prototype for the model to the specified item. The model takes ownership of the prototype.

The item prototype acts as a QStandardItem factory, by relying on the QStandardItem::clone() function. To provide your own prototype, subclass QStandardItem, reimplement QStandardItem::clone() and set the prototype to be an instance of your custom class. Whenever QStandardItemModel needs to create an item on demand (for instance, when a view or item delegate calls setData())), the new items will be instances of your custom class.

See also
itemPrototype(), QStandardItem::clone()
void QStandardItemModel::setItemRoleNames ( const QMultiHash< int, QString > &  roleNames)

Sets the item role names to roleNames.

void QStandardItemModel::setRowCount ( int  rows)

Sets the number of rows in this model to rows. If this is less than rowCount(), the data in the unwanted rows is discarded.

See also
rowCount(), setColumnCount()
void QStandardItemModel::setSortRole ( int  role)

Property documentation pending.

void QStandardItemModel::setVerticalHeaderItem ( int  row,
QStandardItem item 
)

Sets the vertical header item for row to item. The model takes ownership of the item. If necessary, the row count is increased to fit the item. The previous header item (if there was one) is deleted.

See also
verticalHeaderItem(), setVerticalHeaderLabels(), setHorizontalHeaderItem()
void QStandardItemModel::setVerticalHeaderLabels ( const QStringList labels)

Sets the vertical header labels using labels. If necessary, the row count is increased to the size of labels.

See also
setVerticalHeaderItem()
void QStandardItemModel::sort ( int  column,
Qt::SortOrder  order = Qt::AscendingOrder 
)
overridevirtual

Reimplemented from QAbstractItemModel::sort().

Reimplemented from QAbstractItemModel.

int QStandardItemModel::sortRole ( ) const

Property documentation pending.

Qt::DropActions QStandardItemModel::supportedDropActions ( ) const
overridevirtual

Reimplemented from QAbstractItemModel::supportedDropActions().

QStandardItemModel supports both copy and move.

Reimplemented from QAbstractItemModel.

QList< QStandardItem * > QStandardItemModel::takeColumn ( int  column)

Removes the given column without deleting the column items, and returns a list of pointers to the removed items. The model releases ownership of the items. For items in the column that have not been set, the corresponding pointers in the list will be 0.

See also
takeRow()
QStandardItem * QStandardItemModel::takeHorizontalHeaderItem ( int  column)

Removes the horizontal header item at column from the header without deleting it, and returns a pointer to the item. The model releases ownership of the item.

See also
horizontalHeaderItem(), takeVerticalHeaderItem()
QStandardItem * QStandardItemModel::takeItem ( int  row,
int  column = 0 
)

Removes the item at (row, column) without deleting it. The model releases ownership of the item.

See also
item(), takeRow(), takeColumn()
QList< QStandardItem * > QStandardItemModel::takeRow ( int  row)

Removes the given row without deleting the row items, and returns a list of pointers to the removed items. The model releases ownership of the items. For items in the row that have not been set, the corresponding pointers in the list will be 0.

See also
takeColumn()
QStandardItem * QStandardItemModel::takeVerticalHeaderItem ( int  row)

Removes the vertical header item at row from the header without deleting it, and returns a pointer to the item. The model releases ownership of the item.

See also
verticalHeaderItem(), takeHorizontalHeaderItem()
QStandardItem * QStandardItemModel::verticalHeaderItem ( int  row) const

Returns the vertical header item for row row if one has been set, otherwise returns a nullptr.

See also
setVerticalHeaderItem(), horizontalHeaderItem()

Property Documentation

QStandardItemModel::sortRole

This property holds the item role that is used to query the model's data when sorting items.

The default value is Qt::DisplayRole.

See also
sort(), QStandardItem::sortChildren()
PropertiesClass Methods
read sortRole
write setSortRole