Class: QgsProcessingParameterFolderDestination¶
- class qgis.core.QgsProcessingParameterFolderDestination¶
Bases:
QgsProcessingDestinationParameter
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.
QgsProcessingParameterFolderDestination(name: str, description: str = ‘’, defaultValue: Any = None, optional: bool = False, createByDefault: bool = True) Constructor for QgsProcessingParameterFolderDestination.
QgsProcessingParameterFolderDestination(
QgsProcessingParameterFolderDestination
)Methods
- param input:
- rtype:
QgsProcessingParameterDefinition
- rtype:
str
Default gui value for an algorithm parameter from settings
Creates a new parameter using the definition from a script code.
Original (source) provider which this parameter has been derived from.
- rtype:
QgsProcessingOutputDefinition
- rtype:
str
Returns the type name for the parameter class.
- 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
- defaultGuiValueFromSetting(self) Any ¶
Default gui value for an algorithm parameter from settings
- Returns:
default value from settings or invalid QVariant if there is no default value defined in the settings
New in version 3.34.
- 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(self) QgsProcessingProvider ¶
Original (source) provider which this parameter has been derived from. In the case of destination parameters which are part of model algorithms, this will reflect the child algorithm’s provider which actually generates the parameter, as opposed to the provider which this parameter belongs to (i.e. the model provider)
New in version 3.2.
- toOutputDefinition(self) QgsProcessingOutputDefinition ¶
- Return type:
- type(self) str ¶
- Return type:
str
- typeName() str ¶
Returns the type name for the parameter class.
- Return type:
str