QGIS API Documentation
2.6.0-Brighton
|
Abstract base class for all map tools. More...
#include <qgsmaptool.h>
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 |
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.
|
virtual |
virtual destructor
|
protected |
constructor takes map canvas as a parameter
QAction * QgsMapTool::action | ( | ) |
Return associated action with map tool or NULL if no action is associated.
|
virtual |
called when set as currently active map tool
Reimplemented in QgsMapToolIdentify, and QgsMapToolTouch.
|
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
|
virtual |
Mouse double click event for overriding. Default implementation does nothing.
Reimplemented in QgsMapToolTouch.
|
virtual |
Mouse move event for overriding. Default implementation does nothing.
Reimplemented in QgsMapToolIdentify, QgsMapToolTouch, QgsMapToolEmitPoint, QgsMapToolZoom, and QgsMapToolPan.
|
virtual |
Mouse press event for overriding. Default implementation does nothing.
Reimplemented in QgsMapToolIdentify, QgsMapToolEmitPoint, and QgsMapToolZoom.
|
virtual |
Mouse release event for overriding. Default implementation does nothing.
Reimplemented in QgsMapToolIdentify, QgsMapToolTouch, QgsMapToolEmitPoint, QgsMapToolIdentifyFeature, QgsMapToolZoom, and QgsMapToolPan.
|
virtual |
called when map tool is being deactivated
Reimplemented in QgsMapToolIdentify, QgsMapToolZoom, and QgsMapToolTouch.
|
signal |
signal emitted once the map tool is deactivated
|
virtual |
Check whether this MapTool performs an edit operation.
If it does, we will deactivate it when editing is turned off
|
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.
|
virtual |
Key event for overriding. Default implementation does nothing.
Reimplemented in QgsMapToolIdentifyFeature.
|
virtual |
Key event for overriding. Default implementation does nothing.
|
signal |
emit signal to clear previous message
|
signal |
emit a message
|
virtual |
Called when rendering has finished.
Default implementation does nothing.
|
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.
|
static |
Get search radius in map units for given context.
Used by identify, tip etc. The values is calculated from searchRadiusMM().
|
static |
Get search radius in map units for given canvas.
Used by identify, tip etc. The values is calculated from searchRadiusMM().
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.
|
virtual |
Set a user defined cursor.
|
protected |
transformation from map coordinates to screen coordinates
|
protected |
transformation from screen coordinates to layer's coordinates
|
protected |
transformation from map coordinates to layer's coordinates
|
protected |
trnasformation of the rect from map coordinates to layer's coordinates
|
protected |
transformation from screen coordinates to map coordinates
|
protected |
transformation from layer's coordinates to map coordinates (which is different in case reprojection is used)
|
inline |
Emit map tool changed with the old tool.
|
virtual |
Mouse wheel event for overriding. Default implementation does nothing.
|
protected |
optionally map tool can have pointer to action which will be used to set that action as active
|
protected |
optionally map tool can have pointer to a button which will be used to set that action as active
|
protected |
pointer to map canvas
|
protected |
cursor used in map tool
|
protected |
translated name of the map tool