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

A map tool for zooming into the map. More...

#include <qgsmaptoolzoom.h>

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

Public Member Functions

 QgsMapToolZoom (QgsMapCanvas *canvas, bool zoomOut)
 constructor
 ~QgsMapToolZoom ()
virtual void canvasMoveEvent (QMouseEvent *e)
 Overridden mouse move event.
virtual void canvasPressEvent (QMouseEvent *e)
 Overridden mouse press event.
virtual void canvasReleaseEvent (QMouseEvent *e)
 Overridden mouse release event.
virtual bool isTransient ()
 Check whether this MapTool performs a zoom or pan operation.
virtual void deactivate ()
 called when map tool is being deactivated
- 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 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
QgsMapCanvascanvas ()
 returns pointer to the tool's map canvas

Protected Attributes

QRect mZoomRect
 stores actual zoom rect
bool mZoomOut
 indicates whether we're zooming in or out
bool mDragging
 Flag to indicate a map canvas drag operation is taking place.
QgsRubberBandmRubberBand
- 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

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

Detailed Description

A map tool for zooming into the map.

See Also
QgsMapTool

Definition at line 28 of file qgsmaptoolzoom.h.

Constructor & Destructor Documentation

QgsMapToolZoom::QgsMapToolZoom ( QgsMapCanvas canvas,
bool  zoomOut 
)

constructor

Definition at line 29 of file qgsmaptoolzoom.cpp.

References QgsMapTool::mCursor, zoom_in, and zoom_out.

QgsMapToolZoom::~QgsMapToolZoom ( )

Definition at line 37 of file qgsmaptoolzoom.cpp.

References mRubberBand.

Member Function Documentation

void QgsMapToolZoom::canvasMoveEvent ( QMouseEvent *  e)
virtual

Overridden mouse move event.

Reimplemented from QgsMapTool.

Definition at line 43 of file qgsmaptoolzoom.cpp.

References QgsMapTool::mCanvas, mDragging, mRubberBand, mZoomRect, QGis::Polygon, and QgsRubberBand::setToCanvasRectangle().

void QgsMapToolZoom::canvasPressEvent ( QMouseEvent *  e)
virtual

Overridden mouse press event.

Reimplemented from QgsMapTool.

Definition at line 64 of file qgsmaptoolzoom.cpp.

References mZoomRect.

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

called when map tool is being deactivated

Reimplemented from QgsMapTool.

Definition at line 149 of file qgsmaptoolzoom.cpp.

References mRubberBand.

virtual bool QgsMapToolZoom::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 45 of file qgsmaptoolzoom.h.

Member Data Documentation

bool QgsMapToolZoom::mDragging
protected

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

Definition at line 57 of file qgsmaptoolzoom.h.

Referenced by canvasMoveEvent(), and canvasReleaseEvent().

QgsRubberBand* QgsMapToolZoom::mRubberBand
protected

Definition at line 59 of file qgsmaptoolzoom.h.

Referenced by canvasMoveEvent(), canvasReleaseEvent(), deactivate(), and ~QgsMapToolZoom().

bool QgsMapToolZoom::mZoomOut
protected

indicates whether we're zooming in or out

Definition at line 54 of file qgsmaptoolzoom.h.

Referenced by canvasReleaseEvent().

QRect QgsMapToolZoom::mZoomRect
protected

stores actual zoom rect

Definition at line 51 of file qgsmaptoolzoom.h.

Referenced by canvasMoveEvent(), canvasPressEvent(), and canvasReleaseEvent().


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