QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | List of all members
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. More...
 
QgsMapCanvasmapCanvas () const
 Returns the map canvas associated with the widget. More...
 
QgsMessageBarmessageBar () const
 Returns the message bar associated with the widget. More...
 
void setAnnotationId (const QString &id)
 Sets the item id of the target annotation, when modifying an annotation from a QgsAnnotationLayer. More...
 
void setMapCanvas (QgsMapCanvas *canvas)
 Sets the map canvas associated with the widget. More...
 
void setMessageBar (QgsMessageBar *bar)
 Sets the message bar associated with the widget. More...
 

Detailed Description

Encapsulates the context for a QgsMapLayerConfigWidget.

Since
QGIS 3.22

Definition at line 34 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 44 of file qgsmaplayerconfigwidget.h.

◆ mapCanvas()

QgsMapCanvas* QgsMapLayerConfigWidgetContext::mapCanvas ( ) const
inline

Returns the map canvas associated with the widget.

See also
setMapCanvas()

Definition at line 66 of file qgsmaplayerconfigwidget.h.

◆ messageBar()

QgsMessageBar* QgsMapLayerConfigWidgetContext::messageBar ( ) const
inline

Returns the message bar associated with the widget.

See also
setMessageBar()

Definition at line 79 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 52 of file qgsmaplayerconfigwidget.h.

◆ 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 60 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 73 of file qgsmaplayerconfigwidget.h.


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