QGIS/python/gui/auto_generated/layout/qgslayoutcustomdrophandler.sip.in
Nyall Dawson 2800798fef [FEATURE][layouts] Allow drag and drop of pictures onto layouts
E.g. drag an svg from a file explorer onto the layout to create a
new picture item containing that svg image.

Convenience++!
2019-11-28 18:38:31 +10:00

65 lines
2.4 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layout/qgslayoutcustomdrophandler.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutCustomDropHandler : QObject
{
%Docstring
Abstract base class that may be implemented to handle new types of data to be dropped in QGIS layouts.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutcustomdrophandler.h"
%End
public:
QgsLayoutCustomDropHandler( QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsLayoutCustomDropHandler.
%End
virtual bool handleFileDrop( QgsLayoutDesignerInterface *iface, const QString &file ) /Deprecated/;
%Docstring
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.
.. deprecated::
use the version which specifies a drop location instead.
%End
virtual bool handleFileDrop( QgsLayoutDesignerInterface *iface, QPointF dropPoint, const QString &file );
%Docstring
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 ``dropPoint`` point specifies the location (in layout coordinates) at which
the drop occurred.
The base class implementation does nothing.
.. versionadded:: 3.12
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layout/qgslayoutcustomdrophandler.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/