QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | List of all members
QgsRelationReferenceFieldFormatter Class Reference

Field formatter for a relation reference field. More...

#include <qgsrelationreferencefieldformatter.h>

Inheritance diagram for QgsRelationReferenceFieldFormatter:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

Field formatter for a relation reference field.

A value relation field formatter looks up the values from features on another layer.

Since
QGIS 3.0

Definition at line 30 of file qgsrelationreferencefieldformatter.h.

Constructor & Destructor Documentation

◆ QgsRelationReferenceFieldFormatter()

QgsRelationReferenceFieldFormatter::QgsRelationReferenceFieldFormatter ( )
default

Default constructor of field formatter for a relation reference field.

Member Function Documentation

◆ id()

QString QgsRelationReferenceFieldFormatter::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 25 of file qgsrelationreferencefieldformatter.cpp.

◆ representValue()

QString QgsRelationReferenceFieldFormatter::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 30 of file qgsrelationreferencefieldformatter.cpp.

◆ sortValue()

QVariant QgsRelationReferenceFieldFormatter::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.
Since
QGIS 3.0

Reimplemented from QgsFieldFormatter.

Definition at line 88 of file qgsrelationreferencefieldformatter.cpp.


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