PyFlow.UI.Tool package

Submodules

PyFlow.UI.Tool.Tool module

class PyFlow.UI.Tool.Tool.DockTitleBar(dockWidget, renamable=False)

Bases: PySide2.QtWidgets.QWidget

__init__(dockWidget, renamable=False)

Initialize self. See help(type(self)) for accurate signature.

eventFilter(self, watched: PySide2.QtCore.QObject, event: PySide2.QtCore.QEvent) → bool
mouseDoubleClickEvent(self, event: PySide2.QtGui.QMouseEvent)
mouseMoveEvent(self, event: PySide2.QtGui.QMouseEvent)
mousePressEvent(self, event: PySide2.QtGui.QMouseEvent)
mouseReleaseEvent(self, event: PySide2.QtGui.QMouseEvent)
update(self)

update(self, arg__1: PySide2.QtCore.QRect) update(self, arg__1: PySide2.QtGui.QRegion) update(self, x: int, y: int, w: int, h: int)

class PyFlow.UI.Tool.Tool.DockTool

Bases: PySide2.QtWidgets.QDockWidget, PyFlow.UI.Tool.Tool.ToolBase

Base class for dock tools

__init__()

Initialize self. See help(type(self)) for accurate signature.

closeEvent(self, event: PySide2.QtGui.QCloseEvent)
onShow()

Called when tool pops up

restoreState(settings)

Called when application loaded

Restore any saved state here. Same as saveState, settings group already selected, so jsut call value method to access data

Parameters:settings (QSettings) – Settings class instance
class PyFlow.UI.Tool.Tool.ShelfTool

Bases: PyFlow.UI.Tool.Tool.ToolBase

Base class for shelf tools

__init__()

Initialize self. See help(type(self)) for accurate signature.

class PyFlow.UI.Tool.Tool.ToolBase

Bases: object

Base class for all editor tools

__init__()

Initialize self. See help(type(self)) for accurate signature.

onDestroy()

Called when tool destroyed

onShow()

Called when tool pops up

packageName = ''

Package name this tool belongs to

restoreState(settings)

Called when application loaded

Restore any saved state here. Same as saveState, settings group already selected, so jsut call value method to access data

Parameters:settings (QSettings) – Settings class instance
saveState(settings)

Called on tool save

When this method is called, corerct group is already selected. So you just need to call setValue here

1
2
3
def saveState(self, settings):
    super(ScreenshotTool, self).saveState(settings)
    settings.setValue("format", self.format)
Parameters:settings (QSettings) – Settings class instance
static supportedSoftwares()

Under what software to work

static toolTip()

Tool tip message

Return type:str
uniqueName()

Tool unique name

In case if tool is not a singleton like PropertiesTool, wee need to store separate data for each instance. We use unique identifiers (UUID) postfixes for this

Return type:str

Module contents