QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
qgsproviderguiregistry.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsproviderrguiegistry.h
3  -------------------
4  begin : June 2019
5  copyright : (C) 2019 by Peter Petrik
6  email : zilolv at google dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSPROVIDERGUIREGISTRY_H
19 #define QGSPROVIDERGUIREGISTRY_H
20 
21 #include <map>
22 
23 #include <QDir>
24 #include <QString>
25 #include <QStringList>
26 #include <QMainWindow>
27 
28 #include "qgis_gui.h"
29 #include "qgis_sip.h"
30 
38 
51 class GUI_EXPORT QgsProviderGuiRegistry
52 {
53  public:
54 
56  QgsProviderGuiRegistry( const QString &pluginPath );
57 
59  virtual ~QgsProviderGuiRegistry();
60 
62  QStringList providerList() const;
63 
65  const QgsProviderGuiMetadata *providerMetadata( const QString &providerKey ) const;
66 
71  void registerGuis( QMainWindow *widget );
72 
77  virtual const QList<QgsDataItemGuiProvider *> dataItemGuiProviders( const QString &providerKey ) SIP_FACTORY;
78 
83  virtual QList<QgsSourceSelectProvider *> sourceSelectProviders( const QString &providerKey ) SIP_FACTORY;
84 
89  virtual QList<QgsProjectStorageGuiProvider *> projectStorageGuiProviders( const QString &providerKey ) SIP_FACTORY;
90 
96  virtual QList<QgsSubsetStringEditorProvider *> subsetStringEditorProviders( const QString &providerKey ) SIP_FACTORY;
97 
103  virtual QList<QgsProviderSourceWidgetProvider *> sourceWidgetProviders( const QString &providerKey ) SIP_FACTORY;
104 
106  SIP_SKIP typedef std::map<QString, QgsProviderGuiMetadata *> GuiProviders;
107 
108  private:
109 
115  void loadDynamicProviders( const QString &pluginPath );
116 
122  void loadStaticProviders( );
123 
125  GuiProviders mProviders;
126 };
127 
128 #endif
Abstract base class for providers which affect how QgsDataItem items behave within the application GU...
Abstract interface for project storage GUI - to be implemented by various backends and registered in ...
Holds data for GUI part of the data providers.
A registry / canonical manager of GUI parts of data providers.
std::map< QString, QgsProviderGuiMetadata * > GuiProviders
Type for data provider metadata associative container.
An interface for providers of widgets designed to configure a data provider's source.
This is the interface for those who want to add entries to the QgsDataSourceManagerDialog.
This is the interface for those who want to provide a dialog to edit a subset string.
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_FACTORY
Definition: qgis_sip.h:76