QgsLayerMetadataSourceSelectProvider Class Reference

Source select provider for layer metadata. More...

#include <qgslayermetadatasourceselectprovider.h>

Inheritance diagram for QgsLayerMetadataSourceSelectProvider:

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

Additional Inherited Members
Public Types inherited from QgsSourceSelectProvider
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...

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 45 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 40 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 50 of file qgslayermetadatasourceselectprovider.cpp.

providerKey()

QString QgsLayerMetadataSourceSelectProvider::providerKey ( ) const

overridevirtual

Data Provider key.

Implements QgsSourceSelectProvider.

Definition at line 25 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 30 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 35 of file qgslayermetadatasourceselectprovider.cpp.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgslayermetadatasourceselectprovider.h
• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgslayermetadatasourceselectprovider.cpp