一、介绍

Spin Box Delegate示例展示了如何通过重用标准Qt编辑器小部件来为模型/视图框架中的自定义委托创建一个编辑器。

模型/视图框架提供了一个标准委托，默认情况下与标准视图类一起使用。对于大多数情况，通过此委托选择可用的编辑器小部件就足以编辑文本、布尔值和其他简单数据类型。但是，对于特定的数据类型，有时需要通过使用自定义委托以特定的方式显示数据，或者允许用户使用自定义控件编辑数据。

这个例子背后的概念在模型/视图编程概述的委托类一章中有介绍。

二、SpinBoxDelegate类定义

委托的定义如下：

#ifndef DELEGATE_H
#define DELEGATE_H
#include <QStyledItemDelegate>
class SpinBoxDelegate : public QStyledItemDelegate {
    Q_OBJECT
public:
    SpinBoxDelegate(QObject* parent = nullptr);
    QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option,
        const QModelIndex& index) const override;
    void setEditorData(QWidget* editor, const QModelIndex& index) const override;
    void setModelData(QWidget* editor, QAbstractItemModel* model,
        const QModelIndex& index) const override;
    void updateEditorGeometry(QWidget* editor, const QStyleOptionViewItem& option,
        const QModelIndex& index) const override;
};
#endif

委托类只声明创建编辑器小部件、将其显示在视图中的正确位置以及与模型通信所需的那些函数。定制委托还可以通过重新实现paintEvent()函数来提供自己的绘制代码。此外，还可以通过重新实现destroyEditor()函数来重用(并避免删除)编辑器小部件。可重用的小部件可以是在构造函数中创建并在析构函数中删除的可变成员。

三、SpinBoxDelegate类的实现

委托通常是无状态的，构造函数只需要调用基类的构造函数，并将父类QObject作为参数:

SpinBoxDelegate::SpinBoxDelegate(QObject* parent)
    : QStyledItemDelegate(parent)
{
}

由于委托是QStyledItemDelegate的一个子类，它从模型中获取的数据将以默认的样式显示，我们不需要提供自定义的paintEvent()。

createEditor()函数返回一个编辑器小部件，在本例中是一个QSpinBox，它将模型中的值限制为0到100(含100)之间的整数。

QWidget* SpinBoxDelegate::createEditor(QWidget* parent,
    const QStyleOptionViewItem& /* option */,
    const QModelIndex& /* index */) const
{
    QSpinBox* editor = new QSpinBox(parent);
    editor->setFrame(false);
    editor->setMinimum(0);
    editor->setMaximum(100);
    return editor;
}

我们在QSpinBox上安装事件过滤器，以确保它的行为方式与其他委托一致，事件筛选器的实现由基类提供。

setEditorData()函数从模型读取数据，将其转换为整数值，并将其写入编辑器小部件。

void SpinBoxDelegate::setEditorData(QWidget* editor, 
                                    const QModelIndex& index) const
{
    int value = index.model()->data(index, Qt::EditRole).toInt();
    QSpinBox* spinBox = static_cast<QSpinBox*>(editor);
    spinBox->setValue(value);
}

因为视图将委托视为普通的QWidget实例，所以在在QSpinBox中设置值之前，我们必须使用静态强制转换。

setModelData()函数读取QSpinBox的内容，并将其写入模型：

void SpinBoxDelegate::setModelData(QWidget* editor, QAbstractItemModel* model,
    const QModelIndex& index) const
{
    QSpinBox* spinBox = static_cast<QSpinBox*>(editor);
    spinBox->interpretText();
    int value = spinBox->value();
    model->setData(index, value, Qt::EditRole);
}

我们调用interpretText()以确保在QSpinBox中获得最新的值。

updateEditorGeometry()函数使用样式选项中提供的信息更新编辑器小部件的几何形状。这是委托在本例中必须执行的最小操作。

void SpinBoxDelegate::updateEditorGeometry(QWidget* editor,
    const QStyleOptionViewItem& option,
    const QModelIndex& /* index */) const
{
    editor->setGeometry(option.rect);
}

如果需要，更复杂的编辑器小部件可能会将“option.rect”中可用的矩形划分为不同的子小部件。

四、main函数

为了在标准视图中演示自定义编辑器小部件的使用，需要建立一个包含一些任意数据的模型和一个显示它的视图。

我们以正常的方式设置应用程序，构造一个标准项模型来保存一些数据，建立一个表视图来使用模型中的数据，并构造一个自定义委托来用于编辑：

int main(int argc, char* argv[])
{
    QApplication app(argc, argv);
    QStandardItemModel model(4, 2);
    QTableView tableView;
    tableView.setModel(&model);
    SpinBoxDelegate delegate;
    tableView.setItemDelegate(&delegate);

表格视图将被告知委托的相关信息，并将使用它来显示每个项。由于委托是QStyledItemDelegate的一个子类，表中的每个单元格都将使用标准绘制操作进行渲染。

出于演示目的，我们在模型中插入一些任意数据：

    tableView.horizontalHeader()->setStretchLastSection(true);
    for (int row = 0; row < 4; ++row) {
        for (int column = 0; column < 2; ++column) {
            QModelIndex index = model.index(row, column, QModelIndex());
            model.setData(index, QVariant((row + 1) * (column + 1)));
        }
    }

最后，表格视图显示一个窗口标题，然后我们开始应用程序的事件循环：

    tableView.setWindowTitle(QObject::tr("Spin Box Delegate"));
    tableView.show();
    return app.exec();
}

五、示例代码

这个简单的例子展示了视图如何使用自定义委托来编辑从模型中获得的数据。

main.cpp

#include "delegate.h"
#include <QApplication>
#include <QHeaderView>
#include <QStandardItemModel>
#include <QTableView>
int main(int argc, char* argv[])
{
    QApplication app(argc, argv);
    // 设置model
    QStandardItemModel model(4, 2);
    QTableView tableView;
    tableView.setModel(&model);
    // 设置delegate
    SpinBoxDelegate delegate;
    tableView.setItemDelegate(&delegate);
    // 去除选中单元格的时候出现的虚线矩形框
    tableView.setFocusPolicy(Qt::NoFocus);
    // 创建4*2的表格
    tableView.horizontalHeader()->setStretchLastSection(true);
    for (int row = 0; row < 4; ++row) {
        for (int column = 0; column < 2; ++column) {
            QModelIndex index = model.index(row, column, QModelIndex());
            model.setData(index, QVariant((row + 1) * (column + 1)));
        }
    }
    // 设置窗口名称,进入事件循环
    tableView.setWindowTitle(QObject::tr("Spin Box Delegate"));
    tableView.show();
    return app.exec();
}

delegate.h

#ifndef DELEGATE_H
#define DELEGATE_H
// 允许用户使用旋转框小部件从模型中更改整数值的委托。
#include <QStyledItemDelegate>
class SpinBoxDelegate : public QStyledItemDelegate {
    Q_OBJECT
public:
    SpinBoxDelegate(QObject* parent = nullptr);
    QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option,
        const QModelIndex& index) const override;
    void setEditorData(QWidget* editor,
        const QModelIndex& index) const override;
    void setModelData(QWidget* editor, QAbstractItemModel* model,
        const QModelIndex& index) const override;
    void updateEditorGeometry(QWidget* editor, const QStyleOptionViewItem& option,
        const QModelIndex& index) const override;
};
#endif

delegate.cpp

#include "delegate.h"
#include <QSpinBox>
// 委托通常是无状态的, 构造函数只需要调用基类的构造函数并将QObjcet作为参数即可
// - 使用基类提供的重绘事件(paintEvent()), 以确保从模型中获取的数据将按默认的样式显示
// - 使用基类提供的事件过滤器(eventFilter()), 以确保它的行为方式与其它委托一致
SpinBoxDelegate::SpinBoxDelegate(QObject* parent)
    : QStyledItemDelegate(parent)
{
}
// createEditor()函数返回一个编辑器小部件, 在本例中是一个QSpinBox。
QWidget* SpinBoxDelegate::createEditor(QWidget* parent,
    const QStyleOptionViewItem& /* option */,
    const QModelIndex& /* index */) const
{
    // QSpinBox在模型中的值限制为0到100(含100)之间的整数
    QSpinBox* editor = new QSpinBox(parent);
    editor->setFrame(false);
    editor->setMinimum(0);
    editor->setMaximum(100);
    return editor;
}
// setEditorData()函数从模型读取数据, 将其转换为整数值, 并将其写入编辑器小部件。
void SpinBoxDelegate::setEditorData(QWidget* editor,
    const QModelIndex& index) const
{
    int value = index.model()->data(index, Qt::EditRole).toInt();
    // 因为视图将委托视为普通的QWidget实例, 所以在使用QSpinBox之前需要静态强制转换。
    QSpinBox* spinBox = static_cast<QSpinBox*>(editor);
    spinBox->setValue(value);
}
// setModelData()函数读取QSpinBox的内容, 并将其写入模型：
void SpinBoxDelegate::setModelData(QWidget* editor, QAbstractItemModel* model,
    const QModelIndex& index) const
{
    QSpinBox* spinBox = static_cast<QSpinBox*>(editor);
    // interpretText()确保在QSpinBox中获得最新的值。
    spinBox->interpretText();
    int value = spinBox->value();
    model->setData(index, value, Qt::EditRole);
}
// updateEditorGeometry()函数使用样式选项中提供的信息更新编辑器小部件的几何形状。
// 这是委托在本例中必须执行的最小操作。
void SpinBoxDelegate::updateEditorGeometry(QWidget* editor,
    const QStyleOptionViewItem& option,
    const QModelIndex& /* index */) const
{
    editor->setGeometry(option.rect);
}

Qt 控件的使用及美化

Spin Box Delegate示例

一、介绍

二、SpinBoxDelegate类定义

三、SpinBoxDelegate类的实现

四、main函数

五、示例代码

六、示例结果