Class: QgsSourceSelectProvider

class qgis.gui.QgsSourceSelectProvider

Bases: sip.wrapper

This is the interface for those who want to add entries to the QgsDataSourceManagerDialog

Enums

Capability

Bases: enum.IntEnum

Methods

capabilities

Returns the source select provider capabilities.

createDataSourceWidget

Create a new instance of QgsAbstractDataSourceWidget (or None).

icon

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

name

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.

ordering

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

providerKey

Data Provider key

text

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

toolTip

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

Attributes

OrderDatabaseProvider

OrderLocalProvider

OrderOtherProvider

OrderRemoteProvider

OrderSearchProvider

staticMetaObject

class Capabilities
class Capabilities(f: QgsSourceSelectProvider.Capabilities | QgsSourceSelectProvider.Capability)
class Capabilities(a0: QgsSourceSelectProvider.Capabilities)

Bases: sip.wrapper

baseClass

alias of QgsSourceSelectProvider

class Capability(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: enum.IntEnum

The Capability enum describes the capabilities of the source select implementation.

Added in version 3.38.

  • NoCapabilities: No capabilities

  • ConfigureFromUri: The source select widget can be configured from a URI

ConfigureFromUri = 1
NoCapabilities = 0
baseClass

alias of QgsSourceSelectProvider

OrderDatabaseProvider = 1000
OrderLocalProvider = 0
OrderOtherProvider = 5000
OrderRemoteProvider = 2000
OrderSearchProvider = 4000
class Ordering

Bases: int

capabilities(self) QgsSourceSelectProvider.Capabilities

Returns the source select provider capabilities. The default implementation returns no capabilities.

Added in version 3.38.

Return type:

QgsSourceSelectProvider.Capabilities

createDataSourceWidget(self, parent: QWidget | None = None, fl: Qt.WindowFlags | Qt.WindowType = Qt.Widget, widgetMode: QgsProviderRegistry.WidgetMode = QgsProviderRegistry.WidgetMode.Embedded) QgsAbstractDataSourceWidget | None

Create a new instance of QgsAbstractDataSourceWidget (or None). Caller takes responsibility of deleting created.

Parameters:
  • parent (Optional[QWidget] = None)

  • fl (Union[Qt.WindowFlags)

  • widgetMode (QgsProviderRegistry.WidgetMode = QgsProviderRegistry.WidgetMode.Embedded)

Return type:

Optional[QgsAbstractDataSourceWidget]

icon(self) QIcon

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

Return type:

QIcon

name(self) str

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()

Return type:

str

ordering(self) int

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

Return type:

int

providerKey(self) str

Data Provider key

Return type:

str

staticMetaObject = <PyQt5.QtCore.QMetaObject object>
text(self) str

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

Return type:

str

toolTip(self) str

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.

Return type:

str