Convenience metadata class that uses static functions to create annotation items and their configuration widgets. More...

#include <qgsannotationitemregistry.h>

Inheritance diagram for QgsAnnotationItemMetadata:

[legend]

Public Member Functions
	QgsAnnotationItemMetadata (const QString &type, const QString &visibleName, const QString &visiblePluralName, const QgsAnnotationItemCreateFunc &pfCreate)
	Constructor for QgsAnnotationItemMetadata with the specified class type and visibleName, and function pointers for the various item creation functions. More...

QgsAnnotationItemCreateFunc	createFunction () const
	Returns the classes' item default creation function. More...

QgsAnnotationItem *	createItem () override
	Creates a new, default, annotation item of this class. More...

Public Member Functions inherited from QgsAnnotationItemAbstractMetadata
	QgsAnnotationItemAbstractMetadata (const QString &type, const QString &visibleName, const QString &visiblePluralName=QString())
	Constructor for QgsAnnotationItemAbstractMetadata with the specified class type and visibleName. More...

virtual	~QgsAnnotationItemAbstractMetadata ()=default

virtual QgsAnnotationItem *	createItem ()=0
	Creates a new, default, annotation item of this class. More...

QString	type () const
	Returns the unique item type string for the annotation item class. More...

QString	visibleName () const
	Returns a translated, user visible name for the annotation item class. More...

QString	visiblePluralName () const
	Returns a translated, user visible name for plurals of the annotation item class (e.g. More...

Protected Attributes
QgsAnnotationItemCreateFunc	mCreateFunc = nullptr

Detailed Description

Convenience metadata class that uses static functions to create annotation items and their configuration widgets.

Note: not available in Python bindings

Since: QGIS 3.16

Definition at line 98 of file qgsannotationitemregistry.h.

Constructor & Destructor Documentation

◆ QgsAnnotationItemMetadata()

QgsAnnotationItemMetadata::QgsAnnotationItemMetadata	(	const QString &	type,
		const QString &	visibleName,
		const QString &	visiblePluralName,
		const QgsAnnotationItemCreateFunc &	pfCreate
	)

inline

Constructor for QgsAnnotationItemMetadata with the specified class type and visibleName, and function pointers for the various item creation functions.

The visiblePluralName argument is used to specify a plural variant of the item type.

Definition at line 108 of file qgsannotationitemregistry.h.