【Qt6】列表模型——抽象基类

列表模型（Item Model），老周没有翻译为“项目模型”，因为 Project 和 Item 都可以翻译为“项目”，容易出现歧义。干脆叫列表模型。这个模型也确实是为数据列表准备的，它以 MVC 的概念为基础，在原始数据和用户界面视图之间搭建桥梁，使两者可以传递数据（提取、修改）。
Qt 里面使用列表控制比较复杂，需要先创建模型（Model）。当然，也有像 QListWidget 类这样已经封装好，开箱即食的，这个后面再扯，现在咱们的重点是弄清楚 Item Model 是啥玩意儿。
这里所说的 Item Model 并不是真正的数据，应该说算是个控制器。当用户界面要显示数据时，模型负责从原始数据那里提取值，再把值传到界面上呈现；如果用户界面要修改数据，通过输入框（QLineEdit等）输入/修改内容，然后传给模型，模型负责修改原始数据。这么看来，视图和原始数据不是直接通信的，模型就成了“中间商”。这个“中间商”可以不赚差价（按原始数据的样子呈现），也可能赚差价（把原始数据加工一下再让你看）。
列表模型有一个抽象基类，叫 QAbstractItemModel；对应地，视图组件也有一个抽象基类，叫 QAbstractItemView。另外，在模型和视图之间还有一个“代理人”，抽象基类叫 QAbstractItemDelegate，它干吗的呢？这是专业经纪人，负责门面工作。比如，在视图组件里呈现数据时用什么字体，什么颜色来绘制文本，用什么方式从模型提取数据等；在编辑数据时，有什么控件来输入文本。以及在编辑结束后，输入的内容怎么传给模型等。日常使用时咱们用到 QAbstractItemDelegate 不多，除非你自己想为数据项绘制 UI，或用自定义的编辑组件。如果只是改改外观什么的，还不如用 QSS 方便。
行了，不扯太远了，咱们只要知道这几个基类之间的关系就行了。咱们的重点还是放在 QAbstractItemModel 类上面。
QAbstractItemModel 有几个纯虚函数是必须在派生类中重写的：
1、index 方法，声明如下：

1. virtual QModelIndex index(
2.              int row,
3.              int column,
4.              const QModelIndex &parent = QModelIndex()) const = 0;

复制代码

列表模型中的索引，专门用一个叫 QModelIndex 的类表示。index 方法是根据传入的参数，返回 QModelIndex 对象。之所以要用 QModelIndex 类来表示列表项的索引，是因为它是由几个值组成的：

1. a、行号；
2. b、列号；
3. c、父索引。

复制代码

Qt 中的列表模型用的是二维表结构，即由行和列组成，就像这样：

问：D在哪里？
答：row = 1，column = 0。
每个项又可以包含父级节点和子级节点，但上面的二维表只有一层，没有父级，所以它的 parent = QModelIndex()。用默认构造函数创建的 QModelIndex 表示无效索引，即行号是 -1，列号是 -1，无父无子。
综上所言，D 的索引就是：row = 1，col = 0，parent = QModelIndex()。
这个模型真正可怕的地方在于，每个索引都有父、子级。于是你可以构想下面这么恐怖的列表：

Root是一个无效的索引，可以认为是顶层的”父级“。A、B、C、D、E、F 的父级都是 Root，行列号由0开始编排，A在第一行第一列，所以 row=0，col=0，parent=Root。E有子节点，即 M、N、O、P，然后MNOP的行号和列号也要从 0 重新计算，即 N 的索引是 row=0, col=1, parent=E。最后，Q 这厮又有子节点，是一个只有一行的列表：R、S、T。于是，RST的行列号也重新计算。即 R 的索引是 row=0, col=0, parent=Q。
不过，实际使用时，一般不需要构建这么神的数据结构，而且这玩意放到用户界面上还不知道怎么显示好呢。毕竟，咱们在界面上常见的视图也就以下三种：
1）、多行，只有一列，这就相当于像数组这样的数据了。用 QListView 组件来呈现；
2）、一级二维表，由行、列组成，由 QTableView 组件呈现；
3）、多级节点，典型的就是 QTreeView 组件了。Qt 的 TreeView 比 .NET 的控件多了一个特点——可以在显示多级节点的同时显示表格。但要注意的是，只有首列才支持父子节点。所以，对于 QTreeView 视图，构建这样的数据也足够了：

2、parent 方法。它的声明如下：

