Qt学习：项视图类之自定义委托

    我们用好几节内容介绍了Qt的MVC架构中的模型和视图类，至今，我们依然没有提到我们提到的代理的功能，下面我们再回顾一下Qt的项视图类架构。

    我们知道，在经典的 MVC 模型中，view用于向用户展示 model 的数据。但是，Qt提供的不是 MVC 三层架构，而是一个 model/view 设计。这种设计并没有包含一个完整而独立的组件用于管理用户的交互。一般来说，view仅仅是用作对model数据的展示和对用户输入的处理，而不应该去做其他的工作。在这种结构中，为了获得对用户输入控制的灵活性，这种交互工作交给了delegate，也就是“委托”，去完成。简单来说，就像它们的名字一样，view 将用户输入委托给 delegate 处理，而自己不去处理这种输入。这些组件提供一种输入能力，并且能够在某些 view 中提供这种交互情形下的渲染，比如在 table 中通过双击单元格即可编辑内容等。对这种控制委托的标准接口被定义在 QAbstractItemDelegate 类中。
    就是说Qt用委托的方式完成了用户和模型之间的交互。其实本质上还是基于经典的MVC架构思想。
    delegate 可以用于渲染内容，这是通过 paint() 和 sizeHint() 函数来完成的。但是，对于一些简单的基于组件的delegate，可以通过继承 QItemDelegate 或者 QStyledItemDelegate 来实现。这样就可以避免要完全重写 QAbstractItemDelegate 中所需要的所有函数。对于一些相对比较通用的函数，在这两个类中已经有了一个默认的实现。 

 

    Qt提供的标准组件使用 QItemDelegate 提供编辑功能的支持。这种默认的实现被用在 QListView，QTableView 和 QTreeView 之中。view 实用的delegate可以通过 itemDelegate() 函数获得setItemDelegate()函数则可以为一个标准组件设置自定义的delegate。
    Qt 4.4版本之后提供了两个可以被继承的delegate类：QItemDelegate 和 QStyledItemDelegate。默认的delegate是 QStyledItemDelegate。这两个类可以被相互替代，用于给view 组件提供绘制和编辑的功能。它们之间的主要区别在于，QStyledItemDelegate 使用当前的风格(style)去绘制组件。所以，在自定义delegate或者需要使用 Qt style sheets 时，建议使用 QStyledItemDelegate 作为父类。使用这两个类的代码通常是一样的，除了需要使用style进行绘制的部份。如果你希望为view item自定义绘制函数，最好实现一个自定义的style。这个你可以通过QStyle类来实现。
    如果delegate没有支持为你的数据类型进行绘制，或者你希望自己绘制item，那么就可以继承 QStyledItemDelegate 类，并且重写 paint() 或者还需要重写 sizeHint() 函数。paint() 函数会被每一个item独立调用，而sizeHint()函数则可以定义每一个item 的大小。在重写 paint() 函数的时候，通常需要用 if 语句找到你需要进行渲染的数据类型并进行绘制，其他的数据类型需要调用父类的实现进行绘制。 

 

        

    一个自定义的delegate也可以直接提供一个编辑器，而不是使用内置的编辑器工厂(editor item factory)。如果你需要这种功能，那么需要实现一下几个函数：

createEditor():                 返回修改数据的组件；
setEditorData():                为editor提供编辑的原始数据；

updateEditorGeometry():         保证editor显示在 item view 的合适位置以及大小；
setModelData():                 根据editor 的数据更新model的数据。

            下面我们使用一个音轨编辑器的例子来说明这些函数的用法，实现一个自定义的委托，这个例子来自于：(C++ GUI Programming with Qt4, 2nd Edition) 
 首先我们自定义了一个数据类型，用于存储音轨的标题(QString)和持续时间(int)：

 

class Track
{
public:
    Track(const QString &title = "", int duration = 0);

    QString title;
    int duration;
}; 

    关于这个类的实现这里就不提了，接下来我们创建整个界面的布局，这里也只给出构造函数：

TrackEditor::TrackEditor(QList<Track> *tracks, QWidget *parent)
    : QDialog(parent)
{
    this->tracks = tracks;

    tableWidget = new QTableWidget(tracks->count(), 2);
    tableWidget->setItemDelegate(new TrackDelegate(1));
    tableWidget->setHorizontalHeaderLabels(
            QStringList() << tr("Track") << tr("Duration"));

    for (int row = 0; row < tracks->count(); ++row) {
        Track track = tracks->at(row);

        QTableWidgetItem *item0 = new QTableWidgetItem(track.title);
        tableWidget->setItem(row, 0, item0);

        QTableWidgetItem *item1
             = new QTableWidgetItem(QString::number(track.duration));
        item1->setTextAlignment(Qt::AlignRight);
        tableWidget->setItem(row, 1, item1);
    }

    tableWidget->resizeColumnToContents(0);

    buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok
                                     | QDialogButtonBox::Cancel);
    QPushButton *addTrackButton = buttonBox->addButton(tr("&Add Track"),
            QDialogButtonBox::ActionRole);

    connect(addTrackButton, SIGNAL(clicked()), this, SLOT(addTrack()));
    connect(buttonBox, SIGNAL(accepted()), this, SLOT(accept()));
    connect(buttonBox, SIGNAL(rejected()), this, SLOT(reject()));

    QVBoxLayout *mainLayout = new QVBoxLayout;
    mainLayout->addWidget(tableWidget);
    mainLayout->addWidget(buttonBox);
    setLayout(mainLayout);

    setWindowTitle(tr("Track Editor"));
} 

    其中tableWidget->setItemDelegate(new TrackDelegate(1));告诉编译器我们使用TrackDelegate这个对象作为我们的委托，这里
