QgsModelViewToolPan Class Reference

Model designer view tool for panning a model. More...

#include <qgsmodelviewtoolpan.h>

Inheritance diagram for QgsModelViewToolPan:

Public Member Functions
	QgsModelViewToolPan (QgsModelGraphicsView *view)
	Constructor for QgsModelViewToolPan.
void	deactivate () override
	Called when tool is deactivated.
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.
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.
virtual bool	allowItemInteraction ()
	Returns true if the tool allows interaction with component graphic items.
QgsModelViewTool::Flags	flags () const
	Returns the current combination of flags set for the tool.
virtual void	keyPressEvent (QKeyEvent *event)
	Key press event for overriding.
virtual void	keyReleaseEvent (QKeyEvent *event)
	Key release event for overriding.
virtual void	modelDoubleClickEvent (QgsModelViewMouseEvent *event)
	Mouse double-click 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.
virtual void	wheelEvent (QWheelEvent *event)
	Mouse wheel event for overriding.

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 panning a model.

Since

QGIS 3.18

Definition at line 30 of file qgsmodelviewtoolpan.h.

Constructor & Destructor Documentation

QgsModelViewToolPan()

QgsModelViewToolPan::QgsModelViewToolPan

(

QgsModelGraphicsView *

view

)

Constructor for QgsModelViewToolPan.

Definition at line 22 of file qgsmodelviewtoolpan.cpp.

Member Function Documentation

deactivate()

void QgsModelViewToolPan::deactivate ( )

overridevirtual

Called when tool is deactivated.

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

Reimplemented from QgsModelViewTool.

Definition at line 86 of file qgsmodelviewtoolpan.cpp.

modelMoveEvent()

void QgsModelViewToolPan::modelMoveEvent ( QgsModelViewMouseEvent *  event )

overridevirtual

Mouse move event for overriding.

Default implementation does nothing.

Reimplemented from QgsModelViewTool.

Definition at line 43 of file qgsmodelviewtoolpan.cpp.

modelPressEvent()

void QgsModelViewToolPan::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 28 of file qgsmodelviewtoolpan.cpp.

modelReleaseEvent()

void QgsModelViewToolPan::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 56 of file qgsmodelviewtoolpan.cpp.

---

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

• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/processing/models/qgsmodelviewtoolpan.h
• /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/processing/models/qgsmodelviewtoolpan.cpp