PySide6.QtCore.Signal

class Signal

Synopsis

Methods

Detailed Description

The Signal class provides a way to declare and connect Qt signals in a pythonic way.

See also

Signals and Slots

__init__([type1 [, type2...]] [, name="" [, arguments=[]]])
Parameters:

  • name – str

  • 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 Overloading Signals and Slots with Different Types).

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.

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.

connect(receiver[, type=Qt.AutoConnection])
Parameters:

Create a connection between this signal and a receiver.

disconnect(receiver)
Parameters:

receiver – Python callable, @Slot or Signal

Disconnect this signal from the receiver.

emit(*args)

Emits the signal. args is the arguments to pass to any connected slots, if any.