QGIS API Documentation  3.9.0-Master (224899f119)
Public Member Functions | List of all members
QgsLayoutCustomDropHandler Class Reference

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

#include <qgslayoutcustomdrophandler.h>

Inheritance diagram for QgsLayoutCustomDropHandler:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutCustomDropHandler (QObject *parent=nullptr)
 Constructor for QgsLayoutCustomDropHandler. More...
 
virtual bool handleFileDrop (QgsLayoutDesignerInterface *iface, const QString &file)
 Called when the specified file has been dropped onto a QGIS layout. More...
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 31 of file qgslayoutcustomdrophandler.h.

Constructor & Destructor Documentation

◆ QgsLayoutCustomDropHandler()

QgsLayoutCustomDropHandler::QgsLayoutCustomDropHandler ( QObject *  parent = nullptr)

Constructor for QgsLayoutCustomDropHandler.

Definition at line 18 of file qgslayoutcustomdrophandler.cpp.

Member Function Documentation

◆ handleFileDrop()

bool QgsLayoutCustomDropHandler::handleFileDrop ( QgsLayoutDesignerInterface iface,
const QString &  file 
)
virtual

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.

Definition at line 24 of file qgslayoutcustomdrophandler.cpp.


The documentation for this class was generated from the following files: