QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Signals | Public Member Functions | List of all members
QgsMapToolModifyAnnotation Class Reference

A map tool for modifying annotations in a QgsAnnotationLayer. More...

#include <qgsmaptoolmodifyannotation.h>

Inheritance diagram for QgsMapToolModifyAnnotation:
Inheritance graph
[legend]

Signals

void itemSelected (QgsAnnotationLayer *layer, const QString &itemId)
 Emitted when the selected item is changed. More...
 
void selectionCleared ()
 Emitted when the selected item is cleared;. More...
 
- Signals inherited from QgsMapTool
void activated ()
 signal emitted once the map tool is activated More...
 
void deactivated ()
 signal emitted once the map tool is deactivated More...
 
void messageDiscarded ()
 emit signal to clear previous message More...
 
void messageEmitted (const QString &message, Qgis::MessageLevel=Qgis::MessageLevel::Info)
 emit a message More...
 

Public Member Functions

 QgsMapToolModifyAnnotation (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
 Constructor for QgsMapToolModifyAnnotation. More...
 
 ~QgsMapToolModifyAnnotation () override
 
void cadCanvasMoveEvent (QgsMapMouseEvent *event) override
 Override this method when subclassing this class. More...
 
void cadCanvasPressEvent (QgsMapMouseEvent *event) override
 Override this method when subclassing this class. More...
 
void canvasDoubleClickEvent (QgsMapMouseEvent *event) override
 Mouse double-click event for overriding. Default implementation does nothing. More...
 
void deactivate () override
 Unregisters this maptool from the cad dock widget. More...
 
void keyPressEvent (QKeyEvent *event) override
 Key event for overriding. Default implementation does nothing. More...
 
- Public Member Functions inherited from QgsMapToolAdvancedDigitizing
 QgsMapToolAdvancedDigitizing (QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)
 Creates an advanced digitizing maptool. More...
 
void activate () override
 Registers this maptool with the cad dock widget. More...
 
virtual void cadCanvasMoveEvent (QgsMapMouseEvent *e)
 Override this method when subclassing this class. More...
 
virtual void cadCanvasPressEvent (QgsMapMouseEvent *e)
 Override this method when subclassing this class. More...
 
virtual void cadCanvasReleaseEvent (QgsMapMouseEvent *e)
 Override this method when subclassing this class. More...
 
QgsAdvancedDigitizingDockWidgetcadDockWidget () const
 
void canvasMoveEvent (QgsMapMouseEvent *e) override
 Catch the mouse move event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
void canvasPressEvent (QgsMapMouseEvent *e) override
 Catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
void canvasReleaseEvent (QgsMapMouseEvent *e) override
 Catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method. More...
 
void deactivate () override
 Unregisters this maptool from the cad dock widget. More...
 
bool isAdvancedDigitizingAllowed () const
 Returns whether functionality of advanced digitizing dock widget is currently allowed. More...
 
bool isAutoSnapEnabled () const
 Returns whether mouse events (press/move/release) should automatically try to snap mouse position (according to the snapping configuration of map canvas) before passing the mouse coordinates to the tool. More...
 
virtual QgsMapLayerlayer () const
 Returns the layer associated with the map tool. More...
 
void setSnapToLayerGridEnabled (bool snapToLayerGridEnabled)
 Enables or disables snap to grid of mouse events. More...
 
bool snapToLayerGridEnabled () const
 Enables or disables snap to grid of mouse events. More...
 
- Public Member Functions inherited from QgsMapToolEdit
 QgsMapToolEdit (QgsMapCanvas *canvas)
 
QgsGeometryRubberBandcreateGeometryRubberBand (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry, bool alternativeBand=false) const
 Creates a geometry rubber band with the color/line width from the QGIS settings. More...
 
Flags flags () const override
 Returns the flags for the map tool. More...
 
- Public Member Functions inherited from QgsMapTool
 ~QgsMapTool () override
 
QAction * action ()
 Returns associated action with map tool or nullptr if no action is associated. More...
 
virtual void activate ()
 called when set as currently active map tool More...
 
QAbstractButton * button ()
 Returns associated button with map tool or nullptr if no button is associated. More...
 
QgsMapCanvascanvas () const
 returns pointer to the tool's map canvas More...
 
virtual void canvasDoubleClickEvent (QgsMapMouseEvent *e)
 Mouse double-click event for overriding. Default implementation does nothing. More...
 
virtual void canvasMoveEvent (QgsMapMouseEvent *e)
 Mouse move event for overriding. Default implementation does nothing. More...
 
virtual void canvasPressEvent (QgsMapMouseEvent *e)
 Mouse press event for overriding. Default implementation does nothing. More...
 
virtual void canvasReleaseEvent (QgsMapMouseEvent *e)
 Mouse release event for overriding. Default implementation does nothing. More...
 
virtual bool canvasToolTipEvent (QHelpEvent *e)
 Tooltip event for overriding. More...
 
virtual void clean ()
 convenient method to clean members More...
 
virtual void deactivate ()
 called when map tool is being deactivated More...
 
virtual Flags flags () const
 Returns the flags for the map tool. More...
 
virtual bool gestureEvent (QGestureEvent *e)
 gesture event for overriding. Default implementation does nothing. More...
 
bool isActive () const
 Returns if the current map tool active on the map canvas. More...
 
virtual void keyPressEvent (QKeyEvent *e)
 Key event for overriding. Default implementation does nothing. More...
 
virtual void keyReleaseEvent (QKeyEvent *e)
 Key event for overriding. Default implementation does nothing. More...
 
virtual void populateContextMenu (QMenu *menu)
 Allows the tool to populate and customize the given menu, prior to showing it in response to a right-mouse button click. More...
 
virtual bool populateContextMenuWithEvent (QMenu *menu, QgsMapMouseEvent *event)
 Allows the tool to populate and customize the given menu, prior to showing it in response to a right-mouse button click. More...
 
void setAction (QAction *action)
 Use this to associate a QAction to this maptool. More...
 
void setButton (QAbstractButton *button)
 Use this to associate a button to this maptool. More...
 
virtual void setCursor (const QCursor &cursor)
 Sets a user defined cursor. More...
 
QgsPointXY toMapCoordinates (QPoint point)
 Transforms a point from screen coordinates to map coordinates. More...
 
QString toolName ()
 Emit map tool changed with the old tool. More...
 
virtual void wheelEvent (QWheelEvent *e)
 Mouse wheel event for overriding. Default implementation does nothing. More...
 

Additional Inherited Members

- Public Types inherited from QgsMapTool
enum  Flag { Transient = 1 << 1 , EditTool = 1 << 2 , AllowZoomRect = 1 << 3 , ShowContextMenu = 1 << 4 }
 Enumeration of flags that adjust the way the map tool operates. More...
 
- Static Public Member Functions inherited from QgsMapToolEdit
static double defaultMValue ()
 Returns default M value. More...
 
static double defaultZValue ()
 Returns default Z value. More...
 
- Static Public Member Functions inherited from QgsMapTool
static double searchRadiusMM ()
 Gets search radius in mm. More...
 
static double searchRadiusMU (const QgsRenderContext &context)
 Gets search radius in map units for given context. More...
 
static double searchRadiusMU (QgsMapCanvas *canvas)
 Gets search radius in map units for given canvas. More...
 
- Protected Types inherited from QgsMapToolEdit
enum  TopologicalResult { Success = 0 , InvalidCanvas = 1 , InvalidLayer = 2 }
 Result of addTopologicalPoints. More...
 
- Protected Member Functions inherited from QgsMapToolAdvancedDigitizing
void setAdvancedDigitizingAllowed (bool allowed)
 Sets whether functionality of advanced digitizing dock widget is currently allowed. More...
 
void setAutoSnapEnabled (bool enabled)
 Sets whether mouse events (press/move/release) should automatically try to snap mouse position This method is protected because it should be a decision of the map tool and not from elsewhere. More...
 
- Protected Member Functions inherited from QgsMapToolEdit
TopologicalResult addTopologicalPoints (const QVector< QgsPoint > &vertices)
 Adds a list of vertices to other features to keep topology up to date, e.g. More...
 
Q_DECL_DEPRECATED TopologicalResult addTopologicalPoints (const QVector< QgsPointXY > &vertices)
 Adds a list of vertices to other features to keep topology up to date, e.g. More...
 
QgsRubberBandcreateRubberBand (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry, bool alternativeBand=false)
 Creates a rubber band with the color/line width from the QGIS settings. More...
 
QgsVectorLayercurrentVectorLayer ()
 Returns the current vector layer of the map canvas or 0. More...
 
void notifyNotEditableLayer ()
 Display a timed message bar noting the active vector layer is not editable. More...
 
void notifyNotVectorLayer ()
 Display a timed message bar noting the active layer is not vector. More...
 
- Protected Member Functions inherited from QgsMapTool
 QgsMapTool (QgsMapCanvas *canvas)
 Constructor takes a map canvas as a parameter. More...
 
QgsMapLayerlayer (const QString &id)
 Returns the map layer with the matching ID, or nullptr if no layers could be found. More...
 
void setToolName (const QString &name)
 Sets the tool's name. More...
 
QPoint toCanvasCoordinates (const QgsPointXY &point) const
 Transforms a point from map coordinates to screen coordinates. More...
 
QgsPoint toLayerCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
 Transforms a point from map coordinates to layer coordinates. More...
 
QgsPointXY toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
 Transforms a point from map coordinates to layer coordinates. More...
 
QgsRectangle toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect)
 Transforms a rect from map coordinates to layer coordinates. More...
 
QgsPointXY toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
 Transforms a point from screen coordinates to layer coordinates. More...
 
QgsPoint toMapCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
 Transforms a point from layer coordinates to map coordinates (which is different in case reprojection is used). More...
 
QgsPointXY toMapCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
 Transforms a point from layer coordinates to map coordinates (which is different in case reprojection is used). More...
 
- Static Protected Member Functions inherited from QgsMapToolEdit
static QColor digitizingFillColor ()
 Returns fill color for rubber bands (from global settings) More...
 
static QColor digitizingStrokeColor ()
 Returns stroke color for rubber bands (from global settings) More...
 
static int digitizingStrokeWidth ()
 Returns stroke width for rubber bands (from global settings) More...
 
- Protected Attributes inherited from QgsMapToolAdvancedDigitizing
QgsAdvancedDigitizingDockWidgetmCadDockWidget = nullptr
 
- Protected Attributes inherited from QgsMapTool
QAction * mAction = nullptr
 Optional pointer to an action that will be checked on map tool activation and unchecked on map tool deactivation. More...
 
QAbstractButton * mButton = nullptr
 Optional pointer to a button that will be checked on map tool activation and unchecked on map tool deactivation. More...
 
QPointer< QgsMapCanvasmCanvas
 The pointer to the map canvas. More...
 
QCursor mCursor
 The cursor used in the map tool. More...
 
QString mToolName
 The translated name of the map tool. More...
 

Detailed Description

A map tool for modifying annotations in a QgsAnnotationLayer.

Note
Not available in Python bindings
Since
QGIS 3.22

Definition at line 42 of file qgsmaptoolmodifyannotation.h.

Constructor & Destructor Documentation

◆ QgsMapToolModifyAnnotation()

QgsMapToolModifyAnnotation::QgsMapToolModifyAnnotation ( QgsMapCanvas canvas,
QgsAdvancedDigitizingDockWidget cadDockWidget 
)
explicit

Constructor for QgsMapToolModifyAnnotation.

Definition at line 106 of file qgsmaptoolmodifyannotation.cpp.

◆ ~QgsMapToolModifyAnnotation()

QgsMapToolModifyAnnotation::~QgsMapToolModifyAnnotation ( )
overridedefault

Member Function Documentation

◆ cadCanvasMoveEvent()

void QgsMapToolModifyAnnotation::cadCanvasMoveEvent ( QgsMapMouseEvent e)
overridevirtual

Override this method when subclassing this class.

This will receive adapted events from the cad system whenever a canvasMoveEvent is triggered and it's not hidden by the cad's construction mode.

Parameters
eMouse events prepared by the cad system

Reimplemented from QgsMapToolAdvancedDigitizing.

Definition at line 124 of file qgsmaptoolmodifyannotation.cpp.

◆ cadCanvasPressEvent()

void QgsMapToolModifyAnnotation::cadCanvasPressEvent ( QgsMapMouseEvent e)
overridevirtual

Override this method when subclassing this class.

This will receive adapted events from the cad system whenever a canvasPressEvent is triggered and it's not hidden by the cad's construction mode.

Parameters
eMouse events prepared by the cad system

Reimplemented from QgsMapToolAdvancedDigitizing.

Definition at line 255 of file qgsmaptoolmodifyannotation.cpp.

◆ canvasDoubleClickEvent()

void QgsMapToolModifyAnnotation::canvasDoubleClickEvent ( QgsMapMouseEvent e)
overridevirtual

Mouse double-click event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 410 of file qgsmaptoolmodifyannotation.cpp.

◆ deactivate()

void QgsMapToolModifyAnnotation::deactivate ( )
overridevirtual

Unregisters this maptool from the cad dock widget.

Reimplemented from QgsMapToolAdvancedDigitizing.

Definition at line 116 of file qgsmaptoolmodifyannotation.cpp.

◆ itemSelected

void QgsMapToolModifyAnnotation::itemSelected ( QgsAnnotationLayer layer,
const QString &  itemId 
)
signal

Emitted when the selected item is changed.

◆ keyPressEvent()

void QgsMapToolModifyAnnotation::keyPressEvent ( QKeyEvent *  e)
overridevirtual

Key event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 465 of file qgsmaptoolmodifyannotation.cpp.

◆ selectionCleared

void QgsMapToolModifyAnnotation::selectionCleared ( )
signal

Emitted when the selected item is cleared;.


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