QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
QgsLineChartPlotWidget Class Reference

Widget class to control the properties of line chart plots. More...

#include <qgsplotwidget.h>

Inheritance diagram for QgsLineChartPlotWidget:

Public Member Functions

 QgsLineChartPlotWidget (QWidget *parent=nullptr)
 Constructor for QgsLineChartPlotWidget.
QgsPlotcreatePlot () override
 Creates a plot defined by the current settings in the widget.
void setPlot (QgsPlot *plot) override
 Sets the widget to match the settings of the plot.
Public Member Functions inherited from QgsPlotWidget
 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.
void registerExpressionContextGenerator (QgsExpressionContextGenerator *generator)
 Register an expression context generator class that will be used to retrieve an expression context for configuration widgets when required.
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

Static Public Member Functions

static QgsPlotWidgetcreate (QWidget *parent)
 Creates a new line chart plot configuration widget.
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

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.
Protected Member Functions inherited from QgsPlotWidget
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 inherited from QgsPlotWidget
QgsPropertyCollection mPropertyCollection

Detailed Description

Widget class to control the properties of line chart plots.

Since
QGIS 4.0

Definition at line 146 of file qgsplotwidget.h.

Constructor & Destructor Documentation

◆ QgsLineChartPlotWidget()

QgsLineChartPlotWidget::QgsLineChartPlotWidget ( QWidget * parent = nullptr)

Constructor for QgsLineChartPlotWidget.

Parameters
parentparent widget

Definition at line 535 of file qgsplotwidget.cpp.

Member Function Documentation

◆ create()

QgsPlotWidget * QgsLineChartPlotWidget::create ( QWidget * parent)
inlinestatic

Creates a new line chart plot configuration widget.

Definition at line 162 of file qgsplotwidget.h.

◆ createPlot()

QgsPlot * QgsLineChartPlotWidget::createPlot ( )
overridevirtual

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

See also
setPlot()

Implements QgsPlotWidget.

Definition at line 941 of file qgsplotwidget.cpp.

◆ setPlot()

void QgsLineChartPlotWidget::setPlot ( QgsPlot * plot)
overridevirtual

Sets the widget to match the settings of the plot.

Ownership is not transferred.

See also
createPlot()

Implements QgsPlotWidget.

Definition at line 831 of file qgsplotwidget.cpp.


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