QgsLayoutViewToolTemporaryKeyZoom class

Layout view tool for temporarily zooming a layout while a key is depressed.

Base classes

class QgsLayoutViewToolZoom
Layout view tool for zooming into and out of the layout.

Constructors, destructors, conversion operators

QgsLayoutViewToolTemporaryKeyZoom(QgsLayoutView* view)
Constructor for QgsLayoutViewToolTemporaryKeyZoom.

Public functions

void activate() override
Called when tool is set as the currently active layout tool.
void keyPressEvent(QKeyEvent* event) override
Key press event for overriding.
void keyReleaseEvent(QKeyEvent* event) override
Key release event for overriding.
void layoutReleaseEvent(QgsLayoutViewMouseEvent* event) override
Mouse release event for overriding.

Function documentation

void QgsLayoutViewToolTemporaryKeyZoom::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 QgsLayoutViewToolTemporaryKeyZoom::keyPressEvent(QKeyEvent* event) override

Key press event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolTemporaryKeyZoom::keyReleaseEvent(QKeyEvent* event) override

Key release event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolTemporaryKeyZoom::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).