QTableWidget单元格编辑时Escape键拦截与处理异常排查

问题背景 #

子类化QTableWidget实现自定义编辑逻辑：拦截Escape键询问是否放弃编辑，用Ctrl+Enter保存并关闭单元格编辑。目前Escape键的检测符合预期，但完成编辑（无论保存还是放弃）后，无法通过鼠标点击正常高亮单元格，单元格仍显示光标，看似处于编辑状态。

问题代码 #

#!/usr/bin/env python3

from PyQt6.QtCore import Qt
from PyQt6.QtWidgets import (
    QApplication,
    QMainWindow,
    QMessageBox,
    QPlainTextEdit,
    QStyledItemDelegate,
    QStyleOptionViewItem,
    QTableWidget,
    QTableWidgetItem,
)


class EscapeLineEdit(QPlainTextEdit):
    """
    Subclass QPlainTextEdit to detect Escape key.
    """

    def __init__(self, parent, delegate):
        super().__init__(parent)
        self.delegate = delegate

    def keyPressEvent(self, event):
        if event.key() == Qt.Key.Key_Escape:
            discard_edits = QMessageBox.question(
                self.parent(), "Abandon edit", "Discard changes?")
            if discard_edits == QMessageBox.StandardButton.Yes:
                self.close()
        elif event.key() == Qt.Key.Key_Return:
            if event.modifiers() == Qt.KeyboardModifier.ControlModifier:
                self.delegate.commitData.emit(self)
                self.delegate.closeEditor.emit(self)
                self.close()
        super().keyPressEvent(event)


class EscapeDelegate(QStyledItemDelegate):
    def __init__(self, parent=None):
        super().__init__(parent)

    def createEditor(self, parent, option, index):
        return EscapeLineEdit(parent, self)


class MyTableWidget(QTableWidget):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.setItemDelegate(EscapeDelegate())
        self.cellDoubleClicked.connect(self.editCell)

    def editCell(self, row, col):
        """
        Explicitly set the cell editor to enable
        detection of the Escape key
        """

        delegate = self.itemDelegate()
        index = self.model().index(row, col)
        editor = delegate.createEditor(self.viewport(), QStyleOptionViewItem(), index)
        delegate.setEditorData(editor, index)
        self.setCellWidget(row, col, editor)


class MainWindow(QMainWindow):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.table_widget = MyTableWidget(self)
        self.table_widget.setRowCount(2)
        self.table_widget.setColumnCount(2)
        for row in range(2):
            for col in range(2):
                item = QTableWidgetItem()
                item.setText(f"Row {row}, Col {col}")
                self.table_widget.setItem(row, col, item)
        self.setCentralWidget(self.table_widget)

        self.table_widget.resizeColumnsToContents()
        self.table_widget.resizeRowsToContents()


if __name__ == '__main__':
    app = QApplication([])
    window = MainWindow()
    window.show()
    app.exec()

问题根源 #

核心问题在于手动创建编辑器并设置为cellWidget的方式破坏了Qt的委托编辑机制：

• Qt的Item Delegate框架会自动管理编辑器的创建、显示、销毁和状态同步，而手动调用setCellWidget会让编辑器脱离委托的管理，关闭后无法正确恢复单元格的正常状态。
• 自定义的editCell方法完全没必要，QTableWidget默认双击单元格就会触发委托创建编辑器。

修复方案 #

修改步骤 #

1. 移除MyTableWidget中的editCell方法及cellDoubleClicked信号的连接，依赖QTableWidget默认的编辑触发逻辑。
2. 修正EscapeLineEdit的keyPressEvent，确保编辑状态的正确切换：
   • Escape确认放弃时，通知委托关闭编辑器并恢复数据
   • Ctrl+Enter保存时，提交数据后通知委托关闭编辑器，同时阻止事件继续传播避免默认换行
3. 确保编辑器的生命周期完全由Qt委托机制管理。

修复后完整代码 #

#!/usr/bin/env python3

from PyQt6.QtCore import Qt
from PyQt6.QtWidgets import (
    QApplication,
    QMainWindow,
    QMessageBox,
    QPlainTextEdit,
    QStyledItemDelegate,
    QTableWidget,
    QTableWidgetItem,
)


class EscapeLineEdit(QPlainTextEdit):
    def __init__(self, parent, delegate):
        super().__init__(parent)
        self.delegate = delegate

    def keyPressEvent(self, event):
        if event.key() == Qt.Key.Key_Escape:
            discard_edits = QMessageBox.question(
                self.parent(), "Abandon edit", "Discard changes?")
            if discard_edits == QMessageBox.StandardButton.Yes:
                # 通知委托关闭编辑器并恢复数据
                self.delegate.closeEditor.emit(self, QStyledItemDelegate.EndEditHint.RevertModelCache)
                # 阻止事件继续传递，避免默认行为
                event.accept()
                return
        elif event.key() == Qt.Key.Key_Return:
            if event.modifiers() == Qt.KeyboardModifier.ControlModifier:
                # 提交修改数据
                self.delegate.commitData.emit(self)
                # 通知委托关闭编辑器
                self.delegate.closeEditor.emit(self, QStyledItemDelegate.EndEditHint.NoHint)
                # 阻止事件继续传递，避免默认换行
                event.accept()
                return
        # 其他按键保留默认行为
        super().keyPressEvent(event)


class EscapeDelegate(QStyledItemDelegate):
    def __init__(self, parent=None):
        super().__init__(parent)

    def createEditor(self, parent, option, index):
        return EscapeLineEdit(parent, self)


class MyTableWidget(QTableWidget):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.setItemDelegate(EscapeDelegate())
        # 移除自定义的编辑触发逻辑，依赖默认双击行为


class MainWindow(QMainWindow):
    def __init__(self, parent=None):
        super().__init__(parent)
        self.table_widget = MyTableWidget(self)
        self.table_widget.setRowCount(2)
        self.table_widget.setColumnCount(2)
        for row in range(2):
            for col in range(2):
                item = QTableWidgetItem()
                item.setText(f"Row {row}, Col {col}")
                self.table_widget.setItem(row, col, item)
        self.setCentralWidget(self.table_widget)

        self.table_widget.resizeColumnsToContents()
        self.table_widget.resizeRowsToContents()


if __name__ == '__main__':
    app = QApplication([])
    window = MainWindow()
    window.show()
    app.exec()

关键改动说明 #

• 移除自定义编辑触发：删除editCell方法和cellDoubleClicked的连接，让Qt自动处理编辑器的创建和显示。
• 正确通知委托状态：使用closeEditor信号并传递合适的EndEditHint，让委托正确处理编辑器关闭后的模型状态同步。
• 阻止事件传播：处理Escape和Ctrl+Enter后调用event.accept()，避免默认的按键行为干扰编辑流程。

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