Class: QgsProcessingParameterString

class qgis.core.QgsProcessingParameterString(name: str, description: str = '', defaultValue: Any = None, multiLine: bool = False, optional: bool = False)

Bases: qgis._core.QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterString.

QgsProcessingParameterString(QgsProcessingParameterString)

A string parameter for processing algorithms.

New in version 3.0: Methods

asScriptCode
clone
fromScriptCode Creates a new parameter using the definition from a script code.
fromVariantMap
multiLine Returns true if the parameter allows multiline strings.
setMultiLine Sets whether the parameter allows multiline strings.
toVariantMap
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

asScriptCode(self) → str
clone(self) → QgsProcessingParameterDefinition
fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterString

Creates a new parameter using the definition from a script code.

fromVariantMap(self, map: Dict[str, Any]) → bool
multiLine(self) → bool

Returns true if the parameter allows multiline strings.

See also

setMultiLine()

setMultiLine(self, multiLine: bool)

Sets whether the parameter allows multiline strings.

See also

multiLine()

toVariantMap(self) → Dict[str, Any]
type(self) → str
typeName() → str

Returns the type name for the parameter class.

valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str