QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | Protected Attributes | List of all members
QgsAnnotationItemMetadata Class Reference

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

#include <qgsannotationitemregistry.h>

Inheritance diagram for QgsAnnotationItemMetadata:
Inheritance graph
[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...
 
QgsAnnotationItemcreateItem () override
 Creates a new, default, annotation item of this class. 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.

Member Function Documentation

◆ createFunction()

QgsAnnotationItemCreateFunc QgsAnnotationItemMetadata::createFunction ( ) const
inline

Returns the classes' item default creation function.

Definition at line 117 of file qgsannotationitemregistry.h.

◆ createItem()

QgsAnnotationItem* QgsAnnotationItemMetadata::createItem ( )
inlineoverridevirtual

Creates a new, default, annotation item of this class.

Implements QgsAnnotationItemAbstractMetadata.

Definition at line 119 of file qgsannotationitemregistry.h.

Member Data Documentation

◆ mCreateFunc

QgsAnnotationItemCreateFunc QgsAnnotationItemMetadata::mCreateFunc = nullptr
protected

Definition at line 122 of file qgsannotationitemregistry.h.


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