1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgssubsetstringeditorproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsSubsetStringEditorProviderRegistry
{
%Docstring(signature="appended")
This class keeps a list of subset string editor providers.
:py:class:`QgsSubsetStringEditorProviderRegistry` is not usually directly created, but rather accessed through
:py:func:`QgsGui.subsetStringEditorProvideRegistry()`.
.. versionadded:: 3.18
%End
%TypeHeaderCode
#include "qgssubsetstringeditorproviderregistry.h"
%End
public:
QgsSubsetStringEditorProviderRegistry();
~QgsSubsetStringEditorProviderRegistry();
QList< QgsSubsetStringEditorProvider *> providers();
%Docstring
Gets list of available providers
%End
void addProvider( QgsSubsetStringEditorProvider *provider /Transfer/ );
%Docstring
Add a ``provider`` implementation. Takes ownership of the object.
%End
bool removeProvider( QgsSubsetStringEditorProvider *provider /Transfer/ );
%Docstring
Remove ``provider`` implementation from the list (``provider`` object is deleted)
:return: ``True`` if the provider was actually removed and deleted
%End
void initializeFromProviderGuiRegistry( QgsProviderGuiRegistry *providerGuiRegistry );
%Docstring
Initializes the registry. The registry needs to be passed explicitly
(instead of using singleton) because this gets called from :py:class:`QgsGui` constructor.
%End
QgsSubsetStringEditorProvider *providerByName( const QString &name );
%Docstring
Returns a provider by ``name`` or ``None`` if not found
%End
QList<QgsSubsetStringEditorProvider *> providersByKey( const QString &providerKey );
%Docstring
Returns a (possibly empty) list of providers by data ``providerkey``
%End
QgsSubsetStringEditorInterface *createDialog( QgsVectorLayer *layer, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags ) /TransferBack/;
%Docstring
Creates a new dialog to edit the subset string of the provided ``layer``.
It will default to returning a :py:class:`QgsQueryBuilder`* if no provider was found.
The returned object must be destroyed by the caller.
%End
private:
QgsSubsetStringEditorProviderRegistry( const QgsSubsetStringEditorProviderRegistry &rh );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgssubsetstringeditorproviderregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|