QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Member Functions | List of all members
QgsListFieldFormatter Class Reference

Field formatter for a list field. More...

#include <qgslistfieldformatter.h>

Inheritance diagram for QgsListFieldFormatter:
Inheritance graph
[legend]

Public Member Functions

 QgsListFieldFormatter ()=default
 Default constructor of field formatter for a list 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 list field.

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

Since
QGIS 3.0

Definition at line 30 of file qgslistfieldformatter.h.

Constructor & Destructor Documentation

◆ QgsListFieldFormatter()

QgsListFieldFormatter::QgsListFieldFormatter ( )
default

Default constructor of field formatter for a list field.

Member Function Documentation

◆ id()

QString QgsListFieldFormatter::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 20 of file qgslistfieldformatter.cpp.

◆ representValue()

QString QgsListFieldFormatter::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 25 of file qgslistfieldformatter.cpp.


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