QGIS API Documentation  3.6.0-Noosa (5873452)
Public Member Functions | List of all members
QgsLayoutViewToolSelect Class Reference

Layout view tool for selecting items in the layout. More...

#include <qgslayoutviewtoolselect.h>

Inheritance diagram for QgsLayoutViewToolSelect:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutViewToolSelect (QgsLayoutView *view)
 Constructor for QgsLayoutViewToolSelect. More...
 
 ~QgsLayoutViewToolSelect () override
 
void deactivate () override
 Called when tool is deactivated. 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 setLayout (QgsLayout *layout)
 Sets the a layout. More...
 
void wheelEvent (QWheelEvent *event) override
 Mouse wheel event for overriding. 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...
 

Additional Inherited Members

- Public Types inherited from QgsLayoutViewTool
enum  Flag { FlagSnaps = 1 << 1 }
 Flags for controlling how a tool behaves. 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...
 
- 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 selecting items in the layout.

Since
QGIS 3.0

Definition at line 32 of file qgslayoutviewtoolselect.h.

Constructor & Destructor Documentation

◆ QgsLayoutViewToolSelect()

QgsLayoutViewToolSelect::QgsLayoutViewToolSelect ( QgsLayoutView view)

Constructor for QgsLayoutViewToolSelect.

Definition at line 23 of file qgslayoutviewtoolselect.cpp.

◆ ~QgsLayoutViewToolSelect()

QgsLayoutViewToolSelect::~QgsLayoutViewToolSelect ( )
override

Definition at line 33 of file qgslayoutviewtoolselect.cpp.

Member Function Documentation

◆ deactivate()

void QgsLayoutViewToolSelect::deactivate ( )
overridevirtual

Called when tool is deactivated.

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

Reimplemented from QgsLayoutViewTool.

Definition at line 271 of file qgslayoutviewtoolselect.cpp.

◆ keyPressEvent()

void QgsLayoutViewToolSelect::keyPressEvent ( QKeyEvent *  event)
overridevirtual

Key press event for overriding.

Default implementation does nothing.

Reimplemented from QgsLayoutViewTool.

Definition at line 259 of file qgslayoutviewtoolselect.cpp.

◆ layoutMoveEvent()

void QgsLayoutViewToolSelect::layoutMoveEvent ( QgsLayoutViewMouseEvent event)
overridevirtual

Mouse move event for overriding.

Default implementation does nothing.

Reimplemented from QgsLayoutViewTool.

Definition at line 147 of file qgslayoutviewtoolselect.cpp.

◆ layoutPressEvent()

void QgsLayoutViewToolSelect::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 44 of file qgslayoutviewtoolselect.cpp.

◆ layoutReleaseEvent()

void QgsLayoutViewToolSelect::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 159 of file qgslayoutviewtoolselect.cpp.

◆ setLayout()

void QgsLayoutViewToolSelect::setLayout ( QgsLayout layout)

Sets the a layout.

◆ wheelEvent()

void QgsLayoutViewToolSelect::wheelEvent ( QWheelEvent *  event)
overridevirtual

Mouse wheel event for overriding.

Default implementation does nothing.

Reimplemented from QgsLayoutViewTool.

Definition at line 246 of file qgslayoutviewtoolselect.cpp.


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