Class: 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.

Added in version 3.4.

Methods

activeLayer	Returns the current active layer.
browserModel	Returns the browser model associated with the widget.
mapCanvas	Returns the map canvas associated with the widget.
messageBar	Returns the message bar 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.
project	Returns the project associated with the widget.
setActiveLayer	Sets the current active layer.
setBrowserModel	Sets the browser model associated with the widget.
setMapCanvas	Sets the map canvas associated with the widget.
setMessageBar	Sets the message bar 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.
setProject	Sets the project associated with the widget.

class qgis.gui.QgsProcessingParameterWidgetContext

Bases: object

activeLayer(self) → QgsMapLayer | None

Returns the current active layer.

See also

setActiveLayer()

Added in version 3.14.

Return type:

Optional[QgsMapLayer]

browserModel(self) → QgsBrowserGuiModel | None

Returns the browser model associated with the widget.

See also

setBrowserModel()

Added in version 3.12.

Return type:

Optional[QgsBrowserGuiModel]

mapCanvas(self) → QgsMapCanvas | None

Returns the map canvas associated with the widget.

See also

setMapCanvas()

Return type:

Optional[QgsMapCanvas]

messageBar(self) → QgsMessageBar | None

Returns the message bar associated with the widget. This allows the widget to push feedback messages to the user.

See also

setMessageBar()

Added in version 3.12.

Return type:

Optional[QgsMessageBar]

model(self) → QgsProcessingModelAlgorithm | None

Returns the model which the parameter widget is associated with.

See also

setModel()

See also

modelChildAlgorithmId()

Return type:

Optional[QgsProcessingModelAlgorithm]

modelChildAlgorithmId(self) → str

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

See also

setModelChildAlgorithmId()

See also

model()

Return type:

str

project(self) → QgsProject | None

Returns the project associated with the widget.

See also

setProject()

Return type:

Optional[QgsProject]

setActiveLayer(self, layer: QgsMapLayer | None)

Sets the current active layer.

See also

activeLayer()

Added in version 3.14.

Parameters:

layer (Optional[QgsMapLayer])

setBrowserModel(self, model: QgsBrowserGuiModel | None)

Sets the browser model associated with the widget. This will usually be the shared app instance of the browser model

See also

browserModel()

Added in version 3.14.

Parameters:

model (Optional[QgsBrowserGuiModel])

setMapCanvas(self, canvas: QgsMapCanvas | None)

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()

Parameters:

canvas (Optional[QgsMapCanvas])

setMessageBar(self, bar: QgsMessageBar | None)

Sets the message bar associated with the widget. This allows the widget to push feedback messages to the user.

See also

messageBar()

Added in version 3.12.

Parameters:

bar (Optional[QgsMessageBar])

setModel(self, model: QgsProcessingModelAlgorithm | None)

Sets the model which the parameter widget is associated with.

See also

model()

See also

setModelChildAlgorithmId()

Parameters:

model (Optional[QgsProcessingModelAlgorithm])

setModelChildAlgorithmId(self, id: str | None)

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

See also

modelChildAlgorithmId()

See also

setModel()

Parameters:

id (Optional[str])

setProject(self, project: QgsProject | None)

Sets the project associated with the widget. This allows the widget to retrieve the map layers and other properties from the correct project.

See also

project()

Added in version 3.8.

Parameters:

project (Optional[QgsProject])