Class: QgsMapLayerConfigWidgetContext

Encapsulates the context for a QgsMapLayerConfigWidget.

Added in version 3.22.

Methods

annotationId	Returns the item ID of the target annotation, when modifying an annotation from a QgsAnnotationLayer.
layerTreeGroup	Returns the layer tree group associated with the widget.
mapCanvas	Returns the map canvas associated with the widget.
messageBar	Returns the message bar associated with the widget.
setAnnotationId	Sets the item id of the target annotation, when modifying an annotation from a QgsAnnotationLayer.
setLayerTreeGroup	Sets the layer tree group associated with the widget.
setMapCanvas	Sets the map canvas associated with the widget.
setMessageBar	Sets the message bar associated with the widget.

class qgis.gui.QgsMapLayerConfigWidgetContext

Bases: object

annotationId(self) → str

Returns the item ID of the target annotation, when modifying an annotation from a QgsAnnotationLayer.

See also

setAnnotationId()

Return type:

str

layerTreeGroup(self) → QgsLayerTreeGroup | None

Returns the layer tree group associated with the widget.

See also

setLayerTreeGroup()

Added in version 3.24.

Return type:

Optional[QgsLayerTreeGroup]

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.

See also

setMessageBar()

Return type:

Optional[QgsMessageBar]

setAnnotationId(self, id: str | None)

Sets the item id of the target annotation, when modifying an annotation from a QgsAnnotationLayer.

See also

annotationId()

Parameters:

id (Optional[str])

setLayerTreeGroup(self, group: QgsLayerTreeGroup | None)

Sets the layer tree group associated with the widget.

See also

layerTreeGroup()

Added in version 3.24.

Parameters:

group (Optional[QgsLayerTreeGroup])

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 appropriate message bar.

See also

messageBar()

Parameters:

bar (Optional[QgsMessageBar])