Class: QgsRelationEditorWidget¶

The default relation widget in QGIS.

Added in version 3.18.

Class Hierarchy¶

Base classes¶

`QgsAbstractRelationEditorWidget`	Base class to build new relation widgets.
QWidget
QObject
QPaintDevice

Methods

`config`	Returns the current configuration
`deleteSelectedFeatures`	Deletes the currently selected features
`duplicateFeature`	Duplicates a feature
`duplicateSelectedFeatures`	Duplicates the selected features
`featureSelectionManager`	The feature selection manager is responsible for the selected features which are currently being edited.
`setConfig`	Defines the current configuration
`setViewMode`	Define the view mode for the dual view
`setVisibleButtons`	Defines the buttons which are shown
`unlinkSelectedFeatures`	Unlinks the selected features from the relation
`viewMode`	Gets the view mode for the dual view
`visibleButtons`	Returns the buttons which are shown
`zoomToSelectedFeatures`	Zooms to the selected features

Attributes

`AddChildFeature`
`AllButtons`
`DeleteChildFeature`
`DuplicateChildFeature`
`Link`
`NoButton`
`SaveChildEdits`
`Unlink`
`ZoomToChildFeature`

class qgis.gui.QgsRelationEditorWidget[source]¶

Bases: QgsAbstractRelationEditorWidget

__init__(config: Dict[str, Any], parent: QWidget | None = None)

Constructor

Parameters:

config (Dict[str, Any]) – widget configuration
parent (Optional[QWidget] = None) – parent widget

AddChildFeature = 16¶

AllButtons = 254¶

class Button¶: Bases: int

class Buttons¶
class Buttons(f: QgsRelationEditorWidget.Buttons | QgsRelationEditorWidget.Button)
class Buttons(a0: QgsRelationEditorWidget.Buttons): Bases: object

DeleteChildFeature = 64¶

DuplicateChildFeature = 32¶

Link = 2¶

NoButton = 0¶

SaveChildEdits = 8¶

Unlink = 4¶

ZoomToChildFeature = 128¶

config(self) → Dict[str, Any][source]¶

Returns the current configuration

Return type:: Dict[str, Any]

deleteSelectedFeatures(self)[source]¶: Deletes the currently selected features

duplicateFeature(self)[source]¶: Duplicates a feature

Deprecated since version 3.18: Use duplicateSelectedFeatures() instead.

duplicateSelectedFeatures(self)[source]¶: Duplicates the selected features

Added in version 3.18.

featureSelectionManager(self) → QgsIFeatureSelectionManager | None[source]¶

The feature selection manager is responsible for the selected features which are currently being edited.

Return type:: Optional[QgsIFeatureSelectionManager]

setConfig(self, config: Dict[str, Any])[source]¶

Defines the current configuration

Parameters:: config (Dict[str, Any])

setViewMode(self, mode: QgsDualView.ViewMode)[source]¶

Define the view mode for the dual view

Parameters:: mode (QgsDualView.ViewMode)

setVisibleButtons(self, buttons: QgsRelationEditorWidget.Buttons | QgsRelationEditorWidget.Button)[source]¶

Defines the buttons which are shown

Parameters:: buttons (Union[QgsRelationEditorWidget.Buttons, QgsRelationEditorWidget.Button])

unlinkSelectedFeatures(self)[source]¶: Unlinks the selected features from the relation

viewMode(self) → QgsDualView.ViewMode[source]¶

Gets the view mode for the dual view

Return type:: QgsDualView.ViewMode

visibleButtons(self) → QgsRelationEditorWidget.Buttons[source]¶

Returns the buttons which are shown

Return type:: QgsRelationEditorWidget.Buttons

zoomToSelectedFeatures(self)[source]¶: Zooms to the selected features