Base class to build new relation widgets. More...

#include <qgsabstractrelationeditorwidget.h>

Inheritance diagram for QgsAbstractRelationEditorWidget:

[legend]

Public Slots
virtual void	parentFormValueChanged (const QString &attribute, const QVariant &newValue)=0
	Called when an attribute value in the parent widget has changed to newValue.

Signals
void	relatedFeaturesChanged ()
	Emit this signal, whenever the related features changed.

Public Member Functions
	QgsAbstractRelationEditorWidget (const QVariantMap &config, QWidget *parent=nullptr)
	Constructor.

virtual QVariantMap	config () const =0
	Returns the widget configuration.

QgsAttributeEditorContext	editorContext () const
	Returns the attribute editor context.

QgsFeature	feature () const
	Returns the widget's current feature If the widget is in multiedit mode only the first is returned.

QList< QgsFeature >	features () const
	Returns the widget's current features.

bool	forceSuppressFormPopup () const
	Determines the force suppress form popup status that is configured for this widget.

Q_DECL_DEPRECATED QString	label () const
	Determines the label of this element.

bool	multiEditModeActive () const
	Returns true if editing multiple features at a time.

QgsRelation	nmRelation () const
	Returns the nm relation.

QVariant	nmRelationId () const
	Determines the relation id of the second relation involved in an N:M relation.

QgsRelation	relation () const
	Returns the relation.

virtual void	setConfig (const QVariantMap &config)=0
	Defines the widget configuration.

virtual void	setEditorContext (const QgsAttributeEditorContext &context)
	Sets the editor context.

void	setFeature (const QgsFeature &feature, bool update=true)
	Sets the feature being edited and updates the UI unless update is set to `false`.

void	setForceSuppressFormPopup (bool forceSuppressFormPopup)
	Sets force suppress form popup status with forceSuppressFormPopup configured for this widget.

void	setLabel (const QString &label=QString())
	Sets label for this element If it's empty it takes the relation id as label.

void	setMultiEditFeatureIds (const QgsFeatureIds &fids)
	Set multiple feature to edit simultaneously.

void	setNmRelationId (const QVariant &nmRelationId=QVariant())
	Sets nmRelationId for the relation id of the second relation involved in an N:M relation.

void	setRelationFeature (const QgsRelation &relation, const QgsFeature &feature)
	Sets the relation and the feature.

void	setRelations (const QgsRelation &relation, const QgsRelation &nmrelation)
	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.

Q_DECL_DEPRECATED void	setShowLabel (bool showLabel)
	Defines if a title label should be shown for this widget.

Q_DECL_DEPRECATED bool	showLabel () const
	Defines if a title label should be shown for this widget.

Protected Slots
QgsFeatureIds	addFeature (const QgsGeometry &geometry=QgsGeometry())
	Adds new features with given geometry Returns the Id of added features.

void	deleteFeature (QgsFeatureId fid=QgsFeatureId())
	Delete a feature with given fid.

void	duplicateFeature (const QgsFeatureId &fid)
	Duplicates a feature.

void	duplicateFeatures (const QgsFeatureIds &fids)
	Duplicates features.

void	linkFeature ()
	Links a new feature to the relation.

void	onLinkFeatureDlgAccepted ()
	Called when the link feature dialog is confirmed by the user.

void	saveEdits ()
	Saves the current modifications in the relation.

void	toggleEditing (bool state)
	Toggles editing state of the widget.

void	unlinkFeature (QgsFeatureId fid=QgsFeatureId())
	Unlinks a feature with given fid.

Protected Member Functions
virtual void	afterSetRelationFeature ()
	A hook called right after setRelationFeature() is executed, but before updateUi() is called.

virtual void	afterSetRelations ()
	A hook called right after setRelations() is executed, but before updateUi() is called.

virtual void	beforeSetRelationFeature (const QgsRelation &newRelation, const QgsFeature &newFeature)
	A hook called right before setRelationFeature() is executed.

virtual void	beforeSetRelations (const QgsRelation &newRelation, const QgsRelation &newNmRelation)
	A hook called right before setRelations() is executed.

