QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
This is the interface for those who want to add entries to the QgsDataSourceManagerDialog. More...
#include <qgssourceselectprovider.h>
Public Types | |
typedef QFlags< Capability > | Capabilities |
enum class | Capability : int { NoCapabilities = 0 , ConfigureFromUri = 1 } |
The Capability enum describes the capabilities of the source select implementation. More... | |
enum | Ordering { OrderLocalProvider = 0 , OrderDatabaseProvider = 1000 , OrderRemoteProvider = 2000 , OrderSearchProvider = 4000 , OrderOtherProvider = 5000 } |
Provider ordering groups. More... | |
Public Member Functions | |
virtual | ~QgsSourceSelectProvider ()=default |
virtual Capabilities | capabilities () |
Returns the source select provider capabilities. | |
virtual QgsAbstractDataSourceWidget * | createDataSourceWidget (QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::Widget, QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::Embedded) const =0 |
Create a new instance of QgsAbstractDataSourceWidget (or nullptr ). | |
virtual QIcon | icon () const =0 |
Creates a new instance of an QIcon for the menu item entry. | |
virtual QString | name () const |
Source select provider name, this is useful to retrieve a particular source select in case the provider has more than one, it should be unique among all providers. | |
virtual int | ordering () const |
Ordering: the source select provider registry will be able to sort the source selects (ascending) using this integer value. | |
virtual QString | providerKey () const =0 |
Data Provider key. | |
virtual QString | text () const =0 |
Text for the menu item entry, it will be visible to the user so make sure it's translatable. | |
virtual QString | toolTip () const |
Text for the tooltip menu item entry, it will be visible to the user so make sure it's translatable. | |
This is the interface for those who want to add entries to the QgsDataSourceManagerDialog.
Definition at line 34 of file qgssourceselectprovider.h.
typedef QFlags< Capability > QgsSourceSelectProvider::Capabilities |
Definition at line 61 of file qgssourceselectprovider.h.
|
strong |
The Capability enum describes the capabilities of the source select implementation.
Enumerator | |
---|---|
NoCapabilities | No capabilities. |
ConfigureFromUri | The source select widget can be configured from a URI. |
Definition at line 54 of file qgssourceselectprovider.h.
Provider ordering groups.
Definition at line 41 of file qgssourceselectprovider.h.
|
virtualdefault |
|
inlinevirtual |
Returns the source select provider capabilities.
The default implementation returns no capabilities.
Definition at line 108 of file qgssourceselectprovider.h.
|
pure virtual |
Create a new instance of QgsAbstractDataSourceWidget (or nullptr
).
Caller takes responsibility of deleting created.
Implemented in QgsLayerMetadataSourceSelectProvider.
|
pure virtual |
Creates a new instance of an QIcon for the menu item entry.
Implemented in QgsLayerMetadataSourceSelectProvider.
|
inlinevirtual |
Source select provider name, this is useful to retrieve a particular source select in case the provider has more than one, it should be unique among all providers.
The default implementation returns the providerKey()
Definition at line 76 of file qgssourceselectprovider.h.
|
inlinevirtual |
Ordering: the source select provider registry will be able to sort the source selects (ascending) using this integer value.
Reimplemented in QgsLayerMetadataSourceSelectProvider.
Definition at line 95 of file qgssourceselectprovider.h.
|
pure virtual |
Data Provider key.
Implemented in QgsLayerMetadataSourceSelectProvider.
|
pure virtual |
Text for the menu item entry, it will be visible to the user so make sure it's translatable.
Implemented in QgsLayerMetadataSourceSelectProvider.
|
inlinevirtual |
Text for the tooltip menu item entry, it will be visible to the user so make sure it's translatable.
The default implementation returns an empty string.
Reimplemented in QgsLayerMetadataSourceSelectProvider.
Definition at line 86 of file qgssourceselectprovider.h.