aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/extras/QtCore.Slot.rst
blob: 5a59a2ae354e1542ac8070f6c9677660897ce7dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.. currentmodule:: PySide2.QtCore
.. _Slot:

Slot
****

Detailed Description
--------------------

    PySide2 adopt PyQt5's new signal and slot syntax as-is. The PySide2
    implementation is functionally compatible with the PyQt5 one, with the
    exceptions listed below.

    PyQt5's new signal and slot style utilizes method and decorator names
    specific to their implementation. These will be generalized according to
    the table below:

    =======  =======================  =============
    Module   PyQt5 factory function   PySide2 class
    =======  =======================  =============
    QtCore   pyqtSignal               Signal
    QtCore   pyqtSlot                 Slot
    =======  =======================  =============

Q_INVOKABLE
-----------

    There is no equivalent of the Q_INVOKABLE macro of Qt
    since PySide2 slots can actually have return values.
    If you need to create a invokable method that returns some value,
    declare it as a slot, e.g.:

    ::

        class Foo(QObject):

            @Slot(float, result=int)
            def getFloatReturnInt(self, f):
                return int(f)