QgsLayoutViewToolSelect Class Reference

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

#include <qgslayoutviewtoolselect.h>

Inheritance diagram for QgsLayoutViewToolSelect:

Public Member Functions
	QgsLayoutViewToolSelect (QgsLayoutView *view)
	Constructor for QgsLayoutViewToolSelect.
	~QgsLayoutViewToolSelect () override
void	deactivate () override
	Called when tool is deactivated.
void	keyPressEvent (QKeyEvent *event) override
	Key press 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.
double	searchToleranceInLayoutUnits ()
	Compute the search tolerance in layout units from the view current scale.
void	setLayout (QgsLayout *layout)
	Sets the a layout.
void	wheelEvent (QWheelEvent *event) override
	Mouse wheel 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.
virtual void	activate ()
	Called when tool is set as the currently active layout tool.
QgsLayoutViewTool::Flags	flags () const
	Returns the current combination of flags set for the tool.
virtual QList< QgsLayoutItem * >	ignoredSnapItems () const
	Returns a list of items which should be ignored while snapping events for this tool.
virtual void	keyReleaseEvent (QKeyEvent *event)
	Key release event for overriding.
QgsLayout *	layout () const
	Returns the layout associated with the tool.
virtual void	layoutDoubleClickEvent (QgsLayoutViewMouseEvent *event)
	Mouse double-click event for overriding.
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.

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.

Detailed Description

Layout view tool for selecting items in the layout.

Definition at line 31 of file qgslayoutviewtoolselect.h.

Constructor & Destructor Documentation

QgsLayoutViewToolSelect()

QgsLayoutViewToolSelect::QgsLayoutViewToolSelect

(

QgsLayoutView *

view

)

Constructor for QgsLayoutViewToolSelect.

Definition at line 29 of file qgslayoutviewtoolselect.cpp.

~QgsLayoutViewToolSelect()

QgsLayoutViewToolSelect::~QgsLayoutViewToolSelect ( )

override

Definition at line 39 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 321 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 309 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 171 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 50 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 194 of file qgslayoutviewtoolselect.cpp.

searchToleranceInLayoutUnits()

double QgsLayoutViewToolSelect::searchToleranceInLayoutUnits

(

)

Compute the search tolerance in layout units from the view current scale.

Since

QGIS 3.34

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 296 of file qgslayoutviewtoolselect.cpp.

---

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

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/layout/qgslayoutviewtoolselect.h
• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/layout/qgslayoutviewtoolselect.cpp