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)
	Overridden mouse move event.
virtual void	canvasReleaseEvent (QMouseEvent *e)
	Overridden mouse release event.
virtual bool	isTransient ()
	Check whether this MapTool performs a zoom or pan operation.
Public Member Functions inherited from QgsMapTool
virtual	~QgsMapTool ()
	virtual destructor
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	wheelEvent (QWheelEvent *e)
	Mouse wheel event for overriding. Default implementation does nothing.
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.
QAction *	action ()
	Return associated action with map tool or NULL if no action is associated.
void	setButton (QAbstractButton *button)
	Use this to associate a button to this maptool.
QAbstractButton *	button ()
	Return associated button with map tool or NULL if no button is associated.
virtual void	setCursor (QCursor cursor)
	Set a user defined cursor.
virtual bool	isEditTool ()
	Check whether this MapTool performs an edit operation.
virtual void	activate ()
	called when set as currently active map tool
virtual void	deactivate ()
	called when map tool is being deactivated
QgsMapCanvas *	canvas ()
	returns pointer to the tool's map canvas
QString	toolName ()
	Emit map tool changed with the old tool.

Additional Inherited Members
Signals inherited from QgsMapTool
void	messageEmitted (QString message, QgsMessageBar::MessageLevel=QgsMessageBar::INFO)
	emit a message
void	messageDiscarded ()
	emit signal to clear previous message
void	activated ()
	signal emitted once the map tool is activated
void	deactivated ()
	signal emitted once the map tool is deactivated
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
QgsPoint	toMapCoordinates (const QPoint &point)
	transformation from screen coordinates to map 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
QgsPoint	toMapCoordinates (QgsMapLayer *layer, const QgsPoint &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used)
QgsRectangle	toLayerCoordinates (QgsMapLayer *layer, const QgsRectangle &rect)
	trnasformation of the rect from map coordinates to layer's coordinates
QPoint	toCanvasCoordinates (const QgsPoint &point)
	transformation from map coordinates to screen coordinates
Protected Attributes inherited from QgsMapTool
QgsMapCanvas *	mCanvas
	pointer to map canvas
QCursor	mCursor
	cursor used in map tool
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
QString	mToolName
	translated name of the map tool

Detailed Description

A map tool for panning the map.

See Also

QgsMapTool

Constructor & Destructor Documentation

QgsMapToolPan::QgsMapToolPan

(

QgsMapCanvas *

canvas

)

constructor

Member Function Documentation

void QgsMapToolPan::canvasMoveEvent ( QMouseEvent *  e )

virtual

Overridden mouse move event.

Reimplemented from QgsMapTool.

void QgsMapToolPan::canvasReleaseEvent ( QMouseEvent *  e )

virtual

Overridden mouse release event.

Reimplemented from QgsMapTool.

virtual bool QgsMapToolPan::isTransient ( )

inlinevirtual

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.

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmaptoolpan.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmaptoolpan.cpp