void	deleteFeatures (const QgsFeatureIds &fids)
	Deletes the features with fids.

virtual Q_DECL_DEPRECATED void	setTitle (const QString &title)
	Sets the title of the widget, if it is wrapped within a QgsCollapsibleGroupBox.

void	showEvent (QShowEvent *)
	Refresh the UI when the widget becomes visible.

void	unlinkFeatures (const QgsFeatureIds &fids)
	Unlinks the features with fids.

Q_DECL_DEPRECATED void	updateTitle ()
	Updates the title contents to reflect the current state of the widget.

virtual void	updateUi ()
	A hook called every time the state of the relation editor widget has changed via calling its `set*` methods or slots, e.g.

Protected Attributes
QgsAttributeEditorContext	mEditorContext

QgsFeatureList	mFeatureList

bool	mForceSuppressFormPopup = false

bool	mLayerInSameTransactionGroup = false

QgsRelation	mNmRelation

QgsRelation	mRelation

Detailed Description

Base class to build new relation widgets.

Since: QGIS 3.18

Definition at line 45 of file qgsabstractrelationeditorwidget.h.

Constructor & Destructor Documentation

◆ QgsAbstractRelationEditorWidget()

QgsAbstractRelationEditorWidget::QgsAbstractRelationEditorWidget	(	const QVariantMap &	config,
		QWidget *	parent = `nullptr`
	)

Constructor.

Definition at line 36 of file qgsabstractrelationeditorwidget.cpp.

Member Function Documentation

◆ addFeature

QgsFeatureIds QgsAbstractRelationEditorWidget::addFeature ( const QgsGeometry & geometry = QgsGeometry() )

protectedslot

Adds new features with given geometry Returns the Id of added features.

Since: QGIS 3.24

Definition at line 219 of file qgsabstractrelationeditorwidget.cpp.

◆ afterSetRelationFeature()

void QgsAbstractRelationEditorWidget::afterSetRelationFeature ( )

protectedvirtual

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.

Reimplemented in QgsRelationEditorWidget.

Definition at line 720 of file qgsabstractrelationeditorwidget.cpp.

◆ afterSetRelations()

void QgsAbstractRelationEditorWidget::afterSetRelations ( )

protectedvirtual

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.

Reimplemented in QgsRelationEditorWidget.

Definition at line 729 of file qgsabstractrelationeditorwidget.cpp.

◆ beforeSetRelationFeature()

void QgsAbstractRelationEditorWidget::beforeSetRelationFeature	(	const QgsRelation &	newRelation,
		const QgsFeature &	newFeature
	)

protectedvirtual

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.

Reimplemented in QgsRelationEditorWidget.

Definition at line 714 of file qgsabstractrelationeditorwidget.cpp.

◆ beforeSetRelations()

void QgsAbstractRelationEditorWidget::beforeSetRelations	(	const QgsRelation &	newRelation,
		const QgsRelation &	newNmRelation
	)

protectedvirtual

A hook called right before setRelations() is executed.

Used to manipulate UI once setting the relations is done. Check QgsRealationEditorWidget as an example.

Reimplemented in QgsRelationEditorWidget.

Definition at line 723 of file qgsabstractrelationeditorwidget.cpp.

◆ config()

virtual QVariantMap QgsAbstractRelationEditorWidget::config ( ) const

pure virtual

Returns the widget configuration.

Implemented in QgsRelationEditorWidget.

◆ deleteFeature

void QgsAbstractRelationEditorWidget::deleteFeature ( QgsFeatureId fid = QgsFeatureId() )

protectedslot

Delete a feature with given fid.

Definition at line 324 of file qgsabstractrelationeditorwidget.cpp.

◆ deleteFeatures()

void QgsAbstractRelationEditorWidget::deleteFeatures ( const QgsFeatureIds & fids )

protected

Deletes the features with fids.

Definition at line 331 of file qgsabstractrelationeditorwidget.cpp.

◆ duplicateFeature

void QgsAbstractRelationEditorWidget::duplicateFeature ( const QgsFeatureId & fid )

protectedslot

Duplicates a feature.

Definition at line 732 of file qgsabstractrelationeditorwidget.cpp.

◆ duplicateFeatures

void QgsAbstractRelationEditorWidget::duplicateFeatures ( const QgsFeatureIds & fids )

protectedslot

Duplicates features.

Definition at line 739 of file qgsabstractrelationeditorwidget.cpp.

◆ editorContext()

QgsAttributeEditorContext QgsAbstractRelationEditorWidget::editorContext ( ) const

Returns the attribute editor context.

Definition at line 101 of file qgsabstractrelationeditorwidget.cpp.

◆ feature()

QgsFeature QgsAbstractRelationEditorWidget::feature ( ) const

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

See also: features

Definition at line 183 of file qgsabstractrelationeditorwidget.cpp.

◆ features()

QList< QgsFeature > QgsAbstractRelationEditorWidget::features ( ) const

Returns the widget's current features.

Since: QGIS 3.24

Definition at line 191 of file qgsabstractrelationeditorwidget.cpp.

◆ forceSuppressFormPopup()

bool QgsAbstractRelationEditorWidget::forceSuppressFormPopup ( ) const

Determines the force suppress form popup status that is configured for this widget.

Definition at line 169 of file qgsabstractrelationeditorwidget.cpp.

◆ label()

QString QgsAbstractRelationEditorWidget::label ( ) const

Determines the label of this element.

Deprecated:: since QGIS 3.20 label is handled directly in QgsAttributeForm.

Definition at line 144 of file qgsabstractrelationeditorwidget.cpp.

◆ linkFeature

void QgsAbstractRelationEditorWidget::linkFeature ( )

protectedslot

Links a new feature to the relation.

Definition at line 450 of file qgsabstractrelationeditorwidget.cpp.

◆ multiEditModeActive()

bool QgsAbstractRelationEditorWidget::multiEditModeActive ( ) const

Returns true if editing multiple features at a time.

Since: QGIS 3.24

Definition at line 178 of file qgsabstractrelationeditorwidget.cpp.

◆ nmRelation()

QgsRelation QgsAbstractRelationEditorWidget::nmRelation ( ) const

inline

Returns the nm relation.

Since: QGIS 3.18

Definition at line 93 of file qgsabstractrelationeditorwidget.h.

◆ nmRelationId()

QVariant QgsAbstractRelationEditorWidget::nmRelationId ( ) const

Determines the relation id of the second relation involved in an N:M relation.

Definition at line 139 of file qgsabstractrelationeditorwidget.cpp.

◆ onLinkFeatureDlgAccepted

void QgsAbstractRelationEditorWidget::onLinkFeatureDlgAccepted ( )

protectedslot

Called when the link feature dialog is confirmed by the user.

Definition at line 482 of file qgsabstractrelationeditorwidget.cpp.

◆ parentFormValueChanged

virtual void QgsAbstractRelationEditorWidget::parentFormValueChanged	(	const QString &	attribute,
		const QVariant &	newValue
	)

pure virtualslot

Called when an attribute value in the parent widget has changed to newValue.

◆ relatedFeaturesChanged

void QgsAbstractRelationEditorWidget::relatedFeaturesChanged ( )

signal

Emit this signal, whenever the related features changed.

This happens for example when related features are added, removed, linked or unlinked.

Since: QGIS 3.22

◆ relation()

QgsRelation QgsAbstractRelationEditorWidget::relation ( ) const

inline

Returns the relation.

Since: QGIS 3.18

Definition at line 87 of file qgsabstractrelationeditorwidget.h.

◆ saveEdits

void QgsAbstractRelationEditorWidget::saveEdits ( )

protectedslot

Saves the current modifications in the relation.

Definition at line 212 of file qgsabstractrelationeditorwidget.cpp.

◆ setConfig()

virtual void QgsAbstractRelationEditorWidget::setConfig ( const QVariantMap & config )

pure virtual

Defines the widget configuration.

Implemented in QgsRelationEditorWidget.

◆ setEditorContext()

