Model designer view tool for selecting items in the model. More...

#include <qgsmodelviewtoolselect.h>

Inheritance diagram for QgsModelViewToolSelect:

[legend]

Public Member Functions
	QgsModelViewToolSelect (QgsModelGraphicsView *view)
	Constructor for QgsModelViewToolSelect.

	~QgsModelViewToolSelect () override

bool	allowItemInteraction () override
	Returns `true` if the tool allows interaction with component graphic items.

void	deactivate () override
	Called when tool is deactivated.

void	keyPressEvent (QKeyEvent *event) override
	Key press event for overriding.

void	modelDoubleClickEvent (QgsModelViewMouseEvent *event) override
	Mouse double-click event for overriding.

void	modelMoveEvent (QgsModelViewMouseEvent *event) override
	Mouse move event for overriding.

void	modelPressEvent (QgsModelViewMouseEvent *event) override
	Mouse press event for overriding.

void	modelReleaseEvent (QgsModelViewMouseEvent *event) override
	Mouse release event for overriding.

QgsModelViewMouseHandles *	mouseHandles ()
	Returns the view's mouse handles.

void	resetCache ()
	Resets the internal cache following a scene change.

void	setScene (QgsModelGraphicsScene *scene)
	Sets the a scene.

void	wheelEvent (QWheelEvent *event) override
	Mouse wheel event for overriding.

Public Member Functions inherited from QgsModelViewTool
	~QgsModelViewTool () 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 model tool.

QgsModelViewTool::Flags	flags () const
	Returns the current combination of flags set for the tool.

virtual void	keyReleaseEvent (QKeyEvent *event)
	Key release event for overriding.

QgsModelGraphicsScene *	scene () const
	Returns the scene 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.

QgsModelGraphicsView *	view () const
	Returns the view associated with the tool.

Additional Inherited Members
Public Types inherited from QgsModelViewTool
enum	Flag { FlagSnaps = 1 << 1 }
	Flags for controlling how a tool behaves. More...

typedef QFlags< Flag >	Flags

Signals inherited from QgsModelViewTool
void	activated ()
	Emitted when the tool is activated.

void	deactivated ()
	Emitted when the tool is deactivated.

void	itemFocused (QgsModelComponentGraphicItem *item)
	Emitted when an item is "focused" by the tool, i.e.

Protected Member Functions inherited from QgsModelViewTool
	QgsModelViewTool (QgsModelGraphicsView *view, const QString &name)
	Constructor for QgsModelViewTool, taking a model 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 (QgsModelViewTool::Flags flags)
	Sets the combination of flags that will be used for the tool.

Detailed Description

Model designer view tool for selecting items in the model.

Since: QGIS 3.14

Definition at line 36 of file qgsmodelviewtoolselect.h.

Constructor & Destructor Documentation

◆ QgsModelViewToolSelect()

QgsModelViewToolSelect::QgsModelViewToolSelect ( QgsModelGraphicsView * view )

Constructor for QgsModelViewToolSelect.

Definition at line 26 of file qgsmodelviewtoolselect.cpp.

◆ ~QgsModelViewToolSelect()

QgsModelViewToolSelect::~QgsModelViewToolSelect ( )

override

Definition at line 36 of file qgsmodelviewtoolselect.cpp.

Member Function Documentation

◆ allowItemInteraction()

bool QgsModelViewToolSelect::allowItemInteraction ( )

overridevirtual

Returns true if the tool allows interaction with component graphic items.

Reimplemented from QgsModelViewTool.

Definition at line 341 of file qgsmodelviewtoolselect.cpp.

◆ deactivate()

void QgsModelViewToolSelect::deactivate ( )

overridevirtual

Called when tool is deactivated.

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

Reimplemented from QgsModelViewTool.

Definition at line 331 of file qgsmodelviewtoolselect.cpp.

◆ keyPressEvent()

void QgsModelViewToolSelect::keyPressEvent ( QKeyEvent * event )

overridevirtual

Key press event for overriding.

Default implementation does nothing.

Reimplemented from QgsModelViewTool.

Definition at line 319 of file qgsmodelviewtoolselect.cpp.

◆ modelDoubleClickEvent()

void QgsModelViewToolSelect::modelDoubleClickEvent ( QgsModelViewMouseEvent * event )

overridevirtual

Mouse double-click event for overriding.

Default implementation does nothing.

Reimplemented from QgsModelViewTool.

Definition at line 203 of file qgsmodelviewtoolselect.cpp.

◆ modelMoveEvent()

void QgsModelViewToolSelect::modelMoveEvent ( QgsModelViewMouseEvent * event )

overridevirtual

Mouse move event for overriding.

Default implementation does nothing.

Reimplemented from QgsModelViewTool.

Definition at line 145 of file qgsmodelviewtoolselect.cpp.

◆ modelPressEvent()

void QgsModelViewToolSelect::modelPressEvent ( QgsModelViewMouseEvent * event )

overridevirtual

Mouse press event for overriding.

Default implementation does nothing. Note that subclasses must ensure that they correctly handle cases when a modelPressEvent is called without a corresponding modelReleaseEvent (e.g. due to tool being changed mid way through a press-release operation).

Reimplemented from QgsModelViewTool.

Definition at line 47 of file qgsmodelviewtoolselect.cpp.

◆ modelReleaseEvent()

void QgsModelViewToolSelect::modelReleaseEvent ( QgsModelViewMouseEvent * event )

overridevirtual

Mouse release event for overriding.

Default implementation does nothing. Note that subclasses must ensure that they correctly handle cases when a modelPressEvent is called without a corresponding modelReleaseEvent (e.g. due to tool being changed mid way through a press-release operation).

Reimplemented from QgsModelViewTool.

Definition at line 222 of file qgsmodelviewtoolselect.cpp.

◆ mouseHandles()

QgsModelViewMouseHandles * QgsModelViewToolSelect::mouseHandles ( )

Returns the view's mouse handles.

Definition at line 346 of file qgsmodelviewtoolselect.cpp.

◆ resetCache()

void QgsModelViewToolSelect::resetCache ( )

Resets the internal cache following a scene change.

Definition at line 364 of file qgsmodelviewtoolselect.cpp.

◆ setScene()

void QgsModelViewToolSelect::setScene ( QgsModelGraphicsScene * scene )

Sets the a scene.

Definition at line 351 of file qgsmodelviewtoolselect.cpp.

◆ wheelEvent()

void QgsModelViewToolSelect::wheelEvent ( QWheelEvent * event )

overridevirtual

Mouse wheel event for overriding.

Default implementation does nothing.

Reimplemented from QgsModelViewTool.

Definition at line 306 of file qgsmodelviewtoolselect.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/processing/models/qgsmodelviewtoolselect.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/processing/models/qgsmodelviewtoolselect.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsModelViewToolSelect()

◆ ~QgsModelViewToolSelect()

Member Function Documentation

◆ allowItemInteraction()

◆ deactivate()

◆ keyPressEvent()

◆ modelDoubleClickEvent()

◆ modelMoveEvent()

◆ modelPressEvent()

◆ modelReleaseEvent()

◆ mouseHandles()

◆ resetCache()

◆ setScene()

◆ wheelEvent()