Class: QgsDataItemProviderRegistry

class qgis.core.QgsDataItemProviderRegistry

Bases: PyQt5.QtCore.QObject

This class keeps a list of data item providers that may add items to the browser tree. When created, it automatically adds providers from provider plugins (e.g. PostGIS, WMS, …)

QgsDataItemProviderRegistry is not usually directly created, but rather accessed through QgsApplication.dataItemProviderRegistry().

New in version 2.10:

Methods

addProvider

Adds a provider implementation to the registry.

childEvent

connectNotify

customEvent

dataProviderKey

Returns the (possibly blank) data provider key for a given data item provider name.

disconnectNotify

isSignalConnected

provider

Returns the (possibly NULL) data item provider named providerName

providers

Returns the list of available providers.

receivers

removeProvider

Removes a provider implementation from the registry.

sender

senderSignalIndex

timerEvent

Signals

providerAdded

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

providerWillBeRemoved

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

addProvider(self, provider: QgsDataItemProvider)

Adds a provider implementation to the registry. Ownership of the provider is transferred to the registry.

Parameters

provider (QgsDataItemProvider) –

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
dataProviderKey(self, dataItemProviderName: str) str

Returns the (possibly blank) data provider key for a given data item provider name.

Parameters

dataItemProviderName (str) – name of the data item provider

New in version 3.14.

Return type

str

disconnectNotify(self, QMetaMethod)
isSignalConnected(self, QMetaMethod) bool
provider(self, providerName: str) QgsDataItemProvider

Returns the (possibly NULL) data item provider named providerName

New in version 3.14.

Parameters

providerName (str) –

Return type

QgsDataItemProvider

providerAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

providerWillBeRemoved

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

providers(self) List[QgsDataItemProvider]

Returns the list of available providers.

Return type

List[QgsDataItemProvider]

receivers(self, PYQT_SIGNAL) int
removeProvider(self, provider: QgsDataItemProvider)

Removes a provider implementation from the registry. The provider object is automatically deleted.

Parameters

provider (QgsDataItemProvider) –

sender(self) QObject
senderSignalIndex(self) int
timerEvent(self, QTimerEvent)