TrackDelegate就是我们自定义的委托。效果图如下：

    我们可以通过双击来对音轨的持续时间进行编辑，下面我们着重讨论这个自定义委托类的实现过程，像上面提到的那样，我们得重新实现 void paint()、QWidget *createEditor()、void setEditorData()、void setModelData()四个函数。下面是这个类的定义部分

#ifndef TRACKDELEGATE_H
#define TRACKDELEGATE_H

#include <QItemDelegate>

class TrackDelegate : public QItemDelegate
{
    Q_OBJECT

public:
    TrackDelegate(int durationColumn, QObject *parent = 0);

    void paint(QPainter *painter, const QStyleOptionViewItem &option,
               const QModelIndex &index) const;
    QWidget *createEditor(QWidget *parent,
                          const QStyleOptionViewItem &option,
                          const QModelIndex &index) const;
    void setEditorData(QWidget *editor, const QModelIndex &index) const;
    void setModelData(QWidget *editor, QAbstractItemModel *model,
                      const QModelIndex &index) const;

private slots:
    void commitAndCloseEditor();

private:
    int durationColumn;
};

#endif

 

    我们用 durationColumn来存储我们需要设置委托的列。

TrackDelegate::TrackDelegate(int durationColumn, QObject *parent)
    : QItemDelegate(parent)
{
    this->durationColumn = durationColumn;
}

    构造函数接收一个列数告诉这个委托，那一列需要被编辑。

void TrackDelegate::paint(QPainter *painter,
                          const QStyleOptionViewItem &option,
                          const QModelIndex &index) const
{
    if (index.column() == durationColumn) {
        int secs = index.model()->data(index, Qt::DisplayRole).toInt();
        QString text = QString("%1:%2")
                       .arg(secs / 60, 2, 10, QChar('0'))
                       .arg(secs % 60, 2, 10, QChar('0'));

        QStyleOptionViewItem myOption = option;
        myOption.displayAlignment = Qt::AlignRight | Qt::AlignVCenter;

        drawDisplay(painter, myOption, myOption.rect, text);
        drawFocus(painter, myOption, myOption.rect);
    } else{
        QItemDelegate::paint(painter, option, index);
    }
}

 

    paint()函数用于控制某一列的显示格式，因为用户传进去的值是秒数，所以我们得重绘这个显示，用“分钟：秒”、右对齐的格式显示这些数据。

QWidget *TrackDelegate::createEditor(QWidget *parent,const QStyleOptionViewItem &option,
        const QModelIndex &index) const
{
    if (index.column() == durationColumn) {
        QTimeEdit *timeEdit = new QTimeEdit(parent);
        timeEdit->setDisplayFormat("mm:ss");
        connect(timeEdit, SIGNAL(editingFinished()),
                this, SLOT(commitAndCloseEditor()));
        return timeEdit;
    } else {
        return QItemDelegate::createEditor(parent, option, index);
    }
} 

 

    当我们双击一个单元格时 createEditor()函数被调用并在当前单元格创建一个QTimeEdit用于编辑，但要注意我们双击出来的数据并不在这会儿就写入单元格，即当我们把焦点聚焦在另一个单元格时，我们在这个时间编辑器编辑的时间会失效，单元格显示我们原来写入的时间，所以我们连接一个槽，当编辑完后焦点转移就会触发这个槽，这个槽是这样实现的：

void TrackDelegate::commitAndCloseEditor()
{
    QTimeEdit *editor = qobject_cast<QTimeEdit *>(sender());
    emit commitData(editor);
    emit closeEditor(editor);
}

    这个槽发射commitData()信号通知视图用被编辑的数据替换已经存在的数据，并发射closeEditor()信号通知视图已经不再需要这个编辑器了，这时模型就会删除它。

void TrackDelegate::setEditorData(QWidget *editor,
                                  const QModelIndex &index) const
{
    if (index.column() == durationColumn) {
        int secs = index.model()->data(index, Qt::DisplayRole).toInt();
        QTimeEdit *timeEdit = qobject_cast<QTimeEdit *>(editor);
        timeEdit->setTime(QTime(0, secs / 60, secs % 60));
    } else {
        QItemDelegate::setEditorData(editor, index);
    }
}

    当用户初始化编辑的时候是调用createEditor()创建一个编辑器的，这我们上边也提到过， 然后这个项的当前数据调用setEditorData()这个函数来初始化编辑器（原来是拿00:00来初始化的）。

void TrackDelegate::setModelData(QWidget *editor,
                                 QAbstractItemModel *model,
                                 const QModelIndex &index) const
{
    if (index.column() == durationColumn) {
        QTimeEdit *timeEdit = qobject_cast<QTimeEdit *>(editor);
        QTime time = timeEdit->time();
        int secs = (time.minute() * 60) + time.second();
        model->setData(index, secs);
    } else {
        QItemDelegate::setModelData(editor, model, index);
    }
}

    如果用户完成了编辑，就从QTimeEdit中提取出分钟数和秒数，并且设置数据为相应的秒数，paint函数就会把这个秒数以当前的格式写进对应的单元格中。

    至此我们简单扼学完了Qt的MVC框架，但这只是入门之说，仍需努力，努力，再努力。