mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-18 00:06:00 -04:00
24eb319af2
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()
73 lines
2.9 KiB
Plaintext
73 lines
2.9 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgssubsetstringeditorprovider.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsSubsetStringEditorProvider
|
|
{
|
|
%Docstring
|
|
This is the interface for those who want to provide a dialog to edit a
|
|
subset string.
|
|
|
|
.. versionadded:: 3.18
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgssubsetstringeditorprovider.h"
|
|
%End
|
|
public:
|
|
virtual ~QgsSubsetStringEditorProvider();
|
|
|
|
virtual QString providerKey() const = 0;
|
|
%Docstring
|
|
Provider key
|
|
%End
|
|
|
|
virtual QString name() const;
|
|
%Docstring
|
|
Subset string editor provider name, this is useful to retrieve
|
|
a particular subset string editor in case the provider has more
|
|
than one, it should be unique among all providers.
|
|
|
|
The default implementation returns the :py:func:`~QgsSubsetStringEditorProvider.providerKey`
|
|
%End
|
|
|
|
virtual bool canHandleLayer( QgsVectorLayer *layer ) const = 0;
|
|
%Docstring
|
|
Returns true if the provider can handle the layer
|
|
%End
|
|
|
|
virtual bool canHandleLayerStorageType( QgsVectorLayer *layer ) const;
|
|
%Docstring
|
|
Returns true if the provider can handle specifically the
|
|
layer->:py:func:`~QgsSubsetStringEditorProvider.provider`->:py:func:`~QgsSubsetStringEditorProvider.storageType`
|
|
This method will only be called if :py:func:`~QgsSubsetStringEditorProvider.canHandleLayer` returned true.
|
|
Typically a generic SQL provider for the OGR provider will return false,
|
|
whereas a dedicated plugin with a specific behavior for a OGR driver
|
|
will return true.
|
|
%End
|
|
|
|
virtual QgsSubsetStringEditorInterface *createDialog( QgsVectorLayer *layer, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags ) = 0 /Factory/;
|
|
%Docstring
|
|
Creates a new dialog to edit the subset string of the provided ``layer``.
|
|
It may return None if it cannot handle the layer.
|
|
The returned object must be destroyed by the caller.
|
|
On successful :py:func:`~QgsSubsetStringEditorProvider.accept`, the QgsSubsetStringEditorInterface implementation
|
|
is responsible for setting the updated string on layer.
|
|
%End
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgssubsetstringeditorprovider.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|