Interactions (interactions)

User Interaction Handlers

User interaction handlers for a SchemeEditWidget.

User interactions encapsulate the logic of user interactions with the scheme document.

All interactions are subclasses of UserInteraction.

class orangecanvas.document.interactions.UserInteraction(document: SchemeEditWidget, parent: QObject | None = None, deleteOnEnd: bool = True)

Bases: QObject

Base class for user interaction handlers.

Parameters:

• document (SchemeEditWidget) – An scheme editor instance with which the user is interacting.

• parent (QObject, optional) – A parent QObject

• deleteOnEnd (bool, optional) – Should the UserInteraction be deleted when it finishes (True by default).

started()

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

finished()

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

ended()

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

canceled()

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

NoReason = 0

No specified reason

UserCancelReason = 1

User canceled the operation (e.g. pressing ESC)

InteractionOverrideReason = 3

Another interaction was set

ErrorReason = 4

An internal error occurred

OtherReason = 5

Other (unspecified) reason

start() → None

Start the interaction. This is called by the CanvasScene when the interaction is installed.

Note

Must be called from subclass implementations.

end() → None

Finish the interaction. Restore any leftover state in this method.

Note

This gets called from the default cancel() implementation.

cancel(reason: int = 5) → None

Cancel the interaction with reason.

isFinished() → bool

Is the interaction finished.

isCanceled() → bool

Was the interaction canceled.

cancelReason() → int

Return the reason the interaction was canceled.

postQuickTip(contents: str) → None

Post a QuickHelpTipEvent with rich text contents to the document editor.

clearQuickTip()

Clear the quick tip help event.

mousePressEvent(event: QGraphicsSceneMouseEvent) → bool

Handle a QGraphicsScene.mousePressEvent.

mouseMoveEvent(event: QGraphicsSceneMouseEvent) → bool

Handle a GraphicsScene.mouseMoveEvent.

mouseReleaseEvent(event: QGraphicsSceneMouseEvent) → bool

Handle a QGraphicsScene.mouseReleaseEvent.

mouseDoubleClickEvent(event: QGraphicsSceneMouseEvent) → bool

Handle a QGraphicsScene.mouseDoubleClickEvent.

keyPressEvent(event: QKeyEvent) → bool

Handle a QGraphicsScene.keyPressEvent

keyReleaseEvent(event: QKeyEvent) → bool

Handle a QGraphicsScene.keyPressEvent

contextMenuEvent(event: QGraphicsSceneContextMenuEvent) → bool

Handle a QGraphicsScene.contextMenuEvent

dragEnterEvent(event: QGraphicsSceneDragDropEvent) → bool

Handle a QGraphicsScene.dragEnterEvent

Added in version 0.1.20.

dragMoveEvent(event: QGraphicsSceneDragDropEvent) → bool

Handle a QGraphicsScene.dragMoveEvent

Added in version 0.1.20.

dragLeaveEvent(event: QGraphicsSceneDragDropEvent) → bool

Handle a QGraphicsScene.dragLeaveEvent

Added in version 0.1.20.

dropEvent(event: QGraphicsSceneDragDropEvent) → bool

Handle a QGraphicsScene.dropEvent

Added in version 0.1.20.

class orangecanvas.document.interactions.DropAction(document, *args, dropHandlers: Sequence[DropHandler] = (), **kwargs)

Bases: UserInteraction

A drop action on the workflow.

dropHandlers() → Iterable[DropHandler]

Return an iterable over drop handlers.

canHandleDrop(event: QGraphicsSceneDragDropEvent) → bool

Can this interactions handle the drop event.

The default implementation checks each dropHandler if it accepts() the event. The first such handler that accepts is selected to be the designated handler and will receive the drop (doDrop()).

dragEnterEvent(event)

Handle a QGraphicsScene.dragEnterEvent

Added in version 0.1.20.

dragMoveEvent(event)

Handle a QGraphicsScene.dragMoveEvent

Added in version 0.1.20.

dragLeaveEvent(even)

Handle a QGraphicsScene.dragLeaveEvent

Added in version 0.1.20.

dropEvent(event)

Handle a QGraphicsScene.dropEvent

Added in version 0.1.20.

class orangecanvas.document.interactions.DropHandler

Bases: ABC

An abstract drop handler.

Added in version 0.1.20.

abstract accepts(document: SchemeEditWidget, event: QGraphicsSceneDragDropEvent) → bool

Returns True if a document can accept a drop of the data from event.

abstract doDrop(document: SchemeEditWidget, event: QGraphicsSceneDragDropEvent) → bool

Complete the drop of data from event onto the document.

class orangecanvas.document.interactions.DropHandlerAction

Bases: ABC

abstract actionFromDropEvent(document: SchemeEditWidget, event: QGraphicsSceneDragDropEvent) → QAction

Create and return an QAction representing a drop action.

This action is used to disambiguate between possible drop actions.

The action can have sub menus, however all actions in submenus must have the DropHandler instance set as their QAction.data().

The actions must not execute the actual drop from their triggered slot connections. The drop will be dispatched to the action.data() handler’s doDrop() after that action is triggered and the menu is closed.

class orangecanvas.document.interactions.NodeFromMimeDataDropHandler

Bases: DropHandler, DropHandlerAction

Create a new node from dropped mime data.

Subclasses must override canDropMimeData, parametersFromMimeData, and qualifiedName.

Added in version 0.1.20.

abstract qualifiedName() → str

The qualified name for the node created by this handler. The handler will not be invoked if this name does not appear in the registry associated with the workflow.

abstract canDropMimeData(document: SchemeEditWidget, data: QMimeData) → bool

Can the handler create a node from the drop mime data.

Reimplement this in a subclass to check if the data has appropriate format.

abstract parametersFromMimeData(document: SchemeEditWidget, data: QMimeData) → Dict[str, Any]

Return the node parameters based from the drop mime data.

accepts(document: SchemeEditWidget, event: QGraphicsSceneDragDropEvent) → bool

Reimplemented.

doDrop(document: SchemeEditWidget, event: QGraphicsSceneDragDropEvent) → bool

Reimplemented.

shouldActivateNode() → bool

Should the new dropped node activate (open GUI controller) immediately.

If this method returns True then the activateNode method will be called after the node has been added and the GUI controller created.

The default implementation returns False.

activateNode(document: SchemeEditWidget, node: Node, widget: QWidget) → None

Activate (open) the node’s GUI controller widget after a completed drop.

Reimplement this if the node requires further configuration via the GUI.

The default implementation delegates to the WidgetManager associated with the document.

actionFromDropEvent(document: SchemeEditWidget, event: QGraphicsSceneDragDropEvent) → QAction

Reimplemented.

class orangecanvas.document.interactions.PluginDropHandler(group='orangecanvas.document.interactions.DropHandler', **kwargs)

Bases: DropHandler

Delegate drop event processing to plugin drop handlers.

Added in version 0.1.20.

ENTRY_POINT = 'orangecanvas.document.interactions.DropHandler'

The default entry point group

iterEntryPoints() → Iterable[EntryPoint]

Return an iterator over all entry points.

entryPoints() → Iterable[Tuple[EntryPoint, DropHandler]]

Return an iterator over entry points and instantiated drop handlers.

accepts(document: SchemeEditWidget, event: QGraphicsSceneDragDropEvent) → bool

Reimplemented.

Accept the event if any plugin handlers accept the event.

doDrop(document: SchemeEditWidget, event: QGraphicsSceneDragDropEvent) → bool

Reimplemented.

Dispatch the drop to the plugin handler that accepted the event. In case there are multiple handlers that accepted the event, a menu is used to select the handler.