Class: QgsMapCanvasInteractionBlocker

An interface for objects which block interactions with a QgsMapCanvas.

Added in version 3.14.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: blockCanvasInteraction()

Enums

Interaction

Available interactions to block.

Abstract Methods

blockCanvasInteraction

Returns True if the specified interaction should be blocked.

class qgis.gui.QgsMapCanvasInteractionBlocker[source]

Bases: object

class Interaction(*values)

Bases: IntEnum

Available interactions to block.

  • MapPanOnSingleClick: A map pan interaction caused by a single click and release on the map canvas

MapPanOnSingleClick = 1
abstract blockCanvasInteraction(self, interaction: QgsMapCanvasInteractionBlocker.Interaction) bool[source]

Returns True if the specified interaction should be blocked.

Parameters:

interaction (QgsMapCanvasInteractionBlocker.Interaction)

Return type:

bool