void QgsAbstractRelationEditorWidget::setEditorContext ( const QgsAttributeEditorContext & context )

virtual

Sets the editor context.

Note: if context cadDockWidget is null, it won't be possible to digitize the geometry of a referencing feature from this widget

Reimplemented in QgsRelationEditorWidget.

Definition at line 96 of file qgsabstractrelationeditorwidget.cpp.

◆ setFeature()

void QgsAbstractRelationEditorWidget::setFeature	(	const QgsFeature &	feature,
		bool	update = `true`
	)

Sets the feature being edited and updates the UI unless update is set to false.

Definition at line 106 of file qgsabstractrelationeditorwidget.cpp.

◆ setForceSuppressFormPopup()

void QgsAbstractRelationEditorWidget::setForceSuppressFormPopup ( bool forceSuppressFormPopup )

Sets force suppress form popup status with forceSuppressFormPopup configured for this widget.

Definition at line 164 of file qgsabstractrelationeditorwidget.cpp.

◆ setLabel()

void QgsAbstractRelationEditorWidget::setLabel ( const QString & label = QString() )

Sets label for this element If it's empty it takes the relation id as label.

Definition at line 149 of file qgsabstractrelationeditorwidget.cpp.

◆ setMultiEditFeatureIds()

void QgsAbstractRelationEditorWidget::setMultiEditFeatureIds ( const QgsFeatureIds & fids )

Set multiple feature to edit simultaneously.

Parameters

fids	Multiple Id of features to edit

Since: QGIS 3.24

Definition at line 117 of file qgsabstractrelationeditorwidget.cpp.

◆ setNmRelationId()

void QgsAbstractRelationEditorWidget::setNmRelationId ( const QVariant & nmRelationId = QVariant() )

Sets nmRelationId for the relation id of the second relation involved in an N:M relation.

If it's empty, then it's considered as a 1:M relationship.

Definition at line 130 of file qgsabstractrelationeditorwidget.cpp.

◆ setRelationFeature()

void QgsAbstractRelationEditorWidget::setRelationFeature	(	const QgsRelation &	relation,
		const QgsFeature &	feature
	)

Sets the relation and the feature.

Definition at line 42 of file qgsabstractrelationeditorwidget.cpp.

◆ setRelations()

void QgsAbstractRelationEditorWidget::setRelations	(	const QgsRelation &	relation,
		const QgsRelation &	nmrelation
	)

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.

Parameters

relation	Relation referencing the edited table
nmrelation	Optional reference from the referencing table to a 3rd N:M table

Definition at line 56 of file qgsabstractrelationeditorwidget.cpp.

◆ setShowLabel()

void QgsAbstractRelationEditorWidget::setShowLabel ( bool showLabel )

Defines if a title label should be shown for this widget.

Deprecated:: since QGIS 3.20 label is handled directly in QgsAttributeForm.

Definition at line 159 of file qgsabstractrelationeditorwidget.cpp.

◆ setTitle()

void QgsAbstractRelationEditorWidget::setTitle ( const QString & title )

protectedvirtual

Sets the title of the widget, if it is wrapped within a QgsCollapsibleGroupBox.

Deprecated:: since QGIS 3.20 label is handled directly in QgsAttributeForm.

Definition at line 709 of file qgsabstractrelationeditorwidget.cpp.

◆ showEvent()

void QgsAbstractRelationEditorWidget::showEvent ( QShowEvent * )

protected

Refresh the UI when the widget becomes visible.

Definition at line 754 of file qgsabstractrelationeditorwidget.cpp.

◆ showLabel()

bool QgsAbstractRelationEditorWidget::showLabel ( ) const

Defines if a title label should be shown for this widget.

Deprecated:: since QGIS 3.20 label is handled directly in QgsAttributeForm.

Definition at line 154 of file qgsabstractrelationeditorwidget.cpp.

◆ toggleEditing

void QgsAbstractRelationEditorWidget::toggleEditing ( bool state )

protectedslot

Toggles editing state of the widget.

Definition at line 196 of file qgsabstractrelationeditorwidget.cpp.

◆ unlinkFeature

void QgsAbstractRelationEditorWidget::unlinkFeature ( QgsFeatureId fid = QgsFeatureId() )

protectedslot

Unlinks a feature with given fid.

Definition at line 605 of file qgsabstractrelationeditorwidget.cpp.

◆ unlinkFeatures()

void QgsAbstractRelationEditorWidget::unlinkFeatures ( const QgsFeatureIds & fids )

protected

Unlinks the features with fids.

Definition at line 610 of file qgsabstractrelationeditorwidget.cpp.

◆ updateTitle()

void QgsAbstractRelationEditorWidget::updateTitle ( )

protected

Updates the title contents to reflect the current state of the widget.

Deprecated:: since QGIS 3.20 label is handled directly in QgsAttributeForm.

Definition at line 174 of file qgsabstractrelationeditorwidget.cpp.

◆ updateUi()

void QgsAbstractRelationEditorWidget::updateUi ( )

protectedvirtual

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. Should be used to refresh the UI regarding the new data. Check QgsRealationEditorWidget as an example.

Reimplemented in QgsRelationEditorWidget.

Definition at line 706 of file qgsabstractrelationeditorwidget.cpp.

Member Data Documentation

◆ mEditorContext

QgsAttributeEditorContext QgsAbstractRelationEditorWidget::mEditorContext

protected

Definition at line 262 of file qgsabstractrelationeditorwidget.h.

◆ mFeatureList

QgsFeatureList QgsAbstractRelationEditorWidget::mFeatureList

protected

Definition at line 265 of file qgsabstractrelationeditorwidget.h.

◆ mForceSuppressFormPopup

bool QgsAbstractRelationEditorWidget::mForceSuppressFormPopup = false

protected

Definition at line 269 of file qgsabstractrelationeditorwidget.h.

◆ mLayerInSameTransactionGroup

bool QgsAbstractRelationEditorWidget::mLayerInSameTransactionGroup = false

protected

Definition at line 267 of file qgsabstractrelationeditorwidget.h.

◆ mNmRelation

QgsRelation QgsAbstractRelationEditorWidget::mNmRelation

protected

Definition at line 264 of file qgsabstractrelationeditorwidget.h.

◆ mRelation

QgsRelation QgsAbstractRelationEditorWidget::mRelation

protected

Definition at line 263 of file qgsabstractrelationeditorwidget.h.

The documentation for this class was generated from the following files:

/home/fischer/src/qgis-3.38/src/gui/qgsabstractrelationeditorwidget.h
/home/fischer/src/qgis-3.38/src/gui/qgsabstractrelationeditorwidget.cpp

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QgsAbstractRelationEditorWidget()

Member Function Documentation

◆ addFeature

◆ afterSetRelationFeature()

◆ afterSetRelations()

◆ beforeSetRelationFeature()

◆ beforeSetRelations()

◆ config()

◆ deleteFeature

◆ deleteFeatures()

◆ duplicateFeature

◆ duplicateFeatures

◆ editorContext()

◆ feature()

◆ features()

◆ forceSuppressFormPopup()

◆ label()

◆ linkFeature

◆ multiEditModeActive()

◆ nmRelation()

◆ nmRelationId()

◆ onLinkFeatureDlgAccepted

◆ parentFormValueChanged

◆ relatedFeaturesChanged

◆ relation()

◆ saveEdits

◆ setConfig()

◆ setEditorContext()

◆ setFeature()

◆ setForceSuppressFormPopup()

◆ setLabel()

◆ setMultiEditFeatureIds()

◆ setNmRelationId()

◆ setRelationFeature()

◆ setRelations()

◆ setShowLabel()

◆ setTitle()

◆ showEvent()

◆ showLabel()

◆ toggleEditing

◆ unlinkFeature

◆ unlinkFeatures()

◆ updateTitle()

◆ updateUi()

Member Data Documentation

◆ mEditorContext

◆ mFeatureList

◆ mForceSuppressFormPopup

◆ mLayerInSameTransactionGroup

◆ mNmRelation

◆ mRelation