QGIS/python/gui/auto_generated/qgsproviderguimetadata.sip.in
Nyall Dawson d5c3b4b8a5 Add API to allow creation of widgets for customising a layer's source
This adds api in the provider gui to allow a provider to create a custom
widget which exposes options to customise and change the layer's source.

E.g. a file based layer provider could expose a widget for selecting
a new file path, and an online one could expose widgets for changing
the host, authentication, etc.
2020-12-26 09:51:34 +10:00

104 lines
2.8 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsproviderguimetadata.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProviderGuiMetadata
{
%Docstring
Holds data for GUI part of the data providers
.. versionadded:: 3.10
%End
%TypeHeaderCode
#include "qgsproviderguimetadata.h"
%End
public:
explicit QgsProviderGuiMetadata( const QString &key );
%Docstring
Constructor for provider gui metadata
%End
virtual ~QgsProviderGuiMetadata();
virtual void registerGui( QMainWindow *widget );
%Docstring
Called during GUI initialization - allows provider to do its internal initialization
of GUI components, possibly making use of the passed pointer to the QGIS main window.
%End
virtual QList<QgsDataItemGuiProvider *> dataItemGuiProviders() /Factory/;
%Docstring
Returns data item gui providers
.. note::
Ownership of created data item gui providers is passed to the caller.
%End
virtual QList<QgsProjectStorageGuiProvider *> projectStorageGuiProviders() /Factory/;
%Docstring
Returns project storage gui providers
.. note::
Ownership of created project storage gui providers is passed to the caller.
%End
virtual QList<QgsSourceSelectProvider *> sourceSelectProviders() /Factory/;
%Docstring
Returns source select providers
.. note::
Ownership of created source select providers is passed to the caller.
%End
virtual QList<QgsSubsetStringEditorProvider *> subsetStringEditorProviders() /Factory/;
%Docstring
Returns subset string editor providers
.. note::
Ownership of created providers is passed to the caller.
.. versionadded:: 3.18
%End
virtual QList<QgsProviderSourceWidgetProvider *> sourceWidgetProviders() /Factory/;
%Docstring
Returns source widget providers
.. note::
Ownership of created providers is passed to the caller.
.. versionadded:: 3.18
%End
QString key() const;
%Docstring
Returns unique provider key
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsproviderguimetadata.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/