An interface for objects which can create sets of parameter values for processing algorithms. More...

#include <qgsprocessingwidgetwrapper.h>

Public Types
enum class	Flag : int { SkipDefaultValueParameters = 1 << 0 }
	Flags controlling parameter generation. More...

typedef QFlags< Flag >	Flags

Public Member Functions
virtual	~QgsProcessingParametersGenerator ()=default

virtual QVariantMap	createProcessingParameters (QgsProcessingParametersGenerator::Flags flags=QgsProcessingParametersGenerator::Flags())=0
	This method needs to be reimplemented in all classes which implement this interface and return a algorithm parameters.

Detailed Description

An interface for objects which can create sets of parameter values for processing algorithms.

Since: QGIS 3.14

Definition at line 75 of file qgsprocessingwidgetwrapper.h.

Member Typedef Documentation

◆ Flags

typedef QFlags< Flag > QgsProcessingParametersGenerator::Flags

Definition at line 88 of file qgsprocessingwidgetwrapper.h.

Member Enumeration Documentation

◆ Flag

enum class QgsProcessingParametersGenerator::Flag : int

strong

Flags controlling parameter generation.

Since: QGIS 3.24

Enumerator
SkipDefaultValueParameters	Parameters which are unchanged from their default values should not be included.

Definition at line 84 of file qgsprocessingwidgetwrapper.h.

Constructor & Destructor Documentation

◆ ~QgsProcessingParametersGenerator()

virtual QgsProcessingParametersGenerator::~QgsProcessingParametersGenerator ( )

virtualdefault

Member Function Documentation

◆ createProcessingParameters()

virtual QVariantMap QgsProcessingParametersGenerator::createProcessingParameters ( QgsProcessingParametersGenerator::Flags flags = QgsProcessingParametersGenerator::Flags() )

pure virtual

This method needs to be reimplemented in all classes which implement this interface and return a algorithm parameters.

Since QGIS 3.24 the optional flags argument can be used to control the behavior of the parameter generation.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/processing/qgsprocessingwidgetwrapper.h

Public Types

Public Member Functions