如何为QFileSystemModel添加自定义角色以存储复选框选中状态？

嗨，这个需求我太熟了！其实就是通过派生QFileSystemModel扩展自定义角色来存储选中状态，再配合自定义代理处理CheckBox的显示和交互，下面一步步给你讲清楚：

首先我们需要创建一个QFileSystemModel的子类，核心是定义一个自定义角色，并用一个容器来保存每个文件的选中状态：

#include <QFileSystemModel>
#include <QHash>

class CheckableFileSystemModel : public QFileSystemModel
{
    Q_OBJECT
public:
    // 定义自定义角色，要在Qt::UserRole之后
    enum CustomRoles {
        CheckedRole = Qt::UserRole + 1
    };

    explicit CheckableFileSystemModel(QObject *parent = nullptr)
        : QFileSystemModel(parent) {}

    // 重写data方法，返回自定义角色的状态
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override {
        if (role == CheckedRole) {
            QString filePath = this->filePath(index);
            // 如果路径不在哈希表中，默认返回未选中
            return m_checkedItems.value(filePath, false);
        }
        return QFileSystemModel::data(index, role);
    }

    // 重写setData方法，更新选中状态
    bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override {
        if (role == CheckedRole) {
            QString filePath = this->filePath(index);
            bool isChecked = value.toBool();
            m_checkedItems[filePath] = isChecked;
            // 触发数据变化信号，让视图更新
            emit dataChanged(index, index, {CheckedRole});
            return true;
        }
        return QFileSystemModel::setData(index, value, role);
    }

    // 可选：提供方法批量获取选中的文件路径
    QStringList checkedFiles() const {
        QStringList result;
        for (auto it = m_checkedItems.constBegin(); it != m_checkedItems.constEnd(); ++it) {
            if (it.value()) {
                result.append(it.key());
            }
        }
        return result;
    }

private:
    // 用哈希表存储文件路径和选中状态的映射
    QHash<QString, bool> m_checkedItems;
};

接下来需要一个自定义的QStyledItemDelegate子类，用来在文件名旁边绘制CheckBox，并且处理点击交互：

#include <QStyledItemDelegate>
#include <QCheckBox>
#include <QPainter>

class CheckBoxDelegate : public QStyledItemDelegate
{
    Q_OBJECT
public:
    explicit CheckBoxDelegate(QObject *parent = nullptr)
        : QStyledItemDelegate(parent) {}

    // 重写paint方法，绘制CheckBox
    void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override {
        // 先绘制默认的文本和图标（保持QFileSystemModel的原有样式）
        QStyledItemDelegate::paint(painter, option, index);

        // 获取选中状态
        bool isChecked = index.data(CheckableFileSystemModel::CheckedRole).toBool();

        // 计算CheckBox的位置，这里放在单元格左侧，你可以调整坐标
        QRect checkBoxRect = QStyle::alignedRect(
            option.direction,
            Qt::AlignLeft | Qt::AlignVCenter,
            QSize(20, 20),
            option.rect
        );

        // 绘制CheckBox
        QStyleOptionButton checkBoxOption;
        checkBoxOption.state = isChecked ? QStyle::State_On : QStyle::State_Off;
        checkBoxOption.state |= QStyle::State_Enabled;
        checkBoxOption.rect = checkBoxRect;
        option.widget->style()->drawControl(QStyle::CE_CheckBox, &checkBoxOption, painter);
    }

    // 重写editorEvent，处理鼠标点击来切换选中状态
    bool editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index) override {
        if (event->type() == QEvent::MouseButtonRelease) {
            QMouseEvent *mouseEvent = static_cast<QMouseEvent*>(event);
            // 判断点击位置是否在CheckBox区域内
            QRect checkBoxRect = QStyle::alignedRect(
                option.direction,
                Qt::AlignLeft | Qt::AlignVCenter,
                QSize(20, 20),
                option.rect
            );
            if (checkBoxRect.contains(mouseEvent->pos())) {
                // 切换选中状态
                bool currentChecked = index.data(CheckableFileSystemModel::CheckedRole).toBool();
                model->setData(index, !currentChecked, CheckableFileSystemModel::CheckedRole);
                return true;
            }
        }
        return QStyledItemDelegate::editorEvent(event, model, option, index);
    }
};

最后把这两个类整合到你的界面中，比如用QTreeView或者QListView来显示文件：

#include <QMainWindow>
#include <QTreeView>

class MainWindow : public QMainWindow
{
    Q_OBJECT
public:
    MainWindow(QWidget *parent = nullptr)
        : QMainWindow(parent) {
        QTreeView *treeView = new QTreeView(this);
        setCentralWidget(treeView);

        // 创建自定义模型
        CheckableFileSystemModel *model = new CheckableFileSystemModel(this);
        model->setRootPath(QDir::homePath()); // 设置根目录

        // 创建自定义代理并设置到视图
        CheckBoxDelegate *delegate = new CheckBoxDelegate(this);
        treeView->setItemDelegate(delegate);

        // 关联模型和视图
        treeView->setModel(model);
        treeView->setRootIndex(model->index(QDir::homePath()));
    }
};

• 一定要用文件的绝对路径作为哈希表的键，因为QFileSystemModel的index可能会随着视图切换根目录变化，但绝对路径是唯一的。
• 重写setData时必须触发dataChanged信号，否则视图不会更新CheckBox的状态。
• 如果需要持久化选中状态，可以在模型的构造函数中从配置文件加载哈希表，在析构时保存回去。
• 代理的editorEvent是处理点击交互的关键，确保点击CheckBox区域时才切换状态，不影响原有的文件双击等操作。

内容的提问来源于stack exchange，提问作者maxwell