QGIS API Documentation  3.8.0-Zanzibar (11aff65)
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 <QList>
21 
22 class QString;
23 class QgsDataItem;
24 class QMenu;
25 class QgsMessageBar;
26 
35 class GUI_EXPORT QgsDataItemGuiContext
36 {
37  public:
38 
42  QgsDataItemGuiContext() = default;
43 
51  QgsMessageBar *messageBar() const;
52 
60  void setMessageBar( QgsMessageBar *bar );
61 
62  private:
63 
64  QgsMessageBar *mMessageBar = nullptr;
65 };
66 
78 class GUI_EXPORT QgsDataItemGuiProvider
79 {
80  public:
81 
82  virtual ~QgsDataItemGuiProvider() = default;
83 
87  virtual QString name() = 0;
88 
113  virtual void populateContextMenu( QgsDataItem *item, QMenu *menu,
114  const QList<QgsDataItem *> &selectedItems, QgsDataItemGuiContext context );
115 
121  virtual bool handleDoubleClick( QgsDataItem *item, QgsDataItemGuiContext context );
122 
123 };
124 
125 #endif // QGSDATAITEMGUIPROVIDER_H
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:45
Abstract base class for providers which affect how QgsDataItem items behave within the application GU...
Base class for all items in the model.
Definition: qgsdataitem.h:49
Encapsulates the context in which a QgsDataItem is shown within the application GUI.