QgsMapToolPan Class Reference

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

#include <qgsmaptoolpan.h>

Inheritance diagram for QgsMapToolPan:

Public Member Functions
	QgsMapToolPan (QgsMapCanvas *canvas)
	constructor
virtual void	canvasMoveEvent (QMouseEvent *e) override
	Overridden mouse move event.
virtual void	canvasReleaseEvent (QMouseEvent *e) override
	Overridden mouse release event.
virtual bool	isTransient () override
	Check whether this MapTool performs a zoom or pan operation.
Public Member Functions inherited from QgsMapTool
virtual	~QgsMapTool ()
	virtual destructor
QAction *	action ()
	Return associated action with map tool or NULL if no action is associated.
virtual void	activate ()
	called when set as currently active map tool
QAbstractButton *	button ()
	Return associated button with map tool or NULL if no button is associated.
QgsMapCanvas *	canvas ()
	returns pointer to the tool's map canvas
virtual void	canvasDoubleClickEvent (QMouseEvent *e)
	Mouse double click event for overriding. Default implementation does nothing.
virtual void	canvasPressEvent (QMouseEvent *e)
	Mouse press event for overriding. Default implementation does nothing.
virtual void	deactivate ()
	called when map tool is being deactivated
virtual bool	isEditTool ()
	Check whether this MapTool performs an edit operation.
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 Q_DECL_DEPRECATED void	renderComplete ()
	Called when rendering has finished.
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 (QCursor cursor)
	Set a user defined cursor.
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
Signals inherited from QgsMapTool
void	activated ()
	signal emitted once the map tool is activated
void	deactivated ()
	signal emitted once the map tool is deactivated
void	messageDiscarded ()
	emit signal to clear previous message
void	messageEmitted (QString message, QgsMessageBar::MessageLevel=QgsMessageBar::INFO)
	emit a message
Static Public Member Functions inherited from QgsMapTool
static double	searchRadiusMM ()
	Get search radius in mm.
static double	searchRadiusMU (const QgsRenderContext &context)
	Get search radius in map units for given context.
static double	searchRadiusMU (QgsMapCanvas *canvas)
	Get search radius in map units for given canvas.
Protected Member Functions inherited from QgsMapTool
	QgsMapTool (QgsMapCanvas *canvas)
	constructor takes map canvas as a parameter
QPoint	toCanvasCoordinates (const QgsPoint &point)
	transformation from map coordinates to screen coordinates
QgsPoint	toLayerCoordinates (QgsMapLayer *layer, const QPoint &point)
	transformation from screen coordinates to layer's coordinates
QgsPoint	toLayerCoordinates (QgsMapLayer *layer, const QgsPoint &point)
	transformation from map coordinates to layer's coordinates
QgsRectangle	toLayerCoordinates (QgsMapLayer *layer, const QgsRectangle &rect)
	trnasformation of the rect from map coordinates to layer's coordinates
QgsPoint	toMapCoordinates (const QPoint &point)
	transformation from screen coordinates to map coordinates
QgsPoint	toMapCoordinates (QgsMapLayer *layer, const QgsPoint &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used)
Protected Attributes inherited from QgsMapTool
QAction *	mAction
	optionally map tool can have pointer to action which will be used to set that action as active
QAbstractButton *	mButton
	optionally map tool can have pointer to a button which will be used to set that action as active
QgsMapCanvas *	mCanvas
	pointer to map canvas
QCursor	mCursor
	cursor used in map tool
QString	mToolName
	translated name of the map tool

Detailed Description

A map tool for panning the map.

See Also

QgsMapTool

Definition at line 27 of file qgsmaptoolpan.h.

Constructor & Destructor Documentation

QgsMapToolPan::QgsMapToolPan

(

QgsMapCanvas *

canvas

)

constructor

Definition at line 25 of file qgsmaptoolpan.cpp.

Member Function Documentation

void QgsMapToolPan::canvasMoveEvent ( QMouseEvent *  e )

overridevirtual

Overridden mouse move event.

Reimplemented from QgsMapTool.

Definition at line 37 of file qgsmaptoolpan.cpp.

void QgsMapToolPan::canvasReleaseEvent ( QMouseEvent *  e )

overridevirtual

Overridden mouse release event.

Reimplemented from QgsMapTool.

Definition at line 47 of file qgsmaptoolpan.cpp.

virtual bool QgsMapToolPan::isTransient ( )

inlineoverridevirtual

Check whether this MapTool performs a zoom or pan operation.

If it does, we will be able to perform the zoom and then resume operations with the original / previously used tool.

Reimplemented from QgsMapTool.

Definition at line 39 of file qgsmaptoolpan.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgsmaptoolpan.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgsmaptoolpan.cpp