QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingParameterEnum Class Reference

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

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterEnum:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingParameterEnum (const QString &name, const QString &description=QString(), const QStringList &options=QStringList(), bool allowMultiple=false, const QVariant &defaultValue=QVariant(), bool optional=false, bool usesStaticStrings=false)
 Constructor for QgsProcessingParameterEnum. More...
 
bool allowMultiple () const
 Returns true if the parameter allows multiple selected values. More...
 
QString asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const override
 Returns the parameter definition as a Python command which can be used within a Python Processing script. More...
 
QString asScriptCode () const override
 Returns the parameter definition encoded in a string which can be used within a Processing script. More...
 
bool checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const override
 Checks whether the specified input value is acceptable for the parameter. More...
 
QgsProcessingParameterDefinitionclone () const override
 Creates a clone of the parameter definition. More...
 
bool fromVariantMap (const QVariantMap &map) override
 Restores this parameter to a QVariantMap. More...
 
QStringList options () const
 Returns the list of acceptable options for the parameter. More...
 
void setAllowMultiple (bool allowMultiple)
 Sets whether the parameter allows multiple selected values. More...
 
void setOptions (const QStringList &options)
 Sets the list of acceptable options for the parameter. More...
 
void setUsesStaticStrings (bool usesStaticStrings)
 Sets whether the parameter uses static (non-translated) string values for its enumeration choice list. More...
 
QVariantMap toVariantMap () const override
 Saves this parameter to a QVariantMap. More...
 
QString type () const override
 Unique parameter type name. More...
 
bool usesStaticStrings () const
 Returns true if the parameter uses static (non-translated) string values for its enumeration choice list. More...
 
QString valueAsPythonComment (const QVariant &value, QgsProcessingContext &context) const override
 Returns a Python comment explaining a parameter value, or an empty string if no comment is required. More...
 
QString valueAsPythonString (const QVariant &value, QgsProcessingContext &context) const override
 Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command. More...
 
- Public Member Functions inherited from QgsProcessingParameterDefinition
 QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &help=QString())
 Constructor for QgsProcessingParameterDefinition. More...
 
virtual ~QgsProcessingParameterDefinition ()=default
 
QStringList additionalExpressionContextVariables () const
 Returns a list of additional expression context variables which are available for use when evaluating this parameter. More...
 
QgsProcessingAlgorithmalgorithm () const
 Returns a pointer to the algorithm which owns this parameter. More...
 
QVariant defaultValue () const
 Returns the default value for the parameter. More...
 
QVariant defaultValueForGui () const
 Returns the default value to use for the parameter in a GUI. More...
 
virtual QStringList dependsOnOtherParameters () const
 Returns a list of other parameter names on which this parameter is dependent (e.g. More...
 
QString description () const
 Returns the description for the parameter. More...
 
QString dynamicLayerParameterName () const
 Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. More...
 
QgsPropertyDefinition dynamicPropertyDefinition () const
 Returns the property definition for dynamic properties. More...
 
Flags flags () const
 Returns any flags associated with the parameter. More...
 
QVariant guiDefaultValueOverride () const
 Returns the default value to use in the GUI for the parameter. More...
 
QString help () const
 Returns the help for the parameter. More...
 
virtual bool isDestination () const
 Returns true if this parameter represents a file or layer destination, e.g. More...
 
bool isDynamic () const
 Returns true if the parameter supports is dynamic, and can support data-defined values (i.e. More...
 
QVariantMap & metadata ()
 Returns the parameter's freeform metadata. More...
 
QVariantMap metadata () const
 Returns the parameter's freeform metadata. More...
 
QString name () const
 Returns the name of the parameter. More...
 
QgsProcessingProviderprovider () const
 Returns a pointer to the provider for the algorithm which owns this parameter. More...
 
void setAdditionalExpressionContextVariables (const QStringList &variables)
 Sets a list of additional expression context variables which are available for use when evaluating this parameter. More...
 
void setDefaultValue (const QVariant &value)
 Sets the default value for the parameter. More...
 
void setDescription (const QString &description)
 Sets the description for the parameter. More...
 
void setDynamicLayerParameterName (const QString &name)
 Sets the name for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. More...
 
void setDynamicPropertyDefinition (const QgsPropertyDefinition &definition)
 Sets the property definition for dynamic properties. More...
 
void setFlags (Flags flags)
 Sets the flags associated with the parameter. More...
 
void setGuiDefaultValueOverride (const QVariant &value)
 Sets the default value to use for the parameter in GUI widgets. More...
 
void setHelp (const QString &help)
 Sets the help for the parameter. More...
 
void setIsDynamic (bool dynamic)
 Sets whether the parameter is dynamic, and can support data-defined values (i.e. More...
 
void setMetadata (const QVariantMap &metadata)
 Sets the parameter's freeform metadata. More...
 
void setName (const QString &name)
 Sets the name of the parameter. More...
 
virtual QString toolTip () const
 Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type). More...
 

Static Public Member Functions

static QgsProcessingParameterEnumfromScriptCode (const QString &name, const QString &description, bool isOptional, const QString &definition)
 Creates a new parameter using the definition from a script code. More...
 
static QString typeName ()
 Returns the type name for the parameter class. More...
 

Additional Inherited Members

- Public Types inherited from QgsProcessingParameterDefinition
enum  Flag { FlagAdvanced = 1 << 1 , FlagHidden = 1 << 2 , FlagOptional = 1 << 3 , FlagIsModelOutput = 1 << 4 }
 Parameter flags. More...
 
- Protected Attributes inherited from QgsProcessingParameterDefinition
QStringList mAdditionalExpressionVariables
 Additional expression context variables exposed for use by this parameter. More...
 
QgsProcessingAlgorithmmAlgorithm = nullptr
 Pointer to algorithm which owns this parameter. More...
 
QVariant mDefault
 Default value for parameter. More...
 
QString mDescription
 Parameter description. More...
 
QString mDynamicLayerParameterName
 Linked vector layer parameter name for dynamic properties. More...
 
Flags mFlags
 Parameter flags. More...
 
QVariant mGuiDefault
 Default value for parameter in GUI. More...
 
QString mHelp
 Parameter help. More...
 
bool mIsDynamic = false
 True for dynamic parameters, which can have data-defined (QgsProperty) based values. More...
 
QVariantMap mMetadata
 Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior. More...
 
QString mName
 Parameter name. More...
 
QgsPropertyDefinition mPropertyDefinition
 Data defined property definition. More...
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 2480 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterEnum()

QgsProcessingParameterEnum::QgsProcessingParameterEnum ( const QString &  name,
const QString &  description = QString(),
const QStringList &  options = QStringList(),
bool  allowMultiple = false,
const QVariant &  defaultValue = QVariant(),
bool  optional = false,
bool  usesStaticStrings = false 
)

Constructor for QgsProcessingParameterEnum.

Definition at line 4326 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ allowMultiple()

bool QgsProcessingParameterEnum::allowMultiple ( ) const

Returns true if the parameter allows multiple selected values.

See also
setAllowMultiple()

Definition at line 4631 of file qgsprocessingparameters.cpp.

◆ asPythonString()

QString QgsProcessingParameterEnum::asPythonString ( QgsProcessing::PythonOutputType  outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const
overridevirtual

Returns the parameter definition as a Python command which can be used within a Python Processing script.

The outputType argument specifies the desired output format for the Python string, i.e. the intended end use of the generated Python code.

Since
QGIS 3.6

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4591 of file qgsprocessingparameters.cpp.

◆ asScriptCode()

QString QgsProcessingParameterEnum::asScriptCode ( ) const
overridevirtual

Returns the parameter definition encoded in a string which can be used within a Processing script.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4572 of file qgsprocessingparameters.cpp.

◆ checkValueIsAcceptable()

bool QgsProcessingParameterEnum::checkValueIsAcceptable ( const QVariant &  input,
QgsProcessingContext context = nullptr 
) const
overridevirtual

Checks whether the specified input value is acceptable for the parameter.

Returns true if the value can be accepted. The optional context parameter can be specified to allow a more stringent check to be performed, capable of checking for the presence of required layers and other factors within the context.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4340 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterDefinition * QgsProcessingParameterEnum::clone ( ) const
overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 4335 of file qgsprocessingparameters.cpp.

◆ fromScriptCode()

QgsProcessingParameterEnum * QgsProcessingParameterEnum::fromScriptCode ( const QString &  name,
const QString &  description,
bool  isOptional,
const QString &  definition 
)
static

Creates a new parameter using the definition from a script code.

Definition at line 4669 of file qgsprocessingparameters.cpp.

◆ fromVariantMap()

bool QgsProcessingParameterEnum::fromVariantMap ( const QVariantMap &  map)
overridevirtual

Restores this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method.

See also
toVariantMap()

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4660 of file qgsprocessingparameters.cpp.

◆ options()

QStringList QgsProcessingParameterEnum::options ( ) const

Returns the list of acceptable options for the parameter.

See also
setOptions()

Definition at line 4621 of file qgsprocessingparameters.cpp.

◆ setAllowMultiple()

void QgsProcessingParameterEnum::setAllowMultiple ( bool  allowMultiple)

Sets whether the parameter allows multiple selected values.

See also
allowMultiple()

Definition at line 4636 of file qgsprocessingparameters.cpp.

◆ setOptions()

void QgsProcessingParameterEnum::setOptions ( const QStringList &  options)

Sets the list of acceptable options for the parameter.

See also
options()

Definition at line 4626 of file qgsprocessingparameters.cpp.

◆ setUsesStaticStrings()

void QgsProcessingParameterEnum::setUsesStaticStrings ( bool  usesStaticStrings)

Sets whether the parameter uses static (non-translated) string values for its enumeration choice list.

See also
usesStaticStrings()
Since
QGIS 3.18

Definition at line 4646 of file qgsprocessingparameters.cpp.

◆ toVariantMap()

QVariantMap QgsProcessingParameterEnum::toVariantMap ( ) const
overridevirtual

Saves this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method and then extend the result with additional properties.

See also
fromVariantMap()

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4651 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterEnum::type ( ) const
inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 2498 of file qgsprocessingparameters.h.

◆ typeName()

static QString QgsProcessingParameterEnum::typeName ( )
inlinestatic

Returns the type name for the parameter class.

Definition at line 2496 of file qgsprocessingparameters.h.

◆ usesStaticStrings()

bool QgsProcessingParameterEnum::usesStaticStrings ( ) const

Returns true if the parameter uses static (non-translated) string values for its enumeration choice list.

See also
setUsesStaticStrings()
Since
QGIS 3.18

Definition at line 4641 of file qgsprocessingparameters.cpp.

◆ valueAsPythonComment()

QString QgsProcessingParameterEnum::valueAsPythonComment ( const QVariant &  value,
QgsProcessingContext context 
) const
overridevirtual

Returns a Python comment explaining a parameter value, or an empty string if no comment is required.

Since
QGIS 3.20

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4526 of file qgsprocessingparameters.cpp.

◆ valueAsPythonString()

QString QgsProcessingParameterEnum::valueAsPythonString ( const QVariant &  value,
QgsProcessingContext context 
) const
overridevirtual

Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4465 of file qgsprocessingparameters.cpp.


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