pyworkflow.gui.canvas module

This module extends the functionalities of a normal Tkinter Canvas. The new Canvas class allows to easily display Texboxes and Edges that can be interactively dragged and clicked.

class pyworkflow.gui.canvas.Cable(canvas, src, srcConnector, dst, dstConnector)

Bases: object

dstMoved(dx, dy)

paint()

paintPlugs()

srcMoved(dx, dy)

updateCoords()

class pyworkflow.gui.canvas.Canvas(parent, tooltipCallback=None, tooltipDelay=1500, **kwargs)

Bases: Canvas, Scrollable

Canvas to draw some objects. It will really contains a Frame, a Canvas and scrollbars

Construct a canvas widget with the parent MASTER.

Valid resource names: background, bd, bg, borderwidth, closeenough, confine, cursor, height, highlightbackground, highlightcolor, highlightthickness, insertbackground, insertborderwidth, insertofftime, insertontime, insertwidth, offset, relief, scrollregion, selectbackground, selectborderwidth, selectforeground, state, takefocus, width, xscrollcommand, xscrollincrement, yscrollcommand, yscrollincrement.

addItem(item)

clear()

Clear all items from the canvas

createCable(src, srcSocket, dst, dstSocket)

createEdge(srcItem, dstItem)

createRoundedTextbox(text, x, y, bgColor='#99DAE8', textColor='black')

createTextCircle(text, x, y, bgColor='#99DAE8', textColor='black')

createTextbox(text, x, y, bgColor='#99DAE8', textColor='black')

drawGraph(graph, layout=None, drawNode=None, nodeList=None)

Draw a graph in the canvas. nodes in the graph should have x and y. If layout is not None, it will be used to reorganize the node positions. Provide drawNode if you want to customize how to create the boxes for each graph node.

getCoordinates(event)

Converts the events coordinates to canvas coordinates

getImage(img)

getRunsFont()

hideTooltip(e=None)

moveTo(x, y)

move_start(event)

multipleItemsSelected()

Returns True if more than one box selected, False otherwise. TODO: add numItemsSelected as attribute to Canvas class and update when selection changes

onButton1Release(event)

onClick(event)

onControlClick(event)

onDoubleClick(event)

onDrag(event)

onLeave(event)

onMotion(event)

onRightClick(e=None)

reorganizeGraph(graph, layout=None)

selectItem(item)

updateScrollRegion()

zoomerM(event)

zoomerP(event)

class pyworkflow.gui.canvas.ColoredConnector(canvas, x, y, name, fillColor='blue', outline='black')

Bases: Connector

class pyworkflow.gui.canvas.Connector(canvas, x, y, name)

Bases: Item

Default connector has no graphical representation (hence, it’ss invisible). Subclasses offer different looks

move(dx, dy)

paintPlug(canvas, x, y)

Should be implemented by the subclasses

paintSocket()

Should be implemented by the subclasses

class pyworkflow.gui.canvas.Edge(canvas, source, dest)

Bases: object

Edge between two objects

paint()

updateColor(value)

updateDst(dx, dy)

updateSrc(dx, dy)

class pyworkflow.gui.canvas.Item(canvas, x, y)

Bases: object

BOTTOM = 2

LEFT = 3

RIGHT = 1

TOP = 0

addPositionListener(listenerFunc)

addSelectionListener(listenerFunc)

addSocket(name, socketClass, verticalLocation, fillColor='blue', outline='black', position=None)

countSockets(verticalLocation)

getBottomConnectorCoordinates()

getCenter(x1, y1, x2, y2)

getConnectorsCoordinates()

getCorners()

getDimensions()

getInputConnectorCoordinates()

getLeftConnectorCoordinates()

getOutputConnectorCoordinates()

getRightConnectorCoordinates()

getSelected()

getSocket(name)

getSocketCoords(name)

getSocketCoordsAt(verticalLocation, position=1, socketsCount=1)

getSocketsAt(verticalLocation)

getTopConnectorCoordinates()

getUpDownConnectorsCoordinates()

lift()

lower()

move(dx, dy)

moveTo(x, y)

Move TextBox to a new position (x,y)

paintSocket(socket)

paintSockets()

relocateSockets(verticalLocation, count)

setSelected(value)

socketSeparation = 12

verticalFlow = True

class pyworkflow.gui.canvas.Oval(canvas, x, y, radio, color='green', anchor=None)

Bases: object

Oval or circle

paint()

selectionListener(value)

updateSrc(dx, dy)

class pyworkflow.gui.canvas.Rectangle(canvas, x, y, width, height=None, color='green', anchor=None)

Bases: object

paint()

selectionListener(value)

updateSrc(dx, dy)

class pyworkflow.gui.canvas.RoundConnector(canvas, x, y, name, fillColor='blue', outline='black')

Bases: ColoredConnector

paintPlug()

Should be implemented by the subclasses

paintSocket()

Should be implemented by the subclasses

radius = 3

class pyworkflow.gui.canvas.RoundedTextBox(canvas, text, x, y, bgColor, textColor='black')

Bases: TextItem

getDimensions()

class pyworkflow.gui.canvas.SquareConnector(canvas, x, y, name, fillColor='blue', outline='black')

Bases: ColoredConnector

halfside = 3

paintPlug()

Should be implemented by the subclasses

paintSocket()

Should be implemented by the subclasses

class pyworkflow.gui.canvas.TextBox(canvas, text, x, y, bgColor, textColor='black')

Bases: TextItem

class pyworkflow.gui.canvas.TextCircle(canvas, text, x, y, bgColor, textColor='black')

Bases: TextItem

class pyworkflow.gui.canvas.TextItem(canvas, text, x, y, bgColor, textColor='black')

Bases: Item

This class will serve to paint and store rectangle boxes with some text. x and y are the coordinates of the center of this item

lift()

lower()

move(dx, dy)

paint()

Paint the object in a specific position.

pyworkflow.gui.canvas.findClosestConnectors(item1, item2)

pyworkflow.gui.canvas.findClosestPoints(list1, list2)

pyworkflow.gui.canvas.findStrictClosestConnectors(item1, item2)

pyworkflow.gui.canvas.findUpDownClosestConnectors(item1, item2)

pyworkflow.gui.canvas.getConnectors(itemSource, itemDest)