Utility class for handling various methods to create geometry for selection in layers. More...

#include <qgsmaptoolselectionhandler.h>

Inheritance diagram for QgsMapToolSelectionHandler:

Public Types
enum	SelectionMode { SelectSimple , SelectPolygon , SelectFreehand , SelectRadius , SelectOnMouseOver }
	Select features to identify by: More...

Signals
void	geometryChanged (Qt::KeyboardModifiers modifiers=Qt::NoModifier)
	emitted when a new geometry has been picked (selectedGeometry())

Public Member Functions
	QgsMapToolSelectionHandler (QgsMapCanvas *canvas, QgsMapToolSelectionHandler::SelectionMode selectionMode=QgsMapToolSelectionHandler::SelectionMode::SelectSimple)
	constructor
	~QgsMapToolSelectionHandler () override
	destructor
void	canvasMoveEvent (QgsMapMouseEvent *e)
	Handles mouse move event from map tool.
void	canvasPressEvent (QgsMapMouseEvent *e)
	Handles mouse press event from map tool.
void	canvasReleaseEvent (QgsMapMouseEvent *e)
	Handles mouse release event from map tool.
void	deactivate ()
	Deactivates handler (when map tool gets deactivated).
bool	keyReleaseEvent (QKeyEvent *e)
	Handles escape press event - returns true if the even has been processed.
QgsGeometry	selectedGeometry () const
	Returns most recently selected geometry (may be a point or a polygon).
SelectionMode	selectionMode () const
	Sets the current selection mode.
void	setSelectedGeometry (const QgsGeometry &geometry, Qt::KeyboardModifiers modifiers=Qt::NoModifier)
	Sets the selected geometry.
void	setSelectionMode (SelectionMode mode)
	Returns the current selection mode.

Detailed Description

Utility class for handling various methods to create geometry for selection in layers.

Since: QGIS 3.2

Definition at line 85 of file qgsmaptoolselectionhandler.h.

Member Enumeration Documentation

◆ SelectionMode

enum QgsMapToolSelectionHandler::SelectionMode

Select features to identify by:

Enumerator
SelectSimple	SelectSimple - single click or drawing a rectangle, default option.
SelectPolygon	SelectPolygon - drawing a polygon or right-click on existing polygon feature.
SelectFreehand	SelectFreehand - free hand selection.
SelectRadius	SelectRadius - a circle selection.
SelectOnMouseOver	SelectOnMouseMove - selection on mouse over. Since QGIS 3.30

Definition at line 91 of file qgsmaptoolselectionhandler.h.

Constructor & Destructor Documentation

◆ QgsMapToolSelectionHandler()

QgsMapToolSelectionHandler::QgsMapToolSelectionHandler	(	QgsMapCanvas *	canvas,
		QgsMapToolSelectionHandler::SelectionMode	selectionMode = QgsMapToolSelectionHandler::SelectionMode::SelectSimple )

constructor

Definition at line 105 of file qgsmaptoolselectionhandler.cpp.

◆ ~QgsMapToolSelectionHandler()

QgsMapToolSelectionHandler::~QgsMapToolSelectionHandler ( )

override

destructor

Definition at line 115 of file qgsmaptoolselectionhandler.cpp.

Member Function Documentation

◆ canvasMoveEvent()

void QgsMapToolSelectionHandler::canvasMoveEvent ( QgsMapMouseEvent * e )

Handles mouse move event from map tool.

Definition at line 140 of file qgsmaptoolselectionhandler.cpp.

◆ canvasPressEvent()

void QgsMapToolSelectionHandler::canvasPressEvent ( QgsMapMouseEvent * e )

Handles mouse press event from map tool.

Definition at line 160 of file qgsmaptoolselectionhandler.cpp.

◆ canvasReleaseEvent()

void QgsMapToolSelectionHandler::canvasReleaseEvent ( QgsMapMouseEvent * e )

Handles mouse release event from map tool.

Definition at line 120 of file qgsmaptoolselectionhandler.cpp.

◆ deactivate()

void QgsMapToolSelectionHandler::deactivate ( )

Deactivates handler (when map tool gets deactivated).

Definition at line 188 of file qgsmaptoolselectionhandler.cpp.

◆ geometryChanged

void QgsMapToolSelectionHandler::geometryChanged ( Qt::KeyboardModifiers modifiers = Qt::NoModifier )

signal

emitted when a new geometry has been picked (selectedGeometry())

◆ keyReleaseEvent()

bool QgsMapToolSelectionHandler::keyReleaseEvent ( QKeyEvent * e )

Handles escape press event - returns true if the even has been processed.

Definition at line 178 of file qgsmaptoolselectionhandler.cpp.

◆ selectedGeometry()

QgsGeometry QgsMapToolSelectionHandler::selectedGeometry ( ) const

Returns most recently selected geometry (may be a point or a polygon).

Definition at line 496 of file qgsmaptoolselectionhandler.cpp.

◆ selectionMode()

QgsMapToolSelectionHandler::SelectionMode QgsMapToolSelectionHandler::selectionMode ( ) const

Sets the current selection mode.

Definition at line 513 of file qgsmaptoolselectionhandler.cpp.

◆ setSelectedGeometry()

void QgsMapToolSelectionHandler::setSelectedGeometry	(	const QgsGeometry &	geometry,
		Qt::KeyboardModifiers	modifiers = Qt::NoModifier )

Sets the selected geometry.

Definition at line 501 of file qgsmaptoolselectionhandler.cpp.

◆ setSelectionMode()

void QgsMapToolSelectionHandler::setSelectionMode ( SelectionMode mode )

Returns the current selection mode.

Definition at line 508 of file qgsmaptoolselectionhandler.cpp.

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

/build/qgis-4.1.0+git20260518+4aad578bf8d+99sid/src/gui/maptools/qgsmaptoolselectionhandler.h
/build/qgis-4.1.0+git20260518+4aad578bf8d+99sid/src/gui/maptools/qgsmaptoolselectionhandler.cpp

Public Types

Signals

Public Member Functions