The default relation widget in QGIS. More...

#include <qgsrelationeditorwidget.h>

Inheritance diagram for QgsRelationEditorWidget:

Public Types
enum	Button { Link = 1 << 1 , Unlink = 1 << 2 , SaveChildEdits = 1 << 3 , AddChildFeature = 1 << 4 , DuplicateChildFeature = 1 << 5 , DeleteChildFeature = 1 << 6 , ZoomToChildFeature = 1 << 7 , AllButtons = Link \| Unlink \| SaveChildEdits \| AddChildFeature \| DuplicateChildFeature \| DeleteChildFeature \| ZoomToChildFeature }
	Possible buttons shown in the relation editor. More...

Public Slots
void	parentFormValueChanged (const QString &attribute, const QVariant &newValue) override

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

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

QVariantMap	config () const override
	Returns the current configuration. More...

void	deleteSelectedFeatures ()
	Deletes the currently selected features. More...

Q_DECL_DEPRECATED void	duplicateFeature ()
	Duplicates a feature. More...

void	duplicateSelectedFeatures ()
	Duplicates the selected features. More...

QgsIFeatureSelectionManager *	featureSelectionManager ()
	The feature selection manager is responsible for the selected features which are currently being edited. More...

void	setConfig (const QVariantMap &config) override
	Defines the current configuration. More...

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

void	setTitle (const QString &title) override
	Sets the title of the root groupbox. More...

void	setViewMode (QgsDualView::ViewMode mode)
	Define the view mode for the dual view. More...

void	setVisibleButtons (const Buttons &buttons)
	Defines the buttons which are shown. More...

void	unlinkSelectedFeatures ()
	Unlinks the selected features from the relation. More...

QgsDualView::ViewMode	viewMode ()
	Gets the view mode for the dual view. More...

Buttons	visibleButtons () const
	Returns the buttons which are shown. More...

void	zoomToSelectedFeatures ()
	Zooms to the selected features. More...

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

QgsAttributeEditorContext	editorContext () const
	Returns the attribute editor context. More...

QgsFeature	feature () const
	Returns the widget's current feature. More...

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

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

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

QgsRelation	relation () const
	Returns the relation. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions inherited from QgsAbstractRelationEditorWidget
void	deleteFeatures (const QgsFeatureIds &fids)
	Deletes the features with fids. More...

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

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

Properties
QgsDualView::ViewMode	viewMode

Buttons	visibleButtons

Additional Inherited Members
Protected Slots inherited from QgsAbstractRelationEditorWidget
void	addFeature (const QgsGeometry &geometry=QgsGeometry())
	Adds a new feature with given geometry. More...

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

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

void	duplicateFeatures (const QgsFeatureIds &fids)
	Duplicates features. More...

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

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

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

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

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

Protected Attributes inherited from QgsAbstractRelationEditorWidget
QgsAttributeEditorContext	mEditorContext

QgsFeature	mFeature

bool	mForceSuppressFormPopup = false

QString	mLabel

bool	mLayerInSameTransactionGroup = false

QgsRelation	mNmRelation

QVariant	mNmRelationId

QgsRelation	mRelation

bool	mShowLabel = true

Detailed Description

The default relation widget in QGIS.

Since: QGIS 3.18

Definition at line 88 of file qgsrelationeditorwidget.h.

Member Enumeration Documentation

◆ Button

enum QgsRelationEditorWidget::Button

Possible buttons shown in the relation editor.

Enumerator
Link	Link button.
Unlink	Unlink button.
SaveChildEdits	Save child edits button.
AddChildFeature	Add child feature (as in some projects we only want to allow linking/unlinking existing features)
DuplicateChildFeature	Duplicate child feature.
DeleteChildFeature	Delete child feature button.
ZoomToChildFeature	Zoom to child feature.
AllButtons	All buttons.

Definition at line 100 of file qgsrelationeditorwidget.h.

Constructor & Destructor Documentation

◆ QgsRelationEditorWidget()

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

Constructor.

Parameters

config	widget configuration
parent	parent widget

Definition at line 96 of file qgsrelationeditorwidget.cpp.

Member Function Documentation

◆ afterSetRelationFeature()

void QgsRelationEditorWidget::afterSetRelationFeature ( )

overrideprotectedvirtual

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 from QgsAbstractRelationEditorWidget.

Definition at line 530 of file qgsrelationeditorwidget.cpp.

◆ afterSetRelations()

void QgsRelationEditorWidget::afterSetRelations ( )

overrideprotectedvirtual

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 from QgsAbstractRelationEditorWidget.

Definition at line 581 of file qgsrelationeditorwidget.cpp.

◆ beforeSetRelationFeature()

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

overrideprotectedvirtual

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 from QgsAbstractRelationEditorWidget.

Definition at line 518 of file qgsrelationeditorwidget.cpp.

◆ beforeSetRelations()

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

overrideprotectedvirtual

A hook called right before setRelations() is executed.

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

Reimplemented from QgsAbstractRelationEditorWidget.

Definition at line 563 of file qgsrelationeditorwidget.cpp.

