QgsLayoutViewToolTemporaryKeyZoom Class Reference

Layout view tool for temporarily zooming a layout while a key is depressed. More...

#include <qgslayoutviewtooltemporarykeyzoom.h>

Inheritance diagram for QgsLayoutViewToolTemporaryKeyZoom:

Public Member Functions
	QgsLayoutViewToolTemporaryKeyZoom (QgsLayoutView *view)
	Constructor for QgsLayoutViewToolTemporaryKeyZoom.
void	activate () override
	Called when tool is set as the currently active layout tool.
void	keyPressEvent (QKeyEvent *event) override
	Key press event for overriding.
void	keyReleaseEvent (QKeyEvent *event) override
	Key release event for overriding.
void	layoutReleaseEvent (QgsLayoutViewMouseEvent *event) override
	Mouse release event for overriding.
Public Member Functions inherited from QgsLayoutViewToolZoom
	QgsLayoutViewToolZoom (QgsLayoutView *view)
	Constructor for QgsLayoutViewToolZoom.
void	deactivate () override
	Called when tool is deactivated.
void	keyPressEvent (QKeyEvent *event) override
	Key press event for overriding.
void	keyReleaseEvent (QKeyEvent *event) override
	Key release event for overriding.
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.
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.
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.
Protected Attributes inherited from QgsLayoutViewToolZoom
bool	mMarqueeZoom = false
	Will be true will marquee zoom operation is in progress.

Detailed Description

Layout view tool for temporarily zooming a layout while a key is depressed.

Since

QGIS 3.0

Definition at line 30 of file qgslayoutviewtooltemporarykeyzoom.h.

Constructor & Destructor Documentation

QgsLayoutViewToolTemporaryKeyZoom()

QgsLayoutViewToolTemporaryKeyZoom::QgsLayoutViewToolTemporaryKeyZoom

(

QgsLayoutView *

view

)

Constructor for QgsLayoutViewToolTemporaryKeyZoom.

Definition at line 22 of file qgslayoutviewtooltemporarykeyzoom.cpp.

Member Function Documentation

activate()

void QgsLayoutViewToolTemporaryKeyZoom::activate ( )

overridevirtual

Called when tool is set as the currently active layout tool.

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

Reimplemented from QgsLayoutViewTool.

Definition at line 99 of file qgslayoutviewtooltemporarykeyzoom.cpp.

keyPressEvent()

void QgsLayoutViewToolTemporaryKeyZoom::keyPressEvent ( QKeyEvent *  event )

overridevirtual

Key press event for overriding.

Default implementation does nothing.

Reimplemented from QgsLayoutViewTool.

Definition at line 38 of file qgslayoutviewtooltemporarykeyzoom.cpp.

keyReleaseEvent()

void QgsLayoutViewToolTemporaryKeyZoom::keyReleaseEvent ( QKeyEvent *  event )

overridevirtual

Key release event for overriding.

Default implementation does nothing.

Reimplemented from QgsLayoutViewTool.

Definition at line 71 of file qgslayoutviewtooltemporarykeyzoom.cpp.

layoutReleaseEvent()

void QgsLayoutViewToolTemporaryKeyZoom::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 27 of file qgslayoutviewtooltemporarykeyzoom.cpp.

---

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

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