#include <qgsvaluemapconfigdlg.h>

Inheritance diagram for QgsValueMapConfigDlg:

[legend]

Public Member Functions
	QgsValueMapConfigDlg (QgsVectorLayer vl, int fieldIdx, QWidget parent)

QVariantMap	config () override
	Create a configuration from the current GUI state.

bool	eventFilter (QObject watched, QEvent event) override

void	loadMapFromCSV (const QString &filePath)
	Updates the displayed table with the values from a CSV file.

void	setConfig (const QVariantMap &config) override
	Update the configuration widget to represent the given configuration.

void	updateMap (const QList< QPair< QString, QVariant > > &list, bool insertNull)
	Updates the displayed table with the values from list, the order of the values is preserved.

void	updateMap (const QMap< QString, QVariant > &map, bool insertNull)
	Updates the displayed table with the values from map.

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

Static Public Member Functions
static void	populateComboBox (QComboBox *comboBox, const QVariantMap &configuration, bool skipNull)
	Populates a comboBox with the appropriate entries based on a value map configuration.

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

Note: not available in Python bindings

Definition at line 34 of file qgsvaluemapconfigdlg.h.

Constructor & Destructor Documentation

◆ QgsValueMapConfigDlg()

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

explicit

Definition at line 32 of file qgsvaluemapconfigdlg.cpp.

Member Function Documentation

◆ config()

QVariantMap QgsValueMapConfigDlg::config ( )

overridevirtual

Create a configuration from the current GUI state.

Returns: A widget configuration

Implements QgsEditorConfigWidget.

Definition at line 53 of file qgsvaluemapconfigdlg.cpp.

◆ eventFilter()

bool QgsValueMapConfigDlg::eventFilter	(	QObject *	watched,
		QEvent *	event
	)

override

Definition at line 291 of file qgsvaluemapconfigdlg.cpp.

◆ loadMapFromCSV()

void QgsValueMapConfigDlg::loadMapFromCSV ( const QString & filePath )

Updates the displayed table with the values from a CSV file.

Parameters

filePath the absolute file path of the CSV file.

Since: QGIS 3.24

Definition at line 381 of file qgsvaluemapconfigdlg.cpp.

◆ populateComboBox()

void QgsValueMapConfigDlg::populateComboBox	(	QComboBox *	comboBox,
		const QVariantMap &	configuration,
		bool	skipNull
	)

static

Populates a comboBox with the appropriate entries based on a value map configuration.

If skipNull is true, then NULL entries will not be added.

Definition at line 262 of file qgsvaluemapconfigdlg.cpp.

◆ setConfig()

void QgsValueMapConfigDlg::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 88 of file qgsvaluemapconfigdlg.cpp.

◆ updateMap() [1/2]

void QgsValueMapConfigDlg::updateMap	(	const QList< QPair< QString, QVariant > > &	list,
		bool	insertNull
	)

Updates the displayed table with the values from list, the order of the values is preserved.

If insertNull is set to true, it will also insert a NULL value.

Since: QGIS 3.12

Definition at line 189 of file qgsvaluemapconfigdlg.cpp.

◆ updateMap() [2/2]

void QgsValueMapConfigDlg::updateMap	(	const QMap< QString, QVariant > &	map,
		bool	insertNull
	)

Updates the displayed table with the values from map.