QGIS API Documentation  3.8.0-Zanzibar (11aff65)
Public Member Functions | List of all members
QgsKeyValueFieldFormatter Class Reference

Field formatter for a key value field. More...

#include <qgskeyvaluefieldformatter.h>

Inheritance diagram for QgsKeyValueFieldFormatter:
Inheritance graph
[legend]

Public Member Functions

 QgsKeyValueFieldFormatter ()=default
 Default constructor of field formatter for a key value field. More...
 
QString id () const override
 Returns a unique id for this field formatter. More...
 
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. More...
 
- Public Member Functions inherited from QgsFieldFormatter
 QgsFieldFormatter ()
 
virtual ~QgsFieldFormatter ()=default
 
virtual Qt::AlignmentFlag alignmentFlag (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
 Returns the alignment for a particular field. More...
 
virtual QVariant createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
 Create a cache for a given field. 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...
 

Detailed Description

Field formatter for a key value field.

This represents a list type value. Values will be represented as a colon-delimited and comma-separated list.

E.g. "color: yellow, amount: 5"

Since
QGIS 3.0

Definition at line 33 of file qgskeyvaluefieldformatter.h.

Constructor & Destructor Documentation

◆ QgsKeyValueFieldFormatter()

QgsKeyValueFieldFormatter::QgsKeyValueFieldFormatter ( )
default

Default constructor of field formatter for a key value field.

Member Function Documentation

◆ id()

QString QgsKeyValueFieldFormatter::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 21 of file qgskeyvaluefieldformatter.cpp.

◆ representValue()

QString QgsKeyValueFieldFormatter::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.
Since
QGIS 3.0

Reimplemented from QgsFieldFormatter.

Definition at line 26 of file qgskeyvaluefieldformatter.cpp.


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