mcsas.gui.algorithmwidget module¶

class AlgorithmWidget(parent, algorithm, appSettings)[source]¶

Bases: gui.bases.settingswidget.SettingsWidget, gui.bases.mixins.appsettings.AppSettings

algorithm¶: Retrieves AlgorithmBase object containing all parameters for this settings.

blockSigValueChanged()[source]¶: Warning

method ‘gui.algorithmwidget.AlgorithmWidget.blockSigValueChanged’ undocumented

static clearLayout(layout, newParent=None)[source]¶: Removes all widgets from the given layout and reparents them if newParent is a sub class of QWidget

inputWidgets¶: Returns all existing input names (for store/restore).

keys¶

makeSetting(param, activeBtns=False)[source]¶: Creates an input widget for the provided Parameter and configures it appropriately.

makeWidgets(*args)[source]¶: Warning

method ‘gui.algorithmwidget.AlgorithmWidget.makeWidgets’ undocumented

onBackendUpdate()[source]¶: Warning

method ‘gui.algorithmwidget.AlgorithmWidget.onBackendUpdate’ undocumented

static removeWidgets(widget)[source]¶: Removes all widgets from the layout of the given widget.

resizeEvent(resizeEvent)[source]¶: Resizes widget based on available width.

resizeWidgets(targetWidth)[source]¶: Warning

method ‘gui.algorithmwidget.AlgorithmWidget.resizeWidgets’ undocumented

restoreSession(section=None)[source]¶: Warning

method ‘gui.algorithmwidget.AlgorithmWidget.restoreSession’ undocumented

sigBackendUpdated¶

storeSession(section=None)[source]¶: Stores current UI configuration to persistent application settings.

uiWidgets¶: May return a list of input widgets compatible but not associated to a parameter, e.g. for UI configuration. To be overridden in subclasses.

unblockSigValueChanged()[source]¶: Warning

method ‘gui.algorithmwidget.AlgorithmWidget.unblockSigValueChanged’ undocumented

updateAll()[source]¶: Called in MainWindow on calculation start.

updateParam(param, emitBackendUpdated=True)[source]¶: Write UI settings back to the algorithm. Processes all input widgets which belong to a certain parameter.

updateUi()[source]¶: Update input widgets according to possibly changed backend data.

updateWidget(widget, emitBackendUpdated=True)[source]¶: Write UI settings back to the algorithm. Gets the parameter associated with a certain widget and processes all related widgets as well.

class SettingsGridWidget(parent, algorithm, appSettings=None, showParams=None)[source]¶

Bases: gui.algorithmwidget.AlgorithmWidget

Base class for displaying simple input boxes of various settings arranged on a grid dynamically based on the width of the window.

Additional arguments: showParams is a list of parameter names to show in this widget. If not specified it shows all available parameters by default.

resizeWidgets(targetWidth)[source]¶: Creates a new layout with appropriate row/column count.

isNotNone(lst)[source]¶: Warning

function ‘gui.algorithmwidget.isNotNone’ undocumented

rearrangeWidgets(layout, widgets, targetWidth)[source]¶: Warning

function ‘gui.algorithmwidget.rearrangeWidgets’ undocumented