QgsLayoutViewToolTemporaryMousePan class

Layout view tool for temporarily panning a layout while a mouse button is depressed.

Reference

Base classes

class QgsLayoutViewTool: Abstract base class for all layout view tools.

Constructors, destructors, conversion operators

QgsLayoutViewToolTemporaryMousePan(QgsLayoutView* view): Constructor for QgsLayoutViewToolTemporaryMousePan.

Public functions

void activate() override: Called when tool is set as the currently active layout tool.
void layoutMoveEvent(QgsLayoutViewMouseEvent* event) override: Mouse move event for overriding.
void layoutReleaseEvent(QgsLayoutViewMouseEvent* event) override: Mouse release event for overriding.

Function documentation

void QgsLayoutViewToolTemporaryMousePan::activate() override

Called when tool is set as the currently active layout tool.

Overridden implementations must take care to call the base class implementation.

void QgsLayoutViewToolTemporaryMousePan::layoutMoveEvent(QgsLayoutViewMouseEvent* event) override

Mouse move event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolTemporaryMousePan::layoutReleaseEvent(QgsLayoutViewMouseEvent* event) override

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).