Workflow Events (events)

class orangecanvas.scheme.events.WorkflowEvent(etype)

Bases: PyQt5.QtCore.QEvent

NodeAdded = QEvent.Type(...)

Delivered to Scheme when a node has been added (NodeEvent)

NodeRemoved = QEvent.Type(...)

Delivered to Scheme when a node has been removed (NodeEvent)

LinkAdded = QEvent.Type(...)

A Link has been added to the scheme (LinkEvent)

LinkRemoved = QEvent.Type(...)

A Link has been removed from the scheme (LinkEvent)

InputLinkAdded = QEvent.Type(...)

An input Link has been added to a node (LinkEvent)

OutputLinkAdded = QEvent.Type(...)

An output Link has been added to a node (LinkEvent)

InputLinkRemoved = QEvent.Type(...)

An input Link has been removed from a node (LinkEvent)

OutputLinkRemoved = QEvent.Type(...)

An output Link has been removed from a node (LinkEvent)

NodeStateChange = QEvent.Type(...)

Node’s (runtime) state has changed (NodeEvent)

LinkStateChange = QEvent.Type(...)

Link’s (runtime) state has changed (LinkEvent)

InputLinkStateChange = QEvent.Type(...)

Input link’s (runtime) state has changed (LinkEvent)

OutputLinkStateChange = QEvent.Type(...)

Output link’s (runtime) state has changed (LinkEvent)

NodeActivateRequest = QEvent.Type(...)

Node user activate request (e.g. on double click in the canvas GUI)

WorkflowEnvironmentChange = QEvent.Type(...)

Workflow resource changed (e.g. work directory, env variable)

AnnotationAdded = QEvent.Type(...)

AnnotationRemoved = QEvent.Type(...)

AnnotationChange = QEvent.Type(...)

ActivateParentRequest = QEvent.Type(...)

Request activation (show and raise) of the window containing the workflow view

class orangecanvas.scheme.events.NodeEvent(etype, node, pos=- 1)

Bases: orangecanvas.scheme.events.WorkflowEvent

An event notifying the receiver of an workflow link change.

This event is used with:

• WorkflowEvent.NodeAdded

• WorkflowEvent.NodeRemoved

• WorkflowEvent.NodeStateChange

• WorkflowEvent.NodeActivateRequest

• WorkflowEvent.ActivateParentRequest

• WorkflowEvent.OutputLinkRemoved

Parameters

• etype (QEvent.Type) –

• node (SchemeNode) –

• pos (int) –

node() → SchemeNode

Returns

node – The node instance.

Return type

SchemeNode

pos() → int

For NodeAdded/NodeRemoved events this is the position into which the node is inserted or removed from (is -1 if not applicable))

New in version 0.1.16.

class orangecanvas.scheme.events.LinkEvent(etype, link, pos=- 1)

Bases: orangecanvas.scheme.events.WorkflowEvent

An event notifying the receiver of an workflow link change.

This event is used with:

• WorkflowEvent.LinkAdded

• WorkflowEvent.LinkRemoved

• WorkflowEvent.InputLinkAdded

• WorkflowEvent.InputLinkRemoved

• WorkflowEvent.OutputLinkAdded

• WorkflowEvent.OutputLinkRemoved

• WorkflowEvent.InputLinkStateChange

• WorkflowEvent.OutputLinkStateChange

Parameters

• etype (QEvent.Type) –

• link (SchemeLink) – The link subject to change

• pos (int) – The link position index.

link() → SchemeLink

Returns

link – The link instance.

Return type

SchemeLink

pos() → int

The index position into which the link was inserted.

For LinkAdded/LinkRemoved this is the index in the Scheme.links sequence from which the link was removed or was inserted into.

For InputLinkAdded/InputLinkRemoved it is the sequential position in the input links to the sink node.

For OutputLinkAdded/OutputLinkRemoved it is the sequential position in the output links from the source node.

New in version 0.1.16.

class orangecanvas.scheme.events.AnnotationEvent(etype, annotation, pos=- 1)

Bases: orangecanvas.scheme.events.WorkflowEvent

An event notifying the receiver of an workflow annotation changes

This event is used with:

• WorkflowEvent.AnnotationAdded

• WorkflowEvent.AnnotationRemoved

Parameters

• etype (QEvent.Type) –

• annotation (BaseSchemeAnnotation) – The annotation that is a subject of change.

• pos (int) –

annotation() → BaseSchemeAnnotation

Returns

annotation – The annotation instance.

Return type

BaseSchemeAnnotation

pos() → int

The index position of the annotation in the Scheme.annotations

New in version 0.1.16.

class orangecanvas.scheme.events.WorkflowEnvChanged(name, newValue, oldValue)

Bases: orangecanvas.scheme.events.WorkflowEvent

An event notifying the receiver of a workflow environment change.

Parameters

• name (str) – The name of the environment property that was changed

• newValue (Any) – The new value

• oldValue (Any) – The old value

See also

Scheme.runtime_env

name() → str

The name of the environment property.

oldValue() → Any

The old value.

newValue() → Any

The new value.