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: Enums
Methods
Creates a new parameter using the definition from a script code.
Returns
True
if the parameter allows multiline strings.Sets whether the parameter allows multiline strings.
Returns the type name for the parameter class.
Signals
Attributes
-
asPythonString
(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str¶
-
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
(self, multiLine: bool)¶ Sets whether the parameter allows multiline strings.
See also
-
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¶
-