pyworkflow.gui.tree module

class pyworkflow.gui.tree.AttributesTreeProvider(item)

Bases: pyworkflow.gui.tree.ListTreeProviderString

getObjectInfo(obj)

This function will be called by the Tree with each object that will be inserted. A dictionary should be returned with the possible following entries: ‘key’: the key value to insert in the Tree ‘text’: text of the object to be displayed

(if not passed the ‘key’ will be used)

‘image’: image path to be displayed as icon (optional) ‘parent’: the object’s parent in which insert this object (optional) ‘tags’: list of tags names (optional)

getText(obj)

Get the text to display for an object.

getValues(obj)

class pyworkflow.gui.tree.BoundTree(master, provider, frame=True, **opts)

Bases: pyworkflow.gui.tree.Tree

This class is base on Tree but fetch the items from a TreeProvider, which provides columns values for each item and items info to insert into the Tree

getColumnKeyByColumnName(columnName)

getObjectFromId(treeId)

Return the corresponding object from a given Tree item id.

getSelectedObjects()

itemConfig(obj, **args)

Configure inserted items.

iterSelectedObjects()

setProvider(provider)

Set new provider and updated items.

sortTree(heading, column)

update()

Enter event loop until all pending events have been processed by Tcl.

class pyworkflow.gui.tree.DbTreeProvider(dbName, classesDict)

Bases: pyworkflow.gui.tree.ObjectTreeProvider

Retrieve the elements from the database

class pyworkflow.gui.tree.ListTreeProvider(objList=None)

Bases: pyworkflow.gui.tree.TreeProvider

Simple list tree provider.

getObjectInfo(obj)

This function will be called by the Tree with each object that will be inserted. A dictionary should be returned with the possible following entries: ‘key’: the key value to insert in the Tree ‘text’: text of the object to be displayed

(if not passed the ‘key’ will be used)

‘image’: image path to be displayed as icon (optional) ‘parent’: the object’s parent in which insert this object (optional) ‘tags’: list of tags names (optional)

getObjs()

Get the objects.

getText(obj)

Get the text to display for an object.

class pyworkflow.gui.tree.ListTreeProviderString(objList=None)

Bases: pyworkflow.gui.tree.ListTreeProvider

getText(obj)

Get the text to display for an object.

class pyworkflow.gui.tree.ListTreeProviderTemplate(objList=None)

Bases: pyworkflow.gui.tree.ListTreeProviderString

getObjectInfo(obj)

This function will be called by the Tree with each object that will be inserted. A dictionary should be returned with the possible following entries: ‘key’: the key value to insert in the Tree ‘text’: text of the object to be displayed

(if not passed the ‘key’ will be used)

‘image’: image path to be displayed as icon (optional) ‘parent’: the object’s parent in which insert this object (optional) ‘tags’: list of tags names (optional)

getText(obj)

Get the text to display for an object.

getValues(obj)

class pyworkflow.gui.tree.ObjectTreeProvider(objList=None)

Bases: pyworkflow.gui.tree.TreeProvider

Populate Tree from Objects.

getObjectActions(obj)

Return a list of tuples (key, action) were keys are the string options that will be display in the context menu and the actions are the functions to call when the specific action is selected. The first action in the list will be taken as the default one when the element is double-clicked.

getObjectInfo(obj)

This function will be called by the Tree with each object that will be inserted. A dictionary should be returned with the possible following entries: ‘key’: the key value to insert in the Tree ‘text’: text of the object to be displayed

(if not passed the ‘key’ will be used)

‘image’: image path to be displayed as icon (optional) ‘parent’: the object’s parent in which insert this object (optional) ‘tags’: list of tags names (optional)

getObjectPreview(obj)

Should return a tuple (img, desc), where img is the preview image and desc the description string.

getObjects()

Return the objects that will be inserted in the Tree

class pyworkflow.gui.tree.ProjectRunsTreeProvider(project, **kwargs)

Bases: pyworkflow.gui.tree.TreeProvider

Provide run list from a project to populate a tree.

ID_COLUMN = 'Id'

RUN_COLUMN = 'Run'

STATE_COLUMN = 'State'

TIME_COLUMN = 'Time'

getColumns()

Return a list of tuples (c, w) where: c: is the column name and index w: is the column width

getObjectFromId(objId)

getObjectInfo(obj)

This function will be called by the Tree with each object that will be inserted. A dictionary should be returned with the possible following entries: ‘key’: the key value to insert in the Tree ‘text’: text of the object to be displayed

(if not passed the ‘key’ will be used)

‘image’: image path to be displayed as icon (optional) ‘parent’: the object’s parent in which insert this object (optional) ‘tags’: list of tags names (optional)

getObjects()

Return the objects that will be inserted in the Tree

runsKey(run)

setRefresh(value)

class pyworkflow.gui.tree.Tree(master, frame=True, **opts)

Bases: tkinter.ttk.Treeview, pyworkflow.gui.widgets.Scrollable

This widget acts as a wrapper around the ttk.Treeview

clear()

remove all items

getFirst()

Return first selected item or None if selection empty

getImage(img)

moveItemDown(e=None)

if selected item is not the first move up one position

moveItemUp(e=None)

if selected item is not the first move up one position

moveSelectionDown(e=None)

change selection to to next item

moveSelectionUp(e=None)

change selection to previous item

search(initial, fromSelected=True)

Search the first item starting with “start” Implemented for Flat tree like FileBrowser…TODO: consider a proper tree with branches and leaves..

Parameters:

• initial (String - text to look for in the items. Usually the first initial letter)
• fromSelected (Boolean, start looking from the selected item)

selectChild(child)

selectChildByIndex(index)

Select the item at the position index

sortByColumn(col, reverse, casting=<class 'str'>)

Function to sort a treeview :param self: treview :param col: column to apply the sorting on :param reverse: sorting direction :param casting: optional - casting operation to apply on the column value: str is default. int, float are other options :return:

class pyworkflow.gui.tree.TreeProvider(sortingColumnName=None, sortingAscending=True)

Bases: object

Class class will serve to separate the logic of feed data from the graphical Tree build. Subclasses should implement the abstract methods

configureTags(tree)

Configure the available tags in the tree that will be setup later for each item in the tree. :returns: * Nothing

• Adds tags to the tree for customizing

getColumns()

Return a list of tuples (c, w) where: c: is the column name and index w: is the column width

getObjectActions(obj)

Return a list of tuples (key, action) were keys are the string options that will be display in the context menu and the actions are the functions to call when the specific action is selected. The first action in the list will be taken as the default one when the element is double-clicked.

getObjectInfo(obj)

This function will be called by the Tree with each object that will be inserted. A dictionary should be returned with the possible following entries: ‘key’: the key value to insert in the Tree ‘text’: text of the object to be displayed

(if not passed the ‘key’ will be used)

‘image’: image path to be displayed as icon (optional) ‘parent’: the object’s parent in which insert this object (optional) ‘tags’: list of tags names (optional)

getObjectPreview(obj)

Should return a tuple (img, desc), where img is the preview image and desc the description string.

getObjects()

Return the objects that will be inserted in the Tree

getSortingColumnName()

isSortingAscending()

setSortingParams(columnName, ascending)

Column name to sort by it and sorting direction :Parameters: * columnName (Name of the column)

• ascending (If true sorting will be ascending.)

Returns: Return type:Nothing

sortEnabled()