QgsMapLayerConfigWidgetContext Class Reference

Encapsulates the context for a QgsMapLayerConfigWidget. More...

#include <qgsmaplayerconfigwidget.h>

Public Member Functions
QString	annotationId () const
	Returns the item ID of the target annotation, when modifying an annotation from a QgsAnnotationLayer.
QgsLayerTreeGroup *	layerTreeGroup () const
	Returns the layer tree group associated with the widget.
QgsMapCanvas *	mapCanvas () const
	Returns the map canvas associated with the widget.
QgsMessageBar *	messageBar () const
	Returns the message bar associated with the widget.
void	setAnnotationId (const QString &id)
	Sets the item id of the target annotation, when modifying an annotation from a QgsAnnotationLayer.
void	setLayerTreeGroup (QgsLayerTreeGroup *group)
	Sets the layer tree group associated with the widget.
void	setMapCanvas (QgsMapCanvas *canvas)
	Sets the map canvas associated with the widget.
void	setMessageBar (QgsMessageBar *bar)
	Sets the message bar associated with the widget.

Detailed Description

Encapsulates the context for a QgsMapLayerConfigWidget.

Since

QGIS 3.22

Definition at line 36 of file qgsmaplayerconfigwidget.h.

Member Function Documentation

annotationId()

QString QgsMapLayerConfigWidgetContext::annotationId ( ) const

inline

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

See also

setAnnotationId()

Definition at line 46 of file qgsmaplayerconfigwidget.h.

layerTreeGroup()

QgsLayerTreeGroup * QgsMapLayerConfigWidgetContext::layerTreeGroup

(

)

const

Returns the layer tree group associated with the widget.

See also

setLayerTreeGroup()

Since

QGIS 3.24

Definition at line 28 of file qgsmaplayerconfigwidget.cpp.

mapCanvas()

QgsMapCanvas * QgsMapLayerConfigWidgetContext::mapCanvas ( ) const

inline

Returns the map canvas associated with the widget.

See also

setMapCanvas()

Definition at line 68 of file qgsmaplayerconfigwidget.h.

messageBar()

QgsMessageBar * QgsMapLayerConfigWidgetContext::messageBar ( ) const

inline

Returns the message bar associated with the widget.

See also

setMessageBar()

Definition at line 81 of file qgsmaplayerconfigwidget.h.

setAnnotationId()

void QgsMapLayerConfigWidgetContext::setAnnotationId ( const QString &  id )

inline

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

See also

annotationId()

Definition at line 54 of file qgsmaplayerconfigwidget.h.

setLayerTreeGroup()

void QgsMapLayerConfigWidgetContext::setLayerTreeGroup

(

QgsLayerTreeGroup *

group

)

Sets the layer tree group associated with the widget.

See also

layerTreeGroup()

Since

QGIS 3.24

Definition at line 23 of file qgsmaplayerconfigwidget.cpp.

setMapCanvas()

void QgsMapLayerConfigWidgetContext::setMapCanvas ( QgsMapCanvas *  canvas )

inline

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

Definition at line 62 of file qgsmaplayerconfigwidget.h.

setMessageBar()

void QgsMapLayerConfigWidgetContext::setMessageBar ( QgsMessageBar *  bar )

inline

Sets the message bar associated with the widget.

This allows the widget to push feedback messages to the appropriate message bar.

See also

messageBar()

Definition at line 75 of file qgsmaplayerconfigwidget.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.34.0+99sid/src/gui/qgsmaplayerconfigwidget.h
• /build/qgis-3.34.0+99sid/src/gui/qgsmaplayerconfigwidget.cpp