QgsAdvancedDigitizingToolAbstractMetadata Class Reference

Stores metadata about one advanced digitizing tool class. More...

#include <qgsadvanceddigitizingtoolsregistry.h>

Inheritance diagram for QgsAdvancedDigitizingToolAbstractMetadata:

Public Member Functions
	QgsAdvancedDigitizingToolAbstractMetadata (const QString &name, const QString &visibleName, const QIcon &icon=QIcon())
	Constructor for QgsAdvancedDigitizingToolAbstractMetadata with the specified tool name.
virtual	~QgsAdvancedDigitizingToolAbstractMetadata ()=default
virtual QgsAdvancedDigitizingTool *	createTool (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
	Returns new tool of this type. Return nullptr on error.
QIcon	icon () const
	Returns the tool's icon.
QString	name () const
	Returns the tool's unique name.
QString	visibleName () const
	Returns the tool's translatable user-friendly name.

Protected Attributes
QIcon	mIcon
QString	mName
QString	mVisibleName

Detailed Description

Stores metadata about one advanced digitizing tool class.

Since

QGIS 3.40

Definition at line 34 of file qgsadvanceddigitizingtoolsregistry.h.

Constructor & Destructor Documentation

QgsAdvancedDigitizingToolAbstractMetadata()

QgsAdvancedDigitizingToolAbstractMetadata::QgsAdvancedDigitizingToolAbstractMetadata ( const QString &  name, const QString &  visibleName, const QIcon &  icon = QIcon()  )

inline

Constructor for QgsAdvancedDigitizingToolAbstractMetadata with the specified tool name.

visibleName should be set to a translated, user visible name identifying the corresponding annotation item.

An optional icon can be set, which will be used by the advanced digitizing dock widget.

Definition at line 45 of file qgsadvanceddigitizingtoolsregistry.h.

~QgsAdvancedDigitizingToolAbstractMetadata()

virtual QgsAdvancedDigitizingToolAbstractMetadata::~QgsAdvancedDigitizingToolAbstractMetadata ( )

virtualdefault

Member Function Documentation

createTool()

QgsAdvancedDigitizingTool * QgsAdvancedDigitizingToolAbstractMetadata::createTool ( QgsMapCanvas *  canvas, QgsAdvancedDigitizingDockWidget *  cadDockWidget  )

virtual

Returns new tool of this type. Return nullptr on error.

Reimplemented in QgsAdvancedDigitizingToolMetadata.

Definition at line 20 of file qgsadvanceddigitizingtoolsregistry.cpp.

icon()

QIcon QgsAdvancedDigitizingToolAbstractMetadata::icon ( ) const

inline

Returns the tool's icon.

Definition at line 60 of file qgsadvanceddigitizingtoolsregistry.h.

name()

QString QgsAdvancedDigitizingToolAbstractMetadata::name ( ) const

inline

Returns the tool's unique name.

Definition at line 54 of file qgsadvanceddigitizingtoolsregistry.h.

visibleName()

QString QgsAdvancedDigitizingToolAbstractMetadata::visibleName ( ) const

inline

Returns the tool's translatable user-friendly name.

Definition at line 57 of file qgsadvanceddigitizingtoolsregistry.h.

Member Data Documentation

mIcon

QIcon QgsAdvancedDigitizingToolAbstractMetadata::mIcon

protected

Definition at line 68 of file qgsadvanceddigitizingtoolsregistry.h.

mName

QString QgsAdvancedDigitizingToolAbstractMetadata::mName

protected

Definition at line 66 of file qgsadvanceddigitizingtoolsregistry.h.

mVisibleName

QString QgsAdvancedDigitizingToolAbstractMetadata::mVisibleName

protected

Definition at line 67 of file qgsadvanceddigitizingtoolsregistry.h.

---

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

• /build/qgis-3.39.0+git20240917+7b5d8bea57d+99sid/src/gui/qgsadvanceddigitizingtoolsregistry.h
• /build/qgis-3.39.0+git20240917+7b5d8bea57d+99sid/src/gui/qgsadvanceddigitizingtoolsregistry.cpp