Subgroup: Processing

Class: QgsProcessingParameterWidgetContext

class qgis.gui.QgsProcessingParameterWidgetContext

Bases: sip.wrapper

Constructor for QgsProcessingParameterWidgetContext.

QgsProcessingParameterWidgetContext(QgsProcessingParameterWidgetContext)

Contains settings which reflect the context in which a Processing parameter widget is shown, e.g., the parent model algorithm, a linked map canvas, and other relevant information which allows the widget to fine-tune its behavior.

New in version 3.4: Methods

mapCanvas Returns the map canvas associated with the widget.
model Returns the model which the parameter widget is associated with.
modelChildAlgorithmId Returns the child algorithm ID within the model which the parameter widget is associated with.
setMapCanvas Sets the map canvas associated with the widget.
setModel Sets the model which the parameter widget is associated with.
setModelChildAlgorithmId Sets the child algorithm id within the model which the parameter widget is associated with.

Signals

Attributes

mapCanvas(self) → QgsMapCanvas

Returns the map canvas associated with the widget.

See also

setMapCanvas()

model(self) → QgsProcessingModelAlgorithm

Returns the model which the parameter widget is associated with.

See also

setModel()

modelChildAlgorithmId(self) → str

Returns the child algorithm ID within the model which the parameter widget is associated with.

See also

model()

setMapCanvas(self, canvas: QgsMapCanvas)

Sets the map canvas associated with the widget. This allows the widget to retrieve the current map scale and other properties from the canvas.

See also

mapCanvas()

setModel(self, model: QgsProcessingModelAlgorithm)

Sets the model which the parameter widget is associated with.

See also

model()

setModelChildAlgorithmId(self, id: str)

Sets the child algorithm id within the model which the parameter widget is associated with.

See also

setModel()