Element: signal.raise ( )

Type

numeric func

Description

A function to raise a signal, thereby invoking callbacks for all listeners to the signal.

The number of callbacks executed is returned when successful; -1 is returned on error.

The code of the function cannot be redefined.

Parameters

<signal>.raise (<object>,<data>)

e.g.

mysig.raise(myobj,'text value')

Where myobj is a generic identifier associated with the raising of the signal, and 'text value' is a generic parameter. Both these, together with the signal name, are then passed to the callbacks of all objects listening for this signal.

The invocation of such a listener callback would take the following form:

<listener>.<callback>(mysig,myobj,'text value')

See Also

Commands:

signal

Functions:

signal.add_listener, signal.remove_listener

Structures:

signal