QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
A double numeric parameter for area values. More...
#include <qgsprocessingparameters.h>
Public Member Functions | |
QgsProcessingParameterArea (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentParameterName=QString(), bool optional=false, double minValue=0, double maxValue=std::numeric_limits< double >::max()) | |
Constructor for QgsProcessingParameterArea. | |
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. | |
QgsProcessingParameterArea * | clone () const override |
Creates a clone of the parameter definition. | |
Qgis::AreaUnit | defaultUnit () const |
Returns the default area unit for the parameter. | |
QStringList | dependsOnOtherParameters () const override |
Returns a list of other parameter names on which this parameter is dependent (e.g. | |
bool | fromVariantMap (const QVariantMap &map) override |
Restores this parameter to a QVariantMap. | |
QString | parentParameterName () const |
Returns the name of the parent parameter, or an empty string if this is not set. | |
void | setDefaultUnit (Qgis::AreaUnit unit) |
Sets the default area unit for the parameter. | |
void | setParentParameterName (const QString &parentParameterName) |
Sets the name of the parent layer parameter. | |
QVariantMap | toVariantMap () const override |
Saves this parameter to a QVariantMap. | |
QString | type () const override |
Unique parameter type name. | |
![]() | |
QgsProcessingParameterNumber (const QString &name, const QString &description=QString(), Qgis::ProcessingNumberParameterType type=Qgis::ProcessingNumberParameterType::Integer, const QVariant &defaultValue=QVariant(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max()) | |
Constructor for QgsProcessingParameterNumber. | |
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. | |
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. | |
Qgis::ProcessingNumberParameterType | dataType () const |
Returns the acceptable data type for the parameter. | |
bool | fromVariantMap (const QVariantMap &map) override |
Restores this parameter to a QVariantMap. | |
double | maximum () const |
Returns the maximum value acceptable by the parameter. | |
double | minimum () const |
Returns the minimum value acceptable by the parameter. | |
void | setDataType (Qgis::ProcessingNumberParameterType type) |
Sets the acceptable data type for the parameter. | |
void | setMaximum (double maximum) |
Sets the maximum value acceptable by the parameter. | |
void | setMinimum (double minimum) |
Sets the minimum value acceptable by the parameter. | |
QString | toolTip () const override |
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). | |
QVariantMap | toVariantMap () const override |
Saves this parameter to a QVariantMap. | |
QString | type () const override |
Unique parameter type name. | |
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. | |
![]() | |
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. | |
virtual QString | asScriptCode () const |
Returns the parameter definition encoded in a string which can be used within a Processing script. | |
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. | |
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 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 | valueAsPythonComment (const QVariant &value, QgsProcessingContext &context) const |
Returns a Python comment explaining a parameter value, or an empty string if no comment is required. | |
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 QString | typeName () |
Returns the type name for the parameter class. | |
![]() | |
static QgsProcessingParameterNumber * | 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 | |
![]() | |
enum class | ValueAsStringFlag : int { AllowMapLayerValues = 1 << 0 } |
Flags for passing to the valueAsStringPrivate() method. More... | |
typedef QFlags< ValueAsStringFlag > | ValueAsStringFlags |
![]() | |
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. | |
![]() | |
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. | |
A double numeric parameter for area values.
Linked to a source layer or CRS parameter to determine what units the area values are in.
The number of decimals places shown in a area parameter's widget can be specified by setting the parameter's metadata. For example:
Definition at line 2425 of file qgsprocessingparameters.h.
|
explicit |
Constructor for QgsProcessingParameterArea.
Definition at line 7723 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 7748 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Creates a clone of the parameter definition.
Implements QgsProcessingParameterDefinition.
Definition at line 7730 of file qgsprocessingparameters.cpp.
|
inline |
Returns the default area unit for the parameter.
Definition at line 2467 of file qgsprocessingparameters.h.
|
overridevirtual |
Returns a list of other parameter names on which this parameter is dependent (e.g.
field parameters which depend on a parent layer parameter).
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 7740 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 7791 of file qgsprocessingparameters.cpp.
QString QgsProcessingParameterArea::parentParameterName | ( | ) | const |
Returns the name of the parent parameter, or an empty string if this is not set.
Definition at line 7773 of file qgsprocessingparameters.cpp.
|
inline |
Sets the default area unit for the parameter.
Definition at line 2474 of file qgsprocessingparameters.h.
void QgsProcessingParameterArea::setParentParameterName | ( | const QString & | parentParameterName | ) |
Sets the name of the parent layer parameter.
Use an empty string if this is not required.
Definition at line 7778 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 7783 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Unique parameter type name.
Implements QgsProcessingParameterDefinition.
Definition at line 7735 of file qgsprocessingparameters.cpp.
|
inlinestatic |
Returns the type name for the parameter class.
Definition at line 2442 of file qgsprocessingparameters.h.