diff options
Diffstat (limited to 'sources/pyside6/doc/extras/QtCore.Signal.rst')
| -rw-r--r-- | sources/pyside6/doc/extras/QtCore.Signal.rst | 49 |
1 files changed, 34 insertions, 15 deletions
diff --git a/sources/pyside6/doc/extras/QtCore.Signal.rst b/sources/pyside6/doc/extras/QtCore.Signal.rst index 60c611482..c83a76a83 100644 --- a/sources/pyside6/doc/extras/QtCore.Signal.rst +++ b/sources/pyside6/doc/extras/QtCore.Signal.rst @@ -1,8 +1,5 @@ .. currentmodule:: PySide6.QtCore -.. _Signal: - -Signal -****** +.. py:class:: Signal Synopsis -------- @@ -10,30 +7,52 @@ Synopsis Functions ^^^^^^^^^ -+---------------------------------------------------------------------------------------------+ -|def :meth:`connect<Signal.connect>` (receiver) | -+---------------------------------------------------------------------------------------------+ -|def :meth:`disconnect<Signal.disconnect>` (receiver) | -+---------------------------------------------------------------------------------------------+ -|def :meth:`emit<Signal.disconnect>` (\*args) | -+---------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+ +|def :meth:`connect<Signal.connect>` (receiver) | ++-----------------------------------------------------+ +|def :meth:`disconnect<Signal.disconnect>` (receiver) | ++-----------------------------------------------------+ +|def :meth:`emit<Signal.disconnect>` (\*args) | ++-----------------------------------------------------+ Detailed Description -------------------- - The :class:`~.Signal` class provides a way to declare and connect Qt signals in a pythonic way. +The :class:`~.Signal` class provides a way to declare and connect Qt +signals in a pythonic way. + +.. class:: PySide6.QtCore.Signal([type1 [, type2...]] [, name="" [, arguments=[]]]) + + :param name: str + :param arguments: list + +``Signal`` takes a list of Python types of the arguments. + + It is possible to use the same signal name with different types by + passing a list of tuples representing the signatures, but this is a legacy + technique recommended against in new code (see + :ref:`overloading-signals-and-slots`). + +The optional named argument ``name`` defines the signal name. If nothing is +passed, the new signal will have the same name as the variable that it is +being assigned to. - 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. +The optional named argument ``arguments`` receives a list of strings +denoting the argument names. This is useful for QML applications which +may refer to the emitted values by name. .. method:: Signal.connect(receiver[, type=Qt.AutoConnection]) - Create a connection between this signal and a `receiver`, the `receiver` can be a Python callable, a :class:`Slot` or a :class:`Signal`. + Create a connection between this signal and a `receiver`, the `receiver` + can be a Python callable, a :class:`Slot` or a :class:`Signal`. .. method:: Signal.disconnect(receiver) - Disconnect this signal from a `receiver`, the `receiver` can be a Python callable, a :class:`Slot` or a :class:`Signal`. + Disconnect this signal from a `receiver`, the `receiver` can be a Python + callable, a :class:`Slot` or a :class:`Signal`. .. method:: Signal.emit(*args) `args` is the arguments to pass to any connected slots, if any. +.. seealso:: :ref:`signals-and-slots` |