QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Types | Public Member Functions | List of all members
QgsProcessingParameterType Class Referenceabstract

Makes metadata of processing parameters available. More...

#include <qgsprocessingparametertype.h>

Inheritance diagram for QgsProcessingParameterType:
Inheritance graph
[legend]

Public Types

enum  ParameterFlag { ExposeToModeler = 1 }
 Each parameter type can offer a number of additional flags to finetune its behavior and capabilities. More...
 

Public Member Functions

virtual ~QgsProcessingParameterType ()=default
 Destructor. More...
 
virtual QStringList acceptedPythonTypes () const
 Returns a list of the Python data types accepted as values for the parameter. More...
 
virtual QgsProcessingParameterDefinitioncreate (const QString &name) const =0
 Creates a new parameter of this type. More...
 
virtual QString description () const =0
 A human readable and translatable description for this parameter type. More...
 
virtual ParameterFlags flags () const
 Determines if this parameter is available in the modeler. More...
 
virtual QString id () const =0
 A static id for this type which will be used for storing this parameter type. More...
 
virtual QVariantMap metadata () const
 Metadata for this parameter type. More...
 
virtual QString name () const =0
 A human readable and translatable short name for this parameter type. More...
 

Detailed Description

Makes metadata of processing parameters available.

Since
QGIS 3.2

Definition at line 33 of file qgsprocessingparametertype.h.

Member Enumeration Documentation

◆ ParameterFlag

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

Enumerator
ExposeToModeler 

Is this parameter available in the modeler. Is set to on by default.

Definition at line 41 of file qgsprocessingparametertype.h.

Constructor & Destructor Documentation

◆ ~QgsProcessingParameterType()

virtual QgsProcessingParameterType::~QgsProcessingParameterType ( )
virtualdefault

Destructor.

Member Function Documentation

◆ acceptedPythonTypes()

QStringList QgsProcessingParameterType::acceptedPythonTypes ( ) const
virtual

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

Definition at line 30 of file qgsprocessingparametertype.cpp.

◆ create()

virtual QgsProcessingParameterDefinition* QgsProcessingParameterType::create ( const QString &  name) const
pure virtual

Creates a new parameter of this type.

◆ description()

virtual QString QgsProcessingParameterType::description ( ) const
pure virtual

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.

◆ flags()

QgsProcessingParameterType::ParameterFlags QgsProcessingParameterType::flags ( ) const
virtual

Determines if this parameter is available in the modeler.

The default implementation returns true.

Definition at line 20 of file qgsprocessingparametertype.cpp.

◆ id()

virtual QString QgsProcessingParameterType::id ( ) const
pure virtual

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

◆ metadata()

QVariantMap QgsProcessingParameterType::metadata ( ) const
virtual

Metadata for this parameter type.

Can be used for example to define custom widgets. The default implementation returns an empty map.

Definition at line 25 of file qgsprocessingparametertype.cpp.

◆ name()

virtual QString QgsProcessingParameterType::name ( ) const
pure virtual

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

This will be used in comboboxes and list widgets.


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