Scheme Editor (schemeedit)

Scheme Editor Widget

class orangecanvas.document.schemeedit.SchemeEditWidget(parent=None)

Bases: PyQt5.QtWidgets.QWidget

A widget for editing a Scheme instance.

undoAvailable(bool)

Undo command has become available/unavailable.

redoAvailable(bool)

Redo command has become available/unavailable.

modificationChanged(bool)

Document modified state has changed.

undoCommandAdded

Undo command was added to the undo stack.

selectionChanged

Item selection has changed.

titleChanged

Document title has changed.

pathChanged

Document path has changed.

class OpenAnchors(value)

Bases: enum.Enum

Interactions with individual anchors

Never = 'Never'

Channel anchors never separate

Always = 'Always'

Channel anchors separate on hover

OnShift = 'OnShift'

Channel anchors separate on hover on Shift key

toolbarActions() → List[PyQt5.QtWidgets.QAction]

Return a list of actions that can be inserted into a toolbar. At the moment these are:

• ‘Zoom in’ action

• ‘Zoom out’ action

• ‘Zoom Reset’ action

• ‘Clean up’ action (align to grid)

• ‘New text annotation’ action (with a size menu)

• ‘New arrow annotation’ action (with a color menu)

menuBarActions() → List[PyQt5.QtWidgets.QAction]

Return a list of actions that can be inserted into a QMenuBar.

isModified() → bool

Is the document is a modified state.

setModified(modified: bool) → None

Set the document modified state.

modified

Is the document is a modified state.

isModifiedStrict()

Is the document modified.

Run a strict check against all node properties as they were at the time when the last call to setModified(True) was made.

uncleanProperties()

Returns node properties differences since last clean state, excluding unclean nodes.

setQuickMenuTriggers(triggers: int) → None

Set quick menu trigger flags.

Flags can be a bitwise or of:

• SchemeEditWidget.NoTrigeres

• SchemeEditWidget.RightClicked

• SchemeEditWidget.DoubleClicked

• SchemeEditWidget.SpaceKey

• SchemeEditWidget.AnyKey

quickMenuTriggers() → int

Return quick menu trigger flags.

setChannelNamesVisible(visible: bool) → None

Set channel names visibility state. When enabled the links in the view will have a source/sink channel names displayed over them.

channelNamesVisible() → bool

Return the channel name visibility state.

setNodeAnimationEnabled(enabled: bool) → None

Set the node item animation enabled state.

nodeAnimationEnabled()

Return the node item animation enabled state.

undoStack() → PyQt5.QtWidgets.QUndoStack

Return the undo stack.

setPath(path: str) → None

Set the path associated with the current scheme.

Note

Calling setScheme will invalidate the path (i.e. set it to an empty string)

path() → str

Return the path associated with the scheme

setScheme(scheme: orangecanvas.scheme.scheme.Scheme) → None

Set the Scheme instance to display/edit.

ensureVisible(node: orangecanvas.scheme.node.SchemeNode) → None

Scroll the contents of the viewport so that node is visible.

Parameters

node (SchemeNode) –

scheme() → Optional[orangecanvas.scheme.scheme.Scheme]

Return the Scheme edited by the widget.

scene() → PyQt5.QtWidgets.QGraphicsScene

Return the QGraphicsScene instance used to display the current scheme.

view() → PyQt5.QtWidgets.QGraphicsView

Return the QGraphicsView instance used to display the current scene.

suggestions()

Return the widget suggestion prediction class.

usageStatistics()

Return the usage statistics logging class.

quickMenu() → orangecanvas.document.quickmenu.QuickMenu

Return a QuickMenu popup menu instance for new node creation.

setTitle(title: str) → None

Set the scheme title.

setDescription(description: str) → None

Set the scheme description string.

addNode(node: orangecanvas.scheme.node.SchemeNode) → None

Add a new node (SchemeNode) to the document.

createNewNode(description: orangecanvas.registry.description.WidgetDescription, title: Optional[str] = None, position: Optional[Tuple[float, float]] = None) → orangecanvas.scheme.node.SchemeNode

Create a new SchemeNode and add it to the document. The new node is constructed using newNodeHelper() method

newNodeHelper(description: orangecanvas.registry.description.WidgetDescription, title: Optional[str] = None, position: Optional[Tuple[float, float]] = None) → orangecanvas.scheme.node.SchemeNode

Return a new initialized SchemeNode. If title and position are not supplied they are initialized to sensible defaults.

enumerateTitle(title: str) → str

Enumerate a title string (i.e. add a number in parentheses) so it is not equal to any node title in the current scheme.

nextPosition() → Tuple[float, float]

Return the next default node position as a (x, y) tuple. This is a position left of the last added node.

removeNode(node: orangecanvas.scheme.node.SchemeNode) → None

Remove a node (SchemeNode) from the scheme

renameNode(node: orangecanvas.scheme.node.SchemeNode, title: str) → None

Rename a node (SchemeNode) to title.

addLink(link: orangecanvas.scheme.link.SchemeLink) → None

Add a link (SchemeLink) to the scheme.

removeLink(link: orangecanvas.scheme.link.SchemeLink) → None

Remove a link (SchemeLink) from the scheme.

insertNode(new_node: orangecanvas.scheme.node.SchemeNode, old_link: orangecanvas.scheme.link.SchemeLink) → None

Insert a node in-between two linked nodes.

addAnnotation(annotation: orangecanvas.scheme.annotations.BaseSchemeAnnotation) → None

Add annotation (BaseSchemeAnnotation) to the scheme

removeAnnotation(annotation: orangecanvas.scheme.annotations.BaseSchemeAnnotation) → None

Remove annotation (BaseSchemeAnnotation) from the scheme.

removeSelected() → None

Remove all selected items in the scheme.

selectAll() → None

Select all selectable items in the scheme.

alignToGrid() → None

Align nodes to a grid.

focusNode() → Optional[orangecanvas.scheme.node.SchemeNode]

Return the current focused SchemeNode or None if no node has focus.

selectedNodes() → List[orangecanvas.scheme.node.SchemeNode]

Return all selected SchemeNode items.

selectedAnnotations() → List[orangecanvas.scheme.annotations.BaseSchemeAnnotation]

Return all selected BaseSchemeAnnotation items.

openSelected() → None

Open (show and raise) all widgets for the current selected nodes.

editNodeTitle(node: orangecanvas.scheme.node.SchemeNode) → None

Edit (rename) the node’s title.

setDropHandlers(dropHandlers: Sequence[orangecanvas.document.interactions.DropHandler]) → None

Set handlers for drop events onto the workflow view.

changeEvent(self, a0: Optional[QEvent])

eventFilter(self, a0: Optional[QObject], a1: Optional[QEvent]) → bool

activateDefaultWindowGroup() → bool

Activate the default window group if one exists.

Return True if a default group exists and was activated; False if not.

widgetManager() → Optional[orangecanvas.scheme.widgetmanager.WidgetManager]

Return the widget manager.