自定义 QStyledItemDelegate - 将编辑应用于模型
Custom QStyledItemDelegate - Applying Edits to Model
在我的项目中,我对 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
关闭,以及我是否应该将数据写回模型。但是,setModelData
在 closeEditor
信号之前被调用。当最后调用 closeEditor
信号时,如何将数据写回模型?我在这里遗漏了什么吗?
基本答案:
你的概念几乎到最后都很好。我会专注于 TagEditDelegate::setModelData
方法。
如果您真的不想更新模型中的数据,只需检查它是否没有改变。这意味着当 oldData == newData
只是 return;
并跳过模型更新。
补充说明:
看着您创建的编辑器,我的印象是它不包含呈现给用户的单一值。为了更友好地传递参数并更轻松地比较编辑器数据,请考虑为其创建一个单独的 class/struct
。所以你可以打电话:
new TagEditWidget(parent, editorData, parent->width())
其中 EditorData 将是您的 class/struct,它可能由单独的函数获取:
EditorData editorData = readEditorData(index);
该函数可以在 setModelData
方法中重复使用以检查条件:
if (tagEditWidget->getEditorData() == readEditorData(index)) return;
还要避免使用像 Qt::UserRole+2
这样的幻数。创建您自己的枚举以指定所需的角色。例如:
enum class MyRole
{
Data1 = Qt::UserRole,
Data2,
Data3,
};
编辑 根据评论中的讨论
如果您想要发现用户是否实际上没有以某种方式取消版本,您可以在编辑器或委托中覆盖 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
是在构造函数中初始化为 false
的 bool
编辑器成员。然后你可以创建一个 getter 方法 isSubmitted()
并且你准备好检查 setModelData
方法中的状态。
if (tagEditWidget->isSubmitted())
{
// process data or update model here
}
我只是用我自己的方式回答了我自己的问题。我认为 Dusteh 的解决方案是 "more correct"。
我在委托 class 中创建了一个名为 shouldCommit
的 bool 并将其设置为 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
的人来说,这是我的解决方案。
在我的项目中,我对 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
关闭,以及我是否应该将数据写回模型。但是,setModelData
在 closeEditor
信号之前被调用。当最后调用 closeEditor
信号时,如何将数据写回模型?我在这里遗漏了什么吗?
基本答案:
你的概念几乎到最后都很好。我会专注于 TagEditDelegate::setModelData
方法。
如果您真的不想更新模型中的数据,只需检查它是否没有改变。这意味着当 oldData == newData
只是 return;
并跳过模型更新。
补充说明:
看着您创建的编辑器,我的印象是它不包含呈现给用户的单一值。为了更友好地传递参数并更轻松地比较编辑器数据,请考虑为其创建一个单独的 class/struct
。所以你可以打电话:
new TagEditWidget(parent, editorData, parent->width())
其中 EditorData 将是您的 class/struct,它可能由单独的函数获取:
EditorData editorData = readEditorData(index);
该函数可以在 setModelData
方法中重复使用以检查条件:
if (tagEditWidget->getEditorData() == readEditorData(index)) return;
还要避免使用像 Qt::UserRole+2
这样的幻数。创建您自己的枚举以指定所需的角色。例如:
enum class MyRole
{
Data1 = Qt::UserRole,
Data2,
Data3,
};
编辑 根据评论中的讨论
如果您想要发现用户是否实际上没有以某种方式取消版本,您可以在编辑器或委托中覆盖 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
是在构造函数中初始化为 false
的 bool
编辑器成员。然后你可以创建一个 getter 方法 isSubmitted()
并且你准备好检查 setModelData
方法中的状态。
if (tagEditWidget->isSubmitted())
{
// process data or update model here
}
我只是用我自己的方式回答了我自己的问题。我认为 Dusteh 的解决方案是 "more correct"。
我在委托 class 中创建了一个名为 shouldCommit
的 bool 并将其设置为 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
的人来说,这是我的解决方案。