QgsLayoutViewToolEditNodes class

Layout view tool for edit node based items in the layout.

Contents

Base classes

class QgsLayoutViewTool
Abstract base class for all layout view tools.

Constructors, destructors, conversion operators

QgsLayoutViewToolEditNodes(QgsLayoutView* view)
Constructor for QgsLayoutViewToolEditNodes.

Public functions

void activate() override
Called when tool is set as the currently active layout tool.
void deactivate() override
Called when tool is deactivated.
void deleteSelectedNode()
Deletes the selected node from the item.
auto ignoredSnapItems() const -> QList<QgsLayoutItem*> override
Returns a list of items which should be ignored while snapping events for this tool.
void keyPressEvent(QKeyEvent* event) override
Key press event for overriding.
void layoutDoubleClickEvent(QgsLayoutViewMouseEvent* event) override
Mouse double-click 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.

Function documentation

void QgsLayoutViewToolEditNodes::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 QgsLayoutViewToolEditNodes::deactivate() override

Called when tool is deactivated.

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

void QgsLayoutViewToolEditNodes::keyPressEvent(QKeyEvent* event) override

Key press event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolEditNodes::layoutDoubleClickEvent(QgsLayoutViewMouseEvent* event) override

Mouse double-click event for overriding.

Default implementation does nothing.

void QgsLayoutViewToolEditNodes::layoutMoveEvent(QgsLayoutViewMouseEvent* event) override

Mouse move event for overriding.

Default implementation does nothing.

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