An interface for map tools which create annotation items. More...

#include <qgscreateannotationitemmaptool.h>

Inheritance diagram for QgsCreateAnnotationItemMapToolInterface:

[legend]

Public Member Functions
virtual	~QgsCreateAnnotationItemMapToolInterface ()=default

virtual QgsCreateAnnotationItemMapToolHandler *	handler () const =0
	Returns the handler object for the map tool.

virtual QgsMapTool *	mapTool ()=0
	Returns a reference to the associated map tool.

Static Public Attributes
static QgsSettingsTreeNode *	sTreeAnnotationTools = QgsSettingsTree::sTreeGui->createChildNode( QStringLiteral( "annotation-items" ) )

Detailed Description

An interface for map tools which create annotation items.

Clients should connect to the map tool's itemCreated() signal, and call the takeCreatedItem() implementation to take ownership of the newly created item whenever this signal is emitted.

Since: QGIS 3.22

Definition at line 102 of file qgscreateannotationitemmaptool.h.

Constructor & Destructor Documentation

◆ ~QgsCreateAnnotationItemMapToolInterface()

virtual QgsCreateAnnotationItemMapToolInterface::~QgsCreateAnnotationItemMapToolInterface ( )

virtualdefault

Member Function Documentation

◆ handler()

virtual QgsCreateAnnotationItemMapToolHandler * QgsCreateAnnotationItemMapToolInterface::handler ( ) const

pure virtual

Returns the handler object for the map tool.

Implemented in QgsMapToolCaptureAnnotationItem, QgsCreatePointTextItemMapTool, QgsCreateRectangleTextItemMapTool, and QgsCreatePictureItemMapTool.

◆ mapTool()

virtual QgsMapTool * QgsCreateAnnotationItemMapToolInterface::mapTool ( )

pure virtual

Returns a reference to the associated map tool.

Implemented in QgsMapToolCaptureAnnotationItem, QgsCreatePointTextItemMapTool, QgsCreateRectangleTextItemMapTool, and QgsCreatePictureItemMapTool.

Member Data Documentation

◆ sTreeAnnotationTools

QgsSettingsTreeNode* QgsCreateAnnotationItemMapToolInterface::sTreeAnnotationTools = QgsSettingsTree::sTreeGui->createChildNode( QStringLiteral( "annotation-items" ) )

inlinestatic

Definition at line 107 of file qgscreateannotationitemmaptool.h.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/annotations/qgscreateannotationitemmaptool.h

Public Member Functions

Static Public Attributes