A double numeric parameter for map scale values. More...

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterScale:

Public Member Functions
	QgsProcessingParameterScale (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
	Constructor for QgsProcessingParameterScale. 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...

QgsProcessingParameterScale *	clone () const override
	Creates a clone of the parameter definition. More...

QString	type () const override
	Unique parameter type name. More...

Public Member Functions inherited from QgsProcessingParameterNumber
	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...

bool	checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const override
	Checks whether the specified input value is acceptable for the parameter. 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	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)
	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	asScriptCode () const
	Returns the parameter definition encoded in a string which can be used within a Processing script. More...

QVariant	defaultValue () const
	Returns the default value for the parameter. 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	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 () const
	Returns the parameter's freeform metadata. More...

QVariantMap &	metadata ()
	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	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...

Static Public Member Functions
static QgsProcessingParameterScale *	fromScriptCode (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...

Static Public Member Functions inherited from QgsProcessingParameterNumber
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. More...

static QString	typeName ()
	Returns the type name for the parameter class. More...

Additional Inherited Members
Public Types inherited from QgsProcessingParameterNumber
enum	Type { Integer, Double }
	Numeric data type. More...

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

QgsProcessingAlgorithm *	mAlgorithm = 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...

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

A double numeric parameter for map scale values.

QgsProcessingParameterScale should be evaluated by calling QgsProcessingAlgorithm::parameterAsDouble(), which will return a numeric value representing the scale denominator.

Since: QGIS 3.8

Definition at line 1701 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterScale()

QgsProcessingParameterScale::QgsProcessingParameterScale	(	const QString &	name,
		const QString &	description = `QString()`,
		const QVariant &	defaultValue = `QVariant()`,
		bool	optional = `false`
	)

explicit

Constructor for QgsProcessingParameterScale.

Definition at line 5346 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ asPythonString()

QString QgsProcessingParameterScale::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 QgsProcessingParameterNumber.

Definition at line 5362 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterScale * QgsProcessingParameterScale::clone ( ) const

overridevirtual

Creates a clone of the parameter definition.

Reimplemented from QgsProcessingParameterNumber.

Definition at line 5352 of file qgsprocessingparameters.cpp.

◆ fromScriptCode()

QgsProcessingParameterScale * QgsProcessingParameterScale::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 5379 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterScale::type ( ) const

overridevirtual

Unique parameter type name.

Reimplemented from QgsProcessingParameterNumber.

Definition at line 5357 of file qgsprocessingparameters.cpp.

◆ typeName()

static QString QgsProcessingParameterScale::typeName ( )

inlinestatic

Returns the type name for the parameter class.

Definition at line 1715 of file qgsprocessingparameters.h.

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

/tmp/buildd/qgis-3.8.0+99unstable/src/core/processing/qgsprocessingparameters.h
/tmp/buildd/qgis-3.8.0+99unstable/src/core/processing/qgsprocessingparameters.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsProcessingParameterScale()

Member Function Documentation

◆ asPythonString()

◆ clone()

◆ fromScriptCode()

◆ type()

◆ typeName()