QgsMapTool Class Reference

Abstract base class for all map tools. More...

#include <qgsmaptool.h>

Inheritance diagram for QgsMapTool:

Signals
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

Public Member Functions
virtual	~QgsMapTool ()
	virtual destructor
virtual void	canvasMoveEvent (QMouseEvent *e)
	Mouse move event for overriding. Default implementation does nothing.
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	canvasReleaseEvent (QMouseEvent *e)
	Mouse release 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	isTransient ()
	Check whether this MapTool performs a zoom or pan operation.
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.

Static Public Member Functions
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
	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
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

Abstract base class for all map tools.

Map tools are user interactive tools for manipulating the map canvas. For example map pan and zoom features are implemented as map tools.

Constructor & Destructor Documentation

QgsMapTool::~QgsMapTool ( )

virtual

virtual destructor

QgsMapTool::QgsMapTool ( QgsMapCanvas *  canvas )

protected

constructor takes map canvas as a parameter

Member Function Documentation

QAction * QgsMapTool::action

(

)

Return associated action with map tool or NULL if no action is associated.

void QgsMapTool::activate ( )

virtual

called when set as currently active map tool

Reimplemented in QgsMapToolIdentify, and QgsMapToolTouch.

void QgsMapTool::activated ( )

signal

signal emitted once the map tool is activated

QAbstractButton * QgsMapTool::button

(

)

Return associated button with map tool or NULL if no button is associated.

QgsMapCanvas * QgsMapTool::canvas

(

)

returns pointer to the tool's map canvas

void QgsMapTool::canvasDoubleClickEvent ( QMouseEvent *  e )

virtual

Mouse double click event for overriding. Default implementation does nothing.

Reimplemented in QgsMapToolTouch.

void QgsMapTool::canvasMoveEvent ( QMouseEvent *  e )

virtual

Mouse move event for overriding. Default implementation does nothing.

Reimplemented in QgsMapToolIdentify, QgsMapToolTouch, QgsMapToolEmitPoint, QgsMapToolZoom, and QgsMapToolPan.

void QgsMapTool::canvasPressEvent ( QMouseEvent *  e )

virtual

Mouse press event for overriding. Default implementation does nothing.

Reimplemented in QgsMapToolIdentify, QgsMapToolEmitPoint, and QgsMapToolZoom.

void QgsMapTool::canvasReleaseEvent ( QMouseEvent *  e )

virtual

Mouse release event for overriding. Default implementation does nothing.

Reimplemented in QgsMapToolIdentify, QgsMapToolTouch, QgsMapToolEmitPoint, QgsMapToolIdentifyFeature, QgsMapToolZoom, and QgsMapToolPan.

void QgsMapTool::deactivate ( )

virtual

called when map tool is being deactivated

Reimplemented in QgsMapToolIdentify, QgsMapToolZoom, and QgsMapToolTouch.

void QgsMapTool::deactivated ( )

signal

signal emitted once the map tool is deactivated

bool QgsMapTool::isEditTool ( )

virtual

Check whether this MapTool performs an edit operation.

If it does, we will deactivate it when editing is turned off

bool QgsMapTool::isTransient ( )

virtual

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 in QgsMapToolTouch, QgsMapToolZoom, and QgsMapToolPan.

void QgsMapTool::keyPressEvent ( QKeyEvent *  e )

virtual

Key event for overriding. Default implementation does nothing.

Reimplemented in QgsMapToolIdentifyFeature.

void QgsMapTool::keyReleaseEvent ( QKeyEvent *  e )

virtual

Key event for overriding. Default implementation does nothing.

void QgsMapTool::messageDiscarded ( )

signal

emit signal to clear previous message

void QgsMapTool::messageEmitted ( QString  message, QgsMessageBar::MessageLevel  = QgsMessageBar::INFO  )

signal

emit a message

void QgsMapTool::renderComplete ( )

virtual

Called when rendering has finished.

Default implementation does nothing.

Deprecated:

since 2.4 - not called anymore - map tools must not directly depend on rendering progress

double QgsMapTool::searchRadiusMM ( )

static

Get search radius in mm.

Used by identify, tip etc. The values is currently set in identify tool options (move somewhere else?) and defaults to QGis::DEFAULT_SEARCH_RADIUS_MM.

Note

added in 2.3

double QgsMapTool::searchRadiusMU ( const QgsRenderContext &  context )

static

Get search radius in map units for given context.

Used by identify, tip etc. The values is calculated from searchRadiusMM().

Note

added in 2.3

double QgsMapTool::searchRadiusMU ( QgsMapCanvas *  canvas )

static

Get search radius in map units for given canvas.

Used by identify, tip etc. The values is calculated from searchRadiusMM().

Note

added in 2.3

void QgsMapTool::setAction

(

QAction *

action

)

Use this to associate a QAction to this maptool.

Then when the setMapTool method of mapcanvas is called the action state will be set to on. Usually this will cause e.g. a toolbutton to appear pressed in and the previously used toolbutton to pop out.

void QgsMapTool::setButton

(

QAbstractButton *

button

)

Use this to associate a button to this maptool.

It has the same meaning as setAction() function except it works with a button instead of an QAction.

void QgsMapTool::setCursor ( QCursor  cursor )

virtual

Set a user defined cursor.

QPoint QgsMapTool::toCanvasCoordinates ( const QgsPoint &  point )

protected

transformation from map coordinates to screen coordinates

QgsPoint QgsMapTool::toLayerCoordinates ( QgsMapLayer *  layer, const QPoint &  point  )

protected

transformation from screen coordinates to layer's coordinates

QgsPoint QgsMapTool::toLayerCoordinates ( QgsMapLayer *  layer, const QgsPoint &  point  )

protected

transformation from map coordinates to layer's coordinates

QgsRectangle QgsMapTool::toLayerCoordinates ( QgsMapLayer *  layer, const QgsRectangle &  rect  )

protected

trnasformation of the rect from map coordinates to layer's coordinates

QgsPoint QgsMapTool::toMapCoordinates ( const QPoint &  point )

protected

transformation from screen coordinates to map coordinates

QgsPoint QgsMapTool::toMapCoordinates ( QgsMapLayer *  layer, const QgsPoint &  point  )

protected

transformation from layer's coordinates to map coordinates (which is different in case reprojection is used)

QString QgsMapTool::toolName ( )

inline

Emit map tool changed with the old tool.

Note

added in 2.3

void QgsMapTool::wheelEvent ( QWheelEvent *  e )

virtual

Mouse wheel event for overriding. Default implementation does nothing.

Member Data Documentation

QAction* QgsMapTool::mAction

protected

optionally map tool can have pointer to action which will be used to set that action as active

QAbstractButton* QgsMapTool::mButton

protected

optionally map tool can have pointer to a button which will be used to set that action as active

QgsMapCanvas* QgsMapTool::mCanvas

protected

pointer to map canvas

QCursor QgsMapTool::mCursor

protected

cursor used in map tool

QString QgsMapTool::mToolName

protected

translated name of the map tool

---

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

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