Class: QgsDatabaseSchemaComboBox

class qgis.gui.QgsDatabaseSchemaComboBox

Bases: PyQt5.QtWidgets.QWidget

The QgsDatabaseSchemaComboBox class is a combo box which displays the list of schemas 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.

QgsDatabaseSchemaComboBox(provider: str, connection: str, parent: QWidget = None) Constructor for QgsDatabaseSchemaComboBox, for the specified provider and connection.

Warning

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

QgsDatabaseSchemaComboBox(connection: QgsAbstractDatabaseProviderConnection, parent: QWidget = None) Constructor for QgsDatabaseSchemaComboBox, for the specified connection.

Ownership of connection is transferred to the combobox.

Methods

actionEvent

allowEmptySchema

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

changeEvent

childEvent

closeEvent

comboBox

Returns the combobox portion of the widget.

connectNotify

contextMenuEvent

create

currentSchema

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

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

receivers

refreshSchemas

Refreshes the list of available schemas.

resizeEvent

sender

senderSignalIndex

setAllowEmptySchema

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

setConnectionName

Sets the database connection name from which to retrieve the available schemas.

setSchema

Sets the current schema selected in the combo box.

sharedPainter

showEvent

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

schemaChanged

Emitted whenever the currently selected schema changes.

actionEvent(self, QActionEvent)
allowEmptySchema(self)bool

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

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 name of the current schema 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
refreshSchemas(self)

Refreshes the list of available schemas.

resizeEvent(self, QResizeEvent)
schemaChanged

Emitted whenever the currently selected schema changes. [signal]

Parameters

schema (str) –

sender(self)QObject
senderSignalIndex(self)int
setAllowEmptySchema(self, allowEmpty: bool)

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

Parameters

allowEmpty (bool) –

setConnectionName(self, connection: str, provider: str = '')

Sets the database connection name from which to retrieve the available schemas.

Optionally the provider can be reset too.

Parameters
  • connection (str) –

  • provider (str = '') –

setSchema(self, schema: str)

Sets the current schema selected in the combo box.

Parameters

schema (str) –

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