PyFlow.Packages.PyFlowBase.Tools package

Submodules

PyFlow.Packages.PyFlowBase.Tools.AlignBottomTool module

class PyFlow.Packages.PyFlowBase.Tools.AlignBottomTool.AlignBottomTool

Bases: PyFlow.UI.Tool.Tool.ShelfTool

docstring for AlignBottomTool.

__init__()

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

static toolTip()

Tool tip message

Return type:str

PyFlow.Packages.PyFlowBase.Tools.AlignLeftTool module

class PyFlow.Packages.PyFlowBase.Tools.AlignLeftTool.AlignLeftTool

Bases: PyFlow.UI.Tool.Tool.ShelfTool

docstring for AlignLeftTool.

__init__()

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

static toolTip()

Tool tip message

Return type:str

PyFlow.Packages.PyFlowBase.Tools.AlignRightTool module

class PyFlow.Packages.PyFlowBase.Tools.AlignRightTool.AlignRightTool

Bases: PyFlow.UI.Tool.Tool.ShelfTool

docstring for AlignRightTool.

__init__()

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

static toolTip()

Tool tip message

Return type:str

PyFlow.Packages.PyFlowBase.Tools.AlignTopTool module

class PyFlow.Packages.PyFlowBase.Tools.AlignTopTool.AlignTopTool

Bases: PyFlow.UI.Tool.Tool.ShelfTool

docstring for AlignTopTool.

__init__()

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

static toolTip()

Tool tip message

Return type:str

PyFlow.Packages.PyFlowBase.Tools.CompileTool module

class PyFlow.Packages.PyFlowBase.Tools.CompileTool.CompileTool

Bases: PyFlow.UI.Tool.Tool.ShelfTool

docstring for CompileTool.

__init__()

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

static toolTip()

Tool tip message

Return type:str

PyFlow.Packages.PyFlowBase.Tools.HistoryTool module

class PyFlow.Packages.PyFlowBase.Tools.HistoryTool.HistoryEntry(state, icon=None)

Bases: PySide2.QtWidgets.QListWidgetItem

__init__(state, icon=None)

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

class PyFlow.Packages.PyFlowBase.Tools.HistoryTool.HistoryTool

Bases: PyFlow.UI.Tool.Tool.DockTool

__init__()

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

onShow()

Called when tool pops up

static toolTip(self) → str
class PyFlow.Packages.PyFlowBase.Tools.HistoryTool.HistoryWidget(parent=None)

Bases: PySide2.QtWidgets.QListWidget

__init__(parent=None)

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

mouseReleaseEvent(self, e: PySide2.QtGui.QMouseEvent)

PyFlow.Packages.PyFlowBase.Tools.LoggerTool module

class PyFlow.Packages.PyFlowBase.Tools.LoggerTool.LoggerTool

Bases: PyFlow.UI.Tool.Tool.DockTool

docstring for NodeBox tool.

__init__()

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

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

Called when tool destroyed

onShow()

Called when tool pops up

static supportedSoftwares()

Under what software to work

static toolTip(self) → str
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.Packages.PyFlowBase.Tools.LoggerTool.QtHandler(parent)

Bases: logging.Handler

__init__(parent)

Initializes the instance - basically setting the formatter to None and the filter list to empty.

emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

PyFlow.Packages.PyFlowBase.Tools.LoggerTool.addLoggingLevel(levelName, levelNum, methodName=None)

Comprehensively adds a new logging level to the logging module and the currently configured logging class.

levelName becomes an attribute of the logging module with the value levelNum. methodName becomes a convenience method for both logging itself and the class returned by logging.getLoggerClass() (usually just logging.Logger). If methodName is not specified, levelName.lower() is used.

To avoid accidental clobberings of existing attributes, this method will raise an AttributeError if the level name is already an attribute of the logging module or if the method name is already present

>>> addLoggingLevel('TRACE', logging.DEBUG - 5)
>>> logging.getLogger(__name__).setLevel("TRACE")
>>> logging.getLogger(__name__).trace('that worked')
>>> logging.trace('so did this')
>>> logging.TRACE
5

PyFlow.Packages.PyFlowBase.Tools.NodeBoxTool module

class PyFlow.Packages.PyFlowBase.Tools.NodeBoxTool.NodeBoxTool

Bases: PyFlow.UI.Tool.Tool.DockTool

docstring for NodeBox tool.

__init__()

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

onShow()

Called when tool pops up

static toolTip(self) → str

PyFlow.Packages.PyFlowBase.Tools.PropertiesTool module

class PyFlow.Packages.PyFlowBase.Tools.PropertiesTool.PropertiesTool

Bases: PyFlow.UI.Tool.Tool.DockTool

docstring for Properties tool.

__init__()

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

static toolTip(self) → str

PyFlow.Packages.PyFlowBase.Tools.ScreenshotTool module

class PyFlow.Packages.PyFlowBase.Tools.ScreenshotTool.ScreenshotTool

Bases: PyFlow.UI.Tool.Tool.ShelfTool

docstring for ScreenshotTool.

__init__()

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

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 toolTip()

Tool tip message

Return type:str

PyFlow.Packages.PyFlowBase.Tools.SearchResultsTool module

class PyFlow.Packages.PyFlowBase.Tools.SearchResultsTool.SearchResultsTool

Bases: PyFlow.UI.Tool.Tool.DockTool

docstring for NodeBox tool.

__init__()

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

onShow()

Called when tool pops up

static toolTip(self) → str

PyFlow.Packages.PyFlowBase.Tools.VariablesTool module

class PyFlow.Packages.PyFlowBase.Tools.VariablesTool.VariablesTool

Bases: PyFlow.UI.Tool.Tool.DockTool

docstring for Variables tool.

__init__()

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

onShow()

Called when tool pops up

showEvent(self, event: PySide2.QtGui.QShowEvent)
static toolTip(self) → str

Module contents