Class: QgsProcessingParameterString¶
-
class
qgis.core.
QgsProcessingParameterString
(name: str, description: str = '', defaultValue: Any = None, multiLine: bool = False, optional: bool = False)¶ Bases:
QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterString.
QgsProcessingParameterString(
QgsProcessingParameterString
)A string parameter for processing algorithms.
New in version 3.0.
- Parameters
name (str) –
description (str = '') –
defaultValue (Any = None) –
multiLine (bool = False) –
optional –
-
asScriptCode
(self) → str¶ - Return type
str
-
clone
(self) → QgsProcessingParameterDefinition¶ - Return type
-
fromScriptCode
(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterString¶ Creates a new parameter using the definition from a script code.
- Parameters
name (str) –
description (str) –
isOptional (bool) –
definition (str) –
- Return type
-
fromVariantMap
(self, map: Dict[str, Any]) → bool¶ - Parameters
map (Dict[str) –
- Return type
bool
-
multiLine
(self) → bool¶ Returns true if the parameter allows multiline strings.
See also
- Return type
bool
-
setMultiLine
(self, multiLine: bool)¶ Sets whether the parameter allows multiline strings.
See also
- Parameters
multiLine (bool) –
-
toVariantMap
(self) → Dict[str, Any]¶ - Return type
Dict[str, Any]
-
type
(self) → str¶ - Return type
str
-
typeName
() → str¶ Returns the type name for the parameter class.
- Return type
str
-
valueAsPythonString
(self, value: Any, context: QgsProcessingContext) → str¶ - Parameters
value (Any) –
context (QgsProcessingContext) –
- Return type
str