Class: QgsProviderConnectionComboBox

class qgis.gui.QgsProviderConnectionComboBox

Bases: PyQt5.QtWidgets.QComboBox

The QgsProviderConnectionComboBox class is 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.

New in version 3.14.

QgsProviderConnectionComboBox(provider: str, parent: QWidget = 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.

Methods

actionEvent

allowEmptyConnection

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

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

currentConnection

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

currentConnectionUri

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

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

initStyleOption

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

receivers

resizeEvent

sender

senderSignalIndex

setAllowEmptyConnection

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

setConnection

Sets the current connection selected in the combo box.

setProvider

Sets the provider to be used.

sharedPainter

showEvent

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

connectionChanged

Emitted whenever the currently selected connection changes.

actionEvent(self, QActionEvent)
allowEmptyConnection(self)bool

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

Return type

bool

changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
connectionChanged

Emitted whenever the currently selected connection changes. [signal]

Parameters

connection (str) –

contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
currentConnection(self)str

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

Return type

str

currentConnectionUri(self)str

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

Return type

str

customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
focusInEvent(self, QFocusEvent)
focusNextChild(self)bool
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self)bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
initStyleOption(self, QStyleOptionComboBox)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL)int
resizeEvent(self, QResizeEvent)
sender(self)QObject
senderSignalIndex(self)int
setAllowEmptyConnection(self, allowEmpty: bool)

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

Parameters

allowEmpty (bool) –

setConnection(self, connection: str)

Sets the current connection selected in the combo box.

Parameters

connection (str) –

setProvider(self, provider: str)

Sets the provider to be used.

Warning

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

Parameters

provider (str) –

sharedPainter(self)QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)