QStandardItemModel角色控制及QTreeView加入不同的右键菜单

1.概述

QTreeView最长用的一个功能就是作为导航栏，像vs里的项目结构树，word的文档结构图，资源管理器的文档结构，等等都是利用树形结构组织的，在前面已经讲述了Qt中使用标准化项目模型QStandardItemModel对树形控件节点的操作。但有时候，光有节点显示还是不够的，还须要和用户进行交互，如右键点击不同条目会出现不同菜单，这时就须要知道各个节点相应的功能。

在MFC里，树形控件CTreeCtrl是通过SetItemData函数来对节点设置一个指针的值，这个值能够是个指针或者DWORD值，能够设置一个自己定义的标志，或者自己定义类型的指针。Qt的TreeView比MFC的CTreeCtrl封装的更好，其功能更为强大，以至于它能够给每一个节点设定很许多的值（仅仅要你内存足够）。

QTreeView仅仅负责显示渲染，数据都是Model来负责管理，Model和Item构成整个结构，详细可见第一篇。

在有了节点后我想对某些进行标记，须要用到setData函数。Qt中的mvc结构很复杂，setData函数在model和item中都有，功能都一样，就QStandardItemModel来说，setData函数的定义为：

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

在QStandardItem中setData定义为

virtual void    setData(const QVariant & value, int role = Qt::UserRole + 1);

通常使用的是QStandardItem的版本号。

以下具体说说这个函数。

2.使用Role对QStandardItem设定值

setData函数就是给这个item设置一个QVariant的值，可是，这个函数有两个參数，第一个QVariant自然是须要设置的值，还有一个是一个int型数据，Qt中把这个称为role角色，所谓角色，是指设定进item的这个Qvariant所扮演的角色，实际就是对设定值的标定，由于item能够设置很多值，这就须要一个用以区分的标志，这个区分标志就叫角色。

Qt已经把经经常使用到的角色内容定义好了，我们能够自定义角色标志，但不能和定义好的那些冲突，否则会不起作用。如要显示文字用Qt::DisplayRole，要告诉QTreeView须要改变背景颜色，就标定Qt::BackgroundRole，要改变字体就标定Qt::FontRole等等。从中能够看出，role就是一个标示，用来标定存放在item里面的值详细用于什么功能，系统默认的role见Qt::ItemDataRole枚举。

Qt默认role事实上就是一组宏（原理和MFC的消息类型一模一样），那怎么知道能不和Qt预先定义好的不起冲突呢，同MFC自己定义消息一样，Qt要自己定义角色，就从Qt::UserRole開始往上加。

比如，我做个类似于vs或Qt Creator的项目结构树，结构树里很多节点的功能不一样有节点代表目录，有的节点是cpp文件，有的节点是.h文件，假设要知道用户点击的当前节点是什么内容，就须要给节点一些额外的标志。

以下用个样例来演示。

此样例用来复现Qt Creator的项目结构树

项目结构树节点主要有“根节点”，“目录节点”，“条目节点”这三种，于是能够定义一个role来对这三种情况做判别。

另外，“目录节点”又分为“cpp目录”，“h目录”等节点，这个也能够使用一个role作为区分。

“条目节点”有可能也会有h文件，cpp文件，或者其它文件之分，这里也能够使用一个role进行区分。

于是，这里就建立三个自己定义role

#define ROLE_MARK Qt::UserRole + 1

#define ROLE_MARK_FOLDER Qt::UserRole + 2

#define ROLE_MARK_ITEM Qt::UserRole + 3

这三个role中，ROLE_MARK用于区分 “根节点”，“目录节点”，“条目节点”这三种情况。

ROLE_MARK_FOLDER用于区分“cpp目录”，“h目录”等情况。

ROLE_MARK_ITEM用于区分“条目节点”有可能出现的种类。

当然，对于这样的比較少的区分，用一个int型变量进行位的或与操作来推断也是能够的，但这里主要为了演示role的用法。

以下在为三种role定义值，定义例如以下

//相应ROLE_MARK

#define MARK_PROJECT 1 //这是总项目标记

#define MARK_FOLDER 2 //这是目录标记

#define MARK_ITEM 3 //条目标记

 

//相应ROLE_MARK_FOLDER，标记folder种类

#define MARK_FOLDER_H 1 //头文件目录标记

#define MARK_FOLDER_CPP 2 //cpp文件目录标记

 

