aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/extras/QtCore.Slot.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside2/doc/extras/QtCore.Slot.rst')
-rw-r--r--sources/pyside2/doc/extras/QtCore.Slot.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/sources/pyside2/doc/extras/QtCore.Slot.rst b/sources/pyside2/doc/extras/QtCore.Slot.rst
new file mode 100644
index 000000000..5a59a2ae3
--- /dev/null
+++ b/sources/pyside2/doc/extras/QtCore.Slot.rst
@@ -0,0 +1,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)