Class: QgsProviderConnectionComboBox¶

A combo box which displays the list of connections registered for a given provider.

Warning

The provider must support the connection API methods in its QgsProviderMetadata implementation in order for the model to work correctly.

Added in version 3.14.

Class Hierarchy¶

Base classes¶

QComboBox
QWidget
QObject
QPaintDevice

class qgis.gui.QgsProviderConnectionComboBox[source]¶

Bases: QComboBox

__init__(provider: str | None, parent: QWidget | None = None)

Constructor for QgsProviderConnectionComboBox, for the specified provider.

Warning

The provider must support the connection API methods in its QgsProviderMetadata implementation in order for the model to work correctly.

Parameters:

provider (Optional[str])
parent (Optional[QWidget] = None)

allowEmptyConnection(self) → bool[source]¶

Returns True if the combobox allows the empty connection (“not set”) choice.

See also

setAllowEmptyConnection()

Return type:: bool

signal connectionChanged[source]¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

currentConnection(self) → str[source]¶

Returns the name of the current connection selected in the combo box.

Return type:: str

currentConnectionUri(self) → str[source]¶

Returns the uri of the current connection selected in the combo box.

Return type:: str

setAllowEmptyConnection(self, allowEmpty: bool)[source]¶

Sets whether an optional empty connection (“not set”) option is present in the combobox.