QGIS/python/gui/auto_generated/qgssourceselectproviderregistry.sip.in
Nyall Dawson c864d22d1f Add "get ..." to doxygen compliance blacklist
Should be "gets ..." for consistent tense, or better yet
"returns ..." for consistency.
2018-05-27 14:05:06 +10:00

81 lines
2.8 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgssourceselectproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsSourceSelectProviderRegistry
{
%Docstring
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 through
:py:func:`QgsGui.sourceSelectProviderRegistry()`
.. note::
This class access to QgsProviderRegistry instance to initialize, but QgsProviderRegistry is
typically initialized after QgsGui is constructed, for this reason a delayed initialization has been
implemented in the class.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgssourceselectproviderregistry.h"
%End
public:
QgsSourceSelectProviderRegistry();
%Docstring
Constructor for QgsSourceSelectProviderRegistry.
%End
~QgsSourceSelectProviderRegistry();
QList< QgsSourceSelectProvider *> providers();
%Docstring
Gets list of available providers
%End
void addProvider( QgsSourceSelectProvider *provider /Transfer/ );
%Docstring
Add a ``provider`` implementation. Takes ownership of the object.
%End
bool removeProvider( QgsSourceSelectProvider *provider /Transfer/ );
%Docstring
Remove ``provider`` implementation from the list (``provider`` object is deleted)
:return: true if the provider was actually removed and deleted
%End
QgsSourceSelectProvider *providerByName( const QString &name );
%Docstring
Returns a provider by ``name`` or None if not found
%End
QList<QgsSourceSelectProvider *> providersByKey( const QString &providerKey );
%Docstring
Returns a (possibly empty) list of providers by data ``providerkey``
%End
private:
QgsSourceSelectProviderRegistry( const QgsSourceSelectProviderRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgssourceselectproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/