QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
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 "qgis_gui.h"
24
#include "
qgis_sip.h
"
25
26
#include <QDir>
27
#include <QMainWindow>
28
#include <QString>
29
#include <QStringList>
30
31
class
QgsProjectStorageGuiProvider
;
32
class
QgsProviderGuiMetadata
;
33
class
QgsDataItemGuiProvider
;
34
class
QgsSourceSelectProvider
;
35
class
QgsProjectStorageGuiProvider
;
36
class
QgsSubsetStringEditorProvider
;
37
class
QgsProviderSourceWidgetProvider
;
38
class
QgsMapLayerConfigWidgetFactory
;
39
class
QgsMapLayer
;
40
53
class
GUI_EXPORT
QgsProviderGuiRegistry
54
{
55
public
:
57
QgsProviderGuiRegistry
(
const
QString &pluginPath );
58
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
112
virtual
QList<const QgsMapLayerConfigWidgetFactory *>
mapLayerConfigWidgetFactories
(
QgsMapLayer
*layer =
nullptr
);
113
115
SIP_SKIP
typedef
std::map<QString, QgsProviderGuiMetadata *>
GuiProviders
;
116
117
private
:
123
void
loadDynamicProviders(
const
QString &pluginPath );
124
130
void
loadStaticProviders();
131
133
GuiProviders
mProviders;
134
};
135
136
#endif
QgsDataItemGuiProvider
Abstract base class for providers which affect how QgsDataItem items behave within the application GU...
Definition
qgsdataitemguiprovider.h:122
QgsMapLayerConfigWidgetFactory
Factory class for creating custom map layer property pages.
Definition
qgsmaplayerconfigwidgetfactory.h:35
QgsMapLayer
Base class for all map layer types.
Definition
qgsmaplayer.h:83
QgsProjectStorageGuiProvider
Abstract interface for project storage GUI - to be implemented by various backends and registered in ...
Definition
qgsprojectstorageguiprovider.h:32
QgsProviderGuiMetadata
Holds data for the GUI part of the data providers.
Definition
qgsproviderguimetadata.h:41
QgsProviderGuiRegistry::dataItemGuiProviders
virtual const QList< QgsDataItemGuiProvider * > dataItemGuiProviders(const QString &providerKey)
Returns all data item gui providers registered in provider with providerKey.
Definition
qgsproviderguiregistry.cpp:244
QgsProviderGuiRegistry::subsetStringEditorProviders
virtual QList< QgsSubsetStringEditorProvider * > subsetStringEditorProviders(const QString &providerKey)
Returns all subset string editor providers registered in provider with providerKey.
Definition
qgsproviderguiregistry.cpp:268
QgsProviderGuiRegistry::providerMetadata
const QgsProviderGuiMetadata * providerMetadata(const QString &providerKey) const
Returns metadata of the provider or nullptr if not found.
Definition
qgsproviderguiregistry.cpp:309
QgsProviderGuiRegistry::projectStorageGuiProviders
virtual QList< QgsProjectStorageGuiProvider * > projectStorageGuiProviders(const QString &providerKey)
Returns all project storage gui providers registered in provider with providerKey.
Definition
qgsproviderguiregistry.cpp:260
QgsProviderGuiRegistry::mapLayerConfigWidgetFactories
virtual QList< const QgsMapLayerConfigWidgetFactory * > mapLayerConfigWidgetFactories(QgsMapLayer *layer=nullptr)
Returns all map layer config widget factories associated with the registered providers.
Definition
qgsproviderguiregistry.cpp:284
QgsProviderGuiRegistry::GuiProviders
std::map< QString, QgsProviderGuiMetadata * > GuiProviders
Type for data provider metadata associative container.
Definition
qgsproviderguiregistry.h:115
QgsProviderGuiRegistry::QgsProviderGuiRegistry
QgsProviderGuiRegistry(const QString &pluginPath)
Creates registry and loads static provider plugins.
Definition
qgsproviderguiregistry.cpp:80
QgsProviderGuiRegistry::sourceSelectProviders
virtual QList< QgsSourceSelectProvider * > sourceSelectProviders(const QString &providerKey)
Returns all source select providers registered in provider with providerKey.
Definition
qgsproviderguiregistry.cpp:252
QgsProviderGuiRegistry::sourceWidgetProviders
virtual QList< QgsProviderSourceWidgetProvider * > sourceWidgetProviders(const QString &providerKey)
Returns all source widget providers registered in provider with providerKey.
Definition
qgsproviderguiregistry.cpp:276
QgsProviderGuiRegistry::registerGuis
void registerGuis(QMainWindow *widget)
Called during GUI initialization - allows providers to do its internal initialization of GUI componen...
Definition
qgsproviderguiregistry.cpp:236
QgsProviderGuiRegistry::providerList
QStringList providerList() const
Returns list of available providers by their keys.
Definition
qgsproviderguiregistry.cpp:299
QgsProviderSourceWidgetProvider
An interface for providers of widgets designed to configure a data provider's source.
Definition
qgsprovidersourcewidgetprovider.h:38
QgsSourceSelectProvider
An interface for pages shown in a QgsDataSourceManagerDialog.
Definition
qgssourceselectprovider.h:34
QgsSubsetStringEditorProvider
An interface for widgets which edit a subset string.
Definition
qgssubsetstringeditorprovider.h:37
qgis_sip.h
SIP_SKIP
#define SIP_SKIP
Definition
qgis_sip.h:138
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
Generated on
for QGIS API Documentation by
1.17.0