Class: QgsDatabaseTableComboBox¶

class qgis.gui.QgsDatabaseTableComboBox(provider: str, connection: str, schema: str = '', parent: QWidget = None)¶

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsDatabaseTableComboBox, for the specified provider and connection.

The optional schema argument can be used to restrict the listed tables to a specific schema.

Warning

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

QgsDatabaseTableComboBox(connection: QgsAbstractDatabaseProviderConnection, schema: str = ‘’, parent: QWidget = None) Constructor for QgsDatabaseTableComboBox, for the specified connection.

The optional schema argument can be used to restrict the listed tables to a specific schema.

Ownership of connection is transferred to the combobox.

The QgsDatabaseTableComboBox class is a combo box which displays the list of tables for a specific database connection.

Warning

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

New in version 3.14.

Parameters

provider (str) –
connection (str) –
schema (str = '') –
parent –

actionEvent(self, QActionEvent)¶

allowEmptyTable(self) → bool¶

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

See also

setAllowEmptyTable()

Return type: bool

changeEvent(self, QEvent)¶

childEvent(self, QChildEvent)¶

closeEvent(self, QCloseEvent)¶

comboBox(self) → QComboBox¶

Returns the combobox portion of the widget.

Return type: QComboBox

connectNotify(self, QMetaMethod)¶

contextMenuEvent(self, QContextMenuEvent)¶

create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶

currentSchema(self) → str¶

Returns the schema of the current table selected in the combo box.

Return type: str

currentTable(self) → str¶

Returns the name of the current table 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)¶

event(self, QEvent) → bool¶

focusInEvent(self, QFocusEvent)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, bool) → bool¶

focusOutEvent(self, QFocusEvent)¶

focusPreviousChild(self) → bool¶

hideEvent(self, QHideEvent)¶

initPainter(self, QPainter)¶

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¶

refreshTables(self)¶: Refreshes the list of available tables.

resizeEvent(self, QResizeEvent)¶

sender(self) → QObject¶

senderSignalIndex(self) → int¶

setAllowEmptyTable(self, allowEmpty: bool)¶

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