Class: QgsSourceSelectProviderRegistry¶
-
class
qgis.gui.
QgsSourceSelectProviderRegistry
¶ Bases:
sip.wrapper
Constructor for QgsSourceSelectProviderRegistry.
This class keeps a list of source select providers that may add items to the QgsDataSourceManagerDialog When created, it automatically adds providers from data provider plugins (e.g. PostGIS, WMS, …)
QgsSourceSelectProviderRegistry
is not usually directly created, but rather accessed throughQgsGui.sourceSelectProviderRegistry()
Note
This class access to
QgsProviderRegistry
instance to initialize, butQgsProviderRegistry
is typically initialized afterQgsGui
is constructed, for this reason a delayed initialization has been implemented in the class.Methods
Add a
provider
implementation.Returns a provider by
name
or None if not foundGets list of available providers
Returns a (possibly empty) list of providers by data
providerkey
Remove
provider
implementation from the list (provider
object is deleted)-
addProvider
(self, provider: QgsSourceSelectProvider)¶ Add a
provider
implementation. Takes ownership of the object.- Parameters
provider (QgsSourceSelectProvider) –
-
providerByName
(self, name: str) → QgsSourceSelectProvider¶ Returns a provider by
name
or None if not found- Parameters
name (str) –
- Return type
-
providers
(self) → object¶ Gets list of available providers
- Return type
object
-
providersByKey
(self, providerKey: str) → List[QgsSourceSelectProvider]¶ Returns a (possibly empty) list of providers by data
providerkey
- Parameters
providerKey (str) –
- Return type
List[QgsSourceSelectProvider]
-
removeProvider
(self, provider: QgsSourceSelectProvider) → bool¶ Remove
provider
implementation from the list (provider
object is deleted)- Return type
bool
- Returns
true if the provider was actually removed and deleted
- Parameters
provider (QgsSourceSelectProvider) –
-