QgsPlotMetadata Class Reference

Convenience metadata class that uses static functions to create plots. More...

#include <qgsplotregistry.h>

Inheritance diagram for QgsPlotMetadata:

Public Member Functions
	QgsPlotMetadata (const QString &type, const QString &visibleName, const QgsPlotCreateFunc &pfCreate, const QgsPlotDataGathererCreateFunc &pdgfCreate=nullptr, const QgsPlotWidgetCreateFunc &pwfCreate=nullptr)
	Constructor for QgsPlotMetadata with the specified class type.
QgsPlotCreateFunc	createFunction () const
	Returns the classes' plot creation function.
QgsPlot *	createPlot () override
	Creates a plot of this class.
QgsVectorLayerAbstractPlotDataGatherer *	createPlotDataGatherer (QgsPlot *plot=nullptr) override
	Creates a plot data gatherer of this class.
QgsPlotDataGathererCreateFunc	createPlotDataGathererFunction () const
	Returns the classes' plot data gatherer creation function.
QgsPlotWidget *	createPlotWidget (QWidget *parent=nullptr) override
	Creates a widget for configuring plot of this type.
void	setWidgetCreateFunction (QgsPlotWidgetCreateFunc function)
	Sets the classes' plot widget creation function.
QgsPlotWidgetCreateFunc	widgetCreateFunction () const
	Returns the classes' plot widget creation function.
Public Member Functions inherited from QgsPlotAbstractMetadata
	QgsPlotAbstractMetadata (const QString &type, const QString &visibleName)
	Constructor for QgsPlotAbstractMetadata with the specified class type.
virtual	~QgsPlotAbstractMetadata ()=default
QString	type () const
	Returns the unique type code for the plot class.
QString	visibleName () const
	Returns a translated, user visible name for the plot class.

Protected Attributes
QgsPlotCreateFunc	mCreateFunc = nullptr
QgsPlotDataGathererCreateFunc	mDataGathererCreateFunc = nullptr
QgsPlotWidgetCreateFunc	mWidgetCreateFunc = nullptr

Detailed Description

Convenience metadata class that uses static functions to create plots.

Note

not available in Python bindings

Since

QGIS 4.0

Definition at line 111 of file qgsplotregistry.h.

Constructor & Destructor Documentation

QgsPlotMetadata()

QgsPlotMetadata::QgsPlotMetadata ( const QString & type, const QString & visibleName, const QgsPlotCreateFunc & pfCreate, const QgsPlotDataGathererCreateFunc & pdgfCreate = nullptr, const QgsPlotWidgetCreateFunc & pwfCreate = nullptr )

inline

Constructor for QgsPlotMetadata with the specified class type.

Definition at line 118 of file qgsplotregistry.h.

Member Function Documentation

createFunction()

QgsPlotCreateFunc QgsPlotMetadata::createFunction ( ) const

inline

Returns the classes' plot creation function.

Definition at line 131 of file qgsplotregistry.h.

createPlot()

QgsPlot * QgsPlotMetadata::createPlot ( )

inlineoverridevirtual

Creates a plot of this class.

Implements QgsPlotAbstractMetadata.

Definition at line 148 of file qgsplotregistry.h.

createPlotDataGatherer()

QgsVectorLayerAbstractPlotDataGatherer * QgsPlotMetadata::createPlotDataGatherer ( QgsPlot * plot = nullptr )

inlineoverridevirtual

Creates a plot data gatherer of this class.

Implements QgsPlotAbstractMetadata.

Definition at line 149 of file qgsplotregistry.h.

createPlotDataGathererFunction()

QgsPlotDataGathererCreateFunc QgsPlotMetadata::createPlotDataGathererFunction ( ) const

inline

Returns the classes' plot data gatherer creation function.

Definition at line 136 of file qgsplotregistry.h.

createPlotWidget()

QgsPlotWidget * QgsPlotMetadata::createPlotWidget ( QWidget * parent = nullptr )

inlineoverridevirtual

Creates a widget for configuring plot of this type.

Can return nullptr if there's no GUI registered.

Ownership of the widget is transferred to the caller.

Implements QgsPlotAbstractMetadata.

Definition at line 150 of file qgsplotregistry.h.

setWidgetCreateFunction()

void QgsPlotMetadata::setWidgetCreateFunction ( QgsPlotWidgetCreateFunc function )

inline

Sets the classes' plot widget creation function.

Definition at line 146 of file qgsplotregistry.h.

widgetCreateFunction()

QgsPlotWidgetCreateFunc QgsPlotMetadata::widgetCreateFunction ( ) const

inline

Returns the classes' plot widget creation function.

Definition at line 141 of file qgsplotregistry.h.

Member Data Documentation

mCreateFunc

QgsPlotCreateFunc QgsPlotMetadata::mCreateFunc = nullptr

protected

Definition at line 153 of file qgsplotregistry.h.

mDataGathererCreateFunc

QgsPlotDataGathererCreateFunc QgsPlotMetadata::mDataGathererCreateFunc = nullptr

protected

Definition at line 154 of file qgsplotregistry.h.

mWidgetCreateFunc

QgsPlotWidgetCreateFunc QgsPlotMetadata::mWidgetCreateFunc = nullptr

protected

Definition at line 155 of file qgsplotregistry.h.

---

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

• /build/qgis-3.99.0+git20251207+21b3aa880ba+99sid/src/core/plot/qgsplotregistry.h