Class: QgsProcessingAlgorithmConfigurationWidget¶

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

Bases: PyQt5.QtWidgets.QWidget, qgis._core.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: Enums

Methods

`actionEvent`
`algorithm`	Returns the algorithm instance associated with this widget.
`changeEvent`
`childEvent`
`closeEvent`
`configuration`	Read the current configuration from this widget.
`connectNotify`
`contextMenuEvent`
`create`
`createExpressionContext`
`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`	Registers a Processing context `generator` class that will be used to retrieve a Processing context for the widget when required.
`resizeEvent`
`sender`
`senderSignalIndex`
`setAlgorithm`	Sets the algorithm instance associated with the widget.
`setConfiguration`	Set the configuration which this widget should represent.
`setWidgetContext`	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.
`sharedPainter`
`showEvent`
`tabletEvent`
`timerEvent`
`updateMicroFocus`
`wheelEvent`
`widgetContext`	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.

Signals

Attributes

actionEvent()¶

algorithm(self) → QgsProcessingAlgorithm¶: Returns the algorithm instance associated with this widget.

See also

setAlgorithm()

New in version 3.6.

changeEvent()¶

childEvent()¶

closeEvent()¶

configuration(self) → Dict[str, Any]¶: Read the current configuration from this widget.

connectNotify()¶

contextMenuEvent()¶

create()¶

createExpressionContext(self) → 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.

resizeEvent()¶

sender()¶

senderSignalIndex()¶

setAlgorithm(self, algorithm: QgsProcessingAlgorithm)¶: Sets the algorithm instance associated with the widget.

See also

algorithm()

New in version 3.6.

setConfiguration(self, configuration: Dict[str, Any])¶: Set the configuration which this widget should represent.

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.