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 specifiedprovider
.Warning
The provider must support the connection API methods in its
QgsProviderMetadata
implementation in order for the model to work correctly.Methods
Returns
True
if the combobox allows the empty connection ("not set") choice.Returns the name of the current connection selected in the combo box.
Returns the uri of the current connection selected in the combo box.
Sets whether an optional empty connection ("not set") option is present in the combobox.
Sets the current connection selected in the combo box.
Sets the provider to be used.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- actionEvent(self, QActionEvent)¶
- allowEmptyConnection(self) bool ¶
Returns
True
if the combobox allows the empty connection (“not set”) choice.See also
- Return type:
bool
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- connectionChanged¶
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.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: PyQt5.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], PyQt5.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.
See also
- 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) –
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