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

#include <qgsmaptoolpan.h>

Inheritance diagram for QgsMapToolPan:

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

Public Member Functions inherited from QgsMapTool
	~QgsMapTool () override

QAction *	action ()
	Return associated action with map tool or NULL if no action is associated. More...

QAbstractButton *	button ()
	Return associated button with map tool or NULL if no button is associated. More...

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

virtual void	clean ()
	convenient method to clean members 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...

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)
	Set 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 }
	Enumeration of flags that adjust the way the map tool operates. 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::Info)
	emit a message More...

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

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

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

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

QPoint	toCanvasCoordinates (const QgsPointXY &point)
	transformation from map coordinates to screen coordinates More...

QgsPointXY	toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
	transformation from screen coordinates to layer's coordinates More...

QgsPointXY	toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
	transformation from map coordinates to layer's coordinates More...

QgsRectangle	toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect)
	trnasformation of the rect from map coordinates to layer's coordinates More...

QgsPointXY	toMapCoordinates (QPoint point)
	transformation from screen coordinates to map coordinates More...

QgsPointXY	toMapCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...

QgsPoint	toMapCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...

Protected Attributes inherited from QgsMapTool
QAction *	mAction = nullptr
	optionally map tool can have pointer to action which will be used to set that action as active More...

QAbstractButton *	mButton = nullptr
	optionally map tool can have pointer to a button which will be used to set that action as active More...

QgsMapCanvas *	mCanvas = nullptr
	pointer to map canvas More...

QCursor	mCursor
	cursor used in map tool More...

QString	mToolName
	translated name of the map tool More...

Detailed Description

A map tool for panning the map.

See also: QgsMapTool

Definition at line 29 of file qgsmaptoolpan.h.

Constructor & Destructor Documentation

◆ QgsMapToolPan()

QgsMapToolPan::QgsMapToolPan ( QgsMapCanvas * canvas )

constructor

Definition at line 24 of file qgsmaptoolpan.cpp.

◆ ~QgsMapToolPan()

QgsMapToolPan::~QgsMapToolPan ( )

override

Definition at line 33 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 38 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 93 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 57 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 50 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 70 of file qgsmaptoolpan.cpp.

◆ deactivate()

void QgsMapToolPan::deactivate ( )

overridevirtual

called when map tool is being deactivated

Reimplemented from QgsMapTool.

Definition at line 44 of file qgsmaptoolpan.cpp.

◆ flags()

Flags QgsMapToolPan::flags ( ) const

inlineoverridevirtual

Returns the flags for the map tool.

Since: QGIS 2.16

Reimplemented from QgsMapTool.

Definition at line 41 of file qgsmaptoolpan.h.

◆ gestureEvent()

bool QgsMapToolPan::gestureEvent ( QGestureEvent * e )

overridevirtual

gesture event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 101 of file qgsmaptoolpan.cpp.

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

/tmp/buildd/qgis-3.0.2+14stretch/src/gui/qgsmaptoolpan.h
/tmp/buildd/qgis-3.0.2+14stretch/src/gui/qgsmaptoolpan.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsMapToolPan()

◆ ~QgsMapToolPan()

Member Function Documentation

◆ activate()

◆ canvasDoubleClickEvent()

◆ canvasMoveEvent()

◆ canvasPressEvent()

◆ canvasReleaseEvent()

◆ deactivate()

◆ flags()

◆ gestureEvent()