|
| QgsProcessingParameterDistance (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentParameterName=QString(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max()) |
| Constructor for QgsProcessingParameterDistance. 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...
|
|
QgsProcessingParameterDistance * | clone () const override |
| Creates a clone of the parameter definition. More...
|
|
QgsUnitTypes::DistanceUnit | defaultUnit () const |
| Returns the default distance unit for the parameter. More...
|
|
QStringList | dependsOnOtherParameters () const override |
| Returns a list of other parameter names on which this parameter is dependent (e.g. More...
|
|
bool | fromVariantMap (const QVariantMap &map) override |
| Restores this parameter to a QVariantMap. More...
|
|
QString | parentParameterName () const |
| Returns the name of the parent parameter, or an empty string if this is not set. More...
|
|
void | setDefaultUnit (QgsUnitTypes::DistanceUnit unit) |
| Sets the default distance unit for the parameter. More...
|
|
void | setParentParameterName (const QString &parentParameterName) |
| Sets the name of the parent layer parameter. More...
|
|
QVariantMap | toVariantMap () const override |
| Saves this parameter to a QVariantMap. More...
|
|
QString | type () const override |
| Unique parameter type name. More...
|
|
| QgsProcessingParameterNumber (const QString &name, const QString &description=QString(), Type type=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. 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...
|
|
bool | checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const override |
| Checks whether the specified input value is acceptable for the parameter. More...
|
|
QgsProcessingParameterDefinition * | clone () const override |
| Creates a clone of the parameter definition. More...
|
|
Type | dataType () const |
| Returns the acceptable data type for the parameter. More...
|
|
bool | fromVariantMap (const QVariantMap &map) override |
| Restores this parameter to a QVariantMap. More...
|
|
double | maximum () const |
| Returns the maximum value acceptable by the parameter. More...
|
|
double | minimum () const |
| Returns the minimum value acceptable by the parameter. More...
|
|
void | setDataType (Type type) |
| Sets the acceptable data type for the parameter. More...
|
|
void | setMaximum (double maximum) |
| Sets the maximum value acceptable by the parameter. More...
|
|
void | setMinimum (double minimum) |
| Sets the minimum value acceptable by the parameter. More...
|
|
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). More...
|
|
QVariantMap | toVariantMap () const override |
| Saves this parameter to a QVariantMap. More...
|
|
QString | type () const override |
| Unique parameter type name. 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...
|
|
| 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...
|
|
QgsProcessingAlgorithm * | algorithm () const |
| Returns a pointer to the algorithm which owns this parameter. More...
|
|
virtual QString | asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const |
| Returns the parameter definition as a Python command which can be used within a Python Processing script. More...
|
|
virtual QString | asScriptCode () const |
| Returns the parameter definition encoded in a string which can be used within a Processing script. More...
|
|
virtual bool | checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const |
| Checks whether the specified input value is acceptable for the parameter. More...
|
|
virtual QgsProcessingParameterDefinition * | clone () const =0 |
| Creates a clone of the parameter definition. 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...
|
|
virtual bool | fromVariantMap (const QVariantMap &map) |
| Restores this parameter to a QVariantMap. 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...
|
|
QgsProcessingProvider * | provider () 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...
|
|
virtual QVariantMap | toVariantMap () const |
| Saves this parameter to a QVariantMap. More...
|
|
virtual QString | type () const =0 |
| Unique parameter type name. More...
|
|
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. More...
|
|
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. More...
|
|
virtual QString | valueAsPythonString (const QVariant &value, QgsProcessingContext &context) const |
| 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...
|
|
virtual QString | valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
| Returns a string version of the parameter input value (if possible). More...
|
|
virtual QStringList | valueAsStringList (const QVariant &value, QgsProcessingContext &context, bool &ok) const |
| Returns a string list version of the parameter input value (if possible). More...
|
|