|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
|
QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
Layout view tool for adding items to a layout. More...
#include <qgslayoutviewtooladditem.h>
Signals | |
| void | createdItem () |
| Emitted when an item has been created using the tool. More... | |
 Signals inherited from QgsLayoutViewTool | |
| void | activated () |
| Emitted when the tool is activated. More... | |
| void | deactivated () |
| Emitted when the tool is deactivated. More... | |
| void | itemFocused (QgsLayoutItem *item) |
| Emitted when an item is "focused" by the tool, i.e. More... | |
Public Member Functions | |
| QgsLayoutViewToolAddItem (QgsLayoutView *view) | |
| Constructs a QgsLayoutViewToolAddItem for the given layout view. More... | |
| void | deactivate () override |
| Called when tool is deactivated. More... | |
| int | itemMetadataId () const |
| Returns the item metadata id for items created by the tool. More... | |
| void | layoutMoveEvent (QgsLayoutViewMouseEvent *event) override |
| Mouse move event for overriding. More... | |
| void | layoutPressEvent (QgsLayoutViewMouseEvent *event) override |
| Mouse press event for overriding. More... | |
| void | layoutReleaseEvent (QgsLayoutViewMouseEvent *event) override |
| Mouse release event for overriding. More... | |
| void | setItemMetadataId (int metadataId) |
| Sets the item metadata metadataId for items created by the tool. More... | |
| Public Member Functions inherited from QgsLayoutViewTool | |
| ~QgsLayoutViewTool () override | |
| QAction * | action () |
| Returns the action associated with the tool or nullptr if no action is associated. More... | |
| virtual void | activate () |
| Called when tool is set as the currently active layout tool. More... | |
| QgsLayoutViewTool::Flags | flags () const |
| Returns the current combination of flags set for the tool. More... | |
| virtual QList< QgsLayoutItem * > | ignoredSnapItems () const |
| Returns a list of items which should be ignored while snapping events for this tool. More... | |
| virtual void | keyPressEvent (QKeyEvent *event) |
| Key press event for overriding. More... | |
| virtual void | keyReleaseEvent (QKeyEvent *event) |
| Key release event for overriding. More... | |
| QgsLayout * | layout () const |
| Returns the layout associated with the tool. More... | |
| virtual void | layoutDoubleClickEvent (QgsLayoutViewMouseEvent *event) |
| Mouse double-click event for overriding. More... | |
| void | setAction (QAction *action) |
| Associates an action with this tool. More... | |
| void | setCursor (const QCursor &cursor) |
| Sets a user defined cursor for use when the tool is active. More... | |
| QString | toolName () const |
| Returns a user-visible, translated name for the tool. More... | |
| QgsLayoutView * | view () const |
| Returns the view associated with the tool. More... | |
| virtual void | wheelEvent (QWheelEvent *event) |
| Mouse wheel event for overriding. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsLayoutViewTool | |
| enum | Flag { FlagSnaps = 1 << 1 } |
| Flags for controlling how a tool behaves. More... | |
| Protected Member Functions inherited from QgsLayoutViewTool | |
| QgsLayoutViewTool (QgsLayoutView *view, const QString &name) | |
| Constructor for QgsLayoutViewTool, taking a layout view and tool name as parameters. More... | |
| 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". More... | |
| void | setFlags (QgsLayoutViewTool::Flags flags) |
| Sets the combination of flags that will be used for the tool. More... | |
Layout view tool for adding items to a layout.
Definition at line 30 of file qgslayoutviewtooladditem.h.
| QgsLayoutViewToolAddItem::QgsLayoutViewToolAddItem | ( | QgsLayoutView * | view | ) |
Constructs a QgsLayoutViewToolAddItem for the given layout view.
Definition at line 34 of file qgslayoutviewtooladditem.cpp.
|
signal |
Emitted when an item has been created using the tool.
|
overridevirtual |
Called when tool is deactivated.
Overridden implementations must take care to call the base class implementation.
Reimplemented from QgsLayoutViewTool.
Definition at line 152 of file qgslayoutviewtooladditem.cpp.
| int QgsLayoutViewToolAddItem::itemMetadataId | ( | ) | const |
Returns the item metadata id for items created by the tool.
Definition at line 163 of file qgslayoutviewtooladditem.cpp.
|
overridevirtual |
Mouse move event for overriding.
Default implementation does nothing.
Reimplemented from QgsLayoutViewTool.
Definition at line 67 of file qgslayoutviewtooladditem.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 46 of file qgslayoutviewtooladditem.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 79 of file qgslayoutviewtooladditem.cpp.
| void QgsLayoutViewToolAddItem::setItemMetadataId | ( | int | metadataId | ) |
Sets the item metadata metadataId for items created by the tool.
The metadataId associates the current tool behavior with a metadata entry from QgsLayoutItemGuiRegistry.
Definition at line 41 of file qgslayoutviewtooladditem.cpp.
1.8.11
