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.
- Parameters
parent –
-
childEvent
(self, QChildEvent)¶
-
connectNotify
(self, QMetaMethod)¶
-
customEvent
(self, QEvent)¶
-
disconnectNotify
(self, QMetaMethod)¶
-
handleFileDrop
(self, iface: QgsLayoutDesignerInterface, file: str) → bool¶ Called when the specified
file
has been dropped onto a QGIS layout. IfTrue
is returned, then the handler has accepted this file and it should not be further processed (e.g. by otherQgsLayoutCustomDropHandler
).The base class implementation does nothing.
Deprecated since version use: the version which specifies a drop location instead.
handleFileDrop(self, iface:
QgsLayoutDesignerInterface
, dropPoint: Union[QPointF, QPoint], file: str) -> bool Called when the specifiedfile
has been dropped onto a QGIS layout. IfTrue
is returned, then the handler has accepted this file and it should not be further processed (e.g. by otherQgsLayoutCustomDropHandler
).The
dropPoint
point specifies the location (in layout coordinates) at which the drop occurred.The base class implementation does nothing.
New in version 3.12.
- Parameters
iface (QgsLayoutDesignerInterface) –
file (str) –
- Return type
bool
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
receivers
(self, PYQT_SIGNAL) → int¶
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
timerEvent
(self, QTimerEvent)¶