Class: QgsRelationEditorWidget

The default relation widget in QGIS.

Added in version 3.18.

List of all members, including inherited members

Class Hierarchy

Base classes

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

Enums

Button

Abstract Methods

config	Returns the current configuration
setConfig	Defines the current configuration

Methods

Buttons
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.
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

class qgis.gui.QgsRelationEditorWidget

Bases: QgsAbstractRelationEditorWidget

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

Constructor

Parameters:

• config (dict[Optional[str], Any]) – widget configuration

• parent (Optional[QWidget] = None) – parent widget

AddChildFeature = 16

AllButtons = 254

class Button(*values)

Bases: IntEnum

AddChildFeature = 16

AllButtons = 254

DeleteChildFeature = 64

DuplicateChildFeature = 32

Link = 2

NoButton = 0

SaveChildEdits = 8

Unlink = 4

ZoomToChildFeature = 128

Buttons()

DeleteChildFeature = 64

DuplicateChildFeature = 32

Link = 2

NoButton = 0

SaveChildEdits = 8

Unlink = 4

ZoomToChildFeature = 128

abstract config(self) → dict[str, Any]

Returns the current configuration

Return type:

dict[str, Any]

deleteSelectedFeatures(self)

Deletes the currently selected features

duplicateFeature(self)

Duplicates a feature

Deprecated since version 3.18: Use duplicateSelectedFeatures() instead.

duplicateSelectedFeatures(self)

Duplicates the selected features

Added in version 3.18.

featureSelectionManager(self) → QgsIFeatureSelectionManager | None

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

Return type:

Optional[QgsIFeatureSelectionManager]

abstract setConfig(self, config: dict[str | None, Any])

Defines the current configuration

Parameters:

config (dict[Optional[str], Any])

setViewMode(self, mode: QgsDualView.ViewMode)

Define the view mode for the dual view

Parameters:

mode (QgsDualView.ViewMode)

setVisibleButtons(self, buttons: QgsRelationEditorWidget.Button)

Defines the buttons which are shown

Parameters:

buttons (QgsRelationEditorWidget.Button)

unlinkSelectedFeatures(self)

Unlinks the selected features from the relation

viewMode(self) → QgsDualView.ViewMode

Gets the view mode for the dual view

Return type:

QgsDualView.ViewMode

visibleButtons(self) → QgsRelationEditorWidget.Button

Returns the buttons which are shown

Return type:

QgsRelationEditorWidget.Button

zoomToSelectedFeatures(self)

Zooms to the selected features