QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
qgsdataitemguiprovider.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsdataitemguiprovider.cpp
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
17#include "qgsdataitem.h"
18#include "qgsproviderregistry.h"
19#include "qgsprovidermetadata.h"
21#include "qgsmessagebar.h"
22#include <QMessageBox>
23//
24// QgsDataItemGuiContext
25//
26
28{
29 return mMessageBar;
30}
31
33{
34 mMessageBar = messageBar;
35}
36
38{
39 return mView;
40}
41
43{
44 mView = view;
45}
46
47//
48// QgsDataItemGuiProvider
49//
50
51void QgsDataItemGuiProvider::populateContextMenu( QgsDataItem *, QMenu *, const QList<QgsDataItem *> &, QgsDataItemGuiContext )
52{
53
54}
55
57{
58 return 0;
59}
60
62{
63 return false;
64}
65
67{
68 return false;
69}
70
72{
73 return false;
74}
75
77{
78 return false;
79}
80
81bool QgsDataItemGuiProvider::handleDrop( QgsDataItem *, QgsDataItemGuiContext, const QMimeData *, Qt::DropAction )
82{
83 return false;
84}
85
87{
88 return nullptr;
89}
90
91void QgsDataItemGuiProvider::notify( const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level, int duration, QWidget *parent )
92{
93 if ( QgsMessageBar *bar = context.messageBar() )
94 {
95 bar->pushMessage( title, message, level, duration );
96 }
97 else
98 {
99 switch ( level )
100 {
101 case Qgis::MessageLevel::Info:
102 case Qgis::MessageLevel::NoLevel:
103 {
104 QMessageBox::information( parent, title, message );
105 break;
106 }
107 case Qgis::MessageLevel::Warning:
108 {
109 QMessageBox::warning( parent, title, message );
110 break;
111 }
112 case Qgis::MessageLevel::Critical:
113 {
114 QMessageBox::critical( parent, title, message );
115 break;
116 }
117 case Qgis::MessageLevel::Success:
118 {
119 // There is no "success" in message box, let's use information instead
120 QMessageBox::information( parent, title, message );
121 break;
122 }
123 }
124 }
125}
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition: qgis.h:115
The QgsBrowserTreeView class extends QTreeView with save/restore tree state functionality.
Encapsulates the context in which a QgsDataItem is shown within the application GUI.
void setView(QgsBrowserTreeView *view)
Sets the associated view.
QgsMessageBar * messageBar() const
Returns the associated message bar.
QgsBrowserTreeView * view() const
Returns the associated view.
void setMessageBar(QgsMessageBar *bar)
Sets the associated message bar.
virtual void populateContextMenu(QgsDataItem *item, QMenu *menu, const QList< QgsDataItem * > &selectedItems, QgsDataItemGuiContext context)
Called when the given context menu is being populated for the given item, allowing the provider to ad...
virtual bool handleDrop(QgsDataItem *item, QgsDataItemGuiContext context, const QMimeData *data, Qt::DropAction action)
Called when a user drops on an item.
static void notify(const QString &title, const QString &message, QgsDataItemGuiContext context, Qgis::MessageLevel level=Qgis::MessageLevel::Info, int duration=-1, QWidget *parent=nullptr)
Notify the user showing a message with title and level If the context has a message bar the message w...
virtual int precedenceWhenPopulatingMenus() const
Returns the provider's precedence to use when populating context menus via calls to populateContextMe...
virtual bool acceptDrop(QgsDataItem *item, QgsDataItemGuiContext context)
Providers should return true if the drops are allowed (handleDrop() should be implemented in that cas...
virtual bool handleDoubleClick(QgsDataItem *item, QgsDataItemGuiContext context)
Called when a user double clicks on an item.
virtual QWidget * createParamWidget(QgsDataItem *item, QgsDataItemGuiContext context)
Creates source widget from data item for QgsBrowserPropertiesWidget By default it returns nullptr.
virtual bool rename(QgsDataItem *item, const QString &name, QgsDataItemGuiContext context)
Sets a new name for the item, and returns true if the item was successfully renamed.
virtual bool deleteLayer(QgsLayerItem *item, QgsDataItemGuiContext context)
Tries to permanently delete map layer representing the given item.
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:31
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:61