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.
Methods
Returns the map canvas associated with the widget.
Returns the model which the parameter widget is associated with.
Returns the child algorithm ID within the model which the parameter widget is associated with.
Sets the map
canvas
associated with the widget.Sets the
model
which the parameter widget is associated with.Sets the child algorithm
id
within the model which the parameter widget is associated with.-
mapCanvas
(self) → QgsMapCanvas¶ Returns the map canvas associated with the widget.
See also
- Return type
-
model
(self) → QgsProcessingModelAlgorithm¶ Returns the model which the parameter widget is associated with.
See also
See also
- Return type
-
modelChildAlgorithmId
(self) → str¶ Returns the child algorithm ID within the model which the parameter widget is associated with.
See also
See also
- Return type
str
-
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
- Parameters
canvas (QgsMapCanvas) –
-
setModel
(self, model: QgsProcessingModelAlgorithm)¶ Sets the
model
which the parameter widget is associated with.See also
See also
- Parameters
model (QgsProcessingModelAlgorithm) –
-
setModelChildAlgorithmId
(self, id: str)¶ Sets the child algorithm
id
within the model which the parameter widget is associated with.See also
See also
- Parameters
id (str) –
-