qgsdataitemguiprovider.h

Go to the documentation of this file.

/***************************************************************************
  qgsdataitemguiprovider.h
  --------------------------------------
  Date                 : October 2018
  Copyright            : (C) 2018 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSDATAITEMGUIPROVIDER_H
#define QGSDATAITEMGUIPROVIDER_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QList>
#include <QMenu>
#include <QMimeData>
#include <QString>
#include <QWidget>
 
class QgsDataItem;
class QgsMessageBar;
class QgsLayerItem;
class QgsBrowserTreeView;
class QgsMapCanvas;

class GUI_EXPORT QgsDataItemGuiContext
{
  public:
    QgsDataItemGuiContext() = default;

    QgsMessageBar *messageBar() const;

    void setMessageBar( QgsMessageBar *bar );

    void setMapCanvas( QgsMapCanvas *canvas );

    QgsMapCanvas *mapCanvas() const;

    QgsBrowserTreeView *view() const;

    void setView( QgsBrowserTreeView *view );
 
  private:
    QgsMessageBar *mMessageBar = nullptr;
 
    QgsBrowserTreeView *mView = nullptr;
 
    QgsMapCanvas *mCanvas = nullptr;
};
 
Q_DECLARE_METATYPE( QgsDataItemGuiContext );

class GUI_EXPORT QgsDataItemGuiProvider
{
  public:
    virtual ~QgsDataItemGuiProvider() = default;

    virtual QString name() = 0;

    virtual void populateContextMenu( QgsDataItem *item, QMenu *menu, const QList<QgsDataItem *> &selectedItems, QgsDataItemGuiContext context );

    virtual int precedenceWhenPopulatingMenus() const;

    virtual bool rename( QgsDataItem *item, const QString &name, QgsDataItemGuiContext context );

    virtual bool deleteLayer( QgsLayerItem *item, QgsDataItemGuiContext context );

    virtual bool handleDoubleClick( QgsDataItem *item, QgsDataItemGuiContext context );

    virtual bool acceptDrop( QgsDataItem *item, QgsDataItemGuiContext context );

    virtual bool handleDrop( QgsDataItem *item, QgsDataItemGuiContext context, const QMimeData *data, Qt::DropAction action );

    virtual QWidget *createParamWidget( QgsDataItem *item, QgsDataItemGuiContext context ) SIP_FACTORY;

    static void notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level = Qgis::MessageLevel::Info, int duration = -1, QWidget *parent = nullptr );
};
 
#endif // QGSDATAITEMGUIPROVIDER_H