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.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: QgsProcessingParametersGenerator.createProcessingParameters()

Class Hierarchy¶

Base classes¶

`QgsPanelWidget`	Base class for any widget that can be shown as an 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`

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsProcessingParametersWidget. See the FAQ for more details.

initWidgets

class qgis.gui.QgsProcessingParametersWidget[source]¶

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)[source]¶

Parameters:: widget (Optional[QWidget])

addOutputLabel(self, label: QWidget | None)[source]¶

Parameters:: label (Optional[QWidget])

addOutputWidget(self, widget: QWidget | None, stretch: int = 0)[source]¶

Parameters:

widget (Optional[QWidget])
stretch (int = 0)

addParameterLabel(self, parameter: QgsProcessingParameterDefinition | None, label: QWidget | None)[source]¶

Parameters:

parameter (Optional[QgsProcessingParameterDefinition])
label (Optional[QWidget])

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

Parameters:

parameter (Optional[QgsProcessingParameterDefinition])
widget (Optional[QWidget])
stretch (int = 0)

algorithm(self) → QgsProcessingAlgorithm | None[source]¶

Return type:: Optional[QgsProcessingAlgorithm]

virtual initWidgets(self)[source]¶