QgsProcessingParameterType class

Derived classes

class QgsProcessingParameterTypeAuthConfig

A authentication configuration parameter for processing algorithms.

class QgsProcessingParameterTypeBand

A raster band parameter for Processing algorithms.

class QgsProcessingParameterTypeBoolean

A boolean parameter for processing algorithms.

class QgsProcessingParameterTypeCrs

A crs parameter for processing algorithms.

class QgsProcessingParameterTypeDistance

A distance parameter for processing algorithms.

class QgsProcessingParameterTypeEnum

An enum based parameter for processing algorithms, allowing for selection from predefined values.

class QgsProcessingParameterTypeExpression

An expression parameter for processing algorithms.

class QgsProcessingParameterTypeExtent

A rectangular map extent parameter for processing algorithms.

class QgsProcessingParameterTypeFeatureSink

A feature sink parameter for Processing algorithms.

class QgsProcessingParameterTypeFeatureSource

An input feature source (such as vector layers) parameter for processing algorithms.

class QgsProcessingParameterTypeField

A vector layer or feature source field parameter for processing algorithms.

class QgsProcessingParameterTypeFile

An input file or folder parameter for processing algorithms.

class QgsProcessingParameterTypeFileDestination

A generic file based destination parameter, for specifying the destination path for a file (non-map layer) created by the algorithm.

class QgsProcessingParameterTypeFolderDestination

A folder destination parameter, for specifying the destination path for a folder created by the algorithm or used for creating new files within the algorithm.

class QgsProcessingParameterTypeMapLayer

A generic map layer parameter for processing algorithms.

class QgsProcessingParameterTypeMatrix

A table (matrix) parameter for processing algorithms.

class QgsProcessingParameterTypeMeshLayer

A mesh layer parameter for processing algorithms.

class QgsProcessingParameterTypeMultipleLayers

A parameter for processing algorithms which accepts multiple map layers.

class QgsProcessingParameterTypeNumber

A numeric parameter for processing algorithms.

class QgsProcessingParameterTypePoint

A point parameter for processing algorithms.

class QgsProcessingParameterTypeRange

A numeric range parameter for processing algorithms.

class QgsProcessingParameterTypeRasterDestination

A raster layer destination parameter, for specifying the destination path for a raster layer created by the algorithm.

class QgsProcessingParameterTypeRasterLayer

A raster layer parameter for processing algorithms.

class QgsProcessingParameterTypeString

A string parameter for processing algorithms.

class QgsProcessingParameterTypeVectorDestination

A vector layer destination parameter, for specifying the destination path for a vector layer created by the algorithm.

class QgsProcessingParameterTypeVectorLayer

A vector layer parameter for processing algorithms.

Public types

enum ParameterFlag { ExposeToModeler = 1 }

Each parameter type can offer a number of additional flags to finetune its behavior and capabilities.

Constructors, destructors, conversion operators

~QgsProcessingParameterType() defaulted virtual

Destructor.

Public functions

auto acceptedPythonTypes() const -> QStringList virtual

Returns a list of the Python data types accepted as values for the parameter.

auto create(const QString& name) const -> QgsProcessingParameterDefinition* pure virtual

Creates a new parameter of this type.

auto description() const -> QString pure virtual

A human readable and translatable description for this parameter type.

auto flags() const -> ParameterFlags virtual

Determines if this parameter is available in the modeler.

auto id() const -> QString pure virtual

A static id for this type which will be used for storing this parameter type.

auto metadata() const -> QVariantMap virtual

Metadata for this parameter type.

auto name() const -> QString pure virtual

A human readable and translatable short name for this parameter type.

Enum documentation

Function documentation