QgsPlotAbstractMetadata Class Reference

Stores metadata about a plot class. More...

#include <qgsplotregistry.h>

Inheritance diagram for QgsPlotAbstractMetadata:

Public Member Functions
	QgsPlotAbstractMetadata (const QString &type, const QString &visibleName)
	Constructor for QgsPlotAbstractMetadata with the specified class type.
virtual	~QgsPlotAbstractMetadata ()=default
virtual QgsPlot *	createPlot ()=0
	Creates a plot of this class.
virtual QgsVectorLayerAbstractPlotDataGatherer *	createPlotDataGatherer (QgsPlot *plot=nullptr)=0
	Creates a plot data gatherer of this class.
virtual QgsPlotWidget *	createPlotWidget (QWidget *parent=nullptr)=0
	Creates a widget for configuring plot of this type.
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.

Detailed Description

Stores metadata about a plot class.

Note

In C++ you can use QgsPlotAbstractMetadata convenience class.

Since

QGIS 4.0

Definition at line 35 of file qgsplotregistry.h.

Constructor & Destructor Documentation

QgsPlotAbstractMetadata()

QgsPlotAbstractMetadata::QgsPlotAbstractMetadata ( const QString & type, const QString & visibleName )

inline

Constructor for QgsPlotAbstractMetadata with the specified class type.

Definition at line 42 of file qgsplotregistry.h.

~QgsPlotAbstractMetadata()

virtual QgsPlotAbstractMetadata::~QgsPlotAbstractMetadata ( )

virtualdefault

Member Function Documentation

createPlot()

virtual QgsPlot * QgsPlotAbstractMetadata::createPlot ( )

pure virtual

Creates a plot of this class.

Implemented in QgsPlotMetadata.

createPlotDataGatherer()

virtual QgsVectorLayerAbstractPlotDataGatherer * QgsPlotAbstractMetadata::createPlotDataGatherer ( QgsPlot * plot = nullptr )

pure virtual

Creates a plot data gatherer of this class.

Implemented in QgsPlotMetadata.

createPlotWidget()

virtual QgsPlotWidget * QgsPlotAbstractMetadata::createPlotWidget ( QWidget * parent = nullptr )

pure virtual

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.

Implemented in QgsPlotMetadata.

type()

QString QgsPlotAbstractMetadata::type ( ) const

inline

Returns the unique type code for the plot class.

Definition at line 52 of file qgsplotregistry.h.

visibleName()

QString QgsPlotAbstractMetadata::visibleName ( ) const

inline

Returns a translated, user visible name for the plot class.

Definition at line 57 of file qgsplotregistry.h.

---

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

• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/core/plot/qgsplotregistry.h