QStandardItemModel 类

QStandardItemModel 类提供用于存储自定义数据的通用模型。 更多...

头: #include <QStandardItemModel>
CMake: find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
继承: QAbstractItemModel

特性

公共函数

QStandardItemModel (QObject * parent = nullptr)
QStandardItemModel (int rows , int columns , QObject * parent = nullptr)
virtual ~QStandardItemModel ()
void appendColumn (const QList<QStandardItem *> & )
void appendRow (const QList<QStandardItem *> & )
void appendRow (QStandardItem * item )
QBindable<int> bindableSortRole ()
void clear ()
QList<QStandardItem *> findItems (const QString & text , Qt::MatchFlags flags = Qt::MatchExactly, int column = 0) const
QStandardItem * horizontalHeaderItem (int column ) const
QModelIndex indexFromItem (const QStandardItem * item ) const
void insertColumn (int column , const QList<QStandardItem *> & )
bool insertColumn (int column , const QModelIndex & parent = QModelIndex())
void insertRow (int row , const QList<QStandardItem *> & )
void insertRow (int row , QStandardItem * item )
bool insertRow (int row , const QModelIndex & parent = QModelIndex())
QStandardItem * invisibleRootItem () const
QStandardItem * item (int row , int column = 0) const
QStandardItem * itemFromIndex (const QModelIndex & index ) const
const QStandardItem * itemPrototype () const
void setColumnCount (int columns )
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 )
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 )
int sortRole () 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

重实现公共函数

virtual bool clearItemData (const QModelIndex & index ) override
virtual int columnCount (const QModelIndex & parent = QModelIndex()) const override
virtual QVariant data (const QModelIndex & index , int role = Qt::DisplayRole) const override
virtual bool dropMimeData (const QMimeData * data , Qt::DropAction action , int row , int column , const QModelIndex & parent ) override
virtual Qt::ItemFlags flags (const QModelIndex & index ) const override
virtual bool hasChildren (const QModelIndex & parent = QModelIndex()) const override
virtual QVariant headerData (int section , Qt::Orientation orientation , int role = Qt::DisplayRole) const override
virtual QModelIndex index (int row , int column , const QModelIndex & parent = QModelIndex()) const override
virtual bool insertColumns (int column , int count , const QModelIndex & parent = QModelIndex()) override
virtual bool insertRows (int row , int count , const QModelIndex & parent = QModelIndex()) override
virtual QMap<int, QVariant> itemData (const QModelIndex & index ) const override
virtual QMimeData * mimeData (const QModelIndexList & indexes ) const override
virtual QStringList mimeTypes () const override
virtual void multiData (const QModelIndex & index , QModelRoleDataSpan roleDataSpan ) const override
virtual QModelIndex parent (const QModelIndex & child ) const override
virtual bool removeColumns (int column , int count , const QModelIndex & parent = QModelIndex()) override
virtual bool removeRows (int row , int count , const QModelIndex & parent = QModelIndex()) override
virtual QHash<int, QByteArray> roleNames () const override
virtual int rowCount (const QModelIndex & parent = QModelIndex()) const override
virtual bool setData (const QModelIndex & index , const QVariant & value , int role = Qt::EditRole) override
virtual bool setHeaderData (int section , Qt::Orientation orientation , const QVariant & value , int role = Qt::EditRole) override
virtual bool setItemData (const QModelIndex & index , const QMap<int, QVariant> & roles ) override
virtual void sort (int column , Qt::SortOrder order = Qt::AscendingOrder) override
virtual Qt::DropActions supportedDropActions () const override

信号

void itemChanged (QStandardItem * item )

详细描述

QStandardItemModel can be used as a repository for standard Qt data types. It is one of the 模型/视图类 且属于 Qt 的 模型/视图 框架。

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 QFileSystemModel 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 () 和 setColumnCount () to alter the dimensions of the model. To insert items, use insertRow () 或 insertColumn (), and to remove items, use removeRow () 或 removeColumn ().

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

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

调用 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 < model.rowCount(); ++row) {
    for (int column = 0; column < model.columnCount(); ++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 提供 QModelIndex -based signals and functions, you need a way to obtain the QStandardItem that corresponds to a given QModelIndex , and vice versa. itemFromIndex () 和 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, &QTreeView::clicked,
        this, &MyWidget::clicked);
					

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.

另请参阅 QStandardItem , 模型/视图编程 , QAbstractItemModel , Simple Tree Model example ,和 项视图方便类 .

特性文档编制

[bindable] sortRole : int

注意: 此特性支持 QProperty 绑定。

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

默认值为 Qt::DisplayRole .

另请参阅 sort () 和 QStandardItem::sortChildren ().

成员函数文档编制

[explicit] QStandardItemModel:: QStandardItemModel ( QObject * parent = nullptr)

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 .

[virtual noexcept] QStandardItemModel:: ~QStandardItemModel ()

Destructs the model. The model destroys all its items.

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

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

另请参阅 insertColumn () 和 appendRow ().

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

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

另请参阅 insertRow () 和 appendColumn ().

void QStandardItemModel:: appendRow ( QStandardItem * 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 .

void QStandardItemModel:: clear ()

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

另请参阅 removeColumns () 和 removeRows ().

[override virtual] bool QStandardItemModel:: clearItemData (const QModelIndex & index )

重实现: QAbstractItemModel::clearItemData (const QModelIndex &index).

[override virtual] int QStandardItemModel:: columnCount (const QModelIndex & parent = QModelIndex()) const

重实现: QAbstractItemModel::columnCount(const QModelIndex &parent) const .

另请参阅 setColumnCount ().

[override virtual] QVariant QStandardItemModel:: data (const QModelIndex & index , int role = Qt::DisplayRole) const

重实现: QAbstractItemModel::data(const QModelIndex &index, int role) const .

另请参阅 setData ().

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

重实现: QAbstractItemModel::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

返回的项列表匹配给定 text ,使用给定 flags ,在给定 column .

[override virtual] Qt::ItemFlags QStandardItemModel:: flags (const QModelIndex & index ) const

重实现: QAbstractItemModel::flags(const QModelIndex &index) const .

[override virtual] bool QStandardItemModel:: hasChildren (const QModelIndex & parent = QModelIndex()) const

重实现: QAbstractItemModel::hasChildren(const QModelIndex &parent) const .

[override virtual] QVariant QStandardItemModel:: headerData ( int section , Qt::Orientation orientation , int role = Qt::DisplayRole) const

重实现: QAbstractItemModel::headerData(int section, Qt::Orientation orientation, int role) const .

另请参阅 setHeaderData ().

QStandardItem *QStandardItemModel:: horizontalHeaderItem ( int column ) const

Returns the horizontal header item for column 若有设置;否则返回 nullptr .

另请参阅 setHorizontalHeaderItem () 和 verticalHeaderItem ().

[override virtual] QModelIndex QStandardItemModel:: index ( int row , int column , const QModelIndex & parent = QModelIndex()) const

重实现: QAbstractItemModel::index(int row, int column, const QModelIndex &parent) const .

QModelIndex QStandardItemModel:: indexFromItem (const QStandardItem * item ) const

返回 QModelIndex 关联给定 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.

另请参阅 itemFromIndex () 和 QStandardItem::index ().

void QStandardItemModel:: insertColumn ( int column , const QList < QStandardItem *> & )

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

另请参阅 takeColumn (), appendColumn (),和 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 指定。返回 true if the column is inserted; otherwise returns false .

另请参阅 insertColumns (), insertRow (),和 removeColumn ().

[override virtual] bool QStandardItemModel:: insertColumns ( int column , int count , const QModelIndex & parent = QModelIndex())

重实现: QAbstractItemModel::insertColumns (int column, int count, const QModelIndex &parent).

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

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

另请参阅 takeRow (), appendRow (),和 insertColumn ().

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

这是重载函数。

Inserts a row at row 包含 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:: insertRow ( int row , const QModelIndex & parent = QModelIndex())

Inserts a single row before the given row in the child items of the parent 指定。返回 true if the row is inserted; otherwise returns false .

另请参阅 insertRows (), insertColumn (),和 removeRow ().

[override virtual] bool QStandardItemModel:: insertRows ( int row , int count , const QModelIndex & parent = QModelIndex())

重实现: QAbstractItemModel::insertRows (int row, int count, const QModelIndex &parent).

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.

注意: 调用 index () on the QStandardItem object retrieved from this function is not valid.

QStandardItem *QStandardItemModel:: item ( int row , int column = 0) const

返回项为给定 row and column 若有设置;否则返回 nullptr .

另请参阅 setItem (), takeItem (),和 itemFromIndex ().

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

此信号被发射每当数据对于 item 已改变。

[override virtual] QMap < int , QVariant > QStandardItemModel:: itemData (const QModelIndex & index ) const

重实现: QAbstractItemModel::itemData(const QModelIndex &index) const .

另请参阅 setItemData ().

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

返回指针指向 QStandardItem 关联给定 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.

index is an invalid index, this function returns nullptr .

另请参阅 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 ()).

另请参阅 setItemPrototype ().

[override virtual] QMimeData *QStandardItemModel:: mimeData (const QModelIndexList & indexes ) const

重实现: QAbstractItemModel::mimeData(const QModelIndexList &indexes) const .

[override virtual] QStringList QStandardItemModel:: mimeTypes () const

重实现: QAbstractItemModel::mimeTypes() const .

[override virtual] void QStandardItemModel:: multiData (const QModelIndex & index , QModelRoleDataSpan roleDataSpan ) const

重实现: QAbstractItemModel::multiData(const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const .

[override virtual] QModelIndex QStandardItemModel:: parent (const QModelIndex & child ) const

重实现: QAbstractItemModel::parent(const QModelIndex &index) const .

[override virtual] bool QStandardItemModel:: removeColumns ( int column , int count , const QModelIndex & parent = QModelIndex())

重实现: QAbstractItemModel::removeColumns (int column, int count, const QModelIndex &parent).

[override virtual] bool QStandardItemModel:: removeRows ( int row , int count , const QModelIndex & parent = QModelIndex())

重实现: QAbstractItemModel::removeRows (int row, int count, const QModelIndex &parent).

[override virtual] QHash < int , QByteArray > QStandardItemModel:: roleNames () const

重实现: QAbstractItemModel::roleNames() const .

reimp

[override virtual] int QStandardItemModel:: rowCount (const QModelIndex & parent = QModelIndex()) const

重实现: QAbstractItemModel::rowCount(const QModelIndex &parent) const .

另请参阅 setRowCount ().

void QStandardItemModel:: setColumnCount ( int columns )

Sets the number of columns in this model to columns 。若这小于 columnCount (),不想要列中的数据被丢弃。

另请参阅 columnCount () 和 setRowCount ().

[override virtual] bool QStandardItemModel:: setData (const QModelIndex & index , const QVariant & value , int role = Qt::EditRole)

重实现: QAbstractItemModel::setData (const QModelIndex &index, const QVariant &value, int role).

另请参阅 data ().

[override virtual] bool QStandardItemModel:: setHeaderData ( int section , Qt::Orientation orientation , const QVariant & value , int role = Qt::EditRole)

重实现: QAbstractItemModel::setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role).

另请参阅 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.

另请参阅 horizontalHeaderItem (), setHorizontalHeaderLabels (),和 setVerticalHeaderItem ().

void QStandardItemModel:: setHorizontalHeaderLabels (const QStringList & labels )

设置水平 Header (头部) 标签使用 labels . If necessary, the column count is increased to the size of labels .

另请参阅 setHorizontalHeaderItem ().

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

设置项为给定 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.

另请参阅 item ().

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

这是重载函数。

[override virtual] bool QStandardItemModel:: setItemData (const QModelIndex & index , const QMap < int , QVariant > & roles )

重实现: QAbstractItemModel::setItemData (const QModelIndex &index, const QMap<int, QVariant> &roles).

另请参阅 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.

另请参阅 itemPrototype () 和 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 。若这小于 rowCount (),丢弃不想要行中的数据。

另请参阅 rowCount () 和 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.

另请参阅 verticalHeaderItem (), setVerticalHeaderLabels (),和 setHorizontalHeaderItem ().

void QStandardItemModel:: setVerticalHeaderLabels (const QStringList & labels )

设置垂直 Header (头部) 标签使用 labels . If necessary, the row count is increased to the size of labels .

另请参阅 setVerticalHeaderItem ().

[override virtual] void QStandardItemModel:: sort ( int column , Qt::SortOrder order = Qt::AscendingOrder)

重实现: QAbstractItemModel::sort (int column, Qt::SortOrder order).

[override virtual] Qt::DropActions QStandardItemModel:: supportedDropActions () const

重实现: QAbstractItemModel::supportedDropActions() const .

QStandardItemModel supports both copy and move.

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

移除给定 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 nullptr .

另请参阅 takeRow ().

QStandardItem *QStandardItemModel:: takeHorizontalHeaderItem ( int column )

移除水平 Header (头部) 项在 column from the header without deleting it, and returns a pointer to the item. The model releases ownership of the item.

另请参阅 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.

另请参阅 item (), takeRow (),和 takeColumn ().

QList < QStandardItem *> QStandardItemModel:: takeRow ( int row )

移除给定 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 nullptr .

另请参阅 takeColumn ().

QStandardItem *QStandardItemModel:: takeVerticalHeaderItem ( int row )

移除垂直 Header (头部) 项在 row from the header without deleting it, and returns a pointer to the item. The model releases ownership of the item.

另请参阅 verticalHeaderItem () 和 takeHorizontalHeaderItem ().

QStandardItem *QStandardItemModel:: verticalHeaderItem ( int row ) const

返回垂直 Header (头部) 项为行 row 若有设置;否则返回 nullptr .

另请参阅 setVerticalHeaderItem () 和 horizontalHeaderItem ().