QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
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]

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...
 
void keyPressEvent (QKeyEvent *e) override
 Key event for overriding. Default implementation does nothing. More...
 
void keyReleaseEvent (QKeyEvent *e) override
 Key event for overriding. Default implementation does nothing. More...
 
- Public Member Functions inherited from QgsMapTool
 ~QgsMapTool () override
 
QAction * action ()
 Returns associated action with map tool or nullptr 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 nullptr if no button is associated. More...
 
QgsMapCanvascanvas () const
 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 canvasMoveEvent (QgsMapMouseEvent *e)
 Mouse move event for overriding. Default implementation does nothing. More...
 
virtual void canvasPressEvent (QgsMapMouseEvent *e)
 Mouse press event for overriding. Default implementation does nothing. More...
 
virtual void canvasReleaseEvent (QgsMapMouseEvent *e)
 Mouse release event for overriding. Default implementation does nothing. More...
 
virtual bool canvasToolTipEvent (QHelpEvent *e)
 Tooltip event for overriding. More...
 
virtual void clean ()
 convenient method to clean members More...
 
virtual void deactivate ()
 called when map tool is being deactivated More...
 
virtual Flags flags () const
 Returns the flags for the map tool. More...
 
virtual bool gestureEvent (QGestureEvent *e)
 gesture event for overriding. Default implementation does nothing. More...
 
bool isActive () const
 Returns if the current map tool active on the map canvas. 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...
 
virtual void populateContextMenu (QMenu *menu)
 Allows the tool to populate and customize the given menu, prior to showing it in response to a right-mouse button click. More...
 
virtual bool populateContextMenuWithEvent (QMenu *menu, QgsMapMouseEvent *event)
 Allows the tool to populate and customize the given menu, prior to showing it in response to a right-mouse button click. 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...
 
QgsPointXY toMapCoordinates (QPoint point)
 Transforms a point from screen coordinates to map coordinates. 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...
 
int mMinPixelZoom = 20
 
bool mNativeZoomOut
 native tool More...
 
QgsRubberBandmRubberBand = nullptr
 
QCursor mZoomInCursor
 
bool mZoomOut
 indicates whether we're zooming in or out More...
 
QCursor mZoomOutCursor
 
QRect mZoomRect
 stores actual zoom rect More...
 
- Protected Attributes inherited from QgsMapTool
QAction * mAction = nullptr
 Optional pointer to an action that will be checked on map tool activation and unchecked on map tool deactivation. More...
 
QAbstractButton * mButton = nullptr
 Optional pointer to a button that will be checked on map tool activation and unchecked on map tool deactivation. More...
 
QPointer< QgsMapCanvasmCanvas
 The pointer to the map canvas. More...
 
QCursor mCursor
 The cursor used in the map tool. More...
 
QString mToolName
 The 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 , ShowContextMenu = 1 << 4 }
 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::MessageLevel::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 a map canvas as a parameter. More...
 
QgsMapLayerlayer (const QString &id)
 Returns the map layer with the matching ID, or nullptr if no layers could be found. More...
 
void setToolName (const QString &name)
 Sets the tool's name. More...
 
QPoint toCanvasCoordinates (const QgsPointXY &point) const
 Transforms a point from map coordinates to screen coordinates. More...
 
QgsPoint toLayerCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
 Transforms a point from map coordinates to layer coordinates. More...
 
QgsPointXY toLayerCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
 Transforms a point from map coordinates to layer coordinates. More...
 
QgsRectangle toLayerCoordinates (const QgsMapLayer *layer, const QgsRectangle &rect)
 Transforms a rect from map coordinates to layer coordinates. More...
 
QgsPointXY toLayerCoordinates (const QgsMapLayer *layer, QPoint point)
 Transforms a point from screen coordinates to layer coordinates. More...
 
QgsPoint toMapCoordinates (const QgsMapLayer *layer, const QgsPoint &point)
 Transforms a point from layer coordinates to map coordinates (which is different in case reprojection is used). More...
 
QgsPointXY toMapCoordinates (const QgsMapLayer *layer, const QgsPointXY &point)
 Transforms a point from layer 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 32 of file qgsmaptoolzoom.cpp.

◆ ~QgsMapToolZoom()

QgsMapToolZoom::~QgsMapToolZoom ( )
override

Definition at line 45 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 55 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 82 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 91 of file qgsmaptoolzoom.cpp.

◆ deactivate()

void QgsMapToolZoom::deactivate ( )
overridevirtual

called when map tool is being deactivated

Reimplemented from QgsMapTool.

Definition at line 141 of file qgsmaptoolzoom.cpp.

◆ flags()

QgsMapTool::Flags QgsMapToolZoom::flags ( ) const
overridevirtual

Returns the flags for the map tool.

Since
QGIS 2.16

Reimplemented from QgsMapTool.

Definition at line 50 of file qgsmaptoolzoom.cpp.

◆ keyPressEvent()

void QgsMapToolZoom::keyPressEvent ( QKeyEvent *  e)
overridevirtual

Key event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 158 of file qgsmaptoolzoom.cpp.

◆ keyReleaseEvent()

void QgsMapToolZoom::keyReleaseEvent ( QKeyEvent *  e)
overridevirtual

Key event for overriding. Default implementation does nothing.

Reimplemented from QgsMapTool.

Definition at line 166 of file qgsmaptoolzoom.cpp.

Member Data Documentation

◆ mDragging

bool QgsMapToolZoom::mDragging
protected

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

Definition at line 59 of file qgsmaptoolzoom.h.

◆ mMinPixelZoom

int QgsMapToolZoom::mMinPixelZoom = 20
protected

Definition at line 51 of file qgsmaptoolzoom.h.

◆ mNativeZoomOut

bool QgsMapToolZoom::mNativeZoomOut
protected

native tool

Definition at line 56 of file qgsmaptoolzoom.h.

◆ mRubberBand

QgsRubberBand* QgsMapToolZoom::mRubberBand = nullptr
protected

Definition at line 61 of file qgsmaptoolzoom.h.

◆ mZoomInCursor

QCursor QgsMapToolZoom::mZoomInCursor
protected

Definition at line 64 of file qgsmaptoolzoom.h.

◆ mZoomOut

bool QgsMapToolZoom::mZoomOut
protected

indicates whether we're zooming in or out

Definition at line 54 of file qgsmaptoolzoom.h.

◆ mZoomOutCursor

QCursor QgsMapToolZoom::mZoomOutCursor
protected

Definition at line 63 of file qgsmaptoolzoom.h.

◆ mZoomRect

QRect QgsMapToolZoom::mZoomRect
protected

stores actual zoom rect

Definition at line 49 of file qgsmaptoolzoom.h.


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