QGIS API Documentation 3.29.0-Master (006c3c0232)
Public Member Functions | List of all members
QgsJsonEditConfigDlg Class Reference

The QgsJsonEditConfigDlg is a configuration widget for JSON edit widget. More...

#include <qgsjsoneditconfigdlg.h>

Inheritance diagram for QgsJsonEditConfigDlg:
Inheritance graph
[legend]

Public Member Functions

 QgsJsonEditConfigDlg (QgsVectorLayer *vl, int fieldIdx, QWidget *parent=nullptr)
 Constructor for QgsJsonEditWidget. More...
 
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

The QgsJsonEditConfigDlg is a configuration widget for JSON edit widget.

Since
QGIS 3.20

Definition at line 32 of file qgsjsoneditconfigdlg.h.

Constructor & Destructor Documentation

◆ QgsJsonEditConfigDlg()

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

Constructor for QgsJsonEditWidget.

Parameters
vlThe layer for which the configuration dialog will be created
fieldIdxThe index of the field on the layer for which this dialog will be created
parentA parent widget

Definition at line 18 of file qgsjsoneditconfigdlg.cpp.

Member Function Documentation

◆ config()

QVariantMap QgsJsonEditConfigDlg::config ( )
overridevirtual

Create a configuration from the current GUI state.

Returns
A widget configuration

Implements QgsEditorConfigWidget.

Definition at line 27 of file qgsjsoneditconfigdlg.cpp.

◆ setConfig()

void QgsJsonEditConfigDlg::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 37 of file qgsjsoneditconfigdlg.cpp.


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