QGIS API Documentation  2.4.0-Chugiak
 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 More...
 
 ~QgsMapToolZoom ()
 
virtual void canvasMoveEvent (QMouseEvent *e)
 Overridden mouse move event. More...
 
virtual void canvasPressEvent (QMouseEvent *e)
 Overridden mouse press event. More...
 
virtual void canvasReleaseEvent (QMouseEvent *e)
 Overridden mouse release event. More...
 
virtual bool isTransient ()
 Check whether this MapTool performs a zoom or pan operation. More...
 
virtual void deactivate ()
 called when map tool is being deactivated More...
 
- Public Member Functions inherited from QgsMapTool
virtual ~QgsMapTool ()
 virtual destructor More...
 
virtual void canvasDoubleClickEvent (QMouseEvent *e)
 Mouse double click 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...
 
virtual void activate ()
 called when set as currently active map tool More...
 
QgsMapCanvascanvas ()
 returns pointer to the tool's map canvas More...
 
QString toolName ()
 Emit map tool changed with the old tool. More...
 

Protected Attributes

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

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...
 
- 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...
 

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: