QgsAbstractRelationEditorConfigWidget Class Reference

This class should be subclassed for every configurable relation widget type. More...

#include <qgsabstractrelationeditorwidget.h>

Inheritance diagram for QgsAbstractRelationEditorConfigWidget:

Public Member Functions
	QgsAbstractRelationEditorConfigWidget (const QgsRelation &relation, QWidget *parent)
	Create a new configuration widget.
virtual QVariantMap	config ()=0
	Create a configuration from the current GUI state.
QgsVectorLayer *	layer ()
	Returns the layer for which this configuration widget applies.
virtual QgsRelation	nmRelation () const
	Returns the nm relation for which this configuration widget applies.
QgsRelation	relation () const
	Returns the relation for which this configuration widget applies.
virtual void	setConfig (const QVariantMap &config)=0
	Update the configuration widget to represent the given configuration.
virtual void	setNmRelation (const QgsRelation &nmRelation)
	Set the nm relation for this widget.

Detailed Description

This class should be subclassed for every configurable relation widget type.

It implements the GUI configuration widget and transforms this to/from a configuration.

It will only be instantiated by {

See also

QgsAbstractRelationEditorWidgetFactory}

Since

QGIS 3.18

Definition at line 344 of file qgsabstractrelationeditorwidget.h.

Constructor & Destructor Documentation

QgsAbstractRelationEditorConfigWidget()

QgsAbstractRelationEditorConfigWidget::QgsAbstractRelationEditorConfigWidget ( const QgsRelation &  relation, QWidget *  parent  )

explicit

Create a new configuration widget.

Parameters

relation	The relation for which the configuration dialog will be created
parent	A parent widget

Definition at line 766 of file qgsabstractrelationeditorwidget.cpp.

Member Function Documentation

config()

virtual QVariantMap QgsAbstractRelationEditorConfigWidget::config ( )

pure virtual

Create a configuration from the current GUI state.

Returns

A widget configuration

Implemented in QgsRelationEditorConfigWidget.

layer()

QgsVectorLayer * QgsAbstractRelationEditorConfigWidget::layer

(

)

Returns the layer for which this configuration widget applies.

Returns

The layer

Definition at line 772 of file qgsabstractrelationeditorwidget.cpp.

nmRelation()

QgsRelation QgsAbstractRelationEditorConfigWidget::nmRelation ( ) const

virtual

Returns the nm relation for which this configuration widget applies.

Returns

The nm relation

Definition at line 787 of file qgsabstractrelationeditorwidget.cpp.

relation()

QgsRelation QgsAbstractRelationEditorConfigWidget::relation

(

)

const

Returns the relation for which this configuration widget applies.

Returns

The relation

Definition at line 777 of file qgsabstractrelationeditorwidget.cpp.

setConfig()

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

pure virtual

Update the configuration widget to represent the given configuration.

Parameters

config

The configuration which should be represented by this widget

Implemented in QgsRelationEditorConfigWidget.

setNmRelation()

void QgsAbstractRelationEditorConfigWidget::setNmRelation ( const QgsRelation &  nmRelation )

virtual

Set the nm relation for this widget.

Parameters

nmRelation

The nm relation

Definition at line 782 of file qgsabstractrelationeditorwidget.cpp.

---

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

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/qgsabstractrelationeditorwidget.h
• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/qgsabstractrelationeditorwidget.cpp