QGIS API Documentation  2.99.0-Master (8ec3eaf)
Public Types | 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]

Public Types

enum  Flag { Transient = 1 << 1, EditTool = 1 << 2, AllowZoomRect = 1 << 3 }
 Enumeration of flags that adjust the way the map tool operates. More...
 

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 (const 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 (QgsMapMouseEvent *e)
 Mouse double click event for overriding. Default implementation does nothing. More...
 
virtual void canvasMoveEvent (QgsMapMouseEvent *e)
 Mouse move event for overriding. Default implementation does nothing. More...
 
virtual void canvasPressEvent (QgsMapMouseEvent *e)
 Mouse press event for overriding. Default implementation does nothing. More...
 
virtual void canvasReleaseEvent (QgsMapMouseEvent *e)
 Mouse release event for overriding. Default implementation does nothing. More...
 
virtual void deactivate ()
 called when map tool is being deactivated More...
 
virtual Flags flags () const
 Returns the flags for the map tool. 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...
 

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, 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 (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...
 
QgsPointV2 toMapCoordinates (QgsMapLayer *layer, const QgsPointV2 &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 50 of file qgsmaptool.h.

Member Enumeration Documentation

§ Flag

Enumeration of flags that adjust the way the map tool operates.

Note
added in QGIS 2.16
Enumerator
Transient 

Indicates that this map tool performs a transient (one-off) operation. If it does, the tool can be operated once and then a previous map tool automatically restored.

EditTool 

Map tool is an edit tool, which can only be used when layer is editable.

AllowZoomRect 

Allow zooming by rectangle (by holding shift and dragging) while the tool is active.

Definition at line 59 of file qgsmaptool.h.

Constructor & Destructor Documentation

§ ~QgsMapTool()

QgsMapTool::~QgsMapTool ( )
virtual

virtual destructor

Definition at line 35 of file qgsmaptool.cpp.

§ QgsMapTool()

QgsMapTool::QgsMapTool ( QgsMapCanvas canvas)
protected

constructor takes map canvas as a parameter

Definition at line 24 of file qgsmaptool.cpp.

Member Function Documentation

§ action()

QAction * QgsMapTool::action ( )

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

Definition at line 123 of file qgsmaptool.cpp.

§ activate()

void QgsMapTool::activate ( )
virtual

called when set as currently active map tool

Reimplemented in QgsMapToolIdentify, QgsMapToolAdvancedDigitizing, QgsMapToolCapture, and QgsMapToolTouch.

Definition at line 82 of file qgsmaptool.cpp.

§ activated

void QgsMapTool::activated ( )
signal

signal emitted once the map tool is activated

§ button()

QAbstractButton * QgsMapTool::button ( )

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

Definition at line 133 of file qgsmaptool.cpp.

§ canvas()

QgsMapCanvas * QgsMapTool::canvas ( )

returns pointer to the tool's map canvas

Definition at line 187 of file qgsmaptool.cpp.

§ canvasDoubleClickEvent()

void QgsMapTool::canvasDoubleClickEvent ( QgsMapMouseEvent e)
virtual

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

Reimplemented in QgsMapToolTouch.

Definition at line 149 of file qgsmaptool.cpp.

§ canvasMoveEvent()

void QgsMapTool::canvasMoveEvent ( QgsMapMouseEvent e)
virtual

Mouse move event for overriding. Default implementation does nothing.

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

Definition at line 144 of file qgsmaptool.cpp.

§ canvasPressEvent()

void QgsMapTool::canvasPressEvent ( QgsMapMouseEvent e)
virtual

Mouse press event for overriding. Default implementation does nothing.

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

Definition at line 154 of file qgsmaptool.cpp.

§ canvasReleaseEvent()

void QgsMapTool::canvasReleaseEvent ( QgsMapMouseEvent e)
virtual

Mouse release event for overriding. Default implementation does nothing.

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

Definition at line 159 of file qgsmaptool.cpp.

§ deactivate()

void QgsMapTool::deactivate ( )
virtual

called when map tool is being deactivated

Reimplemented in QgsMapToolIdentify, QgsMapToolAdvancedDigitizing, QgsMapToolCapture, QgsMapToolZoom, and QgsMapToolTouch.

Definition at line 98 of file qgsmaptool.cpp.

§ deactivated

void QgsMapTool::deactivated ( )
signal

signal emitted once the map tool is deactivated

§ flags()

virtual Flags QgsMapTool::flags ( ) const
inlinevirtual

Returns the flags for the map tool.

Note
added in QGIS 2.16

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

Definition at line 72 of file qgsmaptool.h.

§ keyPressEvent()

void QgsMapTool::keyPressEvent ( QKeyEvent *  e)
virtual

Key event for overriding. Default implementation does nothing.

Reimplemented in QgsMapToolCapture, and QgsMapToolIdentifyFeature.

Definition at line 169 of file qgsmaptool.cpp.

§ keyReleaseEvent()

void QgsMapTool::keyReleaseEvent ( QKeyEvent *  e)
virtual

Key event for overriding. Default implementation does nothing.

Definition at line 174 of file qgsmaptool.cpp.

§ messageDiscarded

void QgsMapTool::messageDiscarded ( )
signal

emit signal to clear previous message

§ messageEmitted

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

emit a message

§ searchRadiusMM()

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 192 of file qgsmaptool.cpp.

§ searchRadiusMU() [1/2]

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 204 of file qgsmaptool.cpp.

§ searchRadiusMU() [2/2]

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 209 of file qgsmaptool.cpp.

§ setAction()

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 108 of file qgsmaptool.cpp.

§ setButton()

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 128 of file qgsmaptool.cpp.

§ setCursor()

void QgsMapTool::setCursor ( const QCursor &  cursor)
virtual

Set a user defined cursor.

Definition at line 138 of file qgsmaptool.cpp.

§ toCanvasCoordinates()

QPoint QgsMapTool::toCanvasCoordinates ( const QgsPoint point)
protected

transformation from map coordinates to screen coordinates

Definition at line 74 of file qgsmaptool.cpp.

§ toLayerCoordinates() [1/3]

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

transformation from screen coordinates to layer's coordinates

Definition at line 53 of file qgsmaptool.cpp.

§ toLayerCoordinates() [2/3]

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

transformation from map coordinates to layer's coordinates

Definition at line 59 of file qgsmaptool.cpp.

§ toLayerCoordinates() [3/3]

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

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

Definition at line 69 of file qgsmaptool.cpp.

§ toMapCoordinates() [1/3]

QgsPoint QgsMapTool::toMapCoordinates ( QPoint  point)
protected

transformation from screen coordinates to map coordinates

Definition at line 41 of file qgsmaptool.cpp.

§ toMapCoordinates() [2/3]

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 64 of file qgsmaptool.cpp.

§ toMapCoordinates() [3/3]

QgsPointV2 QgsMapTool::toMapCoordinates ( QgsMapLayer layer,
const QgsPointV2 point 
)
protected

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

Note
available in python bindings as toMapCoordinatesV2

Definition at line 46 of file qgsmaptool.cpp.

§ toolName()

QString QgsMapTool::toolName ( )
inline

Emit map tool changed with the old tool.

Note
added in 2.3

Definition at line 133 of file qgsmaptool.h.

§ wheelEvent()

void QgsMapTool::wheelEvent ( QWheelEvent *  e)
virtual

Mouse wheel event for overriding. Default implementation does nothing.

Definition at line 164 of file qgsmaptool.cpp.

Member Data Documentation

§ mAction

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 203 of file qgsmaptool.h.

§ mButton

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 207 of file qgsmaptool.h.

§ mCanvas

QgsMapCanvas* QgsMapTool::mCanvas
protected

pointer to map canvas

Definition at line 196 of file qgsmaptool.h.

§ mCursor

QCursor QgsMapTool::mCursor
protected

cursor used in map tool

Definition at line 199 of file qgsmaptool.h.

§ mToolName

QString QgsMapTool::mToolName
protected

translated name of the map tool

Definition at line 210 of file qgsmaptool.h.


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