QGIS API Documentation  3.21.0-Master (56b4176581)
qgsmaptoolpan.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmaptoolpan.h - map tool for panning in map canvas
3  ---------------------
4  begin : January 2006
5  copyright : (C) 2006 by Martin Dobias
6  email : wonder.sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSMAPTOOLPAN_H
17 #define QGSMAPTOOLPAN_H
18 
19 #include "qgsmaptool.h"
20 #include "qgis_gui.h"
21 #include "qgspointxy.h"
22 #include "qgsdistancearea.h"
23 
24 class QgsMapCanvas;
25 
26 
32 class GUI_EXPORT QgsMapToolPan : public QgsMapTool
33 {
34  Q_OBJECT
35 
36  public:
38  QgsMapToolPan( QgsMapCanvas *canvas );
39  ~QgsMapToolPan() override;
40 
41  void activate() override;
42  void deactivate() override;
43 
44  Flags flags() const override;
45  void canvasPressEvent( QgsMapMouseEvent *e ) override;
46  void canvasMoveEvent( QgsMapMouseEvent *e ) override;
47  void canvasReleaseEvent( QgsMapMouseEvent *e ) override;
48  void canvasDoubleClickEvent( QgsMapMouseEvent *e ) override;
49  bool gestureEvent( QGestureEvent *e ) override;
50 
56  bool isDragging() const { return mDragging; }
57 
58  signals:
59 
70  void panDistanceBearingChanged( double distance, QgsUnitTypes::DistanceUnit unit, double bearing );
71 
72  private:
73 
75  bool mDragging;
77  bool mPinching = false;
78 
79  void pinchTriggered( QPinchGesture *gesture );
80 };
81 
82 #endif
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:87
A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas.
A map tool for panning the map.
Definition: qgsmaptoolpan.h:33
bool isDragging() const
Returns true if a drag operation is in progress.
Definition: qgsmaptoolpan.h:56
void panDistanceBearingChanged(double distance, QgsUnitTypes::DistanceUnit unit, double bearing)
Emitted whenever the distance or bearing of an in-progress panning operation is changed.
Abstract base class for all map tools.
Definition: qgsmaptool.h:66
virtual void canvasDoubleClickEvent(QgsMapMouseEvent *e)
Mouse double-click event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:163
virtual void canvasPressEvent(QgsMapMouseEvent *e)
Mouse press event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:168
virtual void canvasMoveEvent(QgsMapMouseEvent *e)
Mouse move event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:158
virtual Flags flags() const
Returns the flags for the map tool.
Definition: qgsmaptool.h:108
virtual void canvasReleaseEvent(QgsMapMouseEvent *e)
Mouse release event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:173
virtual void activate()
called when set as currently active map tool
Definition: qgsmaptool.cpp:84
virtual bool gestureEvent(QGestureEvent *e)
gesture event for overriding. Default implementation does nothing.
Definition: qgsmaptool.cpp:193
virtual void deactivate()
called when map tool is being deactivated
Definition: qgsmaptool.cpp:100
DistanceUnit
Units of distance.
Definition: qgsunittypes.h:68