QgsPlotToolPan Class Reference

Plot tool for panning/zoom/navigating plots. More...

#include <qgsplottoolpan.h>

Inheritance diagram for QgsPlotToolPan:

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

Additional Inherited Members
Signals inherited from QgsPlotTool
void	activated ()
	Emitted when the tool is activated.
void	deactivated ()
	Emitted when the tool is deactivated.
Protected Member Functions inherited from QgsPlotTool
	QgsPlotTool (QgsPlotCanvas *canvas, const QString &name)
	Constructor takes a plot canvas as a parameter.
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".
QgsPointXY	toCanvasCoordinates (const QgsPoint &point) const
	Converts a point in map coordinates to the associated canvas point.
QgsPoint	toMapCoordinates (const QgsPointXY &point) const
	Converts a point on the canvas to the associated map coordinate.
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.
Protected Attributes inherited from QgsPlotTool
QPointer< QAction >	mAction
	Optional action associated with tool.
QgsPlotCanvas *	mCanvas = nullptr
	The pointer to the canvas.
QCursor	mCursor = Qt::ArrowCursor
	Cursor used by tool.
QString	mToolName
	Translated name of the map tool.

Detailed Description

Plot tool for panning/zoom/navigating plots.

Since

QGIS 3.26

Definition at line 32 of file qgsplottoolpan.h.

Constructor & Destructor Documentation

QgsPlotToolPan()

QgsPlotToolPan::QgsPlotToolPan

(

QgsPlotCanvas *

canvas

)

Constructor for QgsPlotToolPan, with the associated canvas.

Definition at line 23 of file qgsplottoolpan.cpp.

Member Function Documentation

deactivate()

void QgsPlotToolPan::deactivate ( )

overridevirtual

Called when the tool is being deactivated.

Reimplemented from QgsPlotTool.

Definition at line 82 of file qgsplottoolpan.cpp.

flags()

Qgis::PlotToolFlags QgsPlotToolPan::flags ( ) const

overridevirtual

Returns the flags for the plot tool.

Reimplemented from QgsPlotTool.

Definition at line 29 of file qgsplottoolpan.cpp.

plotMoveEvent()

void QgsPlotToolPan::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 34 of file qgsplottoolpan.cpp.

plotPressEvent()

void QgsPlotToolPan::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 46 of file qgsplottoolpan.cpp.

plotReleaseEvent()

void QgsPlotToolPan::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.

Definition at line 61 of file qgsplottoolpan.cpp.

---

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

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/plot/qgsplottoolpan.h
• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/plot/qgsplottoolpan.cpp