QGIS API Documentation  3.27.0-Master (11ef3e5184)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsPlotToolZoom Class Reference

Plot tool for zooming into and out of the plot. More...

#include <qgsplottoolzoom.h>

Inheritance diagram for QgsPlotToolZoom:
Inheritance graph
[legend]

Public Member Functions

 QgsPlotToolZoom (QgsPlotCanvas *canvas)
 Constructor for QgsPlotToolZoom, with the associated canvas. More...
 
 ~QgsPlotToolZoom () override
 
void deactivate () override
 Called when the tool is being deactivated. More...
 
void keyPressEvent (QKeyEvent *event) override
 Key press event for overriding. More...
 
void keyReleaseEvent (QKeyEvent *event) override
 Key release event for overriding. More...
 
void plotMoveEvent (QgsPlotMouseEvent *event) override
 Mouse move event for overriding. More...
 
void plotPressEvent (QgsPlotMouseEvent *event) override
 Mouse press event for overriding. More...
 
void plotReleaseEvent (QgsPlotMouseEvent *event) override
 Mouse release event for overriding. More...
 
- Public Member Functions inherited from QgsPlotTool
 ~QgsPlotTool () override
 
QAction * action ()
 Returns the action associated with the tool or nullptr if no action is associated. More...
 
virtual void activate ()
 Called when the tool is set as the currently active plot tool. More...
 
QgsPlotCanvascanvas () const
 Returns the tool's plot canvas. More...
 
virtual bool canvasToolTipEvent (QHelpEvent *event)
 Tooltip event for overriding. More...
 
virtual Qgis::PlotToolFlags flags () const
 Returns the flags for the plot tool. More...
 
virtual bool gestureEvent (QGestureEvent *event)
 Gesture event for overriding. More...
 
bool isActive () const
 Returns true if this tool is the current tool active on the plot canvas. More...
 
virtual void plotDoubleClickEvent (QgsPlotMouseEvent *event)
 Mouse double-click event for overriding. More...
 
virtual bool populateContextMenuWithEvent (QMenu *menu, QgsPlotMouseEvent *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)
 Associates an action with this tool. More...
 
void setCursor (const QCursor &cursor)
 Sets a user defined cursor for use when the tool is active. More...
 
QString toolName () const
 Returns a user-visible, translated name for the tool. More...
 
virtual void wheelEvent (QWheelEvent *event)
 Mouse wheel event for overriding. More...
 

Protected Member Functions

virtual QRectF constrainBounds (const QRectF &sceneBounds) const
 Applies constraints to the overall bounds of the rubber band. More...
 
virtual QPointF constrainMovePoint (QPointF scenePoint) const
 Applies constraints to a move point of the zoom rubber band. More...
 
virtual QPointF constrainStartPoint (QPointF scenePoint) const
 Applies constraints to the start point of the zoom rubber band. More...
 
virtual void zoomInClickOn (QPointF scenePoint)
 Handles a zoom out click on the given point. More...
 
virtual void zoomOutClickOn (QPointF scenePoint)
 Handles a zoom out click on the given point. More...
 
- Protected Member Functions inherited from QgsPlotTool
 QgsPlotTool (QgsPlotCanvas *canvas, const QString &name)
 Constructor takes a plot canvas as a parameter. More...
 
bool isClickAndDrag (QPoint startViewPoint, QPoint endViewPoint) const
 Returns true if a mouse press/release operation which started at startViewPoint and ended at endViewPoint should be considered a "click and drag". More...
 
QgsPointXY toCanvasCoordinates (const QgsPoint &point) const
 Converts a point in map coordinates to the associated canvas point. More...
 
QgsPoint toMapCoordinates (const QgsPointXY &point) const
 Converts a point on the canvas to the associated map coordinate. More...
 

Protected Attributes

bool mMarqueeZoom = false
 Will be true will marquee zoom operation is in progress. More...
 
- Protected Attributes inherited from QgsPlotTool
QPointer< QAction > mAction
 Optional action associated with tool. More...
 
QgsPlotCanvasmCanvas = nullptr
 The pointer to the canvas. More...
 
QCursor mCursor = Qt::ArrowCursor
 Cursor used by tool. More...
 
QString mToolName
 Translated name of the map tool. More...
 

Additional Inherited Members

- Signals inherited from QgsPlotTool
void activated ()
 Emitted when the tool is activated. More...
 
void deactivated ()
 Emitted when the tool is deactivated. More...
 
- Static Protected Member Functions inherited from QgsPlotTool
static QPointF constrainPointToRect (QPointF point, const QRectF &rect)
 Constrains a point to force it to fall within the specified rectangle. More...
 

Detailed Description

Plot tool for zooming into and out of the plot.

Since
QGIS 3.26

Definition at line 34 of file qgsplottoolzoom.h.

Constructor & Destructor Documentation

◆ QgsPlotToolZoom()

QgsPlotToolZoom::QgsPlotToolZoom ( QgsPlotCanvas canvas)

Constructor for QgsPlotToolZoom, with the associated canvas.

Definition at line 24 of file qgsplottoolzoom.cpp.

◆ ~QgsPlotToolZoom()

QgsPlotToolZoom::~QgsPlotToolZoom ( )
overridedefault

Member Function Documentation

◆ constrainBounds()

QRectF QgsPlotToolZoom::constrainBounds ( const QRectF &  sceneBounds) const
protectedvirtual

Applies constraints to the overall bounds of the rubber band.

Note
Not available in Python bindings

Reimplemented in QgsPlotToolXAxisZoom.

Definition at line 140 of file qgsplottoolzoom.cpp.

◆ constrainMovePoint()

QPointF QgsPlotToolZoom::constrainMovePoint ( QPointF  scenePoint) const
protectedvirtual

Applies constraints to a move point of the zoom rubber band.

Note
Not available in Python bindings

Reimplemented in QgsPlotToolXAxisZoom.

Definition at line 135 of file qgsplottoolzoom.cpp.

◆ constrainStartPoint()

QPointF QgsPlotToolZoom::constrainStartPoint ( QPointF  scenePoint) const
protectedvirtual

Applies constraints to the start point of the zoom rubber band.

Note
Not available in Python bindings

Reimplemented in QgsPlotToolXAxisZoom.

Definition at line 130 of file qgsplottoolzoom.cpp.

◆ deactivate()

void QgsPlotToolZoom::deactivate ( )
overridevirtual

Called when the tool is being deactivated.

Reimplemented from QgsPlotTool.

Definition at line 120 of file qgsplottoolzoom.cpp.

◆ keyPressEvent()

void QgsPlotToolZoom::keyPressEvent ( QKeyEvent *  event)
overridevirtual

Key press event for overriding.

The default implementation does nothing. When subclasses implement this method and have acted on the event, they must explicitly call event->accept() to prevent the event from being passed on to other widgets.

Reimplemented from QgsPlotTool.

Reimplemented in QgsPlotToolTemporaryKeyZoom.

Definition at line 94 of file qgsplottoolzoom.cpp.

◆ keyReleaseEvent()

void QgsPlotToolZoom::keyReleaseEvent ( QKeyEvent *  event)
overridevirtual

Key release event for overriding.

The default implementation does nothing. When subclasses implement this method and have acted on the event, they must explicitly call event->accept() to prevent the event from being passed on to other widgets.

Reimplemented from QgsPlotTool.

Reimplemented in QgsPlotToolTemporaryKeyZoom.

Definition at line 107 of file qgsplottoolzoom.cpp.

◆ plotMoveEvent()

void QgsPlotToolZoom::plotMoveEvent ( QgsPlotMouseEvent event)
overridevirtual

Mouse move event for overriding.

The default implementation does nothing. When subclasses implement this method and have acted on the event, they must explicitly call event->accept() to prevent the event from being passed on to other widgets.

Reimplemented from QgsPlotTool.

Definition at line 60 of file qgsplottoolzoom.cpp.

◆ plotPressEvent()

void QgsPlotToolZoom::plotPressEvent ( QgsPlotMouseEvent event)
overridevirtual

Mouse press event for overriding.

The default implementation does nothing. When subclasses implement this method and have acted on the event, they must explicitly call event->accept() to prevent the event from being passed on to other widgets.

Reimplemented from QgsPlotTool.

Definition at line 35 of file qgsplottoolzoom.cpp.

◆ plotReleaseEvent()

void QgsPlotToolZoom::plotReleaseEvent ( QgsPlotMouseEvent event)
overridevirtual

Mouse release event for overriding.

The default implementation does nothing. When subclasses implement this method and have acted on the event, they must explicitly call event->accept() to prevent the event from being passed on to other widgets.

Reimplemented from QgsPlotTool.

Reimplemented in QgsPlotToolTemporaryKeyZoom.

Definition at line 71 of file qgsplottoolzoom.cpp.

◆ zoomInClickOn()

void QgsPlotToolZoom::zoomInClickOn ( QPointF  scenePoint)
protectedvirtual

Handles a zoom out click on the given point.

Note
Not available in Python bindings

Reimplemented in QgsPlotToolXAxisZoom.

Definition at line 152 of file qgsplottoolzoom.cpp.

◆ zoomOutClickOn()

void QgsPlotToolZoom::zoomOutClickOn ( QPointF  scenePoint)
protectedvirtual

Handles a zoom out click on the given point.

Note
Not available in Python bindings

Reimplemented in QgsPlotToolXAxisZoom.

Definition at line 145 of file qgsplottoolzoom.cpp.

Member Data Documentation

◆ mMarqueeZoom

bool QgsPlotToolZoom::mMarqueeZoom = false
protected

Will be true will marquee zoom operation is in progress.

Definition at line 92 of file qgsplottoolzoom.h.


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