Field formatter for an Enumeration field. More...

#include <qgsenumerationfieldformatter.h>

Inheritance diagram for QgsEnumerationFieldFormatter:

Public Member Functions
	QgsEnumerationFieldFormatter ()
	Default constructor of field formatter provider supplied enumerated values.
QVariant	createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const override
	Create a cache for a given field.
QString	id () const override
	Returns a unique id for this field formatter.
QString	representValue (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const override
	Create a pretty String representation of the value.
QVariant	sortValue (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const override
	If the default sort order should be overwritten for this widget, you can transform the value in here.
Public Member Functions inherited from QgsFieldFormatter
	QgsFieldFormatter ()=default
virtual	~QgsFieldFormatter ()=default
virtual Qt::AlignmentFlag	alignmentFlag (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
	Returns the alignment for a particular field.
virtual QVariantList	availableValues (const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context) const
	Returns a list of the values that would be possible to select with this widget type On a RelationReference that would be the parents ids or on ValueMap all the configured keys according to the settings in the config.
Flags	flags () const
	Returns the flags.
virtual QList< QgsVectorLayerRef >	layerDependencies (const QVariantMap &config) const SIP_SKIP
	Returns a list of weak layer references to other layers required by this formatter for the given config.
void	setFlags (const Flags &flags)
	Sets the flags.
enum Flag	SIP_ENUM_BASETYPE (IntFlag)
	Flags for the abilities of the formatter.

Additional Inherited Members
Public Types inherited from QgsFieldFormatter
typedef QFlags< Flag >	Flags

Detailed Description

Field formatter for an Enumeration field.

Enumeration values can be either list of values (eg. postgres ENUM type) or code-value pairs (eg. gpkg field domains)

A map of code-value pairs is used in both cases, with values==codes in case only values are provided (eg. postgres ENUM type)

Since: QGIS 4.4

Definition at line 33 of file qgsenumerationfieldformatter.h.

Constructor & Destructor Documentation

◆ QgsEnumerationFieldFormatter()

QgsEnumerationFieldFormatter::QgsEnumerationFieldFormatter ( )

Default constructor of field formatter provider supplied enumerated values.

Definition at line 25 of file qgsenumerationfieldformatter.cpp.

Member Function Documentation

◆ createCache()

QVariant QgsEnumerationFieldFormatter::createCache	(	QgsVectorLayer *	layer,
		int	fieldIndex,
		const QVariantMap &	config ) const

overridevirtual

Create a cache for a given field.

This will be used in situations where a field is being represented various times in a loop. And will be passed to other methods on QgsFieldKit and QgsEditorWidgetWrapper.

For example, the attribute table will create a cache once for each field and then use this cache for representation. The QgsValueRelationFieldFormatter and QgsValueRelationEditorWidget implement this functionality to create a lookuptable once (a QVariantMap / dict) and are make use of a cache if present.

Reimplemented from QgsFieldFormatter.

Definition at line 54 of file qgsenumerationfieldformatter.cpp.

◆ id()

QString QgsEnumerationFieldFormatter::id ( ) const

overridevirtual

Returns a unique id for this field formatter.

This id will later be used to identify this field formatter in the registry with QgsFieldFormatterRegistry::fieldFormatter().

This id matches the id of a QgsEditorWidgetFactory.

Implements QgsFieldFormatter.

Definition at line 28 of file qgsenumerationfieldformatter.cpp.

◆ representValue()

QString QgsEnumerationFieldFormatter::representValue	(	QgsVectorLayer *	layer,
		int	fieldIndex,
		const QVariantMap &	config,
		const QVariant &	cache,
		const QVariant &	value ) const

overridevirtual

Create a pretty String representation of the value.

Returns: By default the string representation of the provided value as implied by the field definition is returned.

Reimplemented from QgsFieldFormatter.

Definition at line 33 of file qgsenumerationfieldformatter.cpp.

◆ sortValue()

QVariant QgsEnumerationFieldFormatter::sortValue	(	QgsVectorLayer *	layer,
		int	fieldIndex,
		const QVariantMap &	config,
		const QVariant &	cache,
		const QVariant &	value ) const

overridevirtual

If the default sort order should be overwritten for this widget, you can transform the value in here.

Returns: an unmodified value by default.

Reimplemented from QgsFieldFormatter.

Definition at line 49 of file qgsenumerationfieldformatter.cpp.

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

/build/qgis-4.3.0+git20260904+90cb4ecf9ef+99sid/src/core/fieldformatter/qgsenumerationfieldformatter.h
/build/qgis-4.3.0+git20260904+90cb4ecf9ef+99sid/src/core/fieldformatter/qgsenumerationfieldformatter.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsEnumerationFieldFormatter()

Member Function Documentation

◆ createCache()

◆ id()

◆ representValue()

◆ sortValue()