Class: QgsProcessingParameterBoolean

A boolean parameter for processing algorithms.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

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.QgsProcessingParameterBoolean

Bases: QgsProcessingParameterDefinition

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

Constructor for QgsProcessingParameterBoolean.

Parameters:

• name (Optional[str])

• description (Optional[str] = '')

• defaultValue (Any = None)

• optional (bool = False)

__init__(a0: QgsProcessingParameterBoolean)

Parameters:

a0 (QgsProcessingParameterBoolean)

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterBoolean | None

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[QgsProcessingParameterBoolean]

static typeName() → str

Returns the type name for the parameter class.

Return type:

str