QgsLayoutViewToolZoom class

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

Contents

Base classes

class QgsLayoutViewTool
Abstract base class for all layout view tools.

Derived classes

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

Constructors, destructors, conversion operators

QgsLayoutViewToolZoom(QgsLayoutView* view)
Constructor for QgsLayoutViewToolZoom.

Public functions

void deactivate() override
Called when tool is deactivated.
void keyPressEvent(QKeyEvent* event) override
Key press event for overriding.
void keyReleaseEvent(QKeyEvent* event) override
Key release event for overriding.
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.

Protected variables

bool mMarqueeZoom
Will be true will marquee zoom operation is in progress.

Function documentation

void QgsLayoutViewToolZoom::deactivate() override

Called when tool is deactivated.

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

void QgsLayoutViewToolZoom::keyPressEvent(QKeyEvent* event) override

Key press event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolZoom::keyReleaseEvent(QKeyEvent* event) override

Key release event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolZoom::layoutMoveEvent(QgsLayoutViewMouseEvent* event) override

Mouse move event for overriding.

Default implementation does nothing.

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