QgsCalloutMetadata Class Reference

Convenience metadata class that uses static functions to create callouts and their widgets. More...

#include <qgscalloutsregistry.h>

Inheritance diagram for QgsCalloutMetadata:

Public Member Functions
	QgsCalloutMetadata (const QString &name, const QString &visibleName, const QIcon &icon, QgsCalloutCreateFunc pfCreate, QgsCalloutWidgetFunc pfWidget=nullptr)
QgsCallout *	createCallout (const QVariantMap &properties, const QgsReadWriteContext &context) override
	Create a callout of this type given the map of properties.
QgsCalloutWidget *	createCalloutWidget (QgsMapLayer *vl) override
	Creates a widget for configuring callouts of this type.
QgsCalloutCreateFunc	createFunction () const
void	setWidgetFunction (QgsCalloutWidgetFunc f)
QgsCalloutWidgetFunc	widgetFunction () const
Public Member Functions inherited from QgsCalloutAbstractMetadata
	QgsCalloutAbstractMetadata (const QString &name, const QString &visibleName, const QIcon &icon=QIcon())
	Constructor for QgsCalloutAbstractMetadata, with the specified name.
virtual	~QgsCalloutAbstractMetadata ()=default
QIcon	icon () const
	Returns an icon representing the callout.
QString	name () const
	Returns the unique name of the callout type.
void	setIcon (const QIcon &icon)
	Sets an icon representing the callout.
QString	visibleName () const
	Returns a friendly display name of the callout type.

Protected Attributes
QgsCalloutCreateFunc	mCreateFunc
QgsCalloutWidgetFunc	mWidgetFunc
Protected Attributes inherited from QgsCalloutAbstractMetadata
QIcon	mIcon
QString	mName
QString	mVisibleName

Detailed Description

Convenience metadata class that uses static functions to create callouts and their widgets.

Since

QGIS 3.10

Definition at line 110 of file qgscalloutsregistry.h.

Constructor & Destructor Documentation

QgsCalloutMetadata()

QgsCalloutMetadata::QgsCalloutMetadata ( const QString &  name, const QString &  visibleName, const QIcon &  icon, QgsCalloutCreateFunc  pfCreate, QgsCalloutWidgetFunc  pfWidget = nullptr  )

inline

Note

not available in Python bindings

Definition at line 115 of file qgscalloutsregistry.h.

Member Function Documentation

createCallout()

QgsCallout * QgsCalloutMetadata::createCallout ( const QVariantMap &  properties, const QgsReadWriteContext &  context  )

overridevirtual

Create a callout of this type given the map of properties.

Ownership of the callout is transferred to the caller.

Implements QgsCalloutAbstractMetadata.

Definition at line 34 of file qgscalloutsregistry.cpp.

createCalloutWidget()

QgsCalloutWidget * QgsCalloutMetadata::createCalloutWidget ( QgsMapLayer *  )

overridevirtual

Creates a widget for configuring callouts of this type.

Can return nullptr if there's no GUI required.

Ownership of the widget is transferred to the caller.

Reimplemented from QgsCalloutAbstractMetadata.

Definition at line 39 of file qgscalloutsregistry.cpp.

createFunction()

QgsCalloutCreateFunc QgsCalloutMetadata::createFunction ( ) const

inline

Note

not available in Python bindings

Definition at line 125 of file qgscalloutsregistry.h.

setWidgetFunction()

void QgsCalloutMetadata::setWidgetFunction ( QgsCalloutWidgetFunc  f )

inline

Note

not available in Python bindings

Definition at line 130 of file qgscalloutsregistry.h.

widgetFunction()

QgsCalloutWidgetFunc QgsCalloutMetadata::widgetFunction ( ) const

inline

Note

not available in Python bindings

Definition at line 127 of file qgscalloutsregistry.h.

Member Data Documentation

mCreateFunc

QgsCalloutCreateFunc QgsCalloutMetadata::mCreateFunc

protected

Definition at line 136 of file qgscalloutsregistry.h.

mWidgetFunc

QgsCalloutWidgetFunc QgsCalloutMetadata::mWidgetFunc

protected

Definition at line 137 of file qgscalloutsregistry.h.

---

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

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/callouts/qgscalloutsregistry.h
• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/callouts/qgscalloutsregistry.cpp