不能通过 keyPressEvent 使用 QPlainTextEdit 中的其他键

Posted 2023-03-29

【中文标题】不能通过 keyPressEvent 使用 QPlainTextEdit 中的其他键

【英文标题】：Can't use other keys in QPlainTextEdit with keyPressEvent

【发布时间】：2019-12-30 20:23:42

【问题描述】：

我正在尝试在 QPlainTextEdit 小部件上安装 keyPressEvent，这样当键入时，我可以正常键入，当我按 Enter 时，它将向 QPlainTextEdit 添加文本。我必须创建由 Qt Designer 创建的文件 QtDes.py 和另一个文件 QtTextEvent.py。这些是我的文件：

QtDes.py：

# -*- coding: utf-8 -*-

# Form implementation generated from reading ui file 'QtDes.ui'
#
# Created by: PyQt5 UI code generator 5.13.1
#
# WARNING! All changes made in this file will be lost!
from PyQt5 import QtGui, QtWidgets, QtCore

class Ui_MainWindow(object):
    def __init__(self, *args, **kwargs):
        super(Ui_MainWindow, self).__init__(*args, **kwargs)

        self.exactAns = ""
        self.approxAns = 0

    def setupUi(self, MainWindow):
        MainWindow.setObjectName("MainWindow")
        MainWindow.resize(800, 569)
        self.centralwidget = QtWidgets.QWidget(MainWindow)
        self.centralwidget.setObjectName("centralwidget")
        self.gridLayout = QtWidgets.QGridLayout(self.centralwidget)
        self.gridLayout.setObjectName("gridLayout")
        self.plainTextEdit = QtWidgets.QPlainTextEdit(self.centralwidget)
        font = QtGui.QFont()
        font.setFamily("Courier New")
        self.plainTextEdit.setFont(font)
        self.plainTextEdit.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAsNeeded)
        self.plainTextEdit.setTabChangesFocus(False)
        self.plainTextEdit.setLineWrapMode(QtWidgets.QPlainTextEdit.NoWrap)
        self.plainTextEdit.setOverwriteMode(False)
        self.plainTextEdit.setTabStopWidth(40)
        self.plainTextEdit.setTabStopDistance(40.0)
        self.plainTextEdit.setObjectName("plainTextEdit")
        self.plainTextEdit.appendPlainText("First Line: ")

        self.plainTextEdit.keyPressEvent = self.keyPressEvent

        self.gridLayout.addWidget(self.plainTextEdit, 0, 0, 1, 1)
        MainWindow.setCentralWidget(self.centralwidget)
        self.menubar = QtWidgets.QMenuBar(MainWindow)
        self.menubar.setGeometry(QtCore.QRect(0, 0, 800, 21))
        self.menubar.setObjectName("menubar")
        MainWindow.setMenuBar(self.menubar)
        self.statusbar = QtWidgets.QStatusBar(MainWindow)
        self.statusbar.setObjectName("statusbar")
        MainWindow.setStatusBar(self.statusbar)

        self.retranslateUi(MainWindow)
        QtCore.QMetaObject.connectSlotsByName(MainWindow)

    def retranslateUi(self, MainWindow):
        _translate = QtCore.QCoreApplication.translate
        MainWindow.setWindowTitle(_translate("MainWindow", "MainWindow"))


if __name__ == "__main__":
    import sys
    app = QtWidgets.QApplication(sys.argv)
    MainWindow = QtWidgets.QMainWindow()
    ui = Ui_MainWindow()
    ui.setupUi(MainWindow)
    MainWindow.show()
    sys.exit(app.exec_())

和QtTextEvent.py：

from PyQt5 import QtCore, QtGui, QtWidgets

from QtDes import Ui_MainWindow

class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow):
    def __init__(self, *args, **kwargs):
        QtWidgets.QMainWindow.__init__(self, *args, **kwargs)
        self.setupUi(self)

    def keyPressEvent(self, event):
        if event.key() == QtCore.Qt.Key_Return or event.key() == QtCore.Qt.Key_Enter:
            print("Enter pressed")
            self.plainTextEdit.appendPlainText("New Line: ")
        else:
            super(MainWindow, self).keyPressEvent(event)

if __name__ == "__main__":
    import sys
    app = QtWidgets.QApplication(sys.argv)
    w = MainWindow()
    w.show()
    sys.exit(app.exec_())

按回车键做了它应该做的，但按其他按钮不起作用。我从this question 和this question 那里得到了答案。我的实现有问题吗？我该如何解决？

【参考方案1】：

说明：

keyPressEvent 方法实现了在您按下一个键时将文本添加到 QPlaintTextEdit 的任务，但是您正在为它分配另一个不实现此逻辑的 keyPressEvent（来自 QMainWindow），也就是说，它不添加文本。因此，将一种方法分配给另一种方法是不正确的，因为您删除了小部件默认具有的行为。

解决方案：

在你的情况下，只需要听键盘，如果你按下回车键然后添加一个文本，那么你只需要一个事件过滤器来听一个事件。

为此，您必须删除 QtDes.py 文件中的 self.plainTextEdit.keyPressEvent = self.keyPressEvent。还要在 QtTextEvent.py 文件中实现事件过滤器：

from PyQt5 import QtCore, QtGui, QtWidgets

from QtDes import Ui_MainWindow


class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.setupUi(self)
        self.plainTextEdit.installEventFilter(self)

    def eventFilter(self, obj, event):
        if obj is self.plainTextEdit and event.type() == QtCore.QEvent.KeyPress:
            if event.key() in (QtCore.Qt.Key_Return, QtCore.Qt.Key_Enter):
                print("Enter pressed")
                self.plainTextEdit.appendPlainText("New Line: ")
                return True
        return super(MainWindow, self).eventFilter(obj, event)


if __name__ == "__main__":
    import sys

    app = QtWidgets.QApplication(sys.argv)
    w = MainWindow()
    w.show()
    sys.exit(app.exec_())

另一种可能的解决方案是从 QPlainTextEdit 继承并覆盖 keyPressEvent 方法。

plaintextedit.py

class PlainTextEdit(QtWidgets.QPlainTextEdit):
    def keyPressEvent(self, event):
        if event.key() in (QtCore.Qt.Key_Return, QtCore.Qt.Key_Enter):
            print("Enter pressed")
            self.appendPlainText("New Line: ")
            return
        super(PlainTextEdit, self).keyPressEvent(event)

然后你改为：

QtDes.py

from plaintextedit import PlainTextEdit
# ...
class Ui_MainWindow(object):
    def setupUi(self, MainWindow):
        # ...
        self.plainTextEdit = PlainTextEdit(self.centralwidget)
        # ...

（你也可以promote it，正如我在这个答案中指出的那样）

【参考方案2】：

您不能“安装 keyPressEvent”，即使可以，它也不适用于您的方法。

通过这样做：

self.plainTextEdit.keyPressEvent = self.keyPressEvent

你实际上是在做这样的事情：

mainWindowInstance.plainTextEdit.keyPress = mainWindowInstance.keyPressEvent

结果是事件将不被plainTextEdit接收，而是被主窗口接收，并且由于事件如果不被处理总是被发送回父级，因此不会发生其他任何事情。

理论上的解决方案是针对 QPlainTextEdit 小部件调用基类实现：

    def keyPressEvent(self, event):
        if event.key() == QtCore.Qt.Key_Return or event.key() == QtCore.Qt.Key_Enter:
            print("Enter pressed")
            self.plainTextEdit.appendPlainText("New Line: ")
        else:
            QtWidgets.QPlainTextEdit.keyPressEvent(self.plainTextEdit, event)

请注意，我没有调用self.plainTextEdit.keyPressEvent(event)，因为它会导致递归。

无论如何，这个想法并不好，因为这样你也覆盖了 QMainWindow keyPressEvent（如果你需要它可能会出现问题，但这不是重点）。

有两种可能（而且更“优雅”）的解决方案：

1。子类 QPlainTextEdit 并在 Designer 中推广它

此方法允许您在设计器中创建 UI，并为您可以使用自己的代码扩展的自定义小部件设置基本参数；有关该过程的说明，请参阅this answer。

有了这个，你可以做这样的事情：

class MyTextEdit(QtWidget.QPlainTextEdit):
    def keyPressEvent(self, event):
        if event.key() == QtCore.Qt.Key_Return or event.key() == QtCore.Qt.Key_Enter:
            print("Enter pressed")
            self.appendPlainText("New Line: ")
        else:
            super().keyPressEvent(event)

额外的好处是，这样，代码也更干净，更容易实现。

2。在小部件上安装事件过滤器

事件过滤器能够“拦截”小部件接收到的任何事件，并可能对其做出反应。在你的情况下，它可能是这样的：

class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow):
    def __init__(self, *args, **kwargs):
        QtWidgets.QMainWindow.__init__(self, *args, **kwargs)
        self.setupUi(self)
        self.plainTextEdit.installEventFilter(self)

    def eventFilter(self, source, event):
        if (event.type() == QtCore.QEvent.KeyPress and 
            event.key() in (QtCore.Qt.Key_Enter, QtCore.Qt.Key_Return)):
                # ensure that the widget receives the key event
                super().eventFilter(source, event)
                print("Enter pressed")
                self.plainTextEdit.appendPlainText("New Line: ")
                # the event is accepted and not sent to its ancestors
                return True
        return super().eventFilter(source, event)