QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
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
28class QgsDataItem;
29class QgsMessageBar;
30class QgsLayerItem;
32
41class GUI_EXPORT QgsDataItemGuiContext
42{
43 public:
44
46
54 QgsMessageBar *messageBar() const;
55
63 void setMessageBar( QgsMessageBar *bar );
64
71 QgsBrowserTreeView *view() const;
72
79 void setView( QgsBrowserTreeView *view );
80
81 private:
82
83 QgsMessageBar *mMessageBar = nullptr;
84
85 QgsBrowserTreeView *mView = nullptr;
86};
87
89
102{
103 public:
104
105 virtual ~QgsDataItemGuiProvider() = default;
106
110 virtual QString name() = 0;
111
136 virtual void populateContextMenu( QgsDataItem *item, QMenu *menu,
137 const QList<QgsDataItem *> &selectedItems, QgsDataItemGuiContext context );
138
150 virtual int precedenceWhenPopulatingMenus() const;
151
161 virtual bool rename( QgsDataItem *item, const QString &name, QgsDataItemGuiContext context );
162
173 virtual bool deleteLayer( QgsLayerItem *item, QgsDataItemGuiContext context );
174
180 virtual bool handleDoubleClick( QgsDataItem *item, QgsDataItemGuiContext context );
181
187 virtual bool acceptDrop( QgsDataItem *item, QgsDataItemGuiContext context );
188
195 virtual bool handleDrop( QgsDataItem *item, QgsDataItemGuiContext context, const QMimeData *data, Qt::DropAction action );
196
206 virtual QWidget *createParamWidget( QgsDataItem *item, QgsDataItemGuiContext context ) SIP_FACTORY;
207
219 static void notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level = Qgis::MessageLevel::Info, int duration = -1, QWidget *parent = nullptr );
220};
221
222#endif // QGSDATAITEMGUIPROVIDER_H
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition qgis.h:154
@ Info
Information message.
Definition qgis.h:155
The QgsBrowserTreeView class extends QTreeView with save/restore tree state functionality.
Encapsulates the context in which a QgsDataItem is shown within the application GUI.
QgsDataItemGuiContext()=default
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.
A bar for displaying non-blocking messages to the user.
#define SIP_FACTORY
Definition qgis_sip.h:76
Q_DECLARE_METATYPE(QgsDataItemGuiContext)