Class: QgsAbstractRelationEditorWidget¶

Base class to build new relation widgets.

Added in version 3.18.

Class Hierarchy¶

Base classes¶

QWidget
QObject
QPaintDevice

Subclasses¶

QgsRelationEditorWidget

The default relation widget in QGIS.

Methods

`addFeature`	Adds new features with given geometry
`afterSetRelationFeature`	A hook called right after `setRelationFeature()` is executed, but before `updateUi()` is called.
`afterSetRelations`	A hook called right after `setRelations()` is executed, but before `updateUi()` is called.
`beforeSetRelationFeature`	A hook called right before `setRelationFeature()` is executed.
`beforeSetRelations`	A hook called right before `setRelations()` is executed.
`config`	Returns the widget configuration
`deleteFeature`	Delete a feature with given fid
`deleteFeatures`	Deletes the features with fids
`duplicateFeature`	Duplicates a feature
`duplicateFeatures`	Duplicates features
`editorContext`	Returns the attribute editor context.
`feature`	Returns the widget's current feature If the widget is in multiedit mode only the first is returned
`features`	Returns the widget's current features
`forceSuppressFormPopup`	Determines the force suppress form popup status that is configured for this widget
`label`	Determines the label of this element
`linkFeature`	Links a new feature to the relation
`multiEditModeActive`	Returns true if editing multiple features at a time
`nmRelation`	Returns the nm relation
`nmRelationId`	Determines the relation id of the second relation involved in an N:M relation.
`onLinkFeatureDlgAccepted`	Called when the link feature dialog is confirmed by the user
`parentFormValueChanged`	Called when an attribute value in the parent widget has changed to newValue
`relation`	Returns the relation
`saveEdits`	Saves the current modifications in the relation
`setConfig`	Defines the widget configuration
`setEditorContext`	Sets the editor context
`setFeature`	Sets the feature being edited and updates the UI unless update is set to `False`
`setForceSuppressFormPopup`	Sets force suppress form popup status with forceSuppressFormPopup configured for this widget
`setLabel`	Sets label for this element If it's empty it takes the relation id as label
`setMultiEditFeatureIds`	Set multiple feature to edit simultaneously.
`setNmRelationId`	Sets nmRelationId for the relation id of the second relation involved in an N:M relation.
`setRelationFeature`	Sets the relation and the feature
`setRelations`	Sets the relation(s) for this widget If only one relation is set, it will act as a simple 1:N relation widget If both relations are set, it will act as an N:M relation widget inserting and deleting entries on the intermediate table as required.
`setShowLabel`	Defines if a title label should be shown for this widget.
`setTitle`	Sets the title of the widget, if it is wrapped within a `QgsCollapsibleGroupBox`
`showEvent`	Refresh the UI when the widget becomes visible
`showLabel`	Defines if a title label should be shown for this widget.
`toggleEditing`	Toggles editing state of the widget
`unlinkFeature`	Unlinks a feature with given fid
`unlinkFeatures`	Unlinks the features with fids
`updateTitle`	Updates the title contents to reflect the current state of the widget
`updateUi`	A hook called every time the state of the relation editor widget has changed via calling its set* methods or slots, e.g. changed relation, added feature, etc.

Signals

relatedFeaturesChanged

Emit this signal, whenever the related features changed.

class qgis.gui.QgsAbstractRelationEditorWidget[source]¶

Bases: QWidget

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

Constructor

Parameters:

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

addFeature(self, geometry: QgsGeometry = QgsGeometry()) → Any[source]¶

Adds new features with given geometry

Added in version 3.24.

Parameters:: geometry (QgsGeometry = QgsGeometry())
Return type:: Any

afterSetRelationFeature(self)[source]¶: A hook called right after setRelationFeature() is executed, but before updateUi() is called. Used to update the UI once setting the relation feature is done. Check QgsRealationEditorWidget as an example.

afterSetRelations(self)[source]¶: A hook called right after setRelations() is executed, but before updateUi() is called. Used to update the UI once setting the relations is done. Check QgsRealationEditorWidget as an example.

beforeSetRelationFeature(self, newRelation: QgsRelation, newFeature: QgsFeature)[source]¶

A hook called right before setRelationFeature() is executed. Used to update the UI once setting the relation feature is done. Check QgsRealationEditorWidget as an example.

Parameters:

newRelation (QgsRelation)
newFeature (QgsFeature)

beforeSetRelations(self, newRelation: QgsRelation, newNmRelation: QgsRelation)[source]¶

A hook called right before setRelations() is executed. Used to manipulate UI once setting the relations is done. Check QgsRealationEditorWidget as an example.

Parameters:

newRelation (QgsRelation)
newNmRelation (QgsRelation)

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

Returns the widget configuration

Return type:: Dict[str, Any]

deleteFeature(self, fid: int = int())[source]¶

Delete a feature with given fid

Parameters:: fid (int = int())

deleteFeatures(self, fids: Any)[source]¶

Deletes the features with fids

Parameters:: fids (Any)

duplicateFeature(self, fid: int)[source]¶

Duplicates a feature

Parameters:: fid (int)

duplicateFeatures(self, fids: Any)[source]¶

Duplicates features

Parameters:: fids (Any)

editorContext(self) → QgsAttributeEditorContext[source]¶

Returns the attribute editor context.

Return type:: QgsAttributeEditorContext

feature(self) → QgsFeature[source]¶

Returns the widget’s current feature If the widget is in multiedit mode only the first is returned