QgsLayoutViewToolPan class

Layout view tool for panning the layout.

Reference

Base classes

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

Constructors, destructors, conversion operators

QgsLayoutViewToolPan(QgsLayoutView* view): Constructor for QgsLayoutViewToolPan.

Public functions

void deactivate() override: Called when tool is deactivated.
void layoutMoveEvent(QgsLayoutViewMouseEvent* event) override: Mouse move event for overriding.
void layoutPressEvent(QgsLayoutViewMouseEvent* event) override: Mouse press event for overriding.
void layoutReleaseEvent(QgsLayoutViewMouseEvent* event) override: Mouse release event for overriding.

Function documentation

void QgsLayoutViewToolPan::deactivate() override

Called when tool is deactivated.

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

void QgsLayoutViewToolPan::layoutMoveEvent(QgsLayoutViewMouseEvent* event) override

Mouse move event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolPan::layoutPressEvent(QgsLayoutViewMouseEvent* event) override

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

void QgsLayoutViewToolPan::layoutReleaseEvent(QgsLayoutViewMouseEvent* event) override

Mouse release event for overriding.