Class: QgsProcessingParameterFileDestination

class qgis.core.QgsProcessingParameterFileDestination(name: str, description: str = '', fileFilter: str = '', defaultValue: Any = None, optional: bool = False, createByDefault: bool = True)

Bases: qgis._core.QgsProcessingDestinationParameter

Constructor for QgsProcessingParameterFileDestination.

If createByDefault is false and the parameter is optional, then this destination output will not be created by default.

QgsProcessingParameterFileDestination(QgsProcessingParameterFileDestination)

A generic file based destination parameter, for specifying the destination path for a file (non-map layer) created by the algorithm.

New in version 3.0: Methods

checkValueIsAcceptable
clone
defaultFileExtension
fileFilter Returns the file filter string for file destinations compatible with this parameter.
fromScriptCode Creates a new parameter using the definition from a script code.
fromVariantMap
originalProvider
setFileFilter Sets the file filter string for file destinations compatible with this parameter.
toOutputDefinition
toVariantMap
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
clone(self) → QgsProcessingParameterDefinition
defaultFileExtension(self) → str
fileFilter(self) → str

Returns the file filter string for file destinations compatible with this parameter.

See also

setFileFilter()

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterFileDestination

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

fromVariantMap(self, map: Dict[str, Any]) → bool
originalProvider()
setFileFilter(self, filter: str)

Sets the file filter string for file destinations compatible with this parameter.

See also

fileFilter()

toOutputDefinition(self) → QgsProcessingOutputDefinition
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