Class: QgsDbRelationWidget

A widget for configuration of the properties of a relationship in a database.

Added in version 3.30.

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

class qgis.gui.QgsDbRelationWidget

Bases: QWidget

__init__(connection: QgsAbstractDatabaseProviderConnection | None, parent: QWidget | None = None)

Constructor for QgsDbRelationWidget with the specified parent widget, for the specified connection.

Ownership of connection is transferred to the widget.

Parameters:

• connection (Optional[QgsAbstractDatabaseProviderConnection])

• parent (Optional[QWidget] = None)

isValid(self) → bool

Returns True if the widget currently represents a valid relationship configuration.

See also

validityChanged()

Return type:

bool

relationship(self) → QgsWeakRelation

Returns the relationship as defined in the widget.

See also

setRelationship()

Return type:

QgsWeakRelation

setRelationship(self, relationship: QgsWeakRelation)

Sets the current relationship to show properties for in the widget.

See also

relationship()

Parameters:

relationship (QgsWeakRelation)

signal validityChanged

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.