Subgroup: Processing

Class: QgsProcessingGuiRegistry

class qgis.gui.QgsProcessingGuiRegistry

Bases: sip.wrapper

Constructor. Should never be called manually, is already created by QgsGui.

QgsProcessingGuiRegistry(QgsProcessingGuiRegistry)

The QgsProcessingGuiRegistry is a home for widgets for processing configuration widgets.

New in version 3.2: Methods

addAlgorithmConfigurationWidgetFactory Add a new configuration widget factory for customized algorithm configuration widgets.
algorithmConfigurationWidget Gets the configuration widget for an algorithm.
removeAlgorithmConfigurationWidgetFactory Remove a configuration widget factory for customized algorithm configuration widgets.

Signals

Attributes

addAlgorithmConfigurationWidgetFactory(self, factory: QgsProcessingAlgorithmConfigurationWidgetFactory)

Add a new configuration widget factory for customized algorithm configuration widgets. Ownership is taken.

New in version 3.2.

algorithmConfigurationWidget(self, algorithm: QgsProcessingAlgorithm) → QgsProcessingAlgorithmConfigurationWidget

Gets the configuration widget for an algorithm. This widget will be shown next to parameter widgets. Most algorithms do not have a configuration widget and in this case, None will be returned.

New in version 3.2.

removeAlgorithmConfigurationWidgetFactory(self, factory: QgsProcessingAlgorithmConfigurationWidgetFactory)

Remove a configuration widget factory for customized algorithm configuration widgets.

New in version 3.2.