QGIS API Documentation  3.21.0-Master (909859188c)
qgsdataitemguiprovider.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsdataitemguiprovider.h
3  --------------------------------------
4  Date : October 2018
5  Copyright : (C) 2018 by Nyall Dawson
6  Email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSDATAITEMGUIPROVIDER_H
17 #define QGSDATAITEMGUIPROVIDER_H
18 
19 #include "qgis_gui.h"
20 #include "qgis_sip.h"
21 #include "qgis.h"
22 #include <QList>
23 #include <QWidget>
24 #include <QMimeData>
25 #include <QString>
26 #include <QMenu>
27 
28 class QgsDataItem;
29 class QgsMessageBar;
30 class QgsLayerItem;
31 
40 class GUI_EXPORT QgsDataItemGuiContext
41 {
42  public:
43 
47  QgsDataItemGuiContext() = default;
48 
56  QgsMessageBar *messageBar() const;
57 
65  void setMessageBar( QgsMessageBar *bar );
66 
67  private:
68 
69  QgsMessageBar *mMessageBar = nullptr;
70 };
71 
73 
85 class GUI_EXPORT QgsDataItemGuiProvider
86 {
87  public:
88 
89  virtual ~QgsDataItemGuiProvider() = default;
90 
94  virtual QString name() = 0;
95 
120  virtual void populateContextMenu( QgsDataItem *item, QMenu *menu,
121  const QList<QgsDataItem *> &selectedItems, QgsDataItemGuiContext context );
122 
134  virtual int precedenceWhenPopulatingMenus() const;
135 
145  virtual bool rename( QgsDataItem *item, const QString &name, QgsDataItemGuiContext context );
146 
157  virtual bool deleteLayer( QgsLayerItem *item, QgsDataItemGuiContext context );
158 
164  virtual bool handleDoubleClick( QgsDataItem *item, QgsDataItemGuiContext context );
165 
171  virtual bool acceptDrop( QgsDataItem *item, QgsDataItemGuiContext context );
172 
179  virtual bool handleDrop( QgsDataItem *item, QgsDataItemGuiContext context, const QMimeData *data, Qt::DropAction action );
180 
190  virtual QWidget *createParamWidget( QgsDataItem *item, QgsDataItemGuiContext context ) SIP_FACTORY;
191 
203  static void notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level = Qgis::MessageLevel::Info, int duration = -1, QWidget *parent = nullptr );
204 };
205 
206 #endif // QGSDATAITEMGUIPROVIDER_H
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition: qgis.h:106
Encapsulates the context in which a QgsDataItem is shown within the application GUI.
QgsDataItemGuiContext()=default
Constructor for QgsDataItemGuiContext.
Abstract base class for providers which affect how QgsDataItem items behave within the application GU...
virtual ~QgsDataItemGuiProvider()=default
virtual QString name()=0
Returns the provider's name.
Base class for all items in the model.
Definition: qgsdataitem.h:46
Item that represents a layer that can be opened with one of the providers.
Definition: qgslayeritem.h:30
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:61
#define SIP_FACTORY
Definition: qgis_sip.h:76
Q_DECLARE_METATYPE(QgsDataItemGuiContext)