QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsMapTool Class Reference

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

#include <qgsmaptool.h>

Inheritance diagram for QgsMapTool:
Inheritance graph
[legend]

Signals

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 (QString message, QgsMessageBar::MessageLevel=QgsMessageBar::INFO)
 emit a message More...
 

Public Member Functions

virtual ~QgsMapTool ()
 virtual destructor More...
 
QAction * action ()
 Return associated action with map tool or NULL if no action is associated. More...
 
virtual void activate ()
 called when set as currently active map tool More...
 
QAbstractButton * button ()
 Return associated button with map tool or NULL if no button is associated. More...
 
QgsMapCanvascanvas ()
 returns pointer to the tool's map canvas More...
 
virtual void canvasDoubleClickEvent (QMouseEvent *e)
 Mouse double click event for overriding. Default implementation does nothing. More...
 
virtual void canvasMoveEvent (QMouseEvent *e)
 Mouse move event for overriding. Default implementation does nothing. More...
 
virtual void canvasPressEvent (QMouseEvent *e)
 Mouse press event for overriding. Default implementation does nothing. More...
 
virtual void canvasReleaseEvent (QMouseEvent *e)
 Mouse release event for overriding. Default implementation does nothing. More...
 
virtual void deactivate ()
 called when map tool is being deactivated More...
 
virtual bool isEditTool ()
 Check whether this MapTool performs an edit operation. More...
 
virtual bool isTransient ()
 Check whether this MapTool performs a zoom or pan operation. 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...
 
virtual Q_DECL_DEPRECATED void renderComplete ()
 Called when rendering has finished. 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 (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...
 

Static Public Member Functions

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

 QgsMapTool (QgsMapCanvas *canvas)
 constructor takes map canvas as a parameter More...
 
QPoint toCanvasCoordinates (const QgsPoint &point)
 transformation from map coordinates to screen coordinates More...
 
QgsPoint toLayerCoordinates (QgsMapLayer *layer, const QPoint &point)
 transformation from screen coordinates to layer's coordinates More...
 
QgsPoint toLayerCoordinates (QgsMapLayer *layer, const QgsPoint &point)
 transformation from map coordinates to layer's coordinates More...
 
QgsRectangle toLayerCoordinates (QgsMapLayer *layer, const QgsRectangle &rect)
 trnasformation of the rect from map coordinates to layer's coordinates More...
 
QgsPoint toMapCoordinates (const QPoint &point)
 transformation from screen coordinates to map coordinates More...
 
QgsPoint toMapCoordinates (QgsMapLayer *layer, const QgsPoint &point)
 transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...
 

Protected Attributes

QAction * mAction
 optionally map tool can have pointer to action which will be used to set that action as active More...
 
QAbstractButton * mButton
 optionally map tool can have pointer to a button which will be used to set that action as active More...
 
QgsMapCanvasmCanvas
 pointer to map canvas More...
 
QCursor mCursor
 cursor used in map tool More...
 
QString mToolName
 translated name of the map tool More...
 

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.

Definition at line 48 of file qgsmaptool.h.

Constructor & Destructor Documentation

QgsMapTool::~QgsMapTool ( )
virtual

virtual destructor

Definition at line 36 of file qgsmaptool.cpp.

QgsMapTool::QgsMapTool ( QgsMapCanvas canvas)
protected

constructor takes map canvas as a parameter

Definition at line 25 of file qgsmaptool.cpp.

Member Function Documentation

QAction * QgsMapTool::action ( )

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

Definition at line 117 of file qgsmaptool.cpp.

void QgsMapTool::activate ( )
virtual

called when set as currently active map tool

Reimplemented in QgsMapToolIdentify, and QgsMapToolTouch.

Definition at line 77 of file qgsmaptool.cpp.

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.

Definition at line 127 of file qgsmaptool.cpp.

QgsMapCanvas * QgsMapTool::canvas ( )

returns pointer to the tool's map canvas

Definition at line 195 of file qgsmaptool.cpp.

void QgsMapTool::canvasDoubleClickEvent ( QMouseEvent *  e)
virtual

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

Reimplemented in QgsMapToolTouch.

Definition at line 143 of file qgsmaptool.cpp.

void QgsMapTool::canvasMoveEvent ( QMouseEvent *  e)
virtual

Mouse move event for overriding. Default implementation does nothing.

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

Definition at line 138 of file qgsmaptool.cpp.

void QgsMapTool::canvasPressEvent ( QMouseEvent *  e)
virtual

Mouse press event for overriding. Default implementation does nothing.

Reimplemented in QgsMapToolIdentify, QgsMapToolEmitPoint, and QgsMapToolZoom.

Definition at line 148 of file qgsmaptool.cpp.

void QgsMapTool::canvasReleaseEvent ( QMouseEvent *  e)
virtual

Mouse release event for overriding. Default implementation does nothing.

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

Definition at line 153 of file qgsmaptool.cpp.

void QgsMapTool::deactivate ( )
virtual

called when map tool is being deactivated

Reimplemented in QgsMapToolIdentify, QgsMapToolZoom, and QgsMapToolTouch.

Definition at line 93 of file qgsmaptool.cpp.

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

Definition at line 190 of file qgsmaptool.cpp.

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.

Definition at line 185 of file qgsmaptool.cpp.

void QgsMapTool::keyPressEvent ( QKeyEvent *  e)
virtual

Key event for overriding. Default implementation does nothing.

Reimplemented in QgsMapToolIdentifyFeature.

Definition at line 163 of file qgsmaptool.cpp.

void QgsMapTool::keyReleaseEvent ( QKeyEvent *  e)
virtual

Key event for overriding. Default implementation does nothing.

Definition at line 168 of file qgsmaptool.cpp.

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

Definition at line 181 of file qgsmaptool.cpp.

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

Definition at line 200 of file qgsmaptool.cpp.

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

Definition at line 212 of file qgsmaptool.cpp.

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

Definition at line 217 of file qgsmaptool.cpp.

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.

Definition at line 103 of file qgsmaptool.cpp.

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.

Definition at line 122 of file qgsmaptool.cpp.

void QgsMapTool::setCursor ( QCursor  cursor)
virtual

Set a user defined cursor.

Definition at line 132 of file qgsmaptool.cpp.

QPoint QgsMapTool::toCanvasCoordinates ( const QgsPoint point)
protected

transformation from map coordinates to screen coordinates

Definition at line 69 of file qgsmaptool.cpp.

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

transformation from screen coordinates to layer's coordinates

Definition at line 48 of file qgsmaptool.cpp.

QgsPoint QgsMapTool::toLayerCoordinates ( QgsMapLayer layer,
const QgsPoint point 
)
protected

transformation from map coordinates to layer's coordinates

Definition at line 54 of file qgsmaptool.cpp.

QgsRectangle QgsMapTool::toLayerCoordinates ( QgsMapLayer layer,
const QgsRectangle rect 
)
protected

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

Definition at line 64 of file qgsmaptool.cpp.

QgsPoint QgsMapTool::toMapCoordinates ( const QPoint &  point)
protected

transformation from screen coordinates to map coordinates

Definition at line 42 of file qgsmaptool.cpp.

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)

Definition at line 59 of file qgsmaptool.cpp.

QString QgsMapTool::toolName ( )
inline

Emit map tool changed with the old tool.

Note
added in 2.3

Definition at line 129 of file qgsmaptool.h.

void QgsMapTool::wheelEvent ( QWheelEvent *  e)
virtual

Mouse wheel event for overriding. Default implementation does nothing.

Definition at line 158 of file qgsmaptool.cpp.

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

Definition at line 195 of file qgsmaptool.h.

QAbstractButton* QgsMapTool::mButton
protected

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

Definition at line 199 of file qgsmaptool.h.

QgsMapCanvas* QgsMapTool::mCanvas
protected

pointer to map canvas

Definition at line 188 of file qgsmaptool.h.

QCursor QgsMapTool::mCursor
protected

cursor used in map tool

Definition at line 191 of file qgsmaptool.h.

QString QgsMapTool::mToolName
protected

translated name of the map tool

Definition at line 202 of file qgsmaptool.h.


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