QgsModelViewToolSelect Class Reference

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

#include <qgsmodelviewtoolselect.h>

Inheritance diagram for QgsModelViewToolSelect:

Public Member Functions
	QgsModelViewToolSelect (QgsModelGraphicsView *view)
	Constructor for QgsModelViewToolSelect. More...
	~QgsModelViewToolSelect () override
bool	allowItemInteraction () override
	Returns true if the tool allows interaction with component graphic items. More...
void	deactivate () override
	Called when tool is deactivated. More...
void	keyPressEvent (QKeyEvent *event) override
	Key press event for overriding. More...
void	modelDoubleClickEvent (QgsModelViewMouseEvent *event) override
	Mouse double-click event for overriding. More...
void	modelMoveEvent (QgsModelViewMouseEvent *event) override
	Mouse move event for overriding. More...
void	modelPressEvent (QgsModelViewMouseEvent *event) override
	Mouse press event for overriding. More...
void	modelReleaseEvent (QgsModelViewMouseEvent *event) override
	Mouse release event for overriding. More...
QgsModelViewMouseHandles *	mouseHandles ()
	Returns the view's mouse handles. More...
void	resetCache ()
	Resets the internal cache following a scene change. More...
void	setScene (QgsModelGraphicsScene *scene)
	Sets the a scene. More...
void	wheelEvent (QWheelEvent *event) override
	Mouse wheel event for overriding. More...
Public Member Functions inherited from QgsModelViewTool
	~QgsModelViewTool () 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 model tool. More...
virtual bool	allowItemInteraction ()
	Returns true if the tool allows interaction with component graphic items. More...
virtual void	deactivate ()
	Called when tool is deactivated. More...
QgsModelViewTool::Flags	flags () const
	Returns the current combination of flags set for the tool. More...
virtual void	keyPressEvent (QKeyEvent *event)
	Key press event for overriding. More...
virtual void	keyReleaseEvent (QKeyEvent *event)
	Key release event for overriding. More...
virtual void	modelDoubleClickEvent (QgsModelViewMouseEvent *event)
	Mouse double-click event for overriding. More...
virtual void	modelMoveEvent (QgsModelViewMouseEvent *event)
	Mouse move event for overriding. More...
virtual void	modelPressEvent (QgsModelViewMouseEvent *event)
	Mouse press event for overriding. More...
virtual void	modelReleaseEvent (QgsModelViewMouseEvent *event)
	Mouse release event for overriding. More...
QgsModelGraphicsScene *	scene () const
	Returns the scene associated with the tool. 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...
QgsModelGraphicsView *	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 QgsModelViewTool
enum	Flag { FlagSnaps = 1 << 1 }
	Flags for controlling how a tool behaves. More...
Signals inherited from QgsModelViewTool
void	activated ()
	Emitted when the tool is activated. More...
void	deactivated ()
	Emitted when the tool is deactivated. More...
void	itemFocused (QgsModelComponentGraphicItem *item)
	Emitted when an item is "focused" by the tool, i.e. More...
Protected Member Functions inherited from QgsModelViewTool
	QgsModelViewTool (QgsModelGraphicsView *view, const QString &name)
	Constructor for QgsModelViewTool, taking a model 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 (QgsModelViewTool::Flags flags)
	Sets the combination of flags that will be used for the tool. More...

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 25 of file qgsmodelviewtoolselect.cpp.

~QgsModelViewToolSelect()

QgsModelViewToolSelect::~QgsModelViewToolSelect ( )

override

Definition at line 35 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 340 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 330 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 318 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 202 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 144 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 46 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 221 of file qgsmodelviewtoolselect.cpp.

mouseHandles()

QgsModelViewMouseHandles * QgsModelViewToolSelect::mouseHandles

(

)

Returns the view's mouse handles.

Definition at line 345 of file qgsmodelviewtoolselect.cpp.

resetCache()

void QgsModelViewToolSelect::resetCache

(

)

Resets the internal cache following a scene change.

Definition at line 363 of file qgsmodelviewtoolselect.cpp.

setScene()

void QgsModelViewToolSelect::setScene

(

QgsModelGraphicsScene *

scene

)

Sets the a scene.

Definition at line 350 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 305 of file qgsmodelviewtoolselect.cpp.

---

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

• /build/qgis-3.28.0+99sid/src/gui/processing/models/qgsmodelviewtoolselect.h
• /build/qgis-3.28.0+99sid/src/gui/processing/models/qgsmodelviewtoolselect.cpp