◆ config()

QVariantMap QgsRelationEditorWidget::config ( ) const

overridevirtual

Returns the current configuration.

Implements QgsAbstractRelationEditorWidget.

Definition at line 502 of file qgsrelationeditorwidget.cpp.

◆ deleteSelectedFeatures()

void QgsRelationEditorWidget::deleteSelectedFeatures ( )

Deletes the currently selected features.

Definition at line 629 of file qgsrelationeditorwidget.cpp.

◆ duplicateFeature()

void QgsRelationEditorWidget::duplicateFeature ( )

Duplicates a feature.

Deprecated:: since QGIS 3.18, use duplicateSelectedFeatures() instead

Definition at line 619 of file qgsrelationeditorwidget.cpp.

◆ duplicateSelectedFeatures()

void QgsRelationEditorWidget::duplicateSelectedFeatures ( )

Duplicates the selected features.

Since: QGIS 3.18

Definition at line 624 of file qgsrelationeditorwidget.cpp.

◆ featureSelectionManager()

QgsIFeatureSelectionManager * QgsRelationEditorWidget::featureSelectionManager ( )

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

Definition at line 609 of file qgsrelationeditorwidget.cpp.

◆ parentFormValueChanged

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

overrideslot

Definition at line 440 of file qgsrelationeditorwidget.cpp.

◆ setConfig()

void QgsRelationEditorWidget::setConfig ( const QVariantMap & config )

overridevirtual

Defines the current configuration.

Implements QgsAbstractRelationEditorWidget.

Definition at line 507 of file qgsrelationeditorwidget.cpp.

◆ setEditorContext()

void QgsRelationEditorWidget::setEditorContext ( const QgsAttributeEditorContext & context )

overridevirtual

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 from QgsAbstractRelationEditorWidget.

Definition at line 263 of file qgsrelationeditorwidget.cpp.

◆ setTitle()

void QgsRelationEditorWidget::setTitle ( const QString & title )

overridevirtual

Sets the title of the root groupbox.

Reimplemented from QgsAbstractRelationEditorWidget.

Definition at line 513 of file qgsrelationeditorwidget.cpp.

◆ setViewMode()

void QgsRelationEditorWidget::setViewMode ( QgsDualView::ViewMode mode )

Define the view mode for the dual view.

Definition at line 276 of file qgsrelationeditorwidget.cpp.

◆ setVisibleButtons()

void QgsRelationEditorWidget::setVisibleButtons ( const Buttons & buttons )

Defines the buttons which are shown.

Definition at line 414 of file qgsrelationeditorwidget.cpp.

◆ unlinkSelectedFeatures()

void QgsRelationEditorWidget::unlinkSelectedFeatures ( )

Unlinks the selected features from the relation.

Definition at line 614 of file qgsrelationeditorwidget.cpp.

◆ updateUi()

void QgsRelationEditorWidget::updateUi ( )

overrideprotectedvirtual

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 from QgsAbstractRelationEditorWidget.

Definition at line 377 of file qgsrelationeditorwidget.cpp.

◆ viewMode()

QgsDualView::ViewMode QgsRelationEditorWidget::viewMode ( )

inline

Gets the view mode for the dual view.

Definition at line 126 of file qgsrelationeditorwidget.h.

◆ visibleButtons()

QgsRelationEditorWidget::Buttons QgsRelationEditorWidget::visibleButtons ( ) const

Returns the buttons which are shown.

Definition at line 420 of file qgsrelationeditorwidget.cpp.

◆ zoomToSelectedFeatures()

void QgsRelationEditorWidget::zoomToSelectedFeatures ( )

Zooms to the selected features.

Definition at line 635 of file qgsrelationeditorwidget.cpp.

Property Documentation

◆ viewMode

QgsDualView::ViewMode QgsRelationEditorWidget::viewMode

readwrite

Definition at line 1 of file qgsrelationeditorwidget.h.

◆ visibleButtons

Buttons QgsRelationEditorWidget::visibleButtons

readwrite

Definition at line 1 of file qgsrelationeditorwidget.h.

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

/build/qgis-3.18.1+99unstable/src/gui/qgsrelationeditorwidget.h
/build/qgis-3.18.1+99unstable/src/gui/qgsrelationeditorwidget.cpp

Public Types

Public Slots

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Button

Constructor & Destructor Documentation

◆ QgsRelationEditorWidget()

Member Function Documentation

◆ afterSetRelationFeature()

◆ afterSetRelations()

◆ beforeSetRelationFeature()

◆ beforeSetRelations()

◆ config()

◆ deleteSelectedFeatures()

◆ duplicateFeature()

◆ duplicateSelectedFeatures()

◆ featureSelectionManager()

◆ parentFormValueChanged

◆ setConfig()

◆ setEditorContext()

◆ setTitle()

◆ setViewMode()

◆ setVisibleButtons()

◆ unlinkSelectedFeatures()

◆ updateUi()

◆ viewMode()

◆ visibleButtons()

◆ zoomToSelectedFeatures()

Property Documentation

◆ viewMode

◆ visibleButtons