Class: QgsCreateAnnotationItemMapToolHandler

A handler object for map tools which create annotation items.

This object is designed to be used by map tools which implement the QgsCreateAnnotationItemMapToolInterface, following the composition pattern.

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

Added in version 3.22.

Class Hierarchy

Base classes

QObject

class qgis.gui.QgsCreateAnnotationItemMapToolHandler

Bases: QObject

__init__(canvas: QgsMapCanvas | None, cadDockWidget: QgsAdvancedDigitizingDockWidget | None, parent: QObject | None = None)

Constructor for QgsCreateAnnotationItemMapToolHandler, with the specified parent object.

Parameters:

• canvas (Optional[QgsMapCanvas])

• cadDockWidget (Optional[QgsAdvancedDigitizingDockWidget])

• parent (Optional[QObject] = None)

signal itemCreated

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

pushCreatedItem(self, item: QgsAnnotationItem | None)

Pushes a created item to the handler.

Ownership of item is transferred to the handler.

Calling this method causes the object to emit the itemCreated() signal, and queue the item ready for collection via a call to takeCreatedItem().

Parameters:

item (Optional[QgsAnnotationItem])

takeCreatedItem(self) → QgsAnnotationItem | None

Takes the newly created item from the tool, transferring ownership to the caller.

Return type:

Optional[QgsAnnotationItem]

targetLayer(self) → QgsAnnotationLayer | None

Returns the target layer for newly created items.

Return type:

Optional[QgsAnnotationLayer]