QgsRelationReferenceConfigDlg Class Reference

Configuration widget for relation reference widgets. More...

#include <qgsrelationreferenceconfigdlg.h>

Inheritance diagram for QgsRelationReferenceConfigDlg:

Public Member Functions
	QgsRelationReferenceConfigDlg (QgsVectorLayer *vl, int fieldIdx, QWidget *parent)
QVariantMap	config () override
	Create a configuration from the current GUI state.
void	setConfig (const QVariantMap &config) override
	Update the configuration widget to represent the given configuration.
Public Member Functions inherited from QgsEditorConfigWidget
	QgsEditorConfigWidget (QgsVectorLayer *vl, int fieldIdx, QWidget *parent)
	Create a new configuration widget.
QgsExpressionContext	createExpressionContext () const override
	This method needs to be reimplemented in all classes which implement this interface and return an expression context.
int	field ()
	Returns the field for which this configuration widget applies.
QgsVectorLayer *	layer ()
	Returns the layer for which this configuration widget applies.
Public Member Functions inherited from QgsExpressionContextGenerator
virtual	~QgsExpressionContextGenerator ()=default

Friends
class	TestQgsRelationReferenceWidget

Additional Inherited Members
Signals inherited from QgsEditorConfigWidget
void	changed ()
	Emitted when the configuration of the widget is changed.
Protected Member Functions inherited from QgsEditorConfigWidget
void	initializeDataDefinedButton (QgsPropertyOverrideButton *button, QgsWidgetWrapper::Property key)
	Registers a property override button, setting up its initial value, connections and description.
void	updateDataDefinedButton (QgsPropertyOverrideButton *button)
	Updates a specific property override button to reflect the widgets's current properties.
void	updateDataDefinedButtons ()
	Updates all property override buttons to reflect the widgets's current properties.
Protected Attributes inherited from QgsEditorConfigWidget
QgsPropertyCollection	mPropertyCollection
	Temporary property collection for config widgets.

Detailed Description

Configuration widget for relation reference widgets.

Note

not available in Python bindings

Definition at line 35 of file qgsrelationreferenceconfigdlg.h.

Constructor & Destructor Documentation

QgsRelationReferenceConfigDlg()

QgsRelationReferenceConfigDlg::QgsRelationReferenceConfigDlg ( QgsVectorLayer * vl, int fieldIdx, QWidget * parent )

explicit

Definition at line 28 of file qgsrelationreferenceconfigdlg.cpp.

Member Function Documentation

config()

QVariantMap QgsRelationReferenceConfigDlg::config ( )

overridevirtual

Create a configuration from the current GUI state.

Returns

A widget configuration

Implements QgsEditorConfigWidget.

Definition at line 185 of file qgsrelationreferenceconfigdlg.cpp.

setConfig()

void QgsRelationReferenceConfigDlg::setConfig ( const QVariantMap & config )

overridevirtual

Update the configuration widget to represent the given configuration.

Parameters

config

The configuration which should be represented by this widget

Implements QgsEditorConfigWidget.

Definition at line 102 of file qgsrelationreferenceconfigdlg.cpp.

Friends And Related Symbol Documentation

TestQgsRelationReferenceWidget

friend class TestQgsRelationReferenceWidget

friend

Definition at line 63 of file qgsrelationreferenceconfigdlg.h.

---

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

• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/gui/editorwidgets/qgsrelationreferenceconfigdlg.h
• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/gui/editorwidgets/qgsrelationreferenceconfigdlg.cpp