QGIS API Documentation  3.17.0-Master (a84647cf30)
Signals | Public Member Functions | List of all members
QgsLayoutViewToolAddNodeItem Class Reference

Layout view tool for adding node based items to a layout. More...

#include <qgslayoutviewtooladdnodeitem.h>

Inheritance diagram for QgsLayoutViewToolAddNodeItem:
Inheritance graph
[legend]

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

 QgsLayoutViewToolAddNodeItem (QgsLayoutView *view)
 Constructs a QgsLayoutViewToolAddNodeItem 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 keyPressEvent (QKeyEvent *event) override
 Key press event for overriding. 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 keyReleaseEvent (QKeyEvent *event)
 Key release event for overriding. More...
 
QgsLayoutlayout () 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...
 
QgsLayoutViewview () 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...
 

Detailed Description

Layout view tool for adding node based items to a layout.

Since
QGIS 3.0

Definition at line 30 of file qgslayoutviewtooladdnodeitem.h.

Constructor & Destructor Documentation

◆ QgsLayoutViewToolAddNodeItem()

QgsLayoutViewToolAddNodeItem::QgsLayoutViewToolAddNodeItem ( QgsLayoutView view)

Constructs a QgsLayoutViewToolAddNodeItem for the given layout view.

Definition at line 35 of file qgslayoutviewtooladdnodeitem.cpp.

Member Function Documentation

◆ createdItem

void QgsLayoutViewToolAddNodeItem::createdItem ( )
signal

Emitted when an item has been created using the tool.

◆ deactivate()

void QgsLayoutViewToolAddNodeItem::deactivate ( )
overridevirtual

Called when tool is deactivated.

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

Reimplemented from QgsLayoutViewTool.

Definition at line 144 of file qgslayoutviewtooladdnodeitem.cpp.

◆ itemMetadataId()

int QgsLayoutViewToolAddNodeItem::itemMetadataId ( ) const

Returns the item metadata id for items created by the tool.

See also
setItemMetadataId()

Definition at line 199 of file qgslayoutviewtooladdnodeitem.cpp.

◆ keyPressEvent()

void QgsLayoutViewToolAddNodeItem::keyPressEvent ( QKeyEvent *  event)
overridevirtual

Key press event for overriding.

Default implementation does nothing.

Reimplemented from QgsLayoutViewTool.

Definition at line 112 of file qgslayoutviewtooladdnodeitem.cpp.

◆ layoutMoveEvent()

void QgsLayoutViewToolAddNodeItem::layoutMoveEvent ( QgsLayoutViewMouseEvent event)
overridevirtual

Mouse move event for overriding.

Default implementation does nothing.

Reimplemented from QgsLayoutViewTool.

Definition at line 91 of file qgslayoutviewtooladdnodeitem.cpp.

◆ layoutPressEvent()

void QgsLayoutViewToolAddNodeItem::layoutPressEvent ( QgsLayoutViewMouseEvent event)
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 47 of file qgslayoutviewtooladdnodeitem.cpp.

◆ layoutReleaseEvent()

void QgsLayoutViewToolAddNodeItem::layoutReleaseEvent ( QgsLayoutViewMouseEvent event)
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 103 of file qgslayoutviewtooladdnodeitem.cpp.

◆ setItemMetadataId()

void QgsLayoutViewToolAddNodeItem::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.

See also
itemMetadataId()

Definition at line 42 of file qgslayoutviewtooladdnodeitem.cpp.


The documentation for this class was generated from the following files: