自定义 QStyledItemDelegate - 将编辑应用到模型

Posted 2023-02-17

【中文标题】自定义 QStyledItemDelegate - 将编辑应用到模型

【英文标题】：Custom QStyledItemDelegate - Applying Edits to Model

【发布时间】：2016-12-30 03:52:45

【问题描述】：

在我的项目中，我继承了QStyledItemDelegate 并从createEditor 函数返回了一个自定义编辑器。

QWidget* TagEditDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const

    TagEditWidget* tagEditWidget = new TagEditWidget(parent, index.data(Qt::UserRole+4).toInt(), index.data(Qt::UserRole+2).toByteArray(), index.data(Qt::UserRole+3).toByteArray(), index.parent().data(Qt::UserRole+4).toInt() == 9, parent->width());
    return tagEditWidget; //tagEditWidget is my custom QWidget

编辑完成后，我想将新数据写回模型。所以我覆盖了setModelData。

void TagEditDelegate::setModelData(QWidget * editor, QAbstractItemModel * model, const QModelIndex & index) const

    TagEditWidget * tagEditWidget = qobject_cast<TagEditWidget*>(editor);
    if (!tagEditWidget)
    
        QStyledItemDelegate::setModelData(editor, model, index);
        return;
    

    //Edit model here?

这可行，但问题是无论编辑器如何关闭，setModelData 都会被调用。如果编辑器使用EndEditHint、QAbstractItemDelegate::SubmitModelCache 关闭，我只想写入新数据。所以我将closeEditor 信号连接到我创建的名为editFinished 的插槽。

connect(this, SIGNAL(closeEditor(QWidget*,QAbstractItemDelegate::EndEditHint)), this, SLOT(editFinished(QWidget*,QAbstractItemDelegate::EndEditHint)));

所以现在我可以看到编辑器是如何通过EndEditHint 关闭的，以及我是否应该将数据写回模型。 Buuuuut，setModelData 在closeEditor 信号之前调用。最后一次调用closeEditor 信号时，如何将数据写回模型？我在这里遗漏了什么吗？

【参考方案1】：

基本答案：

你的概念几乎到最后都很好。我会专注于TagEditDelegate::setModelData 方法。

如果您实际上不想更新模型中的数据，只需检查它是否没有更改。这意味着当oldData == newData 只是return; 并跳过模型更新。

补充说明：

查看您的编辑器创建，我得到的印象是它不包含呈现给用户的单个值。为了使传递参数更友好并更容易比较编辑器数据，请考虑为其创建一个单独的class/struct。所以你可以打电话：

new TagEditWidget(parent, editorData, parent->width())

EditorData 将是您的类/结构，可能由单独的函数获取：

EditorData editorData = readEditorData(index);

该函数可以在setModelData方法中重复使用来检查条件：

if (tagEditWidget->getEditorData() == readEditorData(index)) return;

还要避免使用像Qt::UserRole+2 这样的幻数。创建您自己的枚举以指定所需的角色。例如：

enum class MyRole

    Data1 = Qt::UserRole,
    Data2,
    Data3,
;

编辑根据cmets中的讨论

如果您想要发现用户实际上是否没有以一种方式取消版本，您可以在编辑器或委托中覆盖eventFilter。 在构造函数中创建编辑器调用installEventFilter。您的 eventFilter 实现可能如下所示：

bool eventFilter(QObject *object, QEvent *event) override

    if (event->type() == QEvent::KeyPress)
    
        const auto key = static_cast<QKeyEvent *>(event)->key();
        if (key == Qt::Key_Enter || key == Qt::Key_Return || key == Qt::Key_Tab)
            submitted = true;
    
    else if (event->type() == QEvent::FocusAboutToChange &&
             static_cast<QFocusEvent*>(event)->reason() == Qt::MouseFocusReason)
    
        submitted = true;
    
    // extetend the conditions (add else if) to include
    // events which you might want to treat as submitted

    return QLineEdit::eventFilter(object, event);

其中submitted 是bool 编辑器成员，在构造函数中初始化为false。然后你可以创建一个getter方法isSubmitted()，然后你就可以检查setModelData方法中的状态了。

if (tagEditWidget->isSubmitted())

    // process data or update model here

【讨论】：

感谢这些提示，但这并不能解决我的问题。如果新值 == 旧值，我不会尝试退出。我想根据用户关闭编辑器的方式取消编辑。具体来说，使用结束提示 SubmitModelCache。不，小部件中有几个向用户显示的字段。并且这些参数不是构造编辑器实例所必需的。例如，创建一个新项目。

“用户如何关闭编辑器”是什么意思？您想知道用户是否使用了esc、enter，只是集中注意力还是什么？这可以在早期知道 - 重新实现 eventFilter 以便编辑器捕捉发生了什么。

编辑器默认执行此操作。它返回一个 EndHint doc.qt.io/qt-4.8/qabstractitemdelegate.html#EndEditHint-enum 并详细说明它是如何关闭的。我想根据提示采取不同的行动。特别提示 3、4 和 0。

当然可以，但您想干扰已实施的流程。在eventFilter 中查看QStyledItemDelegate 的来源，enter 调用commitData，然后使用提交提示调用closeEditor。反过来，setModelData 调用绑定到commitData - 您可以查看此here。

那么为什么 closeEditor 信号会包含结束提示呢？我在那个来源中没有看到答案。

【参考方案2】：

我只是用我自己的方式回答了我自己的问题。我认为 Dusteh 的解决方案“更正确”。

我在名为 shouldCommit 的委托类中创建了一个布尔值并将其设置为 false。

然后在setModelData 中检查是否应该将数据写入模型。

void TagEditDelegate::setModelData(QWidget * editor, QAbstractItemModel * model, const QModelIndex & index) const

    TagEditWidget * tagEditWidget = qobject_cast<TagEditWidget*>(editor);
    if (!tagEditWidget)
    
        QStyledItemDelegate::setModelData(editor, model, index);
        return;
    

    if(shouldCommit)
    
        //write data here
    

然后，当closeEditor 信号发出时，我检查提示并将shouldCommit 临时设置为true 并再次调用commitData。现在shouldCommit 为真，数据被写入。

void TagEditDelegate::editFinished(QWidget * editor, QAbstractItemDelegate::EndEditHint hint)

    if(hint == QAbstractItemDelegate::SubmitModelCache)
    
        TagEditWidget * tagEditWidget = qobject_cast<TagEditWidget*>(editor);
        if(tagEditWidget)
        
            shouldCommit = true;
            commitData(editor);
            shouldCommit = false;
        
    

虽然这对我的用例非常有效，但可能并不适合所有人，Dusteh 的评论部分可能对某些人更有用。他的方法是覆盖eventFilter 并编写自己的实现来确定何时调用commitData。对于想要更多控制权的人来说，这可能是一个更合适的解决方案。

但是对于任何想要使用默认的eventFilter 实现并只需查看EndEditHint 的人，这是我的解决方案。

【讨论】：

实际上我并不是说应该重新实现整个eventFilter，只需在编辑器中覆盖它以设置编辑器成员submitted=true/false。或者坚持我的回答中描述的标准流程。至于您的答案，您基本上是在调用editFinished 时调用setModelData，这看起来像是一种不必要的解决方法。我会坚持使用if (old != newVal)//update 或if (tagEditWidget->submitted())//update，但如果你的方法适合你，那很好。

同样，这与新旧数据不同无关。这实际上是为了保留旧数据，以防编辑器意外关闭，例如单击关闭或滚动时没有焦点。或者用户改变了他们对编辑的想法。据我了解，您建议我重新实现eventFilter，以便我可以在那里选择何时调用commitData，这是正确的方法吗？