QgsLayoutViewToolPan Class Reference

Layout view tool for panning the layout. More...

#include <qgslayoutviewtoolpan.h>

Inheritance diagram for QgsLayoutViewToolPan:

Public Member Functions
	QgsLayoutViewToolPan (QgsLayoutView *view)
	Constructor for QgsLayoutViewToolPan.
void	deactivate () override
	Called when tool is deactivated.
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.
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	keyPressEvent (QKeyEvent *event)
	Key press event for overriding.
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.
virtual void	wheelEvent (QWheelEvent *event)
	Mouse wheel event for overriding.

Additional Inherited Members
Public Types inherited from QgsLayoutViewTool
enum	Flag { FlagSnaps = 1 << 1 }
	Flags for controlling how a tool behaves. More...
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 panning the layout.

Since

QGIS 3.0

Definition at line 28 of file qgslayoutviewtoolpan.h.

Constructor & Destructor Documentation

QgsLayoutViewToolPan()

QgsLayoutViewToolPan::QgsLayoutViewToolPan

(

QgsLayoutView *

view

)

Constructor for QgsLayoutViewToolPan.

Definition at line 21 of file qgslayoutviewtoolpan.cpp.

Member Function Documentation

deactivate()

void QgsLayoutViewToolPan::deactivate ( )

overridevirtual

Called when tool is deactivated.

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

Reimplemented from QgsLayoutViewTool.

Definition at line 90 of file qgslayoutviewtoolpan.cpp.

layoutMoveEvent()

void QgsLayoutViewToolPan::layoutMoveEvent ( QgsLayoutViewMouseEvent *  event )

overridevirtual

Mouse move event for overriding.

Default implementation does nothing.

Reimplemented from QgsLayoutViewTool.

Definition at line 42 of file qgslayoutviewtoolpan.cpp.

layoutPressEvent()

void QgsLayoutViewToolPan::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 27 of file qgslayoutviewtoolpan.cpp.

layoutReleaseEvent()

void QgsLayoutViewToolPan::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 56 of file qgslayoutviewtoolpan.cpp.

---

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

• /build/qgis-3.34.0+99sid/src/gui/layout/qgslayoutviewtoolpan.h
• /build/qgis-3.34.0+99sid/src/gui/layout/qgslayoutviewtoolpan.cpp