Qt Model/View 学习笔记

Qt Model/View 学习笔记

最近在看Qt的Model/View Framework，在网上搜了搜，好像中文的除了几篇翻译没有什么有价值的文章。E文的除了Qt的官方介绍，其它文章也很少。看到一个老外在blog中写道Model/View是他认为Qt中最不好的一部分了。真的是这样吗？为了回馈开源社区，我写了这篇blog，写的是我认为比较有价值的东东。题目起得是解析，但也没有特别细节的介绍，点到为止，有兴趣的Tx可以继续讨论。我所看的资料有《C++ GUI Programming with Qt 4, Second Edition》、Qt官网和Qt源代码。
      在UI中，最常用的就是list/grid/tree了（在Qt中，grid被称为table）。尤其是做那些数据库相关的程序，可能每个界面都要用到list或grid。在Qt中，它们被归为item view class。有两种实现，一种叫item based，这些类名以widget结尾，如QListWidget等。另一种叫model based，这些类以view结尾，如QListView等。
      item based widget使用起来很简单，与MFC中的CListCtrl/CTreeCtrl等差不多。这些类既是数据容器（data container），又负责显示（presentation），还要处理与用户的交互（user action）。但使用这些类的缺点就是在处理大量数据显示时显得力不从心。我记得使用CListCtrl的report mode显示超过5万条记录时需要等待很长时间。因为它要把所有的数据都拷贝进来，再显示，比如这个list一次只能显示50条记录，但它把剩下的49950条也拷贝进了内存，并为每条记录的显示都加上格式等额外的信息。我想这种实现对于专业的软件来说是无法接受的。那么怎么提高它们的性能呢？有些人想出了virtual list/grid。它们显示之前并不需要把所有的数据都装进来，如有5万条记录，刚开始时它显示前50条，显示哪条时去取哪条。也就是说后49950条它不管，当用户移动滚动条或上下键改变显示内容时，它会根据一系列参数计算出目前需要显示哪几条。如1000-1050条，那么再去取这几条数据显示。由于实现起来有一定的难度，所以很多MFC实现的virtual list/grid显示出来都是“素颜”的（能快速显示出来已经不错了）。当然，coding无止境，这种取数据的方式我们称为delayed fetch，如果实现不好的化，当电脑速度慢且用户急速拖滚动条时也有可能出现白屏、拖尾、模糊等情况。所以还可以做prefetch和caching来尽力避免这些情况。好了，这里铺垫的已经够多了，下面我们直奔主题。
      model based view就是我们今天要重点“解析”的。对应的UI类有QListView/QTreeView/QTableView。那么这些view与上面的widget有什么区别呢？名字就是最大的区别。widget本来就是指小东东，而view可是很“大气”的视图哦。那么这些view大哥是怎么显示的呢？下面就说说我不愿多说但又不得不说的一个设计模式：MVC (Model/View/Controller)，model代表数据(data set)，view代表显示(presentation)，controller处理与用户交互(user action)。MVC模式源自smalltalk，现在好像被用的很多了。它的作用其实是把上面介绍的类似CListCtrl这样的类解放出来，因为它们要干很多事情，太累了。还有就是对于有些程序员来说，实现一个功能复杂的类可能会力不从心。分成3个类每个类解决不同的问题可能更好实现。从软件工程的角度上讲，这种方式的decoupling可以降低系统风险。好了，关于MVC，大家想了解更多的话可以继续在网上搜索。
      模式是MVC，那么Qt是怎么实现的呢？我打开了Qt的官网介绍（http://qt.nokia.com/doc/4.6/model-view-programming.html）。我晕，看到了几十个类，而且很多都有继承关系。很容易让人迷失啊。不过不要紧，经过2天的学习，我对它们做了总结，见下图。Tx们可以从我这幅图开始，抓住该framework的主线，免得迷失在茫茫泪（类）海:-)

