QGIS API Documentation 3.39.0-Master (93ce9bf5c90)
|
An enum based parameter for processing algorithms, allowing for selection from predefined values. More...
#include <qgsprocessingparameters.h>
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. | |
bool | allowMultiple () const |
Returns true if the parameter allows multiple selected values. | |
QString | asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass) const override |
Returns the parameter definition as a Python command which can be used within a Python Processing script. | |
QString | asScriptCode () const override |
Returns the parameter definition encoded in a string which can be used within a Processing script. | |
bool | checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const override |
Checks whether the specified input value is acceptable for the parameter. | |
QgsProcessingParameterDefinition * | clone () const override |
Creates a clone of the parameter definition. | |
bool | fromVariantMap (const QVariantMap &map) override |
Restores this parameter to a QVariantMap. | |
QStringList | options () const |
Returns the list of acceptable options for the parameter. | |
void | setAllowMultiple (bool allowMultiple) |
Sets whether the parameter allows multiple selected values. | |
void | setOptions (const QStringList &options) |
Sets the list of acceptable options for the parameter. | |
void | setUsesStaticStrings (bool usesStaticStrings) |
Sets whether the parameter uses static (non-translated) string values for its enumeration choice list. | |
QVariantMap | toVariantMap () const override |
Saves this parameter to a QVariantMap. | |
QString | type () const override |
Unique parameter type name. | |
bool | usesStaticStrings () const |
Returns true if the parameter uses static (non-translated) string values for its enumeration choice list. | |
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. | |
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. | |
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. | |
virtual | ~QgsProcessingParameterDefinition ()=default |
QStringList | additionalExpressionContextVariables () const |
Returns a list of additional expression context variables which are available for use when evaluating this parameter. | |
QgsProcessingAlgorithm * | algorithm () const |
Returns a pointer to the algorithm which owns this parameter. | |
QVariant | defaultValue () const |
Returns the default value for the parameter. | |
QVariant | defaultValueForGui () const |
Returns the default value to use for the parameter in a GUI. | |
virtual QStringList | dependsOnOtherParameters () const |
Returns a list of other parameter names on which this parameter is dependent (e.g. | |
QString | description () const |
Returns the description for the parameter. | |
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. | |
QgsPropertyDefinition | dynamicPropertyDefinition () const |
Returns the property definition for dynamic properties. | |
Qgis::ProcessingParameterFlags | flags () const |
Returns any flags associated with the parameter. | |
QVariant | guiDefaultValueOverride () const |
Returns the default value to use in the GUI for the parameter. | |
QString | help () const |
Returns the help for the parameter. | |
virtual bool | isDestination () const |
Returns true if this parameter represents a file or layer destination, e.g. | |
bool | isDynamic () const |
Returns true if the parameter supports is dynamic, and can support data-defined values (i.e. | |
QVariantMap & | metadata () |
Returns the parameter's freeform metadata. | |
QVariantMap | metadata () const |
Returns the parameter's freeform metadata. | |
QString | name () const |
Returns the name of the parameter. | |
QgsProcessingProvider * | provider () const |
Returns a pointer to the provider for the algorithm which owns this parameter. | |
void | setAdditionalExpressionContextVariables (const QStringList &variables) |
Sets a list of additional expression context variables which are available for use when evaluating this parameter. | |
void | setDefaultValue (const QVariant &value) |
Sets the default value for the parameter. | |
void | setDescription (const QString &description) |
Sets the description for the parameter. | |
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. | |
void | setDynamicPropertyDefinition (const QgsPropertyDefinition &definition) |
Sets the property definition for dynamic properties. | |
void | setFlags (Qgis::ProcessingParameterFlags flags) |
Sets the flags associated with the parameter. | |
void | setGuiDefaultValueOverride (const QVariant &value) |
Sets the default value to use for the parameter in GUI widgets. | |
void | setHelp (const QString &help) |
Sets the help for the parameter. | |
void | setIsDynamic (bool dynamic) |
Sets whether the parameter is dynamic, and can support data-defined values (i.e. | |
void | setMetadata (const QVariantMap &metadata) |
Sets the parameter's freeform metadata. | |
void | setName (const QString &name) |
Sets the name of the parameter. | |
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). | |
virtual QVariant | valueAsJsonObject (const QVariant &value, QgsProcessingContext &context) const |
Returns a version of the parameter input value, which is suitable for use in a JSON object. | |
virtual QString | valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
Returns a string version of the parameter input value (if possible). | |
virtual QStringList | valueAsStringList (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
Returns a string list version of the parameter input value (if possible). | |
Static Public Member Functions | |
static QgsProcessingParameterEnum * | fromScriptCode (const QString &name, const QString &description, bool isOptional, const QString &definition) |
Creates a new parameter using the definition from a script code. | |
static QString | typeName () |
Returns the type name for the parameter class. | |
Additional Inherited Members | |
Public Types inherited from QgsProcessingParameterDefinition | |
enum class | ValueAsStringFlag : int { AllowMapLayerValues = 1 << 0 } |
Flags for passing to the valueAsStringPrivate() method. More... | |
typedef QFlags< ValueAsStringFlag > | ValueAsStringFlags |
Protected Member Functions inherited from QgsProcessingParameterDefinition | |
QVariant | defaultGuiValueFromSetting () const |
Default gui value for an algorithm parameter from settings. | |
QVariant | valueAsJsonObjectPrivate (const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags) const |
Internal method for evaluating values as JSON objects. | |
QString | valueAsStringPrivate (const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags) const |
Internal method for evaluating values as string. | |
Protected Attributes inherited from QgsProcessingParameterDefinition | |
QStringList | mAdditionalExpressionVariables |
Additional expression context variables exposed for use by this parameter. | |
QgsProcessingAlgorithm * | mAlgorithm = nullptr |
Pointer to algorithm which owns this parameter. | |
QVariant | mDefault |
Default value for parameter. | |
QString | mDescription |
Parameter description. | |
QString | mDynamicLayerParameterName |
Linked vector layer parameter name for dynamic properties. | |
Qgis::ProcessingParameterFlags | mFlags |
Parameter flags. | |
QVariant | mGuiDefault |
Default value for parameter in GUI. | |
QString | mHelp |
Parameter help. | |
bool | mIsDynamic = false |
True for dynamic parameters, which can have data-defined (QgsProperty) based values. | |
QVariantMap | mMetadata |
Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior. | |
QString | mName |
Parameter name. | |
QgsPropertyDefinition | mPropertyDefinition |
Data defined property definition. | |
An enum based parameter for processing algorithms, allowing for selection from predefined values.
Since QGIS 3.24 a list of icons corresponding to the enum values can be specified by setting the widget wrapper metadata "icons" option, as demonstrated below. The "icons" value should be set to a list of QIcon values.
Definition at line 2762 of file qgsprocessingparameters.h.
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 4961 of file qgsprocessingparameters.cpp.
bool QgsProcessingParameterEnum::allowMultiple | ( | ) | const |
Returns true
if the parameter allows multiple selected values.
Definition at line 5266 of file qgsprocessingparameters.cpp.
|
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.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 5226 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Returns the parameter definition encoded in a string which can be used within a Processing script.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 5207 of file qgsprocessingparameters.cpp.
|
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 4975 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Creates a clone of the parameter definition.
Implements QgsProcessingParameterDefinition.
Definition at line 4970 of file qgsprocessingparameters.cpp.
|
static |
Creates a new parameter using the definition from a script code.
Definition at line 5304 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Restores this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 5295 of file qgsprocessingparameters.cpp.
QStringList QgsProcessingParameterEnum::options | ( | ) | const |
Returns the list of acceptable options for the parameter.
Definition at line 5256 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterEnum::setAllowMultiple | ( | bool | allowMultiple | ) |
Sets whether the parameter allows multiple selected values.
Definition at line 5271 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterEnum::setOptions | ( | const QStringList & | options | ) |
Sets the list of acceptable options for the parameter.
Definition at line 5261 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterEnum::setUsesStaticStrings | ( | bool | usesStaticStrings | ) |
Sets whether the parameter uses static (non-translated) string values for its enumeration choice list.
Definition at line 5281 of file qgsprocessingparameters.cpp.
|
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.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 5286 of file qgsprocessingparameters.cpp.
|
inlineoverridevirtual |
Unique parameter type name.
Implements QgsProcessingParameterDefinition.
Definition at line 2780 of file qgsprocessingparameters.h.
|
inlinestatic |
Returns the type name for the parameter class.
Definition at line 2778 of file qgsprocessingparameters.h.
bool QgsProcessingParameterEnum::usesStaticStrings | ( | ) | const |
Returns true
if the parameter uses static (non-translated) string values for its enumeration choice list.
Definition at line 5276 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Returns a Python comment explaining a parameter value, or an empty string if no comment is required.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 5161 of file qgsprocessingparameters.cpp.
|
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 5100 of file qgsprocessingparameters.cpp.