QGIS API Documentation  2.2.0-Valmiera
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
QgsMapToolPan Class Reference

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

#include <qgsmaptoolpan.h>

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

Public Member Functions

 QgsMapToolPan (QgsMapCanvas *canvas)
 constructor
virtual void canvasMoveEvent (QMouseEvent *e)
 Overridden mouse move event.
virtual void canvasReleaseEvent (QMouseEvent *e)
 Overridden mouse release event.
virtual bool isTransient ()
 Check whether this MapTool performs a zoom or pan operation.
- Public Member Functions inherited from QgsMapTool
virtual ~QgsMapTool ()
 virtual destructor
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 wheelEvent (QWheelEvent *e)
 Mouse wheel event for overriding.
virtual void keyPressEvent (QKeyEvent *e)
 Key event for overriding. Default implementation does nothing.
virtual void keyReleaseEvent (QKeyEvent *e)
 Key event for overriding.
virtual void renderComplete ()
 Called when rendering has finished. Default implementation does nothing.
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 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
QgsMapCanvascanvas ()
 returns pointer to the tool's map canvas

Private Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from QgsMapTool
 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 inherited from QgsMapTool
QgsMapCanvasmCanvas
 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

Detailed Description

A map tool for panning the map.

See Also
QgsMapTool

Definition at line 27 of file qgsmaptoolpan.h.

Constructor & Destructor Documentation

QgsMapToolPan::QgsMapToolPan ( QgsMapCanvas canvas)

constructor

Definition at line 25 of file qgsmaptoolpan.cpp.

References QgsMapTool::mCursor, pan_bits, and pan_mask_bits.

Member Function Documentation

void QgsMapToolPan::canvasMoveEvent ( QMouseEvent *  e)
virtual

Overridden mouse move event.

Reimplemented from QgsMapTool.

Definition at line 35 of file qgsmaptoolpan.cpp.

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

void QgsMapToolPan::canvasReleaseEvent ( QMouseEvent *  e)
virtual
virtual bool QgsMapToolPan::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 39 of file qgsmaptoolpan.h.

Member Data Documentation

bool QgsMapToolPan::mDragging
private

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

Definition at line 44 of file qgsmaptoolpan.h.

Referenced by canvasMoveEvent(), and canvasReleaseEvent().


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