QgsMapCanvasInteractionBlocker Class Reference

An interface for objects which block interactions with a QgsMapCanvas. More...

#include <qgsmapcanvasinteractionblocker.h>

Public Types
enum class	Interaction : int { MapPanOnSingleClick = 1 << 0 }
	Available interactions to block. More...

Public Member Functions
virtual	~QgsMapCanvasInteractionBlocker ()=default
virtual bool	blockCanvasInteraction (Interaction interaction) const =0
	Returns true if the specified interaction should be blocked.

Detailed Description

An interface for objects which block interactions with a QgsMapCanvas.

Since

QGIS 3.14

Definition at line 30 of file qgsmapcanvasinteractionblocker.h.

Member Enumeration Documentation

Interaction

enum class QgsMapCanvasInteractionBlocker::Interaction : int

strong

Available interactions to block.

Enumerator
MapPanOnSingleClick	A map pan interaction caused by a single click and release on the map canvas.

Definition at line 37 of file qgsmapcanvasinteractionblocker.h.

Constructor & Destructor Documentation

~QgsMapCanvasInteractionBlocker()

virtual QgsMapCanvasInteractionBlocker::~QgsMapCanvasInteractionBlocker ( )

virtualdefault

Member Function Documentation

blockCanvasInteraction()

virtual bool QgsMapCanvasInteractionBlocker::blockCanvasInteraction ( Interaction  interaction ) const

pure virtual

Returns true if the specified interaction should be blocked.

---

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

• /build/qgis-3.40.0+99sid/src/gui/qgsmapcanvasinteractionblocker.h