QGIS/python/core/auto_generated/browser/qgsdataitemproviderregistry.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

100 lines
2.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/browser/qgsdataitemproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsDataItemProviderRegistry : QObject
{
%Docstring(signature="appended")
A registry for data item providers that may add items to the browser
tree.
When created, it automatically adds providers from provider plugins
(e.g. PostGIS, WMS, ...)
:py:class:`QgsDataItemProviderRegistry` is not usually directly created,
but rather accessed through
:py:func:`QgsApplication.dataItemProviderRegistry()`.
%End
%TypeHeaderCode
#include "qgsdataitemproviderregistry.h"
%End
public:
QgsDataItemProviderRegistry();
~QgsDataItemProviderRegistry();
QList<QgsDataItemProvider *> providers() const;
%Docstring
Returns the list of available providers.
%End
QgsDataItemProvider *provider( const QString &providerName ) const;
%Docstring
Returns the (possibly ``None``) data item provider named
``providerName``
.. versionadded:: 3.14
%End
void addProvider( QgsDataItemProvider *provider /Transfer/ );
%Docstring
Adds a ``provider`` implementation to the registry. Ownership of the
provider is transferred to the registry.
%End
void removeProvider( QgsDataItemProvider *provider );
%Docstring
Removes a ``provider`` implementation from the registry. The provider
object is automatically deleted.
%End
QString dataProviderKey( const QString &dataItemProviderName );
%Docstring
Returns the (possibly blank) data provider key for a given data item
provider name.
:param dataItemProviderName: name of the data item provider
.. versionadded:: 3.14
%End
signals:
void providerAdded( QgsDataItemProvider *provider );
%Docstring
Emitted when a new data item provider has been added.
.. versionadded:: 3.14
%End
void providerWillBeRemoved( QgsDataItemProvider *provider );
%Docstring
Emitted when a data item provider is about to be removed
.. versionadded:: 3.14
%End
private:
QgsDataItemProviderRegistry( const QgsDataItemProviderRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/browser/qgsdataitemproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/