Subgroup: Layout

Class: QgsLayoutCustomDropHandler

class qgis.gui.QgsLayoutCustomDropHandler(parent: QObject = None)

Bases: PyQt5.QtCore.QObject

Constructor for QgsLayoutCustomDropHandler.

Abstract base class that may be implemented to handle new types of data to be dropped in QGIS layouts.

New in version 3.0: Methods

childEvent
connectNotify
customEvent
disconnectNotify
handleFileDrop Called when the specified file has been dropped onto a QGIS layout.
isSignalConnected
receivers
sender
senderSignalIndex
timerEvent

Signals

Attributes

childEvent()
connectNotify()
customEvent()
disconnectNotify()
handleFileDrop(self, iface: QgsLayoutDesignerInterface, file: str) → bool

Called when the specified file has been dropped onto a QGIS layout. If true is returned, then the handler has accepted this file and it should not be further processed (e.g. by other QgsLayoutCustomDropHandler).

The base class implementation does nothing.

isSignalConnected()
receivers()
sender()
senderSignalIndex()
timerEvent()