QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Slots | Public Member Functions | List of all members
QgsValueRelationConfigDlg Class Reference

#include <qgsvaluerelationconfigdlg.h>

Inheritance diagram for QgsValueRelationConfigDlg:
Inheritance graph
[legend]

Public Slots

void editExpression ()
 

Public Member Functions

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

Additional Inherited Members

- Signals inherited from QgsEditorConfigWidget
void changed ()
 Emitted when the configuration of the widget is changed. More...
 
- 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. More...
 
void updateDataDefinedButton (QgsPropertyOverrideButton *button)
 Updates a specific property override button to reflect the widgets's current properties. More...
 
void updateDataDefinedButtons ()
 Updates all property override buttons to reflect the widgets's current properties. More...
 
- Protected Attributes inherited from QgsEditorConfigWidget
QgsPropertyCollection mPropertyCollection
 Temporary property collection for config widgets. More...
 

Detailed Description

Note
not available in Python bindings

Definition at line 32 of file qgsvaluerelationconfigdlg.h.

Constructor & Destructor Documentation

◆ QgsValueRelationConfigDlg()

QgsValueRelationConfigDlg::QgsValueRelationConfigDlg ( QgsVectorLayer vl,
int  fieldIdx,
QWidget *  parent = nullptr 
)
explicit

Definition at line 23 of file qgsvaluerelationconfigdlg.cpp.

Member Function Documentation

◆ config()

QVariantMap QgsValueRelationConfigDlg::config ( )
overridevirtual

Create a configuration from the current GUI state.

Returns
A widget configuration

Implements QgsEditorConfigWidget.

Definition at line 76 of file qgsvaluerelationconfigdlg.cpp.

◆ editExpression

void QgsValueRelationConfigDlg::editExpression ( )
slot

Definition at line 134 of file qgsvaluerelationconfigdlg.cpp.

◆ setConfig()

void QgsValueRelationConfigDlg::setConfig ( const QVariantMap &  config)
overridevirtual

Update the configuration widget to represent the given configuration.

Parameters
configThe configuration which should be represented by this widget

Implements QgsEditorConfigWidget.

Definition at line 103 of file qgsvaluerelationconfigdlg.cpp.


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