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

	~QgsMapToolZoom () override

void	canvasMoveEvent (QgsMapMouseEvent *e) override
	Mouse move event for overriding. Default implementation does nothing. More...

void	canvasPressEvent (QgsMapMouseEvent *e) override
	Mouse press event for overriding. Default implementation does nothing. More...

void	canvasReleaseEvent (QgsMapMouseEvent *e) override
	Mouse release event for overriding. Default implementation does nothing. More...

void	deactivate () override
	called when map tool is being deactivated More...

Flags	flags () const override
	Returns the flags for the map tool. More...

Public Member Functions inherited from QgsMapTool
	~QgsMapTool () override

QAction *	action ()
	Returns associated action with map tool or NULL if no action is associated. More...

virtual void	activate ()
	called when set as currently active map tool More...

QAbstractButton *	button ()
	Returns associated button with map tool or NULL if no button is associated. More...

QgsMapCanvas *	canvas ()
	returns pointer to the tool's map canvas More...

virtual void	canvasDoubleClickEvent (QgsMapMouseEvent *e)
	Mouse double-click event for overriding. Default implementation does nothing. More...

virtual void	clean ()
	convenient method to clean members More...

virtual bool	gestureEvent (QGestureEvent *e)
	gesture event for overriding. Default implementation does nothing. More...

virtual void	keyPressEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing. More...

virtual void	keyReleaseEvent (QKeyEvent *e)
	Key event for overriding. Default implementation does nothing. More...

void	setAction (QAction *action)
	Use this to associate a QAction to this maptool. More...

void	setButton (QAbstractButton *button)
	Use this to associate a button to this maptool. More...

virtual void	setCursor (const QCursor &cursor)
	Sets a user defined cursor. More...

QString	toolName ()
	Emit map tool changed with the old tool. More...

virtual void	wheelEvent (QWheelEvent *e)
	Mouse wheel event for overriding. Default implementation does nothing. More...

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

QgsRubberBand *	mRubberBand = nullptr

bool	mZoomOut
	indicates whether we're zooming in or out More...

QRect	mZoomRect
	stores actual zoom rect More...

Protected Attributes inherited from QgsMapTool
QAction *	mAction = nullptr
	optionally map tool can have pointer to action which will be used to set that action as active More...

QAbstractButton *	mButton = nullptr
	optionally map tool can have pointer to a button which will be used to set that action as active More...

QgsMapCanvas *	mCanvas = nullptr
	pointer to map canvas More...

QCursor	mCursor
	cursor used in map tool More...

QString	mToolName
	translated name of the map tool More...

Additional Inherited Members
Public Types inherited from QgsMapTool
enum	Flag { Transient = 1 << 1, EditTool = 1 << 2, AllowZoomRect = 1 << 3 }
	Enumeration of flags that adjust the way the map tool operates. More...

Signals inherited from QgsMapTool
void	activated ()
	signal emitted once the map tool is activated More...

void	deactivated ()
	signal emitted once the map tool is deactivated More...

void	messageDiscarded ()
	emit signal to clear previous message More...

void	messageEmitted (const QString &message, Qgis::MessageLevel=Qgis::Info)
	emit a message More...

Static Public Member Functions inherited from QgsMapTool
static double	searchRadiusMM ()
	Gets search radius in mm. More...

static double	searchRadiusMU (const QgsRenderContext &context)
	Gets search radius in map units for given context. More...

static double	searchRadiusMU (QgsMapCanvas *canvas)
	Gets 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...

QPoint	toCanvasCoordinates (const QgsPointXY &point)
	transformation from map coordinates to screen coordinates More...

QgsPointXY	toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
	transformation from screen coordinates to layer's coordinates More...

QgsPointXY	toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
	transformation from map coordinates to layer's coordinates More...

QgsRectangle	toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect)
	trnasformation of the rect from map coordinates to layer's coordinates More...

QgsPointXY	toMapCoordinates (QPoint point)
	transformation from screen coordinates to map coordinates More...

QgsPointXY	toMapCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...

QgsPoint	toMapCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
	transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) More...

Detailed Description

A map tool for zooming into the map.

See also: QgsMapTool

Definition at line 30 of file qgsmaptoolzoom.h.

Constructor & Destructor Documentation

◆ QgsMapToolZoom()

QgsMapToolZoom::QgsMapToolZoom	(	QgsMapCanvas *	canvas,
		bool	zoomOut
	)

constructor

Definition at line 29 of file qgsmaptoolzoom.cpp.

◆ ~QgsMapToolZoom()

QgsMapToolZoom::~QgsMapToolZoom ( )

override

Definition at line 41 of file qgsmaptoolzoom.cpp.

Member Function Documentation

◆ canvasMoveEvent()

void QgsMapToolZoom::canvasMoveEvent ( QgsMapMouseEvent * e )

overridevirtual

Mouse move event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 47 of file qgsmaptoolzoom.cpp.

◆ canvasPressEvent()

void QgsMapToolZoom::canvasPressEvent ( QgsMapMouseEvent * e )

overridevirtual

Mouse press event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 71 of file qgsmaptoolzoom.cpp.

◆ canvasReleaseEvent()

void QgsMapToolZoom::canvasReleaseEvent ( QgsMapMouseEvent * e )

overridevirtual

Mouse release event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 80 of file qgsmaptoolzoom.cpp.

◆ deactivate()

void QgsMapToolZoom::deactivate ( )

overridevirtual

called when map tool is being deactivated

Reimplemented from QgsMapTool.

Definition at line 134 of file qgsmaptoolzoom.cpp.

◆ flags()

Flags QgsMapToolZoom::flags ( ) const

inlineoverridevirtual

Returns the flags for the map tool.

Since: QGIS 2.16

Reimplemented from QgsMapTool.

Definition at line 39 of file qgsmaptoolzoom.h.

Member Data Documentation

◆ mDragging

bool QgsMapToolZoom::mDragging

protected

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

Definition at line 53 of file qgsmaptoolzoom.h.

◆ mRubberBand

QgsRubberBand* QgsMapToolZoom::mRubberBand = nullptr

protected

Definition at line 55 of file qgsmaptoolzoom.h.

◆ mZoomOut

bool QgsMapToolZoom::mZoomOut

protected

indicates whether we're zooming in or out

Definition at line 50 of file qgsmaptoolzoom.h.

◆ mZoomRect

QRect QgsMapToolZoom::mZoomRect

protected

stores actual zoom rect

Definition at line 47 of file qgsmaptoolzoom.h.

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

/tmp/buildd/qgis-3.2.0+99unstable/src/gui/qgsmaptoolzoom.h
/tmp/buildd/qgis-3.2.0+99unstable/src/gui/qgsmaptoolzoom.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsMapToolZoom()

◆ ~QgsMapToolZoom()

Member Function Documentation

◆ canvasMoveEvent()

◆ canvasPressEvent()

◆ canvasReleaseEvent()

◆ deactivate()

◆ flags()

Member Data Documentation

◆ mDragging

◆ mRubberBand

◆ mZoomOut

◆ mZoomRect