1. virtual QModelIndex parent(const QModelIndex &child) const = 0;

复制代码

返回 child 节点的父级节点，对于只有一层的列表，返回 QModelIndex() 即可。
3、rowCount 方法。声明如下：

1. virtual int rowCount(const QModelIndex &parent = QModelIndex()) const = 0;

复制代码

返回原始数据有总共有多少行。
4、columnCount 方法。它的声明如下：

1. virtual int columnCount(const QModelIndex &parent = QModelIndex()) const = 0;

复制代码

该方法返回原始数据有多少列，如果是数组之类的，返回 1。
5、data 方法。声明如下：

1. virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const = 0;

复制代码

这是个重要的成员，它要根据 index 参数指定的索引，返回数据项的值。这里要说一下叫”数据角色“的概念。说通俗不易懂一点就是返回的值的用途。比如，role 参数的默认值指定了 DisplayRole，意思就是你返回的值是要显示在用户界面上的，就是你想让用户看到的文本。Qt::ItemDataRole 枚举定义了一系列数据角色。

1. enum ItemDataRole {
2.     DisplayRole = 0,               // 显示在界面的内容
3.     DecorationRole = 1,          // 和文本一起显示的图标，类型一般是QIcon
4.     EditRole = 2,                    // 当编辑数据时，返回给用户看的值
5.     ToolTipRole = 3,                // 显示在工具提示中的文本
6.     StatusTipRole = 4,            // 显示在状态栏中的文本
7.     WhatsThisRole = 5,           // 帮助信息，显示在”这是啥？“提示中
8.     // Metadata
9.     FontRole = 6,                    // 呈现数据时用啥字体
10.     TextAlignmentRole = 7,      // 文本的对齐方式
11.     BackgroundRole = 8,          // 返回画刷对象，用来绘制列表项的背景
12.     ForegroundRole = 9,           // 文本的颜色
13.     CheckStateRole = 10,         // 如果界面上显示了 checkbox，那么返回checkbox的状态（选中？未选中？未知？）
14.     // Accessibility
15.     AccessibleTextRole = 11,     // 简练的辅助信息。用于像”讲述人“这些辅助工具
16.     AccessibleDescriptionRole = 12,    //详细辅助信息，用于像”讲述人“类似的辅助工具
17.     // More general purpose
18.     SizeHintRole = 13,               // 返回该列表项希望显示的大小（宽多少，高多少）
19.     InitialSortOrderRole = 14,    // 数据第一次呈现时用的排序方式（升序？降序？）
20.     // 下面五个不知道是什么鬼
21.     <em>// Internal UiLib roles. Start worrying whe
22. high.
23.     DisplayPropertyRole = 27,
24.     DecorationPropertyRole = 28,
25.     ToolTipPropertyRole = 29,
26.     StatusTipPropertyRole = 30,
27.     WhatsThisPropertyRole = 31,
28. </em>    // Reserved，保留用来给开发者自定义角色。自定义角色从这个数值开始
29.     UserRole = 0x0100
30. };

复制代码

重写 data 方法实现了数据的只读模式，若数据支持编辑，必须重写 setData 方法，把内容写入原始数据。
如果要实现添加、删除数据项，还要重写以下方法：
6、insertRows：在行号为 row 处连续插入 count 行数据。

1. virtual bool insertRows(int row, int count, const QModelIndex &parent = QModelIndex());

复制代码

7、removeRows：从行号为 row 处开始，连续删除 count 行。

1. virtual bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex());

复制代码

8、insertColumns：从列号为 column 处起，连接插入 count 列。

1. virtual bool insertColumns(int column, int count, const QModelIndex &parent = QModelIndex());

复制代码

9、removeColumns：从列号为 column 处开始，连续删除 count 列。

1. virtual bool removeColumns(int column, int count, const QModelIndex &parent = QModelIndex());

复制代码

 ===============================================================
下面咱们做一个简单的模型练练手。该模型的原始数据是一个整数列表（QList）。先实现只读功能，即需要重写 parent、index、rowCount、columnCount 和 data 方法。头文件的声明如下：

1. #ifndef MODELS_H
2. #define MODELS_H
4. #include <QAbstractItemModel>
5. #include <QObject>
6. #include <QList>
8. class MyItemModel: public QAbstractItemModel
9. {
10.     Q_OBJECT
12. public:
13.     // 下面两个是构造函数
14.     explicit MyItemModel(QObject* parent = nullptr);
15.     explicit MyItemModel(const QList<int> &list, QObject* parent = nullptr);
16.    
17.     // 返回父级
18.     QModelIndex parent(const QModelIndex & child) const override;
19.     // 返回索引
20.     QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
21.     // 返回行数和列数
22.     int rowCount(const QModelIndex &parent = QModelIndex()) const override;
23.     int columnCount(const QModelIndex &parent = QModelIndex()) const override;
24.     // 获取数据
25.     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
27.     // 下面这两个方法用来获取或设置数据源
28.     QList<int> intList() const;
29.     void setIntList(const QList<int> &list);
31. private:
32.     QList<int> m_list;  // 私有的
33. };
35. #endif

复制代码

私有字段 m_list 用于引用原始数据，可以通过构造函数的 list 参数设置，也可以通过 setIntList 方法设置。
下面代码实现构造函数，主要是初始化私有成员。

1. MyItemModel::MyItemModel(QObject *parent)
2.     : m_list(QList<int>()), QAbstractItemModel(parent)
3. {
4. }
6. MyItemModel::MyItemModel(const QList<int> &list, QObject *parent)
7.     : QAbstractItemModel(parent), m_list(list)
8. {
9. }

复制代码

下面代码实现 parent 方法。由于是整数列表，数据只有一层，所以直接返回 QModelIndex() 即可。

1. QModelIndex MyItemModel::parent(const QModelIndex &child) const
2. {
3.     // 简单的列表不需要父子层次
4.     // 使用无参构造函数表示无效索引
5.     return QModelIndex();
6. }

复制代码

 
接着是实现返回数据列表的行数和列数。

1. int MyItemModel::rowCount(const QModelIndex &parent) const
2. {
3.     // 一样的道理，不能有父级数据
4.     if (parent.isValid() ){
5.         return 0;
6.     }
7.     // 返回QList中元素个数，每个元素代表一行
8.     return m_list.size();
9. }
11. int MyItemModel::columnCount(const QModelIndex &parent) const
12. {
13.     if(parent.isValid())
14.         return 0;
15.     // 咱们这个模型永远只有一列
16.     return 1;
17. }

复制代码

 
实现 index 方法，为数据项创建索引。

1. QModelIndex MyItemModel::index(int row, int column, const QModelIndex &parent) const
2. {
3.     // 因为此列表不存在爷爷/孙子/父/子关系
4.     // 所以如果索引是有效的，说明它不对
5.     // 咱们这个列表是没有父级的
6.     if(parent.isValid())
7.         return QModelIndex();       // 有效索引不是咱们想要的，返回无效索引
8.     // 如果索引无效，说明是顶层数据，是咱们想要的
9.     return createIndex(row, column);
10. }

复制代码

QModelIndex 无法直接访问其成员，要产生索引请调用 createIndex 方法。
实现 data 方法。返回数据，这里咱们实现了正常显示的文本和作为工具提示用的文本。

1. QVariant MyItemModel::data(const QModelIndex &index, int role) const
2. {
3.     // 注意 role 这个参数，返回前必须判断
4.     if(role == Qt::DisplayRole)
5.     {
6.         // DisplayRole 说明获取的数据是用在界面呈现上的
7.         // 咱们只考虑行号，列号嘛，反正只有一列
8.         int idx = index.row();
9.         return m_list.at(idx);
10.     }
11.     // 可以提供工具提示
12.     if(role == Qt::ToolTipRole)
13.     {
14.         int i = index.row();
15.         int val = m_list.at(i);
16.         return QString("这是整数值：%1").arg(val);
17.     }
18.     // 如果是其他role，就返回一个默认的QVariant给它
19.     return QVariant();
20. }

复制代码

其他未用到的数据角色返回空的 QVariant 就可以。data 方法返回的值，是对应着二维表中某个单元格的，所以，你希望在那个单元格中显示什么就返回什么。
最后实现的两个方法是用来获取或设置数据源的（即原始数据）。

1. QList<int> MyItemModel::intList() const
2. {
3.     return m_list;
4. }
6. void MyItemModel::setIntList(const QList<int> &list)
7. {
8.     m_list = list;
9. }

复制代码

 
至此，一个简单的模型就有了，当然，没有实现 setData 方法，它只能读数据，不支持编辑。现在我们可以拿来用了。
[code]int main(int argc, char** argv){    QApplication app(argc, argv);    // 创建视图实例    QListView lv;    lv.setWindowTitle("简单模型");    // 准备点数据    QList theList;    theList