Layout view tool for temporarily panning a layout while a mouse button is depressed. More...
#include <qgslayoutviewtooltemporarymousepan.h>
Public Member Functions | |
| QgsLayoutViewToolTemporaryMousePan (QgsLayoutView *view) | |
| Constructor for QgsLayoutViewToolTemporaryMousePan. More... | |
| void | activate () override |
| Called when tool is set as the currently active layout tool. More... | |
| void | layoutMoveEvent (QgsLayoutViewMouseEvent *event) override |
| Mouse move event for overriding. More... | |
| void | layoutReleaseEvent (QgsLayoutViewMouseEvent *event) override |
| Mouse release event for overriding. More... | |
 Public Member Functions inherited from QgsLayoutViewTool | |
| ~QgsLayoutViewTool () override | |
| QAction * | action () |
Returns the action associated with the tool or nullptr if no action is associated. More... | |
| virtual void | deactivate () |
| Called when tool is deactivated. More... | |
| QgsLayoutViewTool::Flags | flags () const |
| Returns the current combination of flags set for the tool. More... | |
| virtual QList< QgsLayoutItem * > | ignoredSnapItems () const |
| Returns a list of items which should be ignored while snapping events for this tool. More... | |
| virtual void | keyPressEvent (QKeyEvent *event) |
| Key press event for overriding. More... | |
| virtual void | keyReleaseEvent (QKeyEvent *event) |
| Key release event for overriding. More... | |
| QgsLayout * | layout () const |
| Returns the layout associated with the tool. More... | |
| virtual void | layoutDoubleClickEvent (QgsLayoutViewMouseEvent *event) |
| Mouse double-click event for overriding. More... | |
| virtual void | layoutPressEvent (QgsLayoutViewMouseEvent *event) |
| Mouse press event for overriding. 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... | |
| QgsLayoutView * | view () const |
| Returns the view associated with the tool. More... | |
| virtual void | wheelEvent (QWheelEvent *event) |
| Mouse wheel event for overriding. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsLayoutViewTool | |
| enum | Flag { FlagSnaps = 1 << 1 } |
| Flags for controlling how a tool behaves. More... | |
| Signals inherited from QgsLayoutViewTool | |
| void | activated () |
| Emitted when the tool is activated. More... | |
| void | deactivated () |
| Emitted when the tool is deactivated. More... | |
| void | itemFocused (QgsLayoutItem *item) |
| Emitted when an item is "focused" by the tool, i.e. More... | |
| Protected Member Functions inherited from QgsLayoutViewTool | |
| QgsLayoutViewTool (QgsLayoutView *view, const QString &name) | |
| Constructor for QgsLayoutViewTool, taking a layout view and tool name as parameters. 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... | |
| void | setFlags (QgsLayoutViewTool::Flags flags) |
| Sets the combination of flags that will be used for the tool. More... | |
Detailed Description
Layout view tool for temporarily panning a layout while a mouse button is depressed.
- Since
- QGIS 3.0
Definition at line 28 of file qgslayoutviewtooltemporarymousepan.h.
Constructor & Destructor Documentation
◆ QgsLayoutViewToolTemporaryMousePan()
| QgsLayoutViewToolTemporaryMousePan::QgsLayoutViewToolTemporaryMousePan | ( | QgsLayoutView * | view | ) |
Constructor for QgsLayoutViewToolTemporaryMousePan.
Definition at line 21 of file qgslayoutviewtooltemporarymousepan.cpp.
Member Function Documentation
◆ activate()
|
overridevirtual |
Called when tool is set as the currently active layout tool.
Overridden implementations must take care to call the base class implementation.
Reimplemented from QgsLayoutViewTool.
Definition at line 43 of file qgslayoutviewtooltemporarymousepan.cpp.
◆ layoutMoveEvent()
|
overridevirtual |
Mouse move event for overriding.
Default implementation does nothing.
Reimplemented from QgsLayoutViewTool.
Definition at line 27 of file qgslayoutviewtooltemporarymousepan.cpp.
◆ layoutReleaseEvent()
|
overridevirtual |
Mouse release event for overriding.
Default implementation does nothing. Note that subclasses must ensure that they correctly handle cases when a layoutPressEvent is called without a corresponding layoutReleaseEvent (e.g. due to tool being changed mid way through a press-release operation).
Reimplemented from QgsLayoutViewTool.
Definition at line 35 of file qgslayoutviewtooltemporarymousepan.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.16.0+99unstable/src/gui/layout/qgslayoutviewtooltemporarymousepan.h
- /build/qgis-3.16.0+99unstable/src/gui/layout/qgslayoutviewtooltemporarymousepan.cpp
