QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
qgsprovidersourcewidgetproviderregistry.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsprovidersourcewidgetproviderregistry.h
3
--------------------------------------
4
Date : December 2020
5
Copyright : (C) 2020 by Nyall Dawson
6
Email : nyall dot dawson at gmail dot com
7
****************************************************************************/
8
/***************************************************************************
9
* *
10
* This program is free software; you can redistribute it and/or modify *
11
* it under the terms of the GNU General Public License as published by *
12
* the Free Software Foundation; either version 2 of the License, or *
13
* (at your option) any later version. *
14
* *
15
***************************************************************************/
16
17
#ifndef QGSPROVIDERSOURCEWIDGETPROVIDERREGISTRY_H
18
#define QGSPROVIDERSOURCEWIDGETPROVIDERREGISTRY_H
19
20
#include "qgis_gui.h"
21
#include "
qgis_sip.h
"
22
23
#include <QWidget>
24
25
class
QgsMapLayer
;
26
class
QgsProviderSourceWidget
;
27
class
QgsProviderSourceWidgetProvider
;
28
class
QgsProviderGuiRegistry
;
29
39
class
GUI_EXPORT
QgsProviderSourceWidgetProviderRegistry
40
{
41
public
:
42
QgsProviderSourceWidgetProviderRegistry
();
43
~QgsProviderSourceWidgetProviderRegistry
();
44
45
QgsProviderSourceWidgetProviderRegistry
(
const
QgsProviderSourceWidgetProviderRegistry
&rh ) =
delete
;
46
QgsProviderSourceWidgetProviderRegistry
&
operator=
(
const
QgsProviderSourceWidgetProviderRegistry
&rh ) =
delete
;
47
49
QList<QgsProviderSourceWidgetProvider *>
providers
();
50
52
void
addProvider
(
QgsProviderSourceWidgetProvider
*provider
SIP_TRANSFER
);
53
58
bool
removeProvider
(
QgsProviderSourceWidgetProvider
*provider
SIP_TRANSFER
);
59
64
void
initializeFromProviderGuiRegistry
(
QgsProviderGuiRegistry
*providerGuiRegistry );
65
67
QgsProviderSourceWidgetProvider
*
providerByName
(
const
QString &name );
68
70
QList<QgsProviderSourceWidgetProvider *>
providersByKey
(
const
QString &providerKey );
71
77
QgsProviderSourceWidget
*
createWidget
(
QgsMapLayer
*layer, QWidget *parent
SIP_TRANSFERTHIS
=
nullptr
)
SIP_TRANSFERBACK
;
78
79
private:
80
#ifdef SIP_RUN
81
QgsProviderSourceWidgetProviderRegistry
(
const
QgsProviderSourceWidgetProviderRegistry
&rh );
82
#endif
83
85
QList<QgsProviderSourceWidgetProvider *> mProviders;
86
};
87
88
#endif
// QGSPROVIDERSOURCEWIDGETPROVIDERREGISTRY_H
QgsMapLayer
Base class for all map layer types.
Definition
qgsmaplayer.h:83
QgsProviderGuiRegistry
A registry / canonical manager of GUI parts of data providers.
Definition
qgsproviderguiregistry.h:54
QgsProviderSourceWidgetProviderRegistry::providers
QList< QgsProviderSourceWidgetProvider * > providers()
Gets list of available providers.
Definition
qgsprovidersourcewidgetproviderregistry.cpp:31
QgsProviderSourceWidgetProviderRegistry::providerByName
QgsProviderSourceWidgetProvider * providerByName(const QString &name)
Returns a provider by name or nullptr if not found.
Definition
qgsprovidersourcewidgetproviderregistry.cpp:70
QgsProviderSourceWidgetProviderRegistry::createWidget
QgsProviderSourceWidget * createWidget(QgsMapLayer *layer, QWidget *parent=nullptr)
Creates a new widget to configure the source of the specified layer.
Definition
qgsprovidersourcewidgetproviderregistry.cpp:97
QgsProviderSourceWidgetProviderRegistry::operator=
QgsProviderSourceWidgetProviderRegistry & operator=(const QgsProviderSourceWidgetProviderRegistry &rh)=delete
QgsProviderSourceWidgetProviderRegistry::initializeFromProviderGuiRegistry
void initializeFromProviderGuiRegistry(QgsProviderGuiRegistry *providerGuiRegistry)
Initializes the registry.
Definition
qgsprovidersourcewidgetproviderregistry.cpp:53
QgsProviderSourceWidgetProviderRegistry::providersByKey
QList< QgsProviderSourceWidgetProvider * > providersByKey(const QString &providerKey)
Returns a (possibly empty) list of providers by data providerkey.
Definition
qgsprovidersourcewidgetproviderregistry.cpp:83
QgsProviderSourceWidgetProviderRegistry::removeProvider
bool removeProvider(QgsProviderSourceWidgetProvider *provider)
Remove provider implementation from the list (provider object is deleted).
Definition
qgsprovidersourcewidgetproviderregistry.cpp:41
QgsProviderSourceWidgetProviderRegistry::addProvider
void addProvider(QgsProviderSourceWidgetProvider *provider)
Add a provider implementation. Takes ownership of the object.
Definition
qgsprovidersourcewidgetproviderregistry.cpp:36
QgsProviderSourceWidgetProviderRegistry::QgsProviderSourceWidgetProviderRegistry
QgsProviderSourceWidgetProviderRegistry(const QgsProviderSourceWidgetProviderRegistry &rh)=delete
QgsProviderSourceWidgetProviderRegistry::QgsProviderSourceWidgetProviderRegistry
QgsProviderSourceWidgetProviderRegistry()
QgsProviderSourceWidgetProvider
An interface for providers of widgets designed to configure a data provider's source.
Definition
qgsprovidersourcewidgetprovider.h:38
QgsProviderSourceWidget
Base class for widgets which allow customization of a provider's source URI.
Definition
qgsprovidersourcewidget.h:34
qgis_sip.h
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition
qgis_sip.h:52
SIP_TRANSFER
#define SIP_TRANSFER
Definition
qgis_sip.h:35
SIP_TRANSFERBACK
#define SIP_TRANSFERBACK
Definition
qgis_sip.h:47
Generated on
for QGIS API Documentation by
1.17.0