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 specifiedprovider
andconnection
.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 forQgsDatabaseSchemaComboBox
, for the specifiedconnection
.Ownership of
connection
is transferred to the combobox.Methods
Returns
True
if the combobox allows the empty schema ("not set") choice.Returns the combobox portion of the widget.
Returns the name of the current schema selected in the combo box.
Refreshes the list of available schemas.
Sets whether an optional empty schema ("not set") option is present in the combobox.
Sets the database connection name from which to retrieve the available schemas.
Sets the current schema selected in the combo box.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- actionEvent(self, QActionEvent)¶
- allowEmptySchema(self) bool ¶
Returns
True
if the combobox allows the empty schema (“not set”) choice.See also
- 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: PyQt5.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], PyQt5.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¶
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
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setAllowEmptySchema(self, allowEmpty: bool)¶
Sets whether an optional empty schema (“not set”) option is present in the combobox.
See also
- 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) –
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