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

QString	asScriptCode () const override
	Returns the parameter definition encoded in a string which can be used within a Python processing script. More...

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

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

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

void	setMultiLine (bool multiLine)
	Sets whether the parameter allows multiline strings. 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...

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

QgsProcessingAlgorithm *	algorithm () const
	Returns a pointer to the algorithm which owns this parameter. More...

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

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

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

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

Additional Inherited Members
Public Types inherited from QgsProcessingParameterDefinition
enum	Flag { FlagAdvanced = 1 << 1, FlagHidden = 1 << 2, FlagOptional = 1 << 3 }
	Parameter flags. More...

Protected Attributes inherited from QgsProcessingParameterDefinition
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 customise their appearance and behavior. More...

QString	mName
	Parameter name. More...

QgsPropertyDefinition	mPropertyDefinition
	Data defined property definition. More...

Detailed Description

A string parameter for processing algorithms.

Since: QGIS 3.0

Definition at line 1393 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 2424 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ asScriptCode()

QString QgsProcessingParameterString::asScriptCode ( ) const

overridevirtual

Returns the parameter definition encoded in a string which can be used within a Python processing script.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2446 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterDefinition * QgsProcessingParameterString::clone ( ) const

overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 2431 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 2484 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 2477 of file qgsprocessingparameters.cpp.

◆ multiLine()

bool QgsProcessingParameterString::multiLine ( ) const

Returns true if the parameter allows multiline strings.

See also: setMultiLine()

Definition at line 2460 of file qgsprocessingparameters.cpp.

◆ setMultiLine()

void QgsProcessingParameterString::setMultiLine ( bool multiLine )

Sets whether the parameter allows multiline strings.

See also: multiLine()

Definition at line 2465 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 2470 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterString::type ( ) const

inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 1409 of file qgsprocessingparameters.h.

◆ typeName()

static QString QgsProcessingParameterString::typeName ( )

inlinestatic

Returns the type name for the parameter class.

Definition at line 1407 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.

The returned value must be correctly escaped - e.g. string values must be wrapped in ' 's.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2436 of file qgsprocessingparameters.cpp.

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

/tmp/buildd/qgis-3.0.2+14stretch/src/core/processing/qgsprocessingparameters.h
/tmp/buildd/qgis-3.0.2+14stretch/src/core/processing/qgsprocessingparameters.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsProcessingParameterString()

Member Function Documentation

◆ asScriptCode()

◆ clone()

◆ fromScriptCode()

◆ fromVariantMap()

◆ multiLine()

◆ setMultiLine()

◆ toVariantMap()

◆ type()

◆ typeName()

◆ valueAsPythonString()