QGIS/python/gui/auto_generated/qgsproviderguiregistry.sip.in
Even Rouault 24eb319af2 [FEATURE] Add a subset string editor provider concept and registry
The aim of this work is to be able to provide custom subset string editor
GUI according to the layer. Typically, so that a WFS layer uses the same
editor than in its select source, or that a plugin can provide a custom
editor.

* Add QgsSubsetStringEditorInterface: abstract interface to define a dialog
  that can edit a subset string
* Make QgsQueryBuilder implement QgsSubsetStringEditorInterface
* Add QgsSubsetStringEditorProvider: interface for thos who want to provide
  a dialog to edit a subset string.
* Add QgsSubsetStringEditorProviderRegistry: keeps a list of subset string
  editor providers. Transposed from QgsDataItemGuiProviderRegistry
* Add QgsGui::subsetStringEditorProviderRegistry()
2020-11-16 11:09:06 +10:00

105 lines
3.3 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsproviderguiregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProviderGuiRegistry
{
%Docstring
A registry / canonical manager of GUI parts of data providers.
QgsProviderGuiRegistry is not usually directly created, but rather accessed through
:py:func:`QgsGui.providerGuiRegistry()`.
:py:func:`~setPluginPath` should be called (once) to load dynamic providers. Static providers are
loaded in constructor.
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgsproviderguiregistry.h"
%End
public:
QgsProviderGuiRegistry( const QString &pluginPath );
%Docstring
Creates registry and loads static provider plugins
%End
virtual ~QgsProviderGuiRegistry();
QStringList providerList() const;
%Docstring
Returns list of available providers by their keys
%End
const QgsProviderGuiMetadata *providerMetadata( const QString &providerKey ) const;
%Docstring
Returns metadata of the provider or ``None`` if not found
%End
void registerGuis( QMainWindow *widget );
%Docstring
Called during GUI initialization - allows providers to do its internal initialization
of GUI components, possibly making use of the passed pointer to the QGIS main window.
%End
virtual const QList<QgsDataItemGuiProvider *> dataItemGuiProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all data item gui providers registered in provider with ``providerKey``
.. note::
Ownership of created data item providers is passed to the caller.
%End
virtual QList<QgsSourceSelectProvider *> sourceSelectProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all source select providers registered in provider with ``providerKey``
.. note::
Ownership of created source select providers is passed to the caller.
%End
virtual QList<QgsProjectStorageGuiProvider *> projectStorageGuiProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all project storage gui providers registered in provider with ``providerKey``
.. note::
Ownership of created project storage gui providers is passed to the caller.
%End
virtual QList<QgsSubsetStringEditorProvider *> subsetStringEditorProviders( const QString &providerKey ) /Factory/;
%Docstring
Returns all subset string editor providers registered in provider with ``providerKey``
.. note::
Ownership of providers is passed to the caller.
.. versionadded:: 3.18
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsproviderguiregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/