QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Public Member Functions | List of all members
QgsProcessingParameterTypeTinInputLayers Class Reference

Parameter type definition for QgsProcessingParameterTinInputLayers. More...

#include <qgsprocessingparametertininputlayers.h>

Inheritance diagram for QgsProcessingParameterTypeTinInputLayers:
Inheritance graph
[legend]

Public Member Functions

QStringList acceptedPythonTypes () const override
 Returns a list of the Python data types accepted as values for the parameter. More...
 
QString className () const override
 Returns the corresponding class name for the parameter type. More...
 
QgsProcessingParameterDefinitioncreate (const QString &name) const override
 Creates a new parameter of this type. More...
 
QString description () const override
 A human readable and translatable description for this parameter type. More...
 
QString id () const override
 A static id for this type which will be used for storing this parameter type. More...
 
QString name () const override
 A human readable and translatable short name for this parameter type. More...
 
QString pythonImportString () const override
 Returns a valid Python import string for importing the corresponding parameter type, e.g. More...
 
- Public Member Functions inherited from QgsProcessingParameterType
virtual ~QgsProcessingParameterType ()=default
 Destructor. More...
 
virtual QStringList acceptedStringValues () const
 Returns a descriptive list of the possible string values acceptable for the parameter. More...
 
virtual ParameterFlags flags () const
 Determines if this parameter is available in the modeler. More...
 
virtual QVariantMap metadata () const
 Metadata for this parameter type. More...
 

Additional Inherited Members

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

Detailed Description

Parameter type definition for QgsProcessingParameterTinInputLayers.

Since
QGIS 3.16

Definition at line 74 of file qgsprocessingparametertininputlayers.h.

Member Function Documentation

◆ acceptedPythonTypes()

QStringList QgsProcessingParameterTypeTinInputLayers::acceptedPythonTypes ( ) const
inlineoverridevirtual

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

See also
acceptedStringValues()

Reimplemented from QgsProcessingParameterType.

Definition at line 107 of file qgsprocessingparametertininputlayers.h.

◆ className()

QString QgsProcessingParameterTypeTinInputLayers::className ( ) const
inlineoverridevirtual

Returns the corresponding class name for the parameter type.

See also
pythonImportString()
Since
QGIS 3.6

Reimplemented from QgsProcessingParameterType.

Definition at line 102 of file qgsprocessingparametertininputlayers.h.

◆ create()

QgsProcessingParameterDefinition* QgsProcessingParameterTypeTinInputLayers::create ( const QString &  name) const
inlineoverridevirtual

Creates a new parameter of this type.

Implements QgsProcessingParameterType.

Definition at line 77 of file qgsprocessingparametertininputlayers.h.

◆ description()

QString QgsProcessingParameterTypeTinInputLayers::description ( ) const
inlineoverridevirtual

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.

Implements QgsProcessingParameterType.

Definition at line 82 of file qgsprocessingparametertininputlayers.h.

◆ id()

QString QgsProcessingParameterTypeTinInputLayers::id ( ) const
inlineoverridevirtual

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

Implements QgsProcessingParameterType.

Definition at line 92 of file qgsprocessingparametertininputlayers.h.

◆ name()

QString QgsProcessingParameterTypeTinInputLayers::name ( ) const
inlineoverridevirtual

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

This will be used in comboboxes and list widgets.

Implements QgsProcessingParameterType.

Definition at line 87 of file qgsprocessingparametertininputlayers.h.

◆ pythonImportString()

QString QgsProcessingParameterTypeTinInputLayers::pythonImportString ( ) const
inlineoverridevirtual

Returns a valid Python import string for importing the corresponding parameter type, e.g.

"from qgis.core import QgsProcessingParameterBoolean".

See also
className()
Since
QGIS 3.6

Reimplemented from QgsProcessingParameterType.

Definition at line 97 of file qgsprocessingparametertininputlayers.h.


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