Class: QgsProcessingParametersWidget

A widget which allows users to select the value for the parameters for an algorithm.

Note

Not stable API

Added in version 3.14.

Class Hierarchy

Base classes

QgsPanelWidget	Base class for any widget that can be shown as a inline panel
QWidget
QObject
QPaintDevice
QgsProcessingParametersGenerator	An interface for objects which can create sets of parameter values for processing algorithms.

Methods

addExtraWidget
addOutputLabel
addOutputWidget
addParameterLabel
addParameterWidget
algorithm
initWidgets

class qgis.gui.QgsProcessingParametersWidget

Bases: QgsPanelWidget, QgsProcessingParametersGenerator

__init__(algorithm: QgsProcessingAlgorithm | None, parent: QWidget | None = None)

Constructor for QgsProcessingParametersWidget, for the specified algorithm.

Parameters:

• algorithm (Optional[QgsProcessingAlgorithm])

• parent (Optional[QWidget] = None)

addExtraWidget(self, widget: QWidget | None)

Parameters:

widget (Optional[QWidget])

addOutputLabel(self, label: QWidget | None)

Parameters:

label (Optional[QWidget])

addOutputWidget(self, widget: QWidget | None, stretch: int = 0)

Parameters:

• widget (Optional[QWidget])

• stretch (int = 0)

addParameterLabel(self, parameter: QgsProcessingParameterDefinition | None, label: QWidget | None)

Parameters:

• parameter (Optional[QgsProcessingParameterDefinition])

• label (Optional[QWidget])

addParameterWidget(self, parameter: QgsProcessingParameterDefinition | None, widget: QWidget | None, stretch: int = 0)

Parameters:

• parameter (Optional[QgsProcessingParameterDefinition])

• widget (Optional[QWidget])

• stretch (int = 0)

algorithm(self) → QgsProcessingAlgorithm | None

Return type:

Optional[QgsProcessingAlgorithm]

initWidgets(self)