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

#include <qgsprocessingguiregistry.h>

Public Member Functions
	QgsProcessingGuiRegistry ()
	Constructor. More...

	~QgsProcessingGuiRegistry ()

void	addAlgorithmConfigurationWidgetFactory (QgsProcessingAlgorithmConfigurationWidgetFactory *factory)
	Add a new configuration widget factory for customized algorithm configuration widgets. More...

QgsProcessingAlgorithmConfigurationWidget *	algorithmConfigurationWidget (const QgsProcessingAlgorithm *algorithm) const
	Gets the configuration widget for an algorithm. More...

void	removeAlgorithmConfigurationWidgetFactory (QgsProcessingAlgorithmConfigurationWidgetFactory *factory)
	Remove a configuration widget factory for customized algorithm configuration widgets. More...

Detailed Description

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

Since: QGIS 3.2

Definition at line 37 of file qgsprocessingguiregistry.h.

Constructor & Destructor Documentation

◆ QgsProcessingGuiRegistry()

QgsProcessingGuiRegistry::QgsProcessingGuiRegistry ( )

Constructor.

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

Definition at line 23 of file qgsprocessingguiregistry.cpp.

◆ ~QgsProcessingGuiRegistry()

QgsProcessingGuiRegistry::~QgsProcessingGuiRegistry ( )

Definition at line 28 of file qgsprocessingguiregistry.cpp.

Member Function Documentation

◆ addAlgorithmConfigurationWidgetFactory()

void QgsProcessingGuiRegistry::addAlgorithmConfigurationWidgetFactory ( QgsProcessingAlgorithmConfigurationWidgetFactory * factory )

Add a new configuration widget factory for customized algorithm configuration widgets.

Ownership is taken.

Since: QGIS 3.2

Definition at line 34 of file qgsprocessingguiregistry.cpp.

◆ algorithmConfigurationWidget()

QgsProcessingAlgorithmConfigurationWidget * QgsProcessingGuiRegistry::algorithmConfigurationWidget ( const QgsProcessingAlgorithm * algorithm ) const

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, nullptr will be returned.

Since: QGIS 3.2

Definition at line 45 of file qgsprocessingguiregistry.cpp.

◆ removeAlgorithmConfigurationWidgetFactory()

void QgsProcessingGuiRegistry::removeAlgorithmConfigurationWidgetFactory ( QgsProcessingAlgorithmConfigurationWidgetFactory * factory )

Remove a configuration widget factory for customized algorithm configuration widgets.

Since: QGIS 3.2

Definition at line 39 of file qgsprocessingguiregistry.cpp.

The documentation for this class was generated from the following files:

/tmp/buildd/qgis-3.2.0+99unstable/src/gui/processing/qgsprocessingguiregistry.h
/tmp/buildd/qgis-3.2.0+99unstable/src/gui/processing/qgsprocessingguiregistry.cpp

Public Member Functions