//相应ROLE_MARK_ITEM标记item种类

#define MARK_ITEM_H 1 //头文件条目

#define MARK_ITEM_CPP 2 //cpp文件条目

前期做完，以下開始实现程序

简单界面例如以下：

加上图标文件

树形视图的初始化：

void Widget::init()
{
    QStandardItemModel* model = new QStandardItemModel(ui->treeView);
    model->setHorizontalHeaderLabels(QStringList()<<QStringLiteral("项目"));
    //加入项目目录
    QStandardItem* root = new QStandardItem(QIcon(":/icon/icon/p.png"),QStringLiteral("项目"));
    root->setData(MARK_PROJECT,ROLE_MARK);//首先它是项目中目录
    root->setData(MARK_FOLDER,ROLE_MARK_FOLDER);//其次它属于目录
    model->appendRow(root);
    QStandardItem* folder = new QStandardItem(QIcon(":/icon/icon/h-f.png"),QStringLiteral("头文件"));
    folder->setData(MARK_FOLDER,ROLE_MARK);//首先它是目录
    folder->setData(MARK_FOLDER_H,ROLE_MARK_FOLDER);//其次它属于头文件目录
    root->appendRow(folder);
    folder = new QStandardItem(QIcon(":/icon/icon/c-f.png"),QStringLiteral("源文件"));
    folder->setData(MARK_FOLDER,ROLE_MARK);//首先它是目录
    folder->setData(MARK_FOLDER_CPP,ROLE_MARK_FOLDER);//其次它属于源文件目录
    root->appendRow(folder);
    ui->treeView->setModel(model);
}

在加入条目时，给一些特别的条目设定标志，如头文件目录，由于它是目录，因此首先给它设定角色为ROLE_MARK的值MARK_FOLDER，其次它在目录中属于头文件目录，因此再给他设定角色为ROLE_MARK_FOLDER的值MARK_FOLDER_H。这时，这个条目就有两个额外的值用于特殊的推断。

上面代码执行界面例如以下图所看到的：

当加入头文件时，须要在头文件目录加入条目，button“加入h”就是用来模拟加入头文件的过程。

加入头文件时，首先须要找到“头文件”这个目录相应的QStandardItem*，实现如函数getHeaderFolder，此函数实现须要先找到“项目”这个顶层目录，详细实现例如以下：

 

QStandardItemModel* Widget::getTreeModel()
{
    return qobject_cast<QStandardItemModel*>(ui->treeView->model());
}

QList<QStandardItem*> Widget::getRoots()
{
    QList<QStandardItem*> roots;
    QStandardItemModel* model = getTreeModel();
    for(int i=0;i < model->rowCount();++i)
    {
        roots.append(model->item(i));
    }
    return roots;
}

QStandardItem* Widget::getProjectFolder()
{
    QList<QStandardItem*> roots = getRoots();
    for(auto i=roots.begin();i!=roots.end();++i){
        if((*i)->data(ROLE_MARK) == MARK_PROJECT){
            return (*i);
        }
    }
    return nullptr;
}

QStandardItem* Widget::getHeaderFolder()
{
    QStandardItem* project = getProjectFolder();
    if(nullptr == project)
        return nullptr;
    for(int i=0;i < project->rowCount();++i)
    {
        QStandardItem* child = project->child(i);
        QVariant var = child->data(ROLE_MARK_FOLDER);
        if(!var.isValid())
            continue;//说明不是ROLE_MARK_FOLDER，有可能是一些项目，相应项目结构树那个xxx.pro就是一个非目录条目
        if(MARK_FOLDER_H == var.value<int>())
            return child;
    }
    return nullptr;
}

QStandardItem* Widget::getSrcFolder()
{
    QStandardItem* project = getProjectFolder();
    if(nullptr == project)
        return nullptr;
    for(int i=0;i < project->rowCount();++i)
    {
        QStandardItem* child = project->child(i);
        QVariant var = child->data(ROLE_MARK_FOLDER);
        if(!var.isValid())
            continue;//说明不是ROLE_MARK_FOLDER，有可能是一些项目，相应项目结构树那个xxx.pro就是一个非目录条目
        if(MARK_FOLDER_CPP == var.value<int>())
            return child;
    }
    return nullptr;
}

getTreeModel用于获取treeView的model；

getRoots用于获取全部根节点；

