QGIS API Documentation  3.25.0-Master (349eb7cb1e)
Public Member Functions | List of all members
QgsAbstractRelationEditorConfigWidget Class Referenceabstract

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

#include <qgsabstractrelationeditorwidget.h>

Inheritance diagram for QgsAbstractRelationEditorConfigWidget:
Inheritance graph
[legend]

Public Member Functions

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

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 343 of file qgsabstractrelationeditorwidget.h.

Constructor & Destructor Documentation

◆ QgsAbstractRelationEditorConfigWidget()

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

Create a new configuration widget.

Parameters
relationThe relation for which the configuration dialog will be created
parentA parent widget

Definition at line 731 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 737 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 752 of file qgsabstractrelationeditorwidget.cpp.

◆ relation()

QgsRelation QgsAbstractRelationEditorConfigWidget::relation ( ) const

Returns the relation for which this configuration widget applies.

Returns
The relation

Definition at line 742 of file qgsabstractrelationeditorwidget.cpp.

◆ setConfig()

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

Update the configuration widget to represent the given configuration.

Parameters
configThe 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
nmRelationThe nm relation

Definition at line 747 of file qgsabstractrelationeditorwidget.cpp.


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