Subgroup: Source
Class: QgsSourceSelectProvider¶
-
class
qgis.gui.
QgsSourceSelectProvider
¶ Bases:
sip.wrapper
This is the interface for those who want to add entries to the QgsDataSourceManagerDialog
New in version 3.0: Methods
createDataSourceWidget
Create a new instance of QgsAbstractDataSourceWidget
(or null).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 Signals
Attributes
OrderDatabaseProvider
OrderGeoCmsProvider
OrderLocalProvider
OrderOtherProvider
OrderRemoteProvider
-
OrderDatabaseProvider
= 1000¶
-
OrderGeoCmsProvider
= 3000¶
-
OrderLocalProvider
= 0¶
-
OrderOtherProvider
= 4000¶
-
OrderRemoteProvider
= 2000¶
-
class
Ordering
¶ Bases:
int
-
createDataSourceWidget
(self, parent: QWidget = None, fl: Union[Qt.WindowFlags, Qt.WindowType] = Qt.Widget, widgetMode: QgsProviderRegistry.WidgetMode = QgsProviderRegistry.WidgetMode.Embedded) → QgsAbstractDataSourceWidget¶ Create a new instance of
QgsAbstractDataSourceWidget
(or null). Caller takes responsibility of deleting created.
-
icon
(self) → QIcon¶ Creates a new instance of an QIcon for the menu item entry
-
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()
-
ordering
(self) → int¶ Ordering: the source select provider registry will be able to sort the source selects (ascending) using this integer value
-
providerKey
(self) → str¶ Data Provider key
-
text
(self) → str¶ Text for the menu item entry, it will be visible to the user so make sure it’s translatable
-
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.
-