getProjectFolder用于获取“项目目录”；

getHeaderFolder用于获取“头文件目录”；

getSrcFolder用于获取“源文件目录”；

主要使用了data函数，函数声明例如以下：

QVariant QStandardItem::data(int role = Qt::UserRole + 1) const

它会依据role，返回相应的QVariant，假设没有这个role，返回的QVariant会是不可用，能够通过QVariant的函数isValid进行推断。

QVariant函数内部的值须要先转换，转换能够使用toInt函数或者使用一个通用的模板函数value。

以下看看button“加入头文件”的实现：

void Widget::on_pushButton_clicked()
{
    static int s_header_count = 1;
    //找到头文件目录
    QStandardItem* headerFolder = getHeaderFolder();
    if(headerFolder)
    {
        QStandardItem* item = new QStandardItem(QIcon(":/icon/icon/i.png")
                                                ,QStringLiteral("%1.h").arg(s_header_count));
        item->setData(MARK_ITEM,ROLE_MARK);//首先标定条目的类型 - 目录、项目、条目…
        item->setData(MARK_ITEM_H,ROLE_MARK_ITEM);//再次标定项目的类型
        headerFolder->appendRow(item);
        ++s_header_count;
    }
}

首先找到相应的头文件目录，然后再在这问件夹下加入文件。执行效果例如以下图：

3.给树形视图设置右键菜单

树形视图最大的长处是有清晰的逻辑关系，能够明显的看出每一个条目的父子关系，对于大型project来说显得尤为重要。因为条目之间功能不同，对条目的操作也会有不同的响应。比如，Qt Creator的项目结构树，对顶层跟项目点右键和对其他节点点右键是弹出不同的菜单的，例如以下图所看到的

这里涉及到两个方面，一个是给QTreeView加入菜单，还有一个是对右击的节点进行推断。

给QtreeView加入右键菜单，首先须要把contextMenuPolicy属性设置为：CustomContextMenu。

在ui 编辑器中右击QTreeView，选择转到槽

选择customContextMenuRequested(QPointpos)信号

这时，会自己主动加入相应的槽函数：

void Widget::on_treeView_customContextMenuRequested(const QPoint &pos)
{

}

当然也能够使用代码加入！

此槽函数接收一个点坐标，用于标定点击的方位，能够使用indexAt函数来获取详细点击的条目。

virtual QModelIndex    indexAt(const QPoint & point) const

在加入Menu前先要创建menu。声明两个menu的成员变量，记得加入相应的头文件

#include <QMenu>

#include <QAction>

QMenu* m_projectMenu;

QMenu* m_itemMenu;

在构造函数中创建menu

    m_projectMenu = new QMenu(this);
    m_itemMenu = new QMenu(this);

    QAction* ac = nullptr;
    ac = new QAction(QStringLiteral("构建"),this);
    m_projectMenu->addAction(ac);

    ac = new QAction(QStringLiteral("执行qmake"),this);
    m_projectMenu->addAction(ac);

    ac = new QAction(QStringLiteral("部署"),this);
    ac->setEnabled(false);
    m_projectMenu->addAction(ac);

    ac = new QAction(QStringLiteral("执行"),this);
    m_projectMenu->addAction(ac);

    m_projectMenu->addSeparator();

    ac = new QAction(QStringLiteral("又一次构建"),this);
    m_projectMenu->addAction(ac);

    ac = new QAction(QStringLiteral("清除"),this);
    m_projectMenu->addAction(ac);

    m_projectMenu->addSeparator();

    ac = new QAction(QStringLiteral("加入新文件……"),this);
    m_projectMenu->addAction(ac);

    ac = new QAction(QStringLiteral("余下的省略……"),this);
    m_projectMenu->addAction(ac);

    //

    ac = new QAction(QStringLiteral("打开文件"),this);
    m_itemMenu->addAction(ac);
    ac = new QAction(QStringLiteral("在explorer中显示"),this);
    m_itemMenu->addAction(ac);
    ac = new QAction(QStringLiteral("在此弹出命令提示"),this);
    m_itemMenu->addAction(ac);

    QMenu* itemChildMenu = new QMenu(m_itemMenu);
    itemChildMenu->setTitle(QStringLiteral("用…打开"));
    ac = new QAction(QStringLiteral("C++编辑器"),this);
    itemChildMenu->addAction(ac);
    ac = new QAction(QStringLiteral("普通文本编辑器"),this);
    itemChildMenu->addAction(ac);
    ac = new QAction(QStringLiteral("二进制编辑器"),this);
    itemChildMenu->addAction(ac);
    ac = new QAction(QStringLiteral("System Editor"),this);
    itemChildMenu->addAction(ac);

    m_itemMenu->addAction(itemChildMenu->menuAction());

    ac = new QAction(QStringLiteral("余下省略n条"),this);
    m_itemMenu->addAction(ac);

