QGIS API Documentation 3.43.0-Master (8fc5848dca1)
Public Member Functions | List of all members
QgsHistoryWidgetContext Class Reference

Contains settings which reflect the context in which a history widget is shown, e.g., an associated message bar. More...

#include <qgshistorywidgetcontext.h>

Public Member Functions

 QgsHistoryWidgetContext ()=default
 
QgsHistoryWidgethistoryWidget () const
 Returns the parent history widget.
 
QgsMessageBarmessageBar () const
 Returns the message bar associated with the widget.
 
void setHistoryWidget (QgsHistoryWidget *widget)
 Sets the parent history widget.
 
void setMessageBar (QgsMessageBar *bar)
 Sets the message bar associated with the widget.
 

Detailed Description

Contains settings which reflect the context in which a history widget is shown, e.g., an associated message bar.

Since
QGIS 3.32

Definition at line 32 of file qgshistorywidgetcontext.h.

Constructor & Destructor Documentation

◆ QgsHistoryWidgetContext()

QgsHistoryWidgetContext::QgsHistoryWidgetContext ( )
default

Member Function Documentation

◆ historyWidget()

QgsHistoryWidget * QgsHistoryWidgetContext::historyWidget ( ) const

Returns the parent history widget.

See also
setHistoryWidget()
Since
QGIS 3.44

Definition at line 33 of file qgshistorywidgetcontext.cpp.

◆ messageBar()

QgsMessageBar * QgsHistoryWidgetContext::messageBar ( ) const

Returns the message bar associated with the widget.

See also
setMessageBar()

Definition at line 23 of file qgshistorywidgetcontext.cpp.

◆ setHistoryWidget()

void QgsHistoryWidgetContext::setHistoryWidget ( QgsHistoryWidget widget)

Sets the parent history widget.

See also
historyWidget()
Since
QGIS 3.44

Definition at line 28 of file qgshistorywidgetcontext.cpp.

◆ setMessageBar()

void QgsHistoryWidgetContext::setMessageBar ( QgsMessageBar bar)

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 18 of file qgshistorywidgetcontext.cpp.


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