QGIS API Documentation  3.21.0-Master (909859188c)
qgsdataitemproviderregistry.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsdataitemproviderregistry.h
3  --------------------------------------
4  Date : March 2015
5  Copyright : (C) 2015 by Martin Dobias
6  Email : wonder dot sk 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 QGSDATAITEMPROVIDERREGISTRY_H
17 #define QGSDATAITEMPROVIDERREGISTRY_H
18 
19 #include <QList>
20 #include <QMap>
21 #include <QObject>
22 
23 #include "qgis_sip.h"
24 
25 #include "qgis_core.h"
26 
28 
39 class CORE_EXPORT QgsDataItemProviderRegistry : public QObject
40 {
41  Q_OBJECT
42  public:
43 
45 
47 
52 
56  QList<QgsDataItemProvider *> providers() const;
57 
62  QgsDataItemProvider *provider( const QString &providerName ) const;
63 
68  void addProvider( QgsDataItemProvider *provider SIP_TRANSFER );
69 
74  void removeProvider( QgsDataItemProvider *provider );
75 
82  QString dataProviderKey( const QString &dataItemProviderName );
83 
84  signals:
85 
91 
97 
98  private:
99 #ifdef SIP_RUN
101 #endif
102 
104  QList<QgsDataItemProvider *> mProviders;
105 
107  QMap<QString, QString> mDataItemProviderOrigin;
108 
109 };
110 
111 #endif // QGSDATAITEMPROVIDERREGISTRY_H
This class keeps a list of data item providers that may add items to the browser tree.
void providerWillBeRemoved(QgsDataItemProvider *provider)
Emitted when a data item provider is about to be removed.
QgsDataItemProviderRegistry & operator=(const QgsDataItemProviderRegistry &rh)=delete
QgsDataItemProviderRegistry cannot be copied.
void providerAdded(QgsDataItemProvider *provider)
Emitted when a new data item provider has been added.
QgsDataItemProviderRegistry(const QgsDataItemProviderRegistry &rh)=delete
QgsDataItemProviderRegistry cannot be copied.
This is the interface for those who want to add custom data items to the browser tree.
#define SIP_TRANSFER
Definition: qgis_sip.h:36