Class: QgsLayoutViewToolTemporaryKeyPan

class qgis.gui.QgsLayoutViewToolTemporaryKeyPan

Bases: QgsLayoutViewTool

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

QgsLayoutViewToolTemporaryKeyPan(view: Optional[QgsLayoutView]) Constructor for QgsLayoutViewToolTemporaryKeyPan.

Methods

activate
childEvent
connectNotify
customEvent
disconnectNotify
isClickAndDrag	Returns True if a mouse press/release operation which started at startViewPoint and ended at endViewPoint should be considered a "click and drag".
isSignalConnected
keyReleaseEvent	param event:
layoutMoveEvent	param event:
receivers
sender
senderSignalIndex
setFlags	Sets the combination of flags that will be used for the tool.
timerEvent

activate(self)

childEvent(self, a0: QChildEvent | None)

connectNotify(self, signal: QMetaMethod)

customEvent(self, a0: QEvent | None)

disconnectNotify(self, signal: QMetaMethod)

isClickAndDrag(self, startViewPoint: QPoint, endViewPoint: QPoint) → bool

Returns True if a mouse press/release operation which started at startViewPoint and ended at endViewPoint should be considered a “click and drag”. If False is returned, the operation should be instead treated as just a click on startViewPoint.

isSignalConnected(self, signal: QMetaMethod) → bool

keyReleaseEvent(self, event: QKeyEvent | None)

Parameters:

event (Optional[QKeyEvent])

layoutMoveEvent(self, event: QgsLayoutViewMouseEvent | None)

Parameters:

event (Optional[QgsLayoutViewMouseEvent])

receivers(self, signal: PYQT_SIGNAL) → int

sender(self) → QObject | None

senderSignalIndex(self) → int

setFlags(self, flags: QgsLayoutViewTool.Flags | QgsLayoutViewTool.Flag)

Sets the combination of flags that will be used for the tool.

See also

flags()

timerEvent(self, a0: QTimerEvent | None)