A string parameter for processing algorithms. More...

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterString:

Public Member Functions
	QgsProcessingParameterString (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool multiLine=false, bool optional=false)
	Constructor for QgsProcessingParameterString.

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.

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

bool	fromVariantMap (const QVariantMap &map) override
	Restores this parameter to a QVariantMap.

bool	multiLine () const
	Returns `true` if the parameter allows multiline strings.

void	setMultiLine (bool multiLine)
	Sets whether the parameter allows multiline strings.

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.

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.

virtual bool	checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const
	Checks whether the specified input value is acceptable for the 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	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 QgsProcessingParameterString *	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.

Detailed Description

A string parameter for processing algorithms.

A parameter type which allows users to enter any string value.

In some circumstances it is desirable to restrict the values available when a user is asked to enter a string parameter to a list of predetermined "valid" values. Since QGIS 3.22 this can be done by setting the widget wrapper metadata "value_hints" option, as demonstrated below. (While this provides a mechanism for guiding users to select from valid string values when running a Processing algorithm through the GUI, it does not place any limits on the string values accepted via PyQGIS codes or when running the algorithm via other non-gui means. Algorithms should gracefully handle other values accordingly.)

param = QgsProcessingParameterString( 'PRINTER_NAME', 'Printer name')
# show only printers which are available on the current system as options
# for the string input.
param.setMetadata( {'widget_wrapper':
  { 'value_hints': ['Inkjet printer', 'Laser printer'] }
})

Definition at line 2868 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterString()

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

Constructor for QgsProcessingParameterString.

Definition at line 5335 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ asPythonString()

QString QgsProcessingParameterString::asPythonString ( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonOutputType::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 5373 of file qgsprocessingparameters.cpp.

◆ asScriptCode()

QString QgsProcessingParameterString::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 5359 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterDefinition * QgsProcessingParameterString::clone ( ) const

overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 5342 of file qgsprocessingparameters.cpp.

◆ fromScriptCode()

QgsProcessingParameterString * QgsProcessingParameterString::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 5417 of file qgsprocessingparameters.cpp.

◆ fromVariantMap()

bool QgsProcessingParameterString::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 5410 of file qgsprocessingparameters.cpp.

◆ multiLine()

bool QgsProcessingParameterString::multiLine ( ) const

Returns true if the parameter allows multiline strings.

See also: setMultiLine()

Definition at line 5393 of file qgsprocessingparameters.cpp.

◆ setMultiLine()

void QgsProcessingParameterString::setMultiLine ( bool multiLine )

Sets whether the parameter allows multiline strings.

See also: multiLine()

Definition at line 5398 of file qgsprocessingparameters.cpp.

◆ toVariantMap()

QVariantMap QgsProcessingParameterString::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 5403 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterString::type ( ) const

inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 2884 of file qgsprocessingparameters.h.

◆ typeName()

static QString QgsProcessingParameterString::typeName ( )

inlinestatic

Returns the type name for the parameter class.

Definition at line 2882 of file qgsprocessingparameters.h.

◆ valueAsPythonString()

QString QgsProcessingParameterString::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.

See also: valueAsJsonObject(); valueAsString()

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 5347 of file qgsprocessingparameters.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/processing/qgsprocessingparameters.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/processing/qgsprocessingparameters.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsProcessingParameterString()

Member Function Documentation

◆ asPythonString()

◆ asScriptCode()

◆ clone()

◆ fromScriptCode()

◆ fromVariantMap()

◆ multiLine()

◆ setMultiLine()

◆ toVariantMap()

◆ type()

◆ typeName()

◆ valueAsPythonString()