QgsProcessingParameterTypeFeatureSink class

A feature sink parameter for Processing algorithms.

Reference
- Base classes
- Private functions

Base classes

class QgsProcessingParameterType: Makes metadata of processing parameters available.

Private functions

auto acceptedPythonTypes() const -> QStringList override: Returns a list of the Python data types accepted as values for the parameter.
auto create(const QString& name) const -> QgsProcessingParameterDefinition* override: Creates a new parameter of this type.
auto description() const -> QString override: A human readable and translatable description for this parameter type.
auto flags() const -> ParameterFlags override: Determines if this parameter is available in the modeler.
auto id() const -> QString override: A static id for this type which will be used for storing this parameter type.
auto name() const -> QString override: A human readable and translatable short name for this parameter type.

Function documentation

QStringList QgsProcessingParameterTypeFeatureSink::acceptedPythonTypes() const override private

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

E.g. "str", "QgsVectorLayer", "QgsMapLayer", etc.

These values should should match the Python types exactly (e.g. "str" not "string", "bool" not "boolean"). Extra explanatory help can be used (which must be translated), eg "str: as comma delimited list of numbers".

QString QgsProcessingParameterTypeFeatureSink::description() const override private

A human readable and translatable description for this parameter type.

This can be a longer description suitable for tooltips and other elements that give the user context for a given parameter.

ParameterFlags QgsProcessingParameterTypeFeatureSink::flags() const override private

Determines if this parameter is available in the modeler.

The default implementation returns true.

QString QgsProcessingParameterTypeFeatureSink::name() const override private

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

This will be used in comboboxes and list widgets.