QStandardItemModel Class | Qt GUI 5.6

Qt 5.6 | Qt GUI | C++ Classes | QStandardItemModel

Qt 5.6.2 Reference Documentation

# QStandardItemModel Class

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

Header: | #include <QStandardItemModel>
qmake: | QT += gui

- List of all members, including inherited members

## Properties

- sortRole : int

## Public Functions

| QStandardItemModel(QObject *parent = Q_NULLPTR)
| QStandardItemModel(int rows, int columns, QObject *parent = Q_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
QVariant | data(const QModelIndex &index, int role = Qt::DisplayRole) const
bool | dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
QList<QStandardItem *> | findItems(const QString &text, Qt::MatchFlags flags = Qt::MatchExactly, int column = 0) const
Qt::ItemFlags | flags(const QModelIndex &index) const
bool | hasChildren(const QModelIndex &parent = QModelIndex()) const
QVariant | headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const
QStandardItem * | horizontalHeaderItem(int column) const
QModelIndex | index(int row, int column, const QModelIndex &parent = QModelIndex()) const
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())
void | insertRow(int row, const QList<QStandardItem *> &items)
void | insertRow(int row, QStandardItem *item)
bool | insertRow(int row, const QModelIndex &parent = QModelIndex())
bool | insertRows(int row, int count, const QModelIndex &parent = QModelIndex())
QStandardItem * | invisibleRootItem() const
QStandardItem * | item(int row, int column = 0) const
QMap<int, QVariant> | itemData(const QModelIndex &index) const
QStandardItem * | itemFromIndex(const QModelIndex &index) const
const QStandardItem * | itemPrototype() const
QMimeData * | mimeData(const QModelIndexList &indexes) const
QStringList | mimeTypes() const
QModelIndex | parent(const QModelIndex &child) const
bool | removeColumns(int column, int count, const QModelIndex &parent = QModelIndex())
bool | removeRows(int row, int count, const QModelIndex &parent = QModelIndex())
int | rowCount(const QModelIndex &parent = QModelIndex()) const
void | setColumnCount(int columns)
bool | setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole)
bool | setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role = Qt::EditRole)
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)
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)
QModelIndex | sibling(int row, int column, const QModelIndex &idx) const
void | sort(int column, Qt::SortOrder order = Qt::AscendingOrder)
int | sortRole() const
Qt::DropActions | supportedDropActions() const
QList<QStandardItem *> | takeColumn(int column)
QStandardItem * | takeHorizontalHeaderItem(int column)
QStandardItem * | takeItem(int row, int column = 0)
QList<QStandardItem *> | takeRow(int row)
QStandardItem * | takeVerticalHeaderItem(int row)
QStandardItem * | verticalHeaderItem(int row) const

## Signals

void | itemChanged(QStandardItem *item)

## Detailed Description

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

QStandardItemModel can be used as a repository for standard Qt data types. It is one of the Model/View Classes and is part of Qt's model/view framework.

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

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").arg(row).arg(column));
              model.setItem(row, column, item);
          }
      }

An example usage of QStandardItemModel to create a tree:

      QStandardItemModel model;
      QStandardItem *parentItem = model.invisibleRootItem();
      for (int i = 0; i < 4; ++i) {
          QStandardItem *item = new QStandardItem(QString("item %0").arg(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, of course, not required to use the item-based approach; you could 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, Simple Tree Model example, and Item View Convenience Classes.

## Property Documentation

### sortRole : int

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

The default value is Qt::DisplayRole.

This property was introduced in Qt 4.2.

Access functions:

int | sortRole() const
void | setSortRole(int role)

See also sort() and QStandardItem::sortChildren().

## Member Function Documentation

### QStandardItemModel::QStandardItemModel(QObject *parent = Q_NULLPTR)

Constructs a new item model with the given parent.

### QStandardItemModel::QStandardItemModel(int rows, int columns, QObject *parent = Q_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.

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

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

This function was introduced in Qt 4.2.

See also insertColumn() and 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.

This function was introduced in Qt 4.2.

See also insertRow() and appendColumn().

### void QStandardItemModel::appendRow(QStandardItem *item)

This is an overloaded function.

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

This function was introduced in Qt 4.2.

### 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() and removeRows().

### int QStandardItemModel::columnCount(const QModelIndex &parent = QModelIndex()) const

See also setColumnCount().

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

See also setData().

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

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

This function was introduced in Qt 4.2.

### Qt::ItemFlags QStandardItemModel::flags(const QModelIndex &index) const

### bool QStandardItemModel::hasChildren(const QModelIndex &parent = QModelIndex()) const

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

See also setHeaderData().

### QStandardItem *QStandardItemModel::horizontalHeaderItem(int column) const

Returns the horizontal header item for column if one has been set; otherwise returns 0.

This function was introduced in Qt 4.2.

See also setHorizontalHeaderItem() and verticalHeaderItem().

### QModelIndex QStandardItemModel::index(int row, int column, const QModelIndex &parent = QModelIndex()) const

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

This function was introduced in Qt 4.2.

See also itemFromIndex() and 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.

This function was introduced in Qt 4.2.

See also takeColumn(), appendColumn(), and insertRow().

### bool QStandardItemModel::insertColumn(int column, const QModelIndex &parent = QModelIndex())

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(), and removeColumn().

### bool QStandardItemModel::insertColumns(int column, int count, const QModelIndex &parent = QModelIndex())

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

This function was introduced in Qt 4.2.

See also takeRow(), appendRow(), and insertColumn().

### void QStandardItemModel::insertRow(int row, QStandardItem *item)

This is an overloaded function.

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.

This function was introduced in Qt 4.2.

### bool QStandardItemModel::insertRow(int row, const QModelIndex &parent = QModelIndex())

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(), and removeRow().

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

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

This function was introduced in Qt 4.2.

### 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 0.

This function was introduced in Qt 4.2.

See also setItem(), takeItem(), and itemFromIndex().

### `[signal]` void QStandardItemModel::itemChanged(QStandardItem *item)

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

This function was introduced in Qt 4.2.

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

See also setItemData().

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

Returns a pointer to the QStandardItem associated with the given index.

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.

If index is an invalid index, this function returns 0.

This function was introduced in Qt 4.2.

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()).

This function was introduced in Qt 4.2.

See also setItemPrototype().

### QMimeData *QStandardItemModel::mimeData(const QModelIndexList &indexes) const

### QStringList QStandardItemModel::mimeTypes() const

### QModelIndex QStandardItemModel::parent(const QModelIndex &child) const

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

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

### int QStandardItemModel::rowCount(const QModelIndex &parent = QModelIndex()) const

See also setRowCount().

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

This function was introduced in Qt 4.2.

See also columnCount() and setRowCount().

### bool QStandardItemModel::setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole)

See also data().

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

See also headerData().

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

This function was introduced in Qt 4.2.

See also horizontalHeaderItem(), setHorizontalHeaderLabels(), and 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.

This function was introduced in Qt 4.2.

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.

This function was introduced in Qt 4.2.

See also item().

### void QStandardItemModel::setItem(int row, QStandardItem *item)

This is an overloaded function.

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

See also itemData().

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

This function was introduced in Qt 4.2.

See also itemPrototype() and QStandardItem::clone().

### void QStandardItemModel::setItemRoleNames(const QHash<int, QByteArray> &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.

This function was introduced in Qt 4.2.

See also rowCount() and setColumnCount().

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

This function was introduced in Qt 4.2.

See also verticalHeaderItem(), setVerticalHeaderLabels(), and 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.

This function was introduced in Qt 4.2.

See also setVerticalHeaderItem().

### QModelIndex QStandardItemModel::sibling(int row, int column, const QModelIndex &idx) const

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

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

QStandardItemModel supports both copy and move.

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

This function was introduced in Qt 4.2.

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.

This function was introduced in Qt 4.2.

See also horizontalHeaderItem() and 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.

This function was introduced in Qt 4.2.

See also item(), takeRow(), and 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.

This function was introduced in Qt 4.2.

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.

This function was introduced in Qt 4.2.

See also verticalHeaderItem() and takeHorizontalHeaderItem().

### QStandardItem *QStandardItemModel::verticalHeaderItem(int row) const

Returns the vertical header item for row row if one has been set; otherwise returns 0.

This function was introduced in Qt 4.2.

See also setVerticalHeaderItem() and horizontalHeaderItem().