一般来说，Model里面并没有真正存储数据（数据少的话也可以直接存储在Model里），它的数据是从真正的“肉(raw)”里取得，如一个disk file，或database的query result set等等。那么这个model究竟是干什么用的呢？说白了吧，它就是负责将“肉”数据获取并提供给view，然后将view所做的对“肉”数据的修改更新至真正的“肉”中。所以，读写文件、操作数据库、网络通讯等一系列与数据打交道的工作就在model中做了。有的时候“肉”可能真的很肥，所以model还有一项重要的工作就是把这些“肉”编号。这样就出现了Model Index这个非常重要的类。一般来说，它使用一个2维的编号（row/colum）来对“肉”编号。但对于tree这种有层次结构的数据来说，又加上一个parent index作为第3个编号。即一个父亲下面的叶子也是从0，0开始编号，获取model index的时候用递归来实现。OK，现在model已经有了一堆编好号码的“肉”了，谁来买啊？“肉”便宜了。。。。。。
      View适时出现，注意，很多view可以同时来买同一块“肉”。（汗，不开玩笑了，这篇blog快水了）。当view需要显示某些数据时，它们通过model index从model中获取数据（调用model的data函数，当model的data变化时，它也会自动发dataChanged signal给所有的view以便它们更新）。当然，在view中也可以调用model的setData函数来设定某个model index所对应的数据。这里要说明一下model中的数据，用QVarient来承载，可以是所有Qt支持的类型，比较贴心的是，数据可以分成多个角色(role)，例如Qt::DisplayRole专用于显示，Qt::BackgroundRole用于显示背景色等等。所以在model中，你不光可以对“肉”进行编号，还可以对“肉”进行“深加工”，使它们更“好看”或是更“美味”。View组织这些数据并显示，但却没有做真正的显示工作，真正的工作留给了delegate。
      Delegate就是MVC中的C。view让它显示时它就在paint函数中显示。当然，你可以重载这个函数并实现你自己的显示。你还可以给一个view设定row delegate和colum delegate专用于row和colum。当用户触发了view的edit trigger时（如双击鼠标或回车），view开始in place edit (beginEditing)。Delegate会在合适的地方创建一个合适的widget(如line edit或combo box等)处理用户的输入，用户输入完成以后delegate获取用户的输入并返回。这些输入可以通过调用model的setData函数保存到真正的“肉”中。所以Delegate其实就是负责最终显示数据和处理用户交互的。
      既然由用户交互，最重要的肯定是用户的选择了。说一下selection model。View将用户选择的item index全部存入selection model中，显示的时候根据selection model的内容显示。另外，多个view可以共享同一个selection model，这样，当你选中其中的一个时，另一个view中的相应item也会被选中。

      最后总结一下，Smalltalk怎么实现的MVC我不清楚，但是Qt model/view framework对MVC的实现完全是基于C++的虚基类和虚函数特性。MVC各部分之间的联通除了应用signal/slot之外，就全是虚函数了。Tx们如果有兴趣的话，可以看看model/view framework源代码中那些QAbstract开头的类，它们定义了统一的接口虚函数后，派生类只需要重新实现这些函数即可。这里再重复一下学习这部分时Tx们应该关注的2条主线。
      无论什么view，作用都是把数据显示出来，那么第一条主线是数据怎样从数据源显示到view中。
      显示的数据可能被修改，所以第二条主线就是修改后的数据怎样再更新至数据源中。如果你能把这2幅sequence map画出来，相信你就已经完全明白了。

      我不知道Qt在这里的设计是不是做了太多的decoupling。反正灵活性是足够了（model/view/delegate都可以继承），但无法让程序员快速掌握。虽然Qt已经弱化了delegate并而且为view提供默认的delegate。但在做具体项目时，程序员大部分时候还是要根据具体情况重写派生类数的。这对于那些想快速做界面并显示的程序员来说，可能会难以接受。总之，这个轮子做的够精细，但一般在使用之前你还要自己拧点螺丝，上点油。

Models

所有的item models都基于QAbstractItemModel类，这个类定义了用于views和delegates访问数据的接口。
数据本身不必存储在model,数据可被置于一个数据结构或另外的类，文件，数据库，或别的程序组件中。
关于model的基本概念在Model Classes部分中描述。
QAbstractItemModel提供给数据一个接口，它非常灵活，基本满足views的需要，无论数据用以下任何样的形式
表现，如tables,lists,trees。然而，当你重新实现一个model时，如果它基于table或list形式的数据结构，最好从QAbstractListModel,QAbstractTableModel开始做起，因为它们提供了适当的常规功能的缺省实现。这些类可以被子类化以支持特殊的定制需求。子类化model的过程在Create New Model部分讨论

。这给我展示了使用model的最简单的方式。
model的创建与使用都在main()函数中完成：
 int main(int argc, char *argv[])
 {
     QApplication app(argc, argv);
     QSplitter *splitter = new QSplitter;

     QDirModel *model = new QDirModel;
    //从缺省目录创建数据
     QTreeView *tree = new QTreeView(splitter);
     tree->setModel(model);
     tree->setRootIndex(model->index(QDir::currentPath()));

     QListView *list = new QListView(splitter);
     list->setModel(model);
     list->setRootIndex(model->index(QDir::currentPath()));
     //配置一个view去显示model中的数据，只需要简单地调用setModel(),并把目录model作为参数传递
     //setRootIndex()告诉views显示哪个目录的信息，这需要提供一个model index,然后用这个
     //model index去model中去获取数据
     //index()这个函数是QDirModel特有的，通过把一个目录做为参数，得到了需要的model index
     //其他的代码只是窗口show出来,进入程序的事件循环就好了
      splitter->setWindowTitle("Two views onto the same directory model");
     splitter->show();
     return app.exec();
 }

Model类

基本概念
在model/view构架中，model为view和delegates使用数据提供了标准接口。在Qt中，标准接口QAbstractItemModel类中被定义。不管数据在底层以何种数据结构存储，QAabstractItemModel的子类会以层次结构的形式来表示数据，结构中包含了数据项表。我们按这种约定来访问model中的数据项，但这个约定不会对如何显示这些数据有任何限制。数据发生改变时，model通过信号槽机制来通知关联的

Model Indexes

为了使数据存储与数据访问分开，引入了model index的概念。通过model index，可以引用model中的数据项，Views和delegates都使用indexes来访问数据项，然后再显示出来。因此，只有model需要了解如何获取数据，被model管理的数据类型可以非常广泛地被定义。Model indexes包含一个指向创建它们的model的指针，这会在配合多个model工作时避免混乱。
QAbstractItemModel *model = index.model();

model indexes提供了对一项数据信息的临时引用，通过它可以访问或是修改model中的数据。既然model有时会重新组织内部的数据结构，这时model indexes便会失效，因此不应该保存临时的model indexes。假如需要一个对数据信息的长期的引用，那么应该创建一个persistent model index。这个引用会保持更新。临时的model indexes由QModelIndex提供，而具有持久能力的model indexes则由QPersistentModelIndex提供。在获取对应一个数据项的model index时，需要考虑有关于model的三个属性：行数，列数，父项的model index。

行与列
在最基本的形式中，一个model可作为一个简单的表来访问，每个数据项由行，列数来定位。这必不意味着
底层的数据用数组结构来存储。行和列的使用仅仅是一种约定，它允许组件之间相互通讯。可以通过指定
model中的行列数来获取任一项数据，可以得到与数据项一一对应的那个index。
QModelIndex index = model->index(row, column, ...);
Model为简单的，单级的数据结构如list与tables提供了接口，它们如上面代码所显示的那样，不再需要别的信息被提供。当我们在获取一个model index时，我们需要提供另外的信息。

父项
类似于表的接口在搭配使用table或list view时理想的，这种行列系统与view显示的方式是确切匹配的。
然则，像tree views这种结构需要model提供更为灵活的接口来访问数据项。每个数据项可能是别的项的
父项，上级的项可以获取下级项的列表。
当获取model中数据项的index时，我们必须指定关于数据项的父项的信息。在model外部，引用一个数据
项的唯一方法就是通过model index,因此需要在求取model index时指定父项的信息。
QModelIndex index = model->index(row, column, parent);

QModelIndex index = model->index(row, column, parent);

上图中，A项和C项作为model中顶层的兄弟项：
 QModelIndex indexA = model->index(0, 0, QModelIndex());
 QModelIndex indexC = model->index(2, 1, QModelIndex());
A有许多孩子，它的一个孩子B用以下代码获取：
QModelIndex indexB = model->index(1, 0, indexA);

项角色
model中的项可以作为各种角色来使用，这允许为不同的环境提供不同的数据。举例来说，Qt::DisplayRole被用于访问一个字符串，它作为文本会在view中显示。典型地，每个数据项都可以为许多不同的角色提供数据，标准的角色在Qt::ItemDataRole中定义。我们可以通过指定model index与角色来获取我们需要的数据：
QVariant value = model->data(index, role);

角色指出了从model中引用哪种类型的数据。views可以用不同的形式显示角色，因此为每个角色提供正确
的信息是非常重要的。通过为每个角色提供适当数据，model也为views和delegates提供了暗示，如何正确地
把这些数据项显给用户。不同的views可以自由地解析或忽略这些数据信息，对于特殊的场合，也可以定义
一些附加的角色。
概念总结：
1，Model indexes为views与delegages提供model中数据项定位的信息，它与底层的数据结构无关。
2，通过指定行，列数，父项的model index来引用数据项。
3,依照别的组件的要求，model indexes被model构建。
4，使用index()时，如果指定了有效的父项的model index,那么返回得到的model index对应于父项的某个孩子。
5，使用index()时，如果指定了无效的父项的model index,那么返回得到的model index对应于顶层项的某个孩子。
6, 角色对一个数据项包含的不同类型的数据给出了区分。

使用Model Indexes
QDirModel *model = new QDirModel;
     QModelIndex parentIndex = model->index(QDir::currentPath());
     int numRows = model->rowCount(parentIndex);
 for (int row = 0; row < numRows; ++row)
 {
         QModelIndex index = model->index(row, 0, parentIndex);
         tring text = model->data(index, Qt::DisplayRole).toString();
         // Display the text in a widget.

     }
以上的例子说明了从model中获取数据的基本原则：
1，model的尺寸可以从rowCount()与columnCount()中得出。这些函数通常都需要一个表示父项的model index。
2，model indexes用来从model中访问数据项，数据项用行，列，父项model index定位。
3, 为了访问model顶层项，可以使用QModelIndex()指定。
4, 数据项为不同的角色提供不同的数据。为了获取数据，除了model index之外，还要指定角色。

创建新的Models

介绍
model/view组件之间功能的分离，允许创建model利用现成的views。这也可以使用标准的功能 图形用户接口组件像QListView,QTableView和QTreeView来显示来自各种数据源的数据为。
QAbstractListModel类提供了非常灵活的接口，允许数据源以层次结构的形式来管理信息，也允许以某种
方式对数据进行插入、删除、修改和存储。它也提供了对拖拽操作的支持。
QAbstractListModel与QAbstractTableModel为简单的非层次结构的数据提供了接口，对于比较简单的list和table models来说，这是不错的一个开始点。

设计一个Model
当我们为存在的数据结构新建一个model时，首先要考虑的问题是应该选用哪种model来为这些数据提供接口。
假如数据结构可以用数据项的列表或表来表示，那么可以考虑子类化QAbstractListModel或QAbstractTableModel
,既然这些类已经合理地对许多功能提供缺省实现。
然而，假如底层的数据结构只能表示成具有层次结构的树型结构，那么必须得子类化QAbstractItemModel。
无论底层的数据结构采取何种形式，在特定的model中实现标准的QAbstractItemModel API总是一个不错的主意，这使得可以使用更自然的方式对底层的数据结构进行访问。这也使得用数据构建model 更为容易，其他
的model/view组件也可以使用标准的API与之进行交互。

一个只读model示例
这个示例实现了一个简单的，非层次结构的，只读的数据model,它基于QStringistModel类。它有一个QStringList作为它内部的数据源，只实现了一些必要的接口。为了简单化，它子类化了QAbstractListModel,这个基类提供了合理的缺省行为，对外提供了比QAbstractItemModel更为简单的接口。当我们实现一个model时，不要忘了QAbstractItemModel本身不存储任何数据，它仅仅提供了给views访问
数据的接口。
class StringListModel : public QAbstractListModel
 {
     Q_OBJECT

 public:
     StringListModel(const QStringList &strings, QObject *parent = 0)
         : QAbstractListModel(parent), stringList(strings) {}

     int rowCount(const QModelIndex &parent = QModelIndex()) const;
     QVariant data(const QModelIndex &index, int role) const;
     QVariant headerData(int section, Qt::Orientation orientation,
                         int role = Qt::DisplayRole) const;

 private:
     QStringList stringList;
 };
除了构造函数，我们仅需要实现两个函数：rowCount()返回model中的行数，data()返回与特定model index对应的数据项。具有良好行为的model也会实现headerData()，它返回tree和table views需要的，在标题中显示的数据。
因为这是一个非层次结构的model,我们不必考虑父子关系。假如model具有层次结构，我们也应该实现index()与parent()函数。

Model的尺寸
我们认为model中的行数与string list中的string数目一致：
int StringListModel::rowCount(const QModelIndex &parent) const
 {
     return stringList.count();
 }
在缺省情况下，从QAbstractListModel派生的model只具有一列，因此不需要实现columnCount()。

Model 标题与数据
 QVariant StringListModel::data(const QModelIndex &index, int role) const
 {
     if (!index.isValid())
         return QVariant();

     if (index.row() >= stringList.size())
         return QVariant();

     if (role == Qt::DisplayRole)
         return stringList.at(index.row());
     else
         return QVariant();
 }
QVariant StringListModel::headerData(int section, Qt::Orientation orientation,
                                      int role) const
 {
     if (role != Qt::DisplayRole)
         return QVariant();

     if (orientation == Qt::Horizontal)
         return QString("Column %1").arg(section);
     else
         return QString("Row %1").arg(section);
 }
一个数据项可能有多个角色，根据角色的不同输出不同的数据。上例中，model中的数据项只有一个角色 ，
DisplayRole,然而我们也可以重用提供给DisplayRole的数据，作为别的角色使用，如我们可以作为ToolTipRole来用。

可编辑的model
上面我们演示了一个只读的model,它只用于向用户显示，对于许多程序来说，可编辑的list model可能更有用。我们只需要给只读的model提供另外两个函数flags()与setData()的实现。下列函数声明被添加到类定义中：
     Qt::ItemFlags flags(const QModelIndex &index) const;
     bool setData(const QModelIndex &index, const QVariant &value,
                  int role = Qt::EditRole);

让model可编辑
delegate会在创建编辑器之前检查数据项是否是可编辑的。model必须得让delegate知道它的数据项是可
编辑的。这可以通过为每一个数据项返回一个正确的标记得到，在本例中，我们假设所有的数据项都是
可编辑可选择的：
Qt::ItemFlags StringListModel::flags(const QModelIndex &index) const
 {
     if (!index.isValid())
         return Qt::ItemIsEnabled;

     return QAbstractItemModel::flags(index) | Qt::ItemIsEditable;
 }
我们不必知道delegate执行怎样实际的编辑处理过程，我们只需提供给delegate一个方法，delegate会使用它对model中的数据进行设置。这个特殊的函数就是setData():
bool StringListModel::setData(const QModelIndex &index,
                               const QVariant &value, int role)
 {
     if (index.isValid() && role == Qt::EditRole) {

         stringList.replace(index.row(), value.toString());
         emit dataChanged(index, index);
         return true;
     }
     return false;
 }
当数据被设置后，model必须得让views知道一些数据发生了变化，这可通过发射一个dataChanged() 信号实现。
因为只有一个数据项发生了变化，因此在信号中说明的变化范围只限于一个model index。
插入，删除行
在model中改变行数与列数是可能的。当然在本列中，只考虑行的情况，我们只需要重新实现插入、删除
的函数就可以了，下面应在类定义中声明：
     bool insertRows(int position, int rows, const QModelIndex &index = QModelIndex());
     bool removeRows(int position, int rows, const QModelIndex &index = QModelIndex());
既然model中的每行对应于列表中的一个string,因此，insertRows()函数在string list  中指定位置插入一个空string,
父index通常用于决定model中行列的位置，本例中只有一个单独的顶级项，困此只需要在list中插入空string。
bool StringListModel::insertRows(int position, int rows, const QModelIndex &parent)
 {
     beginInsertRows(QModelIndex(), position, position+rows-1);

     for (int row = 0; row < rows; ++row) {
         stringList.insert(position, "");
     }

     endInsertRows();
     return true;
 }
beginInsertRows()通知其他组件行数将会改变。endInsertRows()对操作进行确认与通知。
返回true表示成功。
删除操作与插入操作类似：
bool StringListModel::removeRows(int position, int rows, const QModelIndex &parent)
 {
     beginRemoveRows(QModelIndex(), position, position+rows-1);

     for (int row = 0; row < rows; ++row) {
         stringList.removeAt(position);
     }

     endRemoveRows();
     return true;
 }

 

 原帖地址：http://blog.csdn.net/hahajing9/article/details/6090511