QgsFallbackFieldFormatter Class Reference

A default fallback field formatter in case no specialized field formatter is defined. More...

#include <qgsfallbackfieldformatter.h>

Inheritance diagram for QgsFallbackFieldFormatter:

Public Member Functions
	QgsFallbackFieldFormatter ()=default
	Default constructor of field formatter as a fallback when no specialized formatter is defined. More...
QString	id () const override
	Returns a unique id for this field formatter. More...
Public Member Functions inherited from QgsFieldFormatter
	QgsFieldFormatter ()=default
	Default constructor. More...
virtual	~QgsFieldFormatter ()=default
virtual Qt::AlignmentFlag	alignmentFlag (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
	Returns the alignment for a particular field. More...
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. More...
virtual QVariant	createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
	Create a cache for a given field. More...
Flags	flags () const
	Returns the flags. More...
virtual QString	id () const =0
	Returns a unique id for this field formatter. More...
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. More...
virtual QString	representValue (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const
	Create a pretty String representation of the value. More...
void	setFlags (const Flags &flags)
	Sets the flags. More...
virtual QVariant	sortValue (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const
	If the default sort order should be overwritten for this widget, you can transform the value in here. More...

Additional Inherited Members
Public Types inherited from QgsFieldFormatter
enum	Flag { CanProvideAvailableValues = 1 }
	Flags for the abilities of the formatter. More...

Detailed Description

A default fallback field formatter in case no specialized field formatter is defined.

The values will be returned unmodified.

Since

QGIS 3.0

Definition at line 30 of file qgsfallbackfieldformatter.h.

Constructor & Destructor Documentation

QgsFallbackFieldFormatter()

QgsFallbackFieldFormatter::QgsFallbackFieldFormatter ( )

default

Default constructor of field formatter as a fallback when no specialized formatter is defined.

Member Function Documentation

id()

QString QgsFallbackFieldFormatter::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 18 of file qgsfallbackfieldformatter.cpp.

---

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

• /build/qgis-3.28.0+99sid/src/core/fieldformatter/qgsfallbackfieldformatter.h
• /build/qgis-3.28.0+99sid/src/core/fieldformatter/qgsfallbackfieldformatter.cpp