Class: 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.

Class Hierarchy

Inheritance diagram of qgis.core.QgsProcessingParameterFolderDestination

Base classes

QgsProcessingDestinationParameter

Base class for all parameter definitions which represent file or layer destinations, e.g. parameters which are used for the destination for layers output by an algorithm.

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

QgsFileFilterGenerator

Abstract interface for classes which generate a file filter string.

Static Methods

fromScriptCode

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

typeName

Returns the type name for the parameter class.
class qgis.core.QgsProcessingParameterFolderDestination[source]

Bases: QgsProcessingDestinationParameter

__init__(name: str | None, description: str | None = '', defaultValue: Any = None, optional: bool = False, createByDefault: bool = True)

Constructor for QgsProcessingParameterFolderDestination.

Parameters:

  • name (Optional[str])

  • description (Optional[str] = '')

  • defaultValue (Any = None)

  • optional (bool = False)

  • createByDefault (bool = True)

__init__(a0: QgsProcessingParameterFolderDestination)
Parameters:

a0 (QgsProcessingParameterFolderDestination)

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterFolderDestination | None[source]

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

Parameters:

  • name (Optional[str])

  • description (Optional[str])

  • isOptional (bool)

  • definition (Optional[str])

Return type:

Optional[QgsProcessingParameterFolderDestination]

static typeName() → str[source]

Returns the type name for the parameter class.

Return type:

str