Plot tool for temporarily panning a plot while a key is depressed. More...
#include <qgsplottransienttools.h>
Public Member Functions | |
| QgsPlotToolTemporaryKeyPan (QgsPlotCanvas *canvas) | |
| Constructor for QgsPlotToolTemporaryKeyPan. More... | |
| void | activate () override |
| Called when the tool is set as the currently active plot tool. More... | |
| void | keyReleaseEvent (QKeyEvent *event) override |
| Key release event for overriding. More... | |
| void | plotMoveEvent (QgsPlotMouseEvent *event) override |
| Mouse move 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... | |
| QgsPlotCanvas * | canvas () const |
| Returns the tool's plot canvas. More... | |
| virtual bool | canvasToolTipEvent (QHelpEvent *event) |
| Tooltip event for overriding. More... | |
| virtual void | deactivate () |
| Called when the tool is being deactivated. 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 | keyPressEvent (QKeyEvent *event) |
| Key press event for overriding. More... | |
| virtual void | keyReleaseEvent (QKeyEvent *event) |
| Key release event for overriding. More... | |
| virtual void | plotDoubleClickEvent (QgsPlotMouseEvent *event) |
| Mouse double-click event for overriding. More... | |
| virtual void | plotMoveEvent (QgsPlotMouseEvent *event) |
| Mouse move event for overriding. More... | |
| virtual void | plotPressEvent (QgsPlotMouseEvent *event) |
| Mouse press event for overriding. More... | |
| virtual void | plotReleaseEvent (QgsPlotMouseEvent *event) |
| Mouse release 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... | |
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... | |
| 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... | |
| 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... | |
| Protected Attributes inherited from QgsPlotTool | |
| QPointer< QAction > | mAction |
| Optional action associated with tool. More... | |
| QgsPlotCanvas * | mCanvas = 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... | |
Detailed Description
Plot tool for temporarily panning a plot while a key is depressed.
- Since
- QGIS 3.26
Definition at line 32 of file qgsplottransienttools.h.
Constructor & Destructor Documentation
◆ QgsPlotToolTemporaryKeyPan()
| QgsPlotToolTemporaryKeyPan::QgsPlotToolTemporaryKeyPan | ( | QgsPlotCanvas * | canvas | ) |
Constructor for QgsPlotToolTemporaryKeyPan.
Definition at line 30 of file qgsplottransienttools.cpp.
Member Function Documentation
◆ activate()
|
overridevirtual |
Called when the tool is set as the currently active plot tool.
Reimplemented from QgsPlotTool.
Definition at line 51 of file qgsplottransienttools.cpp.
◆ keyReleaseEvent()
|
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.
Definition at line 43 of file qgsplottransienttools.cpp.
◆ plotMoveEvent()
|
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 36 of file qgsplottransienttools.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.28.0+99sid/src/gui/plot/qgsplottransienttools.h
- /build/qgis-3.28.0+99sid/src/gui/plot/qgsplottransienttools.cpp
