QGIS API Documentation 3.29.0-Master (006c3c0232)
Public Member Functions | List of all members
QgsModelViewToolPan Class Reference

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

#include <qgsmodelviewtoolpan.h>

Inheritance diagram for QgsModelViewToolPan:
Inheritance graph
[legend]

Public Member Functions

 QgsModelViewToolPan (QgsModelGraphicsView *view)
 Constructor for QgsModelViewToolPan. More...
 
void deactivate () override
 Called when tool is deactivated. 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...
 
- 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 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 21 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 85 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 42 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 27 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 55 of file qgsmodelviewtoolpan.cpp.


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