QGIS/python/core/auto_generated/qgsdataitemproviderregistry.sip.in
Martin Dobias 0633989524 [browser] React when a custom data item provider is added/removed
Until now, if a plugin adds a custom data item provider that adds
a root item to the browser model, the new root data item would not
get added and a restart of QGIS was necessary.
2020-04-21 08:20:08 +10:00

96 lines
2.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsdataitemproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsDataItemProviderRegistry : QObject
{
%Docstring
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
:py:func:`QgsApplication.dataItemProviderRegistry()`
.. versionadded:: 2.10
%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 NULL) 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/qgsdataitemproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/