QGIS API Documentation  3.25.0-Master (dec16ba68b)
Public Types | Public Member Functions | List of all members
QgsProcessingParametersGenerator Class Referenceabstract

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...
 

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. More...
 

Detailed Description

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

Since
QGIS 3.14

Definition at line 76 of file qgsprocessingwidgetwrapper.h.

Member Enumeration Documentation

◆ Flag

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 85 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: