Class: QgsProcessingParametersGenerator¶
- class qgis.gui.QgsProcessingParametersGenerator¶
Bases:
sip.wrapper
An interface for objects which can create sets of parameter values for processing algorithms.
New in version 3.14:
Enums
Bases:
enum.IntEnum
Methods
This method needs to be reimplemented in all classes which implement this interface and return a algorithm parameters.
- class Flag(value)¶
Bases:
enum.IntEnum
Flags controlling parameter generation.
New in version 3.24.
SkipDefaultValueParameters
: Parameters which are unchanged from their default values should not be included
- SkipDefaultValueParameters = 1¶
- class Flags¶
- class Flags(Union[QgsProcessingParametersGenerator.Flags, QgsProcessingParametersGenerator.Flag])
- class Flags(QgsProcessingParametersGenerator.Flags)
Bases:
sip.wrapper
- createProcessingParameters(self, flags: QgsProcessingParametersGenerator.Flags | QgsProcessingParametersGenerator.Flag = QgsProcessingParametersGenerator.Flags()) Dict[str, Any] ¶
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.- Parameters:
flags (Union[QgsProcessingParametersGenerator.Flags) –
- Return type:
Dict[str, Any]