Encapsulates the context in which a QgsDataItem is shown within the application GUI. More...

#include <qgsdataitemguiprovider.h>

Public Member Functions
	QgsDataItemGuiContext ()=default

QgsMapCanvas *	mapCanvas () const
	Returns the map canvas associated with the item.

QgsMessageBar *	messageBar () const
	Returns the associated message bar.

void	setMapCanvas (QgsMapCanvas *canvas)
	Sets the map canvas associated with the data item.

void	setMessageBar (QgsMessageBar *bar)
	Sets the associated message bar.

void	setView (QgsBrowserTreeView *view)
	Sets the associated view.

QgsBrowserTreeView *	view () const
	Returns the associated view.

Detailed Description

Encapsulates the context in which a QgsDataItem is shown within the application GUI.

Since: QGIS 3.6

Definition at line 42 of file qgsdataitemguiprovider.h.

Constructor & Destructor Documentation

◆ QgsDataItemGuiContext()

QgsDataItemGuiContext::QgsDataItemGuiContext ( )

default

Member Function Documentation

◆ mapCanvas()

QgsMapCanvas * QgsDataItemGuiContext::mapCanvas ( ) const

Returns the map canvas associated with the item.

See also: setMapCanvas()

Since: QGIS 3.44

Definition at line 42 of file qgsdataitemguiprovider.cpp.

◆ messageBar()

QgsMessageBar * QgsDataItemGuiContext::messageBar ( ) const

Returns the associated message bar.

This bar can be used to provide non-blocking feedback to users.

See also: setMessageBar()

Definition at line 27 of file qgsdataitemguiprovider.cpp.

◆ setMapCanvas()

void QgsDataItemGuiContext::setMapCanvas ( QgsMapCanvas * canvas )

Sets the map canvas associated with the data item.

This allows the item to retrieve the current map scale and other properties from the canvas.

See also: mapCanvas()

Since: QGIS 3.44

Definition at line 37 of file qgsdataitemguiprovider.cpp.

◆ setMessageBar()

void QgsDataItemGuiContext::setMessageBar ( QgsMessageBar * bar )

Sets the associated message bar.

This bar can be used to provide non-blocking feedback to users.

See also: messageBar()

Definition at line 32 of file qgsdataitemguiprovider.cpp.

◆ setView()

void QgsDataItemGuiContext::setView ( QgsBrowserTreeView * view )

Sets the associated view.

See also: view()

Since: QGIS 3.28

Definition at line 52 of file qgsdataitemguiprovider.cpp.

◆ view()

QgsBrowserTreeView * QgsDataItemGuiContext::view ( ) const

Returns the associated view.

See also: setView()

Since: QGIS 3.28

Definition at line 47 of file qgsdataitemguiprovider.cpp.

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

/build/qgis-3.43.0+git20250312+9e873c7bc91+99sid/src/gui/qgsdataitemguiprovider.h
/build/qgis-3.43.0+git20250312+9e873c7bc91+99sid/src/gui/qgsdataitemguiprovider.cpp

Public Member Functions