on_treeView_customContextMenuRequested槽函数详细实现代码例如以下：

void Widget::on_treeView_customContextMenuRequested(const QPoint &pos)
{
    QModelIndex index = ui->treeView->indexAt(pos);
    QVariant var = index.data(ROLE_MARK);
    if(var.isValid())
    {
        if(MARK_PROJECT == var.toInt())
            m_projectMenu->exec(QCursor::pos());//弹出右键菜单，菜单位置为光标位置
        else if(MARK_ITEM == var.toInt())
            m_itemMenu->exec(QCursor::pos());
    }
}

首先用indexAt获取当前点击条目的QModelIndex。通过QModelIndex获取条目的data，QTreeView的data能够通过model，item，index三者随意一个获取，很方便。

之前对项目和条目通过ROLE_MARK角色做过标记，仅仅要推断ROLE_MARK角色，就能够区分点击的是根节点项目还是随意一个条目。详细效果见下图

4.系统role的使用

在设定data时，须要制定角色，而自己定义角色都是从Qt::UserRole開始往上延伸的，那么Qt::UserRole之前的那些内容是什么呢。Qt为我们定义了一些经常使用的角色，在Qt::ItemDataRole枚举中。在Qt说明文档中有具体说明(比較懒不想copy，截了一个图)

我们最经常使用的就是Qt::DisplayRole，或许你用QStandardItemModel从来都不会在代码中用到它，可是，在显示文字过程中，都会调用此role的值。

仅仅要给这些系统role复制，在视图上就会有相应的效果。

如Qt::BackgroundRole用于设置背景色，仅仅要调用setData时把role设置为Qt::BackgroundRole，同一时候传入的值为一个颜色值，那么它就会在设置背景颜色。

void Widget::on_pushButton_3_clicked()
{
    QModelIndex index = ui->treeView->currentIndex();
    if(!index.isValid())
        return;
    getTreeModel()->itemFromIndex(index)->setData(QColor(232,209,57,200),Qt::BackgroundRole);
}

效果例如以下：

Qt::ToolTipRole用于给条目加入额外的说明

在根节点增加一个额外说明例如以下：

void Widget::init()
{
    QStandardItemModel* model = new QStandardItemModel(ui->treeView);
    model->setHorizontalHeaderLabels(QStringList()<<QStringLiteral("项目"));

    //加入项目目录
    QStandardItem* root = new QStandardItem(QIcon(":/icon/icon/p.png"),QStringLiteral("项目"));
    root->setData(MARK_PROJECT,ROLE_MARK);//首先它是项目中目录
    root->setData(MARK_FOLDER,ROLE_MARK_FOLDER);//其次它属于目录
    root->setData(
                QStringLiteral("这是关于QStandardItemModel设定角色的教程\n具体介绍见：http://blog.csdn.net/czyt1988/article/details/26018513")
                ,Qt::ToolTipRole
                );
 ……
 }

效果如图所看到的：

Qt::TextColorRole用于改变文字颜色，Qt::TextAlignmentRole改变对齐方式，Qt::FontRole控制字体等等，这里不一一介绍。

ps:

高亮背景后须要把高亮取消，就须要遍历全部子节点，并把设置有Qt::BackgroundRole角色的data设置为QVariant();详细遍历见http://blog.csdn.net/czyt1988/article/details/21093451使用了C++11的一些新特性。

void Widget::on_pushButton_4_clicked()
{
    //涉及到遍历，因此使用回调函数，把遍历须要运行的函数传给封装好的遍历
    StandardItemModelEx::ergodicAllItem(getTreeModel()
                   ,std::bind(&Widget::callback_clearColor,this,std::placeholders::_1));
}

void Widget::callback_clearColor(QStandardItem* item)
{
    item->setData(QVariant(),Qt::BackgroundRole);
}

demo代码：http://download.csdn.net/detail/czyt1988/7368399