Class: QgsProcessingParameterFolderDestination¶
-
class
qgis.core.
QgsProcessingParameterFolderDestination
(name: str, description: str = '', defaultValue: Any = None, optional: bool = False)¶ Bases:
QgsProcessingDestinationParameter
Constructor for QgsProcessingParameterFolderDestination.
QgsProcessingParameterFolderDestination(
QgsProcessingParameterFolderDestination
)A folder destination parameter, for specifying the destination path for a folder created by the algorithm or used for creating new files within the algorithm. A folder output parameter.
New in version 3.0.
- Parameters
name (str) –
description (str = '') –
defaultValue (Any = None) –
optional –
-
checkValueIsAcceptable
(self, input: Any, context: QgsProcessingContext = None) → bool¶ - Parameters
input (Any) –
context (
QgsProcessingContext
= None) –
- Return type
bool
-
clone
(self) → QgsProcessingParameterDefinition¶ - Return type
-
defaultFileExtension
(self) → str¶ - Return type
str
-
fromScriptCode
(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterFolderDestination¶ Creates a new parameter using the definition from a script code.
- Parameters
name (str) –
description (str) –
isOptional (bool) –
definition (str) –
- Return type
-
originalProvider
()¶
-
toOutputDefinition
(self) → QgsProcessingOutputDefinition¶ - Return type
-
type
(self) → str¶ - Return type
str
-
typeName
() → str¶ Returns the type name for the parameter class.
- Return type
str