diff options
| author | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2018-12-18 16:57:12 +0100 |
|---|---|---|
| committer | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2019-01-10 20:00:56 +0000 |
| commit | 2fd7a5682667a9a87b7375e9516e73282281aaf7 (patch) | |
| tree | 6552e2728173b41cb381a0e10dad949ef763492e /sources | |
| parent | b0c04069b18f58696c6a87e02c8854628eb9988d (diff) | |
Doc: Update and fix the Slot documentation
Task-number: PYSIDE-691
Change-Id: I5a6691554b64b808591e3ed000f01ca0211167ab
Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'sources')
| -rw-r--r-- | sources/pyside2/doc/extras/PySide.QtCore.Slot.rst | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/sources/pyside2/doc/extras/PySide.QtCore.Slot.rst b/sources/pyside2/doc/extras/PySide.QtCore.Slot.rst index 6b93014cf..3bc64c03a 100644 --- a/sources/pyside2/doc/extras/PySide.QtCore.Slot.rst +++ b/sources/pyside2/doc/extras/PySide.QtCore.Slot.rst @@ -7,33 +7,33 @@ Slot Detailed Description -------------------- - PySide adopt PyQt's new signal and slot syntax as-is. The PySide - implementation is functionally compatible with the PyQt 4.5 one, with the - exceptions listed bellow. + 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. - PyQt's new signal and slot style utilizes method and decorator names + 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 PyQt factory function PySide class - ======= ====================== ============= - QtCore pyqtSignal Signal - QtCore pyqtSlot Slot - ======= ====================== ============= + ======= ======================= ============= + Module PyQt5 factory function PySide2 class + ======= ======================= ============= + QtCore pyqtSignal Signal + QtCore pyqtSlot Slot + ======= ======================= ============= Q_INVOKABLE ----------- - PySide doesn't offer something identical to Q_INVOKABLE macro of Qt, the - reason is simple, PySide slots can have return values, so if you need to - create a invokable method that returns some value, declare it as a slot, - e.g.: + 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(result=int, float) + @Slot(float, result=int) def getFloatReturnInt(self, f): return int(f) |