QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
QgsMapToolTouch Class Reference

A map tool for panning the map. More...

#include <qgsmaptooltouch.h>

Inheritance diagram for QgsMapToolTouch:
Inheritance graph
[legend]
Collaboration diagram for QgsMapToolTouch:
Collaboration graph
[legend]

Public Member Functions

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

Private Member Functions

void pinchTriggered (QPinchGesture *gesture)
 

Private Attributes

bool mDragging
 Flag to indicate a map canvas drag operation is taking place. More...
 
bool mPinching
 Flag to indicate a pinch gesture is taking place. More...
 

Additional Inherited Members

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

Detailed Description

A map tool for panning the map.

See also
QgsMapTool

Definition at line 30 of file qgsmaptooltouch.h.

Constructor & Destructor Documentation

QgsMapToolTouch::QgsMapToolTouch ( QgsMapCanvas canvas)

constructor

Definition at line 26 of file qgsmaptooltouch.cpp.

QgsMapToolTouch::~QgsMapToolTouch ( )

Definition at line 35 of file qgsmaptooltouch.cpp.

References QgsMapTool::mCanvas.

Member Function Documentation

void QgsMapToolTouch::activate ( )
virtual

called when set as currently active map tool

Reimplemented from QgsMapTool.

Definition at line 40 of file qgsmaptooltouch.cpp.

References QgsMapTool::activate(), and QgsMapTool::mCanvas.

void QgsMapToolTouch::canvasDoubleClickEvent ( QMouseEvent *  e)
virtual

Overridden Mouse double click event.

Reimplemented from QgsMapTool.

Definition at line 87 of file qgsmaptooltouch.cpp.

References QgsMapTool::mCanvas, mPinching, and QgsMapCanvas::zoomWithCenter().

void QgsMapToolTouch::canvasMoveEvent ( QMouseEvent *  e)
virtual

Overridden mouse move event.

Reimplemented from QgsMapTool.

Definition at line 52 of file qgsmaptooltouch.cpp.

References QgsMapTool::mCanvas, mDragging, mPinching, and QgsMapCanvas::panAction().

void QgsMapToolTouch::canvasReleaseEvent ( QMouseEvent *  e)
virtual
void QgsMapToolTouch::deactivate ( )
virtual

called when map tool is being deactivated

Reimplemented from QgsMapTool.

Definition at line 46 of file qgsmaptooltouch.cpp.

References QgsMapTool::deactivate(), and QgsMapTool::mCanvas.

bool QgsMapToolTouch::gestureEvent ( QGestureEvent *  event)

Definition at line 95 of file qgsmaptooltouch.cpp.

References mPinching, and pinchTriggered().

virtual bool QgsMapToolTouch::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.

Definition at line 50 of file qgsmaptooltouch.h.

void QgsMapToolTouch::pinchTriggered ( QPinchGesture *  gesture)
private

Member Data Documentation

bool QgsMapToolTouch::mDragging
private

Flag to indicate a map canvas drag operation is taking place.

Definition at line 57 of file qgsmaptooltouch.h.

Referenced by canvasMoveEvent(), and canvasReleaseEvent().

bool QgsMapToolTouch::mPinching
private

Flag to indicate a pinch gesture is taking place.

Definition at line 59 of file qgsmaptooltouch.h.

Referenced by canvasDoubleClickEvent(), canvasMoveEvent(), canvasReleaseEvent(), gestureEvent(), and pinchTriggered().


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