This page describes the use of signals and slots in Qt for Python.The emphasis is on illustrating the use of so-called new-style signals and slots, although the traditional syntax is also given as a reference.
@Asimov said in Can someone explain how the new qt5 signals and slots work: I probably only scratched the surface with signals and slots, but I am progressing slowly. If you understand the old syntax and understand how pointer-to-member (and/or function pointers) work then you know it all.
The main goal of this new-style is to provide a more Pythonic syntax to Python programmers.
QtCore.SIGNAL() and QtCore.SLOT() macros allow Python to interface with Qt signal and slot delivery mechanisms.This is the old way of using signals and slots.
The example below uses the well known clicked signal from a QPushButton.The connect method has a non python-friendly syntax.It is necessary to inform the object, its signal (via macro) and a slot to be connected to.
The new-style uses a different syntax to create and to connect signals and slots.The previous example could be rewritten as:
Signals can be defined using the QtCore.Signal() class.Python types and C types can be passed as parameters to it.If you need to overload it just pass the types as tuples or lists.
In addition to that, it can receive also a named argument name that defines the signal name.If nothing is passed as name then the new signal will have the same name as the variable that it is being assigned to.
The Examples section below has a collection of examples on the use of QtCore.Signal().
Note: Signals should be defined only within classes inheriting from QObject.This way the signal information is added to the class QMetaObject structure.
Slots are assigned and overloaded using the decorator QtCore.Slot().Again, to define a signature just pass the types like the QtCore.Signal() class.Unlike the Signal() class, to overload a function, you don't pass every variation as tuple or list.Instead, you have to define a new decorator for every different signature.The examples section below will make it clearer.
Another difference is about its keywords.Slot() accepts a name and a result.The result keyword defines the type that will be returned and can be a C or Python type.name behaves the same way as in Signal().If nothing is passed as name then the new slot will have the same name as the function that is being decorated.
The examples below illustrate how to define and connect signals and slots in PySide2.Both basic connections and more complex examples are given.
Qt5 alpha has been released. One of the features which I have been working on is a new syntax for signals and slot.This blog entry will present it.
Here is how you would connect a signal to a slot:
What really happens behind the scenes is that the SIGNAL
and SLOT
macros will convert their argument to a string. Then QObject::connect()
will compare those strings with the introspection data collected by the moc tool.
While working fine in general, we can identify some issues:
typedef
or namespacesIn the upcoming Qt5, an alternative syntax exist. The former syntax will still work. But you can now also use this new way of connecting your signals to your slots:
Which one is the more beautiful is a matter of taste. One can quickly get used to the new syntax.
So apart from the aesthetic point of view, let us go over some of the things that it brings us:
You will get a compiler error if you misspelled the signal or slot name, or if the arguments of your slot do not match those from the signal.
This might save you some time while you are doing some re-factoring and change the name or arguments of signals or slots.
An effort has been made, using static_assert to get nice compile errors if the arguments do not match or of you miss a Q_OBJECT
Not only you can now use typedef
or namespaces properly, but you can also connect signalsto slots that take arguments of different types if an implicit conversion is possible
In the following example, we connect a signal that has a QString
as a parameter to a slot that takes a QVariant
. It works because QVariant
has an implicit constructor that takes a QString
As you might have seen in the previous example, the slot was just declared as public
and not as slot
. Qt will indeed call directly the function pointer of the slot, andwill not need moc
introspection anymore. (It still needs it for the signal)
But what we can also do is connecting to any function or functor:
This can become very powerful when you associate that with boost or tr1::bind
.
Everything documented here works with the plain old C++98. But if you use compiler that supportsC++11, I really recommend you to use some of the language's new features.Lambda expressions are supportedby at least MSVC 2010, GCC 4.5, clang 3.1. For the last two, you need to pass -std=c++0x asa flag.
You can then write code like:
This allows you to write asynchronous code very easily.
Update: Also have a look what other C++11 features Qt5 offers.
It is time to try it out. Check out the alpha and start playing. Don't hesistate to report bugs.