QgsLayoutViewToolSelect class

Layout view tool for selecting items in the layout.

Contents

Base classes

class QgsLayoutViewTool
Abstract base class for all layout view tools.

Constructors, destructors, conversion operators

QgsLayoutViewToolSelect(QgsLayoutView* view)
Constructor for QgsLayoutViewToolSelect.

Public functions

void deactivate() override
Called when tool is deactivated.
void keyPressEvent(QKeyEvent* event) override
Key press 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.
void setLayout(QgsLayout* layout)
Sets the a layout.
void wheelEvent(QWheelEvent* event) override
Mouse wheel event for overriding.

Function documentation

void QgsLayoutViewToolSelect::deactivate() override

Called when tool is deactivated.

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

void QgsLayoutViewToolSelect::keyPressEvent(QKeyEvent* event) override

Key press event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolSelect::layoutMoveEvent(QgsLayoutViewMouseEvent* event) override

Mouse move event for overriding.

Default implementation does nothing.

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

void QgsLayoutViewToolSelect::wheelEvent(QWheelEvent* event) override

Mouse wheel event for overriding.

Default implementation does nothing.