QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
Layout view tool for edit node based items in the layout. More...
#include <qgslayoutviewtooleditnodes.h>
Public Member Functions | |
QgsLayoutViewToolEditNodes (QgsLayoutView *view) | |
Constructor for QgsLayoutViewToolEditNodes. | |
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. | |
QList< QgsLayoutItem * > | ignoredSnapItems () const 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. | |
Public Member Functions inherited from QgsLayoutViewTool | |
~QgsLayoutViewTool () override | |
QAction * | action () |
Returns the action associated with the tool or nullptr if no action is associated. | |
QgsLayoutViewTool::Flags | flags () const |
Returns the current combination of flags set for the tool. | |
virtual void | keyReleaseEvent (QKeyEvent *event) |
Key release event for overriding. | |
QgsLayout * | layout () const |
Returns the layout associated with the tool. | |
void | setAction (QAction *action) |
Associates an action with this tool. | |
void | setCursor (const QCursor &cursor) |
Sets a user defined cursor for use when the tool is active. | |
QString | toolName () const |
Returns a user-visible, translated name for the tool. | |
QgsLayoutView * | view () const |
Returns the view associated with the tool. | |
virtual void | wheelEvent (QWheelEvent *event) |
Mouse wheel event for overriding. | |
Additional Inherited Members | |
Public Types inherited from QgsLayoutViewTool | |
enum | Flag { FlagSnaps = 1 << 1 } |
Flags for controlling how a tool behaves. More... | |
typedef QFlags< Flag > | Flags |
Signals inherited from QgsLayoutViewTool | |
void | activated () |
Emitted when the tool is activated. | |
void | deactivated () |
Emitted when the tool is deactivated. | |
void | itemFocused (QgsLayoutItem *item) |
Emitted when an item is "focused" by the tool, i.e. | |
Protected Member Functions inherited from QgsLayoutViewTool | |
QgsLayoutViewTool (QgsLayoutView *view, const QString &name) | |
Constructor for QgsLayoutViewTool, taking a layout view and tool name as parameters. | |
bool | isClickAndDrag (QPoint startViewPoint, QPoint endViewPoint) const |
Returns true if a mouse press/release operation which started at startViewPoint and ended at endViewPoint should be considered a "click and drag". | |
void | setFlags (QgsLayoutViewTool::Flags flags) |
Sets the combination of flags that will be used for the tool. | |
Layout view tool for edit node based items in the layout.
Definition at line 29 of file qgslayoutviewtooleditnodes.h.
QgsLayoutViewToolEditNodes::QgsLayoutViewToolEditNodes | ( | QgsLayoutView * | view | ) |
Constructor for QgsLayoutViewToolEditNodes.
Definition at line 23 of file qgslayoutviewtooleditnodes.cpp.
|
overridevirtual |
Called when tool is set as the currently active layout tool.
Overridden implementations must take care to call the base class implementation.
Reimplemented from QgsLayoutViewTool.
Definition at line 58 of file qgslayoutviewtooleditnodes.cpp.
|
overridevirtual |
Called when tool is deactivated.
Overridden implementations must take care to call the base class implementation.
Reimplemented from QgsLayoutViewTool.
Definition at line 226 of file qgslayoutviewtooleditnodes.cpp.
void QgsLayoutViewToolEditNodes::deleteSelectedNode | ( | ) |
Deletes the selected node from the item.
Definition at line 30 of file qgslayoutviewtooleditnodes.cpp.
|
overridevirtual |
Returns a list of items which should be ignored while snapping events for this tool.
Reimplemented from QgsLayoutViewTool.
Definition at line 233 of file qgslayoutviewtooleditnodes.cpp.
|
overridevirtual |
Key press event for overriding.
Default implementation does nothing.
Reimplemented from QgsLayoutViewTool.
Definition at line 198 of file qgslayoutviewtooleditnodes.cpp.
|
overridevirtual |
Mouse double-click event for overriding.
Default implementation does nothing.
Reimplemented from QgsLayoutViewTool.
Definition at line 143 of file qgslayoutviewtooleditnodes.cpp.
|
overridevirtual |
Mouse move event for overriding.
Default implementation does nothing.
Reimplemented from QgsLayoutViewTool.
Definition at line 107 of file qgslayoutviewtooleditnodes.cpp.
|
overridevirtual |
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).
Reimplemented from QgsLayoutViewTool.
Definition at line 64 of file qgslayoutviewtooleditnodes.cpp.
|
overridevirtual |
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).
Reimplemented from QgsLayoutViewTool.
Definition at line 121 of file qgslayoutviewtooleditnodes.cpp.