QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Signals | Public Member Functions | List of all members
QgsMapToolPan Class Reference

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

#include <qgsmaptoolpan.h>

Inheritance diagram for QgsMapToolPan:
Inheritance graph
[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. 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...
 
void reactivated ()
 

Public Member Functions

 QgsMapToolPan (QgsMapCanvas *canvas)
 constructor More...
 
 ~QgsMapToolPan () override
 
void activate () override
 called when set as currently active map tool More...
 
void canvasDoubleClickEvent (QgsMapMouseEvent *e) override
 Mouse double-click event for overriding. Default implementation does nothing. 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...
 
void deactivate () override
 called when map tool is being deactivated More...
 
Flags flags () const override
 Returns the flags for the map tool. More...
 
bool gestureEvent (QGestureEvent *e) override
 gesture event for overriding. Default implementation does nothing. More...
 
bool isDragging () const
 Returns true if a drag operation is in progress. 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...
 
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 bool canvasToolTipEvent (QHelpEvent *e)
 Tooltip event for overriding. More...
 
virtual void clean ()
 convenient method to clean members 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...
 
virtual void reactivate ()
 Called when the map tool is being activated while it is already active. 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...
 
typedef QFlags< FlagFlags
 
- 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...
 
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...
 
- 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 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 25 of file qgsmaptoolpan.cpp.

◆ ~QgsMapToolPan()

QgsMapToolPan::~QgsMapToolPan ( )
override

Definition at line 34 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 40 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 117 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 67 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 57 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 80 of file qgsmaptoolpan.cpp.

◆ deactivate()

void QgsMapToolPan::deactivate ( )
overridevirtual

called when map tool is being deactivated

Reimplemented from QgsMapTool.

Definition at line 46 of file qgsmaptoolpan.cpp.

◆ flags()

QgsMapTool::Flags QgsMapToolPan::flags ( ) const
overridevirtual

Returns the flags for the map tool.

Reimplemented from QgsMapTool.

Definition at line 52 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 125 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: