QgsPlotWidget Class Reference

Base class for widgets which allow control over the properties of plots. More...

#include <qgsplotwidget.h>

Inheritance diagram for QgsPlotWidget:

Public Member Functions
	QgsPlotWidget (QWidget *parent=nullptr)
	Constructor for QgsPlotWidget.
QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
virtual QgsPlot *	createPlot ()=0
	Creates a plot defined by the current settings in the widget.
void	registerExpressionContextGenerator (QgsExpressionContextGenerator *generator)
	Register an expression context generator class that will be used to retrieve an expression context for configuration widgets when required.
virtual void	setPlot (QgsPlot *plot)=0
	Sets the widget to match the settings of the plot.
Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as an inline panel.
virtual bool	applySizeConstraintsToStack () const
	Returns true if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.
bool	autoDelete () const
	The the auto delete property on the widget.
void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.
bool	dockMode () const
	Returns the dock mode state.
virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.
virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.
QString	panelTitle () const
	The title of the panel.
void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.
virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.
Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Protected Member Functions
void	initializeDataDefinedButton (QgsPropertyOverrideButton *button, QgsPlot::DataDefinedProperty key)
	Initiate a data-defined property button tied to a plot widget.
void	updateDataDefinedButton (QgsPropertyOverrideButton *button)
	Initiate a data-defined property button tied to a plot widget.
Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Protected Attributes
QgsPropertyCollection	mPropertyCollection

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.
void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event.
Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.
void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.
void	widgetChanged ()
	Emitted when the widget state changes.
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Detailed Description

Base class for widgets which allow control over the properties of plots.

Since

QGIS 4.0

Definition at line 35 of file qgsplotwidget.h.

Constructor & Destructor Documentation

QgsPlotWidget()

QgsPlotWidget::QgsPlotWidget ( QWidget * parent = nullptr )

inline

Constructor for QgsPlotWidget.

Parameters

parent

parent widget

Definition at line 45 of file qgsplotwidget.h.

Member Function Documentation

createExpressionContext()

QgsExpressionContext QgsPlotWidget::createExpressionContext ( ) const

overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 36 of file qgsplotwidget.cpp.

createPlot()

virtual QgsPlot * QgsPlotWidget::createPlot ( )

pure virtual

Creates a plot defined by the current settings in the widget.

See also

setPlot()

Implemented in QgsBarChartPlotWidget, QgsLineChartPlotWidget, and QgsPieChartPlotWidget.

initializeDataDefinedButton()

void QgsPlotWidget::initializeDataDefinedButton ( QgsPropertyOverrideButton * button, QgsPlot::DataDefinedProperty key )

protected

Initiate a data-defined property button tied to a plot widget.

Definition at line 63 of file qgsplotwidget.cpp.

registerExpressionContextGenerator()

void QgsPlotWidget::registerExpressionContextGenerator

(

QgsExpressionContextGenerator *

generator

)

Register an expression context generator class that will be used to retrieve an expression context for configuration widgets when required.

Definition at line 31 of file qgsplotwidget.cpp.

setPlot()

virtual void QgsPlotWidget::setPlot ( QgsPlot * plot )

pure virtual

Sets the widget to match the settings of the plot.

Ownership is not transferred.

See also

createPlot()

Implemented in QgsBarChartPlotWidget, QgsLineChartPlotWidget, and QgsPieChartPlotWidget.

updateDataDefinedButton()

void QgsPlotWidget::updateDataDefinedButton ( QgsPropertyOverrideButton * button )

protected

Initiate a data-defined property button tied to a plot widget.

Definition at line 72 of file qgsplotwidget.cpp.

Member Data Documentation

mPropertyCollection

QgsPropertyCollection QgsPlotWidget::mPropertyCollection

protected

Definition at line 81 of file qgsplotwidget.h.

---

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

• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/gui/plot/qgsplotwidget.h
• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/gui/plot/qgsplotwidget.cpp