aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/extras/PySide.QtCore.Slot.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside2/doc/extras/PySide.QtCore.Slot.rst')
-rw-r--r--sources/pyside2/doc/extras/PySide.QtCore.Slot.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/sources/pyside2/doc/extras/PySide.QtCore.Slot.rst b/sources/pyside2/doc/extras/PySide.QtCore.Slot.rst
new file mode 100644
index 000000000..6b93014cf
--- /dev/null
+++ b/sources/pyside2/doc/extras/PySide.QtCore.Slot.rst
@@ -0,0 +1,39 @@
+.. module:: PySide2.QtCore
+.. _Slot:
+
+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.
+
+ PyQt'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
+ ======= ====================== =============
+
+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.:
+
+ ::
+
+ class Foo(QObject):
+
+ @Slot(result=int, float)
+ def getFloatReturnInt(self, f):
+ return int(f)