翻译自原文:Events and signals in PyQt5

翻译时间 2020 年 8 月 19 日

在 PyQt5 编程教程的这一部分中,我们将探讨应用程序中发生的事件和信号。

PyQt5 中的事件

GUI 应用程序是事件驱动的,事件主要由应用程序的用户生成。但是,它们也可以通过其他方式产生,例如,互联网连接、窗口管理器或计时器。当我们调用应用程序的exec_()方法时,应用程序进入主循环。主循环获取事件并将其发送到对象。

在活动模型中,有三个参与者:

  • 事件源
  • 事件对象
  • 事件目标

事件源是状态更改的对象,它生成事件。

事件对象(事件)封装事件源中的状态更改。

事件目标是想要收到通知的对象。事件源对象将处理事件的任务委托给事件目标。

PyQt5 具有独特的信号和插槽机制来处理事件。信号和插槽用于对象之间的通信。发生特定事件时发出信号。插槽可以是任何可调用的 Python 程序。发出连接信号时调用插槽。

PyQt5 信号和插槽

这是一个简单的示例,演示 PyQt5 中的信号和插槽。

signals_slots.py

import sys
from PyQt5.QtCore import Qt
from PyQt5.QtWidgets import (QWidget, QLCDNumber, QSlider,
                             QVBoxLayout, QApplication)


class Example(QWidget):

    def __init__(self):
        super().__init__()

        self.initUI()


    def initUI(self):

        lcd = QLCDNumber(self)
        sld = QSlider(Qt.Horizontal, self)

        vbox = QVBoxLayout()
        vbox.addWidget(lcd)
        vbox.addWidget(sld)

        self.setLayout(vbox)
        sld.valueChanged.connect(lcd.display)

        self.setGeometry(300, 300, 250, 150)
        self.setWindowTitle('Signal and slot')
        self.show()


def main():
    app = QApplication(sys.argv)
    ex = Example()
    sys.exit(app.exec_())


if __name__ == '__main__':
    main()

在我们的示例中,我们展示了QtGui.QLCDNumberQtGui.QSlider部件。我们通过拖动滑块旋钮来更改lcd的数字。

sld.valueChanged.connect(lcd.display)

在这里,我们将滑块的valueChanged信号连接到lcd数字的display插槽。

发送方是发送信号的对象。接收器是接收信号的对象。插槽是响应信号的方法。

image-20200819141726404

图:信号和插槽

PyQt5 重新实现事件处理程序

PyQt5 中的事件通常由重新实现的事件处理程序进行处理。

reimplement_handler.py

import sys
from PyQt5.QtCore import Qt
from PyQt5.QtWidgets import QWidget, QApplication


class Example(QWidget):

    def __init__(self):
        super().__init__()

        self.initUI()

    def initUI(self):
        self.setGeometry(300, 300, 250, 150)
        self.setWindowTitle('Event handler')
        self.show()

    def keyPressEvent(self, e):
        if e.key() == Qt.Key_Escape:
            self.close()


def main():
    app = QApplication(sys.argv)
    ex = Example()
    sys.exit(app.exec_())


if __name__ == '__main__':
    main()

在我们的示例中,我们重新实现事件处理程序keyPressEvent()

def keyPressEvent(self, e):

    if e.key() == Qt.Key_Escape:
        self.close()

如果我们单击"Escape“按钮(键盘的ESC键),应用程序将终止。

PyQt5 中的事件对象

事件对象是一个 Python 对象,其中包含描述事件的多个属性。事件对象特定于生成的事件类型。

event_object.py

import sys
from PyQt5.QtCore import Qt
from PyQt5.QtWidgets import QWidget, QApplication, QGridLayout, QLabel


class Example(QWidget):

    def __init__(self):
        super().__init__()

        self.initUI()

    def initUI(self):
        grid = QGridLayout()

        x = 0
        y = 0

        self.text = f'x: {x},  y: {y}'

        self.label = QLabel(self.text, self)
        grid.addWidget(self.label, 0, 0, Qt.AlignTop)

        self.setMouseTracking(True)

        self.setLayout(grid)

        self.setGeometry(300, 300, 450, 300)
        self.setWindowTitle('Event object')
        self.show()

    def mouseMoveEvent(self, e):
        x = e.x()
        y = e.y()

        text = f'x: {x},  y: {y}'
        self.label.setText(text)


def main():
    app = QApplication(sys.argv)
    ex = Example()
    sys.exit(app.exec_())


if __name__ == '__main__':
    main()

在此示例中,我们在标签部件中显示鼠标指针的 x 和 y 坐标。

self.text = f'x: {x},  y: {y}'

self.label = QLabel(self.text, self)

x 和 y 坐标显示在QLabel部件中。

self.setMouseTracking(True)

默认情况下,鼠标跟踪处于禁用状态,因此部件仅在移动鼠标时至少按下一个鼠标按钮时才收到鼠标移动事件。如果启用鼠标跟踪,则即使未按下任何按钮,部件也将收到鼠标移动事件。

def mouseMoveEvent(self, e):

    x = e.x()
    y = e.y()

    text = f'x: {x},  y: {y}'
    self.label.setText(text)

e是事件对象,它包含有关触发事件的数据。在我们的案例中,e是鼠标移动事件。使用x()y()方法,我们确定鼠标指针的 x 和 y 坐标。我们生成字符串并设置为标签部件的内容。

image-20200819142642009

图:事件对象

PyQt5 事件发送者

有时,知道哪个部件是信号的发送者是很方便的。为此,PyQt5 具有sender方法。

event_sender.py

import sys
from PyQt5.QtWidgets import QMainWindow, QPushButton, QApplication


class Example(QMainWindow):

    def __init__(self):
        super().__init__()

        self.initUI()

    def initUI(self):
        btn1 = QPushButton("Button 1", self)
        btn1.move(30, 50)

        btn2 = QPushButton("Button 2", self)
        btn2.move(150, 50)

        btn1.clicked.connect(self.buttonClicked)
        btn2.clicked.connect(self.buttonClicked)

        self.statusBar()

        self.setGeometry(300, 300, 450, 350)
        self.setWindowTitle('Event sender')
        self.show()

    def buttonClicked(self):
        sender = self.sender()
        self.statusBar().showMessage(sender.text() + ' was pressed')


def main():
    app = QApplication(sys.argv)
    ex = Example()
    sys.exit(app.exec_())


if __name__ == '__main__':
    main()

我们的示例有两个按钮。在buttonClicked方法中,我们通过调用sender()方法确定单击的按钮。

btn1.clicked.connect(self.buttonClicked)
btn2.clicked.connect(self.buttonClicked)

两个按钮都连接到同一插槽。

def buttonClicked(self):

    sender = self.sender()
    self.statusBar().showMessage(sender.text() + ' was pressed')

我们通过调用sender()方法确定信号源。在应用程序的状态栏中,我们显示按下按钮的标签。

image-20200819143108993

图:事件发送者

PyQt5 发射信号

QObject中创建的对象可以发出信号。下面的示例演示我们如何发出自定义信号。

custom_signal.py

import sys
from PyQt5.QtCore import pyqtSignal, QObject
from PyQt5.QtWidgets import QMainWindow, QApplication


class Communicate(QObject):

    closeApp = pyqtSignal()


class Example(QMainWindow):

    def __init__(self):
        super().__init__()

        self.initUI()

    def initUI(self):

        self.c = Communicate()
        self.c.closeApp.connect(self.close)

        self.setGeometry(300, 300, 450, 350)
        self.setWindowTitle('Emit signal')
        self.show()

    def mousePressEvent(self, event):

        self.c.closeApp.emit()


def main():
    app = QApplication(sys.argv)
    ex = Example()
    sys.exit(app.exec_())


if __name__ == '__main__':
    main()

我们创建一个名为closeApp的新信号。此信号在鼠标按下事件期间发出。信号连接到QMainWindowclose()插槽。

class Communicate(QObject):

    closeApp = pyqtSignal()

使用pyqtSignal()作为外部类Communicate的类属性创建信号。

self.c = Communicate()
self.c.closeApp.connect(self.close)

自定义closeApp信号连接到QMainWindowclose()插槽。

def mousePressEvent(self, event):

    self.c.closeApp.emit()

当我们用鼠标指针单击窗口时,closeApp信号会发出。应用程序终止。

在 PyQt5 教程的这一部分中,我们介绍了信号和插槽。