A map tool for panning the map. More...

#include <qgsmaptoolpan.h>

Inheritance diagram for QgsMapToolPan:

[legend]

Signals
void	panDistanceBearingChanged (double distance, Qgis::DistanceUnit unit, double bearing)
	Emitted whenever the distance or bearing of an in-progress panning operation is changed.

Signals inherited from QgsMapTool
void	activated ()
	Emitted when the map tool is activated.

void	deactivated ()
	Emitted when the map tool is deactivated.

void	messageDiscarded ()
	Emitted when the previous message from the tool should be cleared from the application message bar.

void	messageEmitted (const QString &message, Qgis::MessageLevel level=Qgis::MessageLevel::Info)
	Emitted when a message should be shown to the user in the application message bar.

void	reactivated ()
	Emitted when the map tool is activated, while it is already active.

Public Member Functions
	QgsMapToolPan (QgsMapCanvas *canvas)
	constructor

	~QgsMapToolPan () override

void	activate () override
	called when set as currently active map tool

void	canvasDoubleClickEvent (QgsMapMouseEvent *e) override
	Mouse double-click event for overriding. Default implementation does nothing.

void	canvasMoveEvent (QgsMapMouseEvent *e) override
	Mouse move event for overriding. Default implementation does nothing.

void	canvasPressEvent (QgsMapMouseEvent *e) override
	Mouse press event for overriding. Default implementation does nothing.

void	canvasReleaseEvent (QgsMapMouseEvent *e) override
	Mouse release event for overriding. Default implementation does nothing.

void	deactivate () override
	called when map tool is being deactivated

Flags	flags () const override
	Returns the flags for the map tool.

bool	gestureEvent (QGestureEvent *e) override
	gesture event for overriding. Default implementation does nothing.

bool	isDragging () const
	Returns `true` if a drag operation is in progress.

Public Member Functions inherited from QgsMapTool
	~QgsMapTool () override

QAction *	action ()
	Returns associated action with map tool or `nullptr` if no action is associated.

QAbstractButton *	button ()
	Returns associated button with map tool or `nullptr` if no button is associated.

QgsMapCanvas *	canvas () const
	returns pointer to the tool's map canvas

virtual bool	canvasToolTipEvent (QHelpEvent *e)
	Tooltip event for overriding.

virtual void	clean ()
	convenient method to clean members

bool	isActive () const
	Returns if the current map tool active on the map canvas.

virtual void	keyPressEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing.

virtual void	keyReleaseEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing.

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.

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.

virtual void	reactivate ()
	Called when the map tool is being activated while it is already active.

void	setAction (QAction *action)
	Use this to associate a QAction to this maptool.

void	setButton (QAbstractButton *button)
	Use this to associate a button to this maptool.

virtual void	setCursor (const QCursor &cursor)
	Sets a user defined cursor.

QgsPointXY	toMapCoordinates (QPoint point)
	Transforms a point from screen coordinates to map coordinates.

QString	toolName ()
	Emit map tool changed with the old tool.

virtual void	wheelEvent (QWheelEvent *e)
	Mouse wheel event for overriding. Default implementation does nothing.

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...

typedef QFlags< Flag >	Flags

Static Public Member Functions inherited from QgsMapTool
static double	searchRadiusMM ()
	Gets search radius in mm.

static double	searchRadiusMU (const QgsRenderContext &context)
	Gets search radius in map units for given context.

static double	searchRadiusMU (QgsMapCanvas *canvas)
	Gets search radius in map units for given canvas.

Protected Member Functions inherited from QgsMapTool
	QgsMapTool (QgsMapCanvas *canvas)
	Constructor takes a map canvas as a parameter.

QgsMapLayer *	layer (const QString &id)
	Returns the map layer with the matching ID, or `nullptr` if no layers could be found.

void	setToolName (const QString &name)
	Sets the tool's name.

QPoint	toCanvasCoordinates (const QgsPointXY &point) const
	Transforms a point from map coordinates to screen coordinates.

QgsPoint	toLayerCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
	Transforms a point from map coordinates to layer coordinates.

