QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | List of all members
QgsLayerMetadataSourceSelectProvider Class Reference

Source select provider for layer metadata. More...

#include <qgslayermetadatasourceselectprovider.h>

Inheritance diagram for QgsLayerMetadataSourceSelectProvider:
Inheritance graph
[legend]

Public Member Functions

 QgsLayerMetadataSourceSelectProvider ()
 
QgsAbstractDataSourceWidgetcreateDataSourceWidget (QWidget *parent, Qt::WindowFlags fl, QgsProviderRegistry::WidgetMode widgetMode) const override
 Create a new instance of QgsAbstractDataSourceWidget (or nullptr). More...
 
QIcon icon () const override
 Creates a new instance of an QIcon for the menu item entry. More...
 
int ordering () const override
 Ordering: the source select provider registry will be able to sort the source selects (ascending) using this integer value. More...
 
QString providerKey () const override
 Data Provider key. More...
 
QString text () const override
 Text for the menu item entry, it will be visible to the user so make sure it's translatable. More...
 
QString toolTip () const override
 Text for the tooltip menu item entry, it will be visible to the user so make sure it's translatable. More...
 
- Public Member Functions inherited from QgsSourceSelectProvider
virtual ~QgsSourceSelectProvider ()=default
 
virtual Capabilities capabilities ()
 Returns the source select provider capabilities. More...
 
virtual QgsAbstractDataSourceWidgetcreateDataSourceWidget (QWidget *parent=nullptr, Qt::WindowFlags fl=Qt::Widget, QgsProviderRegistry::WidgetMode widgetMode=QgsProviderRegistry::WidgetMode::Embedded) const =0
 Create a new instance of QgsAbstractDataSourceWidget (or nullptr). More...
 
virtual QIcon icon () const =0
 Creates a new instance of an QIcon for the menu item entry. More...
 
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. More...
 
virtual int ordering () const
 Ordering: the source select provider registry will be able to sort the source selects (ascending) using this integer value. More...
 
virtual QString providerKey () const =0
 Data Provider key. More...
 
virtual QString text () const =0
 Text for the menu item entry, it will be visible to the user so make sure it's translatable. More...
 
virtual QString toolTip () const
 Text for the tooltip menu item entry, it will be visible to the user so make sure it's translatable. More...
 

Additional Inherited Members

- Public Types inherited from QgsSourceSelectProvider
typedef QFlags< CapabilityCapabilities
 
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...
 

Detailed Description

Source select provider for layer metadata.

Note
Not available in Python bindings
Since
QGIS 3.28

Definition at line 32 of file qgslayermetadatasourceselectprovider.h.

Constructor & Destructor Documentation

◆ QgsLayerMetadataSourceSelectProvider()

QgsLayerMetadataSourceSelectProvider::QgsLayerMetadataSourceSelectProvider ( )

Definition at line 20 of file qgslayermetadatasourceselectprovider.cpp.

Member Function Documentation

◆ createDataSourceWidget()

QgsAbstractDataSourceWidget * QgsLayerMetadataSourceSelectProvider::createDataSourceWidget ( QWidget *  parent,
Qt::WindowFlags  fl,
QgsProviderRegistry::WidgetMode  widgetMode 
) const
overridevirtual

Create a new instance of QgsAbstractDataSourceWidget (or nullptr).

Caller takes responsibility of deleting created.

Implements QgsSourceSelectProvider.

Definition at line 47 of file qgslayermetadatasourceselectprovider.cpp.

◆ icon()

QIcon QgsLayerMetadataSourceSelectProvider::icon ( ) const
overridevirtual

Creates a new instance of an QIcon for the menu item entry.

Implements QgsSourceSelectProvider.

Definition at line 42 of file qgslayermetadatasourceselectprovider.cpp.

◆ ordering()

int QgsLayerMetadataSourceSelectProvider::ordering ( ) const
overridevirtual

Ordering: the source select provider registry will be able to sort the source selects (ascending) using this integer value.

Reimplemented from QgsSourceSelectProvider.

Definition at line 52 of file qgslayermetadatasourceselectprovider.cpp.

◆ providerKey()

QString QgsLayerMetadataSourceSelectProvider::providerKey ( ) const
overridevirtual

Data Provider key.

Implements QgsSourceSelectProvider.

Definition at line 26 of file qgslayermetadatasourceselectprovider.cpp.

◆ text()

QString QgsLayerMetadataSourceSelectProvider::text ( ) const
overridevirtual

Text for the menu item entry, it will be visible to the user so make sure it's translatable.

Implements QgsSourceSelectProvider.

Definition at line 32 of file qgslayermetadatasourceselectprovider.cpp.

◆ toolTip()

QString QgsLayerMetadataSourceSelectProvider::toolTip ( ) const
overridevirtual

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 from QgsSourceSelectProvider.

Definition at line 37 of file qgslayermetadatasourceselectprovider.cpp.


The documentation for this class was generated from the following files: