QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | List of all members
QgsDataItemGuiContext Class Reference

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

#include <qgsdataitemguiprovider.h>

Public Member Functions

 QgsDataItemGuiContext ()=default
 Constructor for QgsDataItemGuiContext. More...
 
QgsMessageBarmessageBar () const
 Returns the associated message bar. More...
 
void setMessageBar (QgsMessageBar *bar)
 Sets the associated message bar. More...
 
void setView (QgsBrowserTreeView *view)
 Sets the associated view. More...
 
QgsBrowserTreeViewview () const
 Returns the associated view. More...
 

Detailed Description

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

Since
QGIS 3.6

Definition at line 41 of file qgsdataitemguiprovider.h.

Constructor & Destructor Documentation

◆ QgsDataItemGuiContext()

QgsDataItemGuiContext::QgsDataItemGuiContext ( )
default

Constructor for QgsDataItemGuiContext.

Member Function Documentation

◆ 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.

◆ 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 42 of file qgsdataitemguiprovider.cpp.

◆ view()

QgsBrowserTreeView * QgsDataItemGuiContext::view ( ) const

Returns the associated view.

See also
setView()
Since
QGIS 3.28

Definition at line 37 of file qgsdataitemguiprovider.cpp.


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