Class: QgsProcessingParameterBoolean

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

Bases: qgis._core.QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterBoolean.

QgsProcessingParameterBoolean(QgsProcessingParameterBoolean)

A boolean parameter for processing algorithms.

New in version 3.0: Methods

asScriptCode
clone
fromScriptCode Creates a new parameter using the definition from a script code.
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

asScriptCode(self) → str
clone(self) → QgsProcessingParameterDefinition
fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterBoolean

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

type(self) → str
typeName() → str

Returns the type name for the parameter class.

valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str