Class: QgsDatabaseSchemaComboBox

class qgis.gui.QgsDatabaseSchemaComboBox(provider: str, connection: str, parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

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.

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.

Parameters
  • provider (str) –

  • connection (str) –

  • parent

actionEvent()
allowEmptySchema(self) → bool

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

Return type

bool

changeEvent()
childEvent()
closeEvent()
comboBox(self) → QComboBox

Returns the combobox portion of the widget.

Return type

QComboBox

connectNotify()
contextMenuEvent()
create()
currentSchema(self) → str

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

Return type

str

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(self)

Refreshes the list of available schemas.

resizeEvent()
schemaChanged

Emitted whenever the currently selected schema changes. [signal]

Parameters

schema (str) –

sender()
senderSignalIndex()
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()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()