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

Methods

isValid	Returns True if the widget currently represents a valid relationship configuration.
relationship	Returns the relationship as defined in the widget.
setRelationship	Sets the current relationship to show properties for in the widget.

Signals

validityChanged

Emitted whenever the validity of the relationship configuration in the widget changes.

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(isValid: bool)

Emitted whenever the validity of the relationship configuration in the widget changes.

See also

isValid()

Parameters:

isValid (bool)