Registry of available annotation item types. More...

#include <qgsannotationitemregistry.h>

Inheritance diagram for QgsAnnotationItemRegistry:

Signals
void	typeAdded (const QString &type, const QString &name)
	Emitted whenever a new item type is added to the registry, with the specified type and visible name. More...

Public Member Functions
	QgsAnnotationItemRegistry (const QgsAnnotationItemRegistry &rh)=delete
	QgsAnnotationItemRegistry cannot be copied. More...

	QgsAnnotationItemRegistry (QObject *parent=nullptr)
	Creates a new empty item registry. More...

	~QgsAnnotationItemRegistry () override

bool	addItemType (QgsAnnotationItemAbstractMetadata *metadata)
	Registers a new annotation item type. More...

QgsAnnotationItem *	createItem (const QString &type) const
	Creates a new instance of a annotation item given the item type. More...

QgsAnnotationItemAbstractMetadata *	itemMetadata (const QString &type) const
	Returns the metadata for the specified item type. More...

QMap< QString, QString >	itemTypes () const
	Returns a map of available item types to translated name. More...

QgsAnnotationItemRegistry &	operator= (const QgsAnnotationItemRegistry &rh)=delete
	QgsAnnotationItemRegistry cannot be copied. More...

bool	populate ()
	Populates the registry with standard item types. More...

Detailed Description

Registry of available annotation item types.

QgsAnnotationItemRegistry is not usually directly created, but rather accessed through QgsApplication::annotationItemRegistry().

A companion class, QgsAnnotationItemGuiRegistry, handles the GUI behavior of annotation items.

Since: QGIS 3.16

Definition at line 142 of file qgsannotationitemregistry.h.

Constructor & Destructor Documentation

◆ QgsAnnotationItemRegistry() [1/2]

QgsAnnotationItemRegistry::QgsAnnotationItemRegistry ( QObject * parent = nullptr )

Creates a new empty item registry.

QgsAnnotationItemRegistry is not usually directly created, but rather accessed through QgsApplication::annotationItemRegistry().

See also: populate()

Definition at line 25 of file qgsannotationitemregistry.cpp.

◆ ~QgsAnnotationItemRegistry()

QgsAnnotationItemRegistry::~QgsAnnotationItemRegistry ( )

override

Definition at line 30 of file qgsannotationitemregistry.cpp.

◆ QgsAnnotationItemRegistry() [2/2]

QgsAnnotationItemRegistry::QgsAnnotationItemRegistry ( const QgsAnnotationItemRegistry & rh )

delete

QgsAnnotationItemRegistry cannot be copied.

Member Function Documentation

◆ addItemType()

bool QgsAnnotationItemRegistry::addItemType ( QgsAnnotationItemAbstractMetadata * metadata )

Registers a new annotation item type.

Takes ownership of the metadata instance.

Definition at line 56 of file qgsannotationitemregistry.cpp.

◆ createItem()

QgsAnnotationItem * QgsAnnotationItemRegistry::createItem ( const QString & type ) const

Creates a new instance of a annotation item given the item type.

Definition at line 66 of file qgsannotationitemregistry.cpp.

◆ itemMetadata()

QgsAnnotationItemAbstractMetadata * QgsAnnotationItemRegistry::itemMetadata ( const QString & type ) const

Returns the metadata for the specified item type.

Returns nullptr if a corresponding type was not found in the registry.

Definition at line 51 of file qgsannotationitemregistry.cpp.

◆ itemTypes()

QMap< QString, QString > QgsAnnotationItemRegistry::itemTypes ( ) const

Returns a map of available item types to translated name.

Definition at line 74 of file qgsannotationitemregistry.cpp.

◆ operator=()

QgsAnnotationItemRegistry& QgsAnnotationItemRegistry::operator= ( const QgsAnnotationItemRegistry & rh )

delete

QgsAnnotationItemRegistry cannot be copied.

◆ populate()

bool QgsAnnotationItemRegistry::populate ( )

Populates the registry with standard item types.

If called on a non-empty registry then this will have no effect and will return false.

Definition at line 35 of file qgsannotationitemregistry.cpp.

◆ typeAdded

void QgsAnnotationItemRegistry::typeAdded	(	const QString &	type,
		const QString &	name
	)

signal

Emitted whenever a new item type is added to the registry, with the specified type and visible name.

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

/build/qgis-3.18.1+99unstable/src/core/annotations/qgsannotationitemregistry.h
/build/qgis-3.18.1+99unstable/src/core/annotations/qgsannotationitemregistry.cpp

Signals

Public Member Functions