Class: QgsProcessingAlgorithmConfigurationWidget

class qgis.gui.QgsProcessingAlgorithmConfigurationWidget(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget, QgsExpressionContextGenerator

Creates a new QgsProcessingAlgorithmConfigurationWidget

A configuration widget for processing algorithms allows providing additional configuration options directly on algorithm level, in addition to parameters.

New in version 3.2.

Parameters

parent

actionEvent()
algorithm(self) → QgsProcessingAlgorithm

Returns the algorithm instance associated with this widget.

See also

setAlgorithm()

New in version 3.6.

Return type

QgsProcessingAlgorithm

changeEvent()
childEvent()
closeEvent()
configuration(self) → Dict[str, Any]

Read the current configuration from this widget.

Return type

Dict[str, Any]

connectNotify()
contextMenuEvent()
create()
createExpressionContext(self) → QgsExpressionContext
Return type

QgsExpressionContext

customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
registerProcessingContextGenerator(self, generator: QgsProcessingContextGenerator)

Registers a Processing context generator class that will be used to retrieve a Processing context for the widget when required.

New in version 3.6.

Parameters

generator (QgsProcessingContextGenerator) –

resizeEvent()
sender()
senderSignalIndex()
setAlgorithm(self, algorithm: QgsProcessingAlgorithm)

Sets the algorithm instance associated with the widget.

See also

algorithm()

New in version 3.6.

Parameters

algorithm (QgsProcessingAlgorithm) –

setConfiguration(self, configuration: Dict[str, Any])

Set the configuration which this widget should represent.

Parameters

configuration (Dict[str) –

setWidgetContext(self, context: QgsProcessingParameterWidgetContext)

Sets the context in which the Processing algorithm widget is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.

Subclasses should take care to call the base class method when reimplementing this method.

See also

widgetContext()

New in version 3.6.

Parameters

context (QgsProcessingParameterWidgetContext) –

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()
widgetContext(self) → QgsProcessingParameterWidgetContext

Returns the context in which the Processing algorithm widget is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.

New in version 3.6.

Return type

QgsProcessingParameterWidgetContext