QgsMapToolZoom Class Reference

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

#include <qgsmaptoolzoom.h>

Inheritance diagram for QgsMapToolZoom:

Public Member Functions
	QgsMapToolZoom (QgsMapCanvas *canvas, bool zoomOut)
	constructor
	~QgsMapToolZoom ()
virtual void	canvasMoveEvent (QMouseEvent *e) override
	Overridden mouse move event.
virtual void	canvasPressEvent (QMouseEvent *e) override
	Overridden mouse press event.
virtual void	canvasReleaseEvent (QMouseEvent *e) override
	Overridden mouse release event.
virtual void	deactivate () override
	Flag to indicate a map canvas drag operation is taking place.
virtual bool	isTransient () override
	indicates whether we're zooming in or out
Public Member Functions inherited from QgsMapTool
virtual	~QgsMapTool ()
	virtual destructor
QAction *	action ()
	Return associated action with map tool or NULL if no action is associated.
virtual void	activate ()
	called when set as currently active map tool
QAbstractButton *	button ()
	Return associated button with map tool or NULL if no button is associated.
QgsMapCanvas *	canvas ()
	returns pointer to the tool's map canvas
virtual void	canvasDoubleClickEvent (QMouseEvent *e)
	Mouse double click event for overriding. Default implementation does nothing.
virtual bool	isEditTool ()
	Check whether this MapTool performs an edit operation.
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.
void	setButton (QAbstractButton *button)
	Use this to associate a button to this maptool.
virtual void	setCursor (QCursor cursor)
	Set a user defined cursor.
QString	toolName ()
	Emit map tool changed with the old tool.
virtual void	wheelEvent (QWheelEvent *e)
	Mouse wheel event for overriding. Default implementation does nothing.

Protected Attributes
bool	mDragging
	Flag to indicate a map canvas drag operation is taking place.
QgsRubberBand *	mRubberBand
bool	mZoomOut
	indicates whether we're zooming in or out
QRect	mZoomRect
	stores actual zoom rect
Protected Attributes inherited from QgsMapTool
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
QgsMapCanvas *	mCanvas
	pointer to map canvas
QCursor	mCursor
	cursor used in map tool
QString	mToolName
	translated name of the map tool

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

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 30 of file qgsmaptoolzoom.cpp.

QgsMapToolZoom::~QgsMapToolZoom

(

)

Definition at line 42 of file qgsmaptoolzoom.cpp.

Member Function Documentation

void QgsMapToolZoom::canvasMoveEvent ( QMouseEvent *  e )

overridevirtual

Overridden mouse move event.

Reimplemented from QgsMapTool.

Definition at line 48 of file qgsmaptoolzoom.cpp.

void QgsMapToolZoom::canvasPressEvent ( QMouseEvent *  e )

overridevirtual

Overridden mouse press event.

Reimplemented from QgsMapTool.

Definition at line 72 of file qgsmaptoolzoom.cpp.

void QgsMapToolZoom::canvasReleaseEvent ( QMouseEvent *  e )

overridevirtual

Overridden mouse release event.

Reimplemented from QgsMapTool.

Definition at line 81 of file qgsmaptoolzoom.cpp.

void QgsMapToolZoom::deactivate ( )

overridevirtual

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

Reimplemented from QgsMapTool.

Definition at line 129 of file qgsmaptoolzoom.cpp.

virtual bool QgsMapToolZoom::isTransient ( )

inlineoverridevirtual

indicates whether we're zooming in or out

Reimplemented from QgsMapTool.

Definition at line 46 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 59 of file qgsmaptoolzoom.h.

QgsRubberBand* QgsMapToolZoom::mRubberBand

protected

Definition at line 61 of file qgsmaptoolzoom.h.

bool QgsMapToolZoom::mZoomOut

protected

indicates whether we're zooming in or out

Definition at line 56 of file qgsmaptoolzoom.h.

QRect QgsMapToolZoom::mZoomRect

protected

stores actual zoom rect

Definition at line 53 of file qgsmaptoolzoom.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgsmaptoolzoom.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgsmaptoolzoom.cpp