QgsPointXY	toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
	Transforms a point from map coordinates to layer coordinates.

QgsRectangle	toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect)
	Transforms a rect from map coordinates to layer coordinates.

QgsPointXY	toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
	Transforms a point from screen coordinates to layer coordinates.

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).

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).

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.

QAbstractButton *	mButton = nullptr
	Optional pointer to a button that will be checked on map tool activation and unchecked on map tool deactivation.

QPointer< QgsMapCanvas >	mCanvas
	The pointer to the map canvas.

QCursor	mCursor
	The cursor used in the map tool.

QString	mToolName
	The translated name of the map tool.

Detailed Description

A map tool for panning the map.

See also: QgsMapTool

Definition at line 30 of file qgsmaptoolpan.h.

Constructor & Destructor Documentation

◆ QgsMapToolPan()

QgsMapToolPan::QgsMapToolPan ( QgsMapCanvas * canvas )

constructor

Definition at line 26 of file qgsmaptoolpan.cpp.

◆ ~QgsMapToolPan()

QgsMapToolPan::~QgsMapToolPan ( )

override

Definition at line 35 of file qgsmaptoolpan.cpp.

Member Function Documentation

◆ activate()

void QgsMapToolPan::activate ( )

overridevirtual

called when set as currently active map tool

Reimplemented from QgsMapTool.

Definition at line 41 of file qgsmaptoolpan.cpp.

◆ canvasDoubleClickEvent()

void QgsMapToolPan::canvasDoubleClickEvent ( QgsMapMouseEvent * e )

overridevirtual

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

Reimplemented from QgsMapTool.

Definition at line 118 of file qgsmaptoolpan.cpp.

◆ canvasMoveEvent()

void QgsMapToolPan::canvasMoveEvent ( QgsMapMouseEvent * e )

overridevirtual

Mouse move event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 68 of file qgsmaptoolpan.cpp.

◆ canvasPressEvent()

void QgsMapToolPan::canvasPressEvent ( QgsMapMouseEvent * e )

overridevirtual

Mouse press event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 58 of file qgsmaptoolpan.cpp.

◆ canvasReleaseEvent()

void QgsMapToolPan::canvasReleaseEvent ( QgsMapMouseEvent * e )

overridevirtual

Mouse release event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 81 of file qgsmaptoolpan.cpp.

◆ deactivate()

void QgsMapToolPan::deactivate ( )

overridevirtual

called when map tool is being deactivated

Reimplemented from QgsMapTool.

Definition at line 47 of file qgsmaptoolpan.cpp.

◆ flags()

QgsMapTool::Flags QgsMapToolPan::flags ( ) const

overridevirtual

Returns the flags for the map tool.

Reimplemented from QgsMapTool.

Definition at line 53 of file qgsmaptoolpan.cpp.

◆ gestureEvent()

bool QgsMapToolPan::gestureEvent ( QGestureEvent * e )

overridevirtual

gesture event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 126 of file qgsmaptoolpan.cpp.

◆ isDragging()

bool QgsMapToolPan::isDragging ( ) const

inline

Returns true if a drag operation is in progress.

Since: QGIS 3.12

Definition at line 54 of file qgsmaptoolpan.h.

◆ panDistanceBearingChanged

void QgsMapToolPan::panDistanceBearingChanged	(	double	distance,
		Qgis::DistanceUnit	unit,
		double	bearing
	)

signal

Emitted whenever the distance or bearing of an in-progress panning operation is changed.

This signal will be emitted during a pan operation as the user moves the map, giving the total distance and bearing between the map position at the start of the pan and the current pan position.

Since: QGIS 3.12

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

/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/maptools/qgsmaptoolpan.h
/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/gui/maptools/qgsmaptoolpan.cpp

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsMapToolPan()

◆ ~QgsMapToolPan()

Member Function Documentation

◆ activate()

◆ canvasDoubleClickEvent()

◆ canvasMoveEvent()

◆ canvasPressEvent()

◆ canvasReleaseEvent()

◆ deactivate()

◆ flags()

◆ gestureEvent()

◆ isDragging()

◆ panDistanceBearingChanged