PyQt5 signals and slots Graphical applications (GUI) are event-driven, unlike console or terminal applications. A users action like clicks a button or selecting an item in a list is called an event. If an event takes place, each PyQt5 widget can emit a signal. PyQt5 - Lesson 007. Works with QML QtQuick (Signals and slots). And now we will go deeper into the work with Qt using PyQt5, taking advantage of modern Qt features. By such possibilities I mean QtQuick and QML. PyQt5 allows you to use Qt classes that can.

1. Pyqt Signals And Slots
2. How To Use Pyqt Signals And Slots Using
3. How To Use Pyqt Signals And Slots Games

• PyQt5 Tutorial
• PyQt5 Useful Resources

• Selected Reading

Unlike a console mode application, which is executed in a sequential manner, a GUI based application is event driven. Functions or methods are executed in response to user’s actions like clicking on a button, selecting an item from a collection or a mouse click etc., called events.

Widgets used to build the GUI interface act as the source of such events. Each PyQt widget, which is derived from QObject class, is designed to emit ‘signal’ in response to one or more events. The signal on its own does not perform any action. Instead, it is ‘connected’ to a ‘slot’. The slot can be any callable Python function.

Using Qt Designer's Signal/Slot Editor

First design a simple form with a LineEdit control and a PushButton.

It is desired that if button is pressed, contents of text box should be erased. The QLineEdit widget has a clear() method for this purpose. Hence, the button’s clicked signal is to be connected to clear() method of the text box.

To start with, choose Edit signals/slots from Edit menu (or press F4). Then highlight the button with mouse and drag the cursor towards the textbox

As the mouse is released, a dialog showing signals of button and methods of slot will be displayed. Select clicked signal and clear() method

The Signal/Slot Editor window at bottom right will show the result −

Save ui and Build and Python code from ui file as shown in the below code −

Generated Python code will have the connection between signal and slot by the following statement −

Run signalslot.py and enter some text in the LineEdit. The text will be cleared if the button is pressed.

Building Signal-slot Connection

Instead of using Designer, you can directly establish signal-slot connection by following syntax −

Suppose if a function is to be called when a button is clicked. Here, the clicked signal is to be connected to a callable function. It can be achieved in any of the following technique −

Example

In the following example, two QPushButton objects (b1 and b2) are added in QDialog window. We want to call functions b1_clicked() and b2_clicked() on clicking b1 and b2 respectively.

When b1 is clicked, the clicked() signal is connected to b1_clicked() function −

When b2 is clicked, the clicked() signal is connected to b2_clicked() function.

Pyqt Signals And Slots

The above code produces the following output −

Output

QGIS Tutorials

This tutorial is part of our QGIS tutorial series:

This is a brief explanation of the concept of signal and slot in PyQt5, which is the GUI framework for QGIS plugins.

In summary, this very much resembles events and callbacks in JavaScript. It's an asynchronous mechanism to let one part of a program know when another part of a program was updated, which is a most crucial concept in GUI programming. You master signal/slot, you master a whole lot about plugin development in QGIS.

General concept

Generally a signal is a trigger which can be emitted (hence the term signal) and carry an arbitrary amount of information when it is emitted.

The signal can be connected to a slot, which needs to be Python callable (in other words, a method or a class, anything implementing the __call__ magic), which can be any arbitrary function. The slot can accept the information which is emitted by the signal to process it further.

This is useful when one object needs to know about the actions of another object. For instance, if your plugin features a button that should paste the clipboard contents into a text field, then your plugin would need to know which function to call once the button is clicked. This is typically done via signal and slot.

Signal

A signalhas to be a class attribute of a descendant of QObject. Any QGIS widget and almost all GUI classes are descendants of QObject (i.e. have QObject as the very basic parent class) and they all come with predefined signals, such as QgsFilterLineEdit's valueChanged signal, which is triggered when a user changes the text of the widget.

Definition

A signal has the general definition of PyQt5.QtCore.pyqtSignal(types), where types will be the data type(s) a signal can emit:

• any basic Python data type (int, str, list etc.) or C++ type. In the latter case it needs to be defined as a string, e.g. pyqtSignal(int) or pyqtSignal('QgsPointXY')
• multiple Python or C++ types, which will emit several values, e.g. pyqtSignal(int, str) will take two arguments
• multiple sequences, which will create multiple versions of the signal, i.e. signal overloads, e.g. pyqtSignal([int], ['QgsPointXY'])

The first two options are fairly easy to grasp. However, the latter is a little more mysterious. Basically, overloaded signatures are a way to define the same object or class in multiple ways (you might call it Schrödinger's signal). The concept of overloaded class definitions is not really a thing in Python, though it can be done. If you define a signal with overloaded signatures, it's like you're creating the same object multiple times with different arguments, e.g. the example above would translate to:

This method to define a signal is a little more elaborate as we'll see soon, but very handy.

Methods

connect()

This method connects the signal to a slot. I.e. the signal can connect to a function, which takes its arguments and does something with them. For all practical purposes, you'll only need to pass the slot function to connect(). Each signal can connect to an arbitrary amount of slot functions.

disconnect()

Often you want to disconnect a slot from its signal to control whether the slot function should still be executed when the signal is triggered. You can either pass the specific slot function or nothing, in which case all slots for the signal will be disconnected.

emit()

When called, it emits values of the data types you specified when defining the signal (if any). These values have to be in the same order as in the definition, i.e. if pyqtSignal(int, str) was the definition, the signal needs to e.g. emit(4, 'blabla'), not emit('blabla', 4).

Examples

Let's see how this would work with more practical examples. To more relate to QGIS plugins, I'll use a similar (harshly abstracted) barebone structure as in our Interactive QGIS Plugin tutorial to depict the general usage when e.g. defining a new Map Tool (QgsMapTool).

How To Use Pyqt Signals And Slots Using

Simple Example

How To Use Pyqt Signals And Slots Games

This is only non-working pseudo-code, which will just demonstrate the general usage. A map tool is created which implements a canvasReleaseEvent event emitting a custom signal when triggered. This signal connects to a custom slot function in the main plugin code.

So, this hypothetical plugin would capture the point clicked by a user upon releasing the mouse button and print the WKT (Well Known Text) representation of that point to the Python console. Not very useful, I know, but I hope it gets the point across.

Overloaded signal example

Let's get a little fancier and say we want to print the distance of that point to our location when we click the mouse, but the WKT representation when we release the mouse button.

We can achieve this with the exact same signal if we define it with an overloaded signature. Yep, finally seeing how a Schrödinger's signal can work:

We now defined another canvasPressEvent, which will be triggered if the user presses the map canvas while the NewMapTool is active.

Since we defined our canvasClicked event now with the overloaded signature pyqtSignal([int], ['QgsPointXY']), we need to watch out that we only call the right signature for connect() and emit(). If we would omit the specific signature when calling these functions, they would use the first signature they find, which would be int in this case.

We connected both signatures to separate functions. Now, when the user clicks in the map canvas, the distance of the point to 13.413513, 52.491019 will be printed (*), when he releases the mouse button, the point's WKT representation will be printed.

Be aware however, that overloaded signatures have a catch: the Python data types in the pyqtSignal definition are converted to C++ types and some combinations can lead to undesired outcomes. E.g. pyqtSignal(, [dict]) will be converted to the same C++ data type. Calling emit() or connect() on the dict signature will be interpreted as calling the method on the list signature instead.

(*) Note, that those coordinates are in X, Y WGS84. The point captured by the canvasPressEvent depends on the map canvas CRS which is likely different, so you'd need to transform. Even if it were WGS84, the distance would be in degrees.