A map tool that simply emits a point when clicking on the map. More...
#include <qgsmaptoolemitpoint.h>
Inheritance diagram for QgsMapToolEmitPoint:
Signals | |
| void | canvasClicked (const QgsPointXY &point, Qt::MouseButton button) |
| signal emitted on canvas click 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 | |
| QgsMapToolEmitPoint (QgsMapCanvas *canvas) | |
| constructor More... | |
| void | canvasMoveEvent (QgsMapMouseEvent *e) override |
| Mouse move event for overriding. Default implementation does nothing. More... | |
| void | canvasPressEvent (QgsMapMouseEvent *e) override |
| Mouse press event for overriding. Default implementation does nothing. More... | |
| void | canvasReleaseEvent (QgsMapMouseEvent *e) override |
| Mouse release event for overriding. Default implementation does nothing. 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... | |
| QgsMapCanvas * | canvas () 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 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 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... | |
| 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 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 Member Functions inherited from QgsMapTool | |
| QgsMapTool (QgsMapCanvas *canvas) | |
| Constructor takes a map canvas as a parameter. More... | |
| QgsMapLayer * | layer (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... | |
| QgsPointXY | toMapCoordinates (QPoint point) |
| Transforms a point from screen coordinates to map coordinates. More... | |
| 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... | |
| QgsMapCanvas * | mCanvas = nullptr |
| 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 that simply emits a point when clicking on the map.
Connecting a slot to its canvasClicked() signal will let you implement custom behavior for the passed in point.
Definition at line 30 of file qgsmaptoolemitpoint.h.
Constructor & Destructor Documentation
◆ QgsMapToolEmitPoint()
| QgsMapToolEmitPoint::QgsMapToolEmitPoint | ( | QgsMapCanvas * | canvas | ) |
constructor
Definition at line 23 of file qgsmaptoolemitpoint.cpp.
Member Function Documentation
◆ canvasClicked
|
signal |
signal emitted on canvas click
◆ canvasMoveEvent()
|
overridevirtual |
Mouse move event for overriding. Default implementation does nothing.
Reimplemented from QgsMapTool.
Definition at line 28 of file qgsmaptoolemitpoint.cpp.
◆ canvasPressEvent()
|
overridevirtual |
Mouse press event for overriding. Default implementation does nothing.
Reimplemented from QgsMapTool.
Definition at line 33 of file qgsmaptoolemitpoint.cpp.
◆ canvasReleaseEvent()
|
overridevirtual |
Mouse release event for overriding. Default implementation does nothing.
Reimplemented from QgsMapTool.
Definition at line 39 of file qgsmaptoolemitpoint.cpp.
◆ flags()
|
inlineoverridevirtual |
Returns the flags for the map tool.
- Since
- QGIS 2.16
Reimplemented from QgsMapTool.
Definition at line 38 of file qgsmaptoolemitpoint.h.
The documentation for this class was generated from the following files:
- /build/qgis-3.22.4+99unstable/src/gui/qgsmaptoolemitpoint.h
- /build/qgis-3.22.4+99unstable/src/gui/qgsmaptoolemitpoint.cpp
