Class: QgsProcessingParameterFolderDestination

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

Bases: qgis._core.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: Enums

Methods

checkValueIsAcceptable
clone
defaultFileExtension
fromScriptCode Creates a new parameter using the definition from a script code.
originalProvider
toOutputDefinition
type
typeName Returns the type name for the parameter class.

Signals

Attributes

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
clone(self) → QgsProcessingParameterDefinition
defaultFileExtension(self) → str
fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterFolderDestination

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

originalProvider()
toOutputDefinition(self) → QgsProcessingOutputDefinition
type(self) → str
typeName() → str

Returns the type name for the parameter class.