QGIS API Documentation
3.0.2-Girona (307d082)
|
Field formatter for a value relation field. More...
#include <qgsvaluerelationfieldformatter.h>
Classes | |
struct | ValueRelationItem |
Public Types | |
typedef QVector< QgsValueRelationFieldFormatter::ValueRelationItem > | ValueRelationCache |
Public Member Functions | |
QgsValueRelationFieldFormatter ()=default | |
Constructor for QgsValueRelationFieldFormatter. More... | |
QVariant | createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const override |
Create a cache for a given field. More... | |
QString | id () const override |
Return 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 |
Return the alignment for a particular field. More... | |
Static Public Member Functions | |
static QgsValueRelationFieldFormatter::ValueRelationCache | createCache (const QVariantMap &config) |
Create a cache for a value relation field. More... | |
Field formatter for a value relation field.
A value relation field formatter looks up the values from features on another layer.
Definition at line 33 of file qgsvaluerelationfieldformatter.h.
typedef QVector< QgsValueRelationFieldFormatter::ValueRelationItem > QgsValueRelationFieldFormatter::ValueRelationCache |
Definition at line 51 of file qgsvaluerelationfieldformatter.h.
|
default |
Constructor for QgsValueRelationFieldFormatter.
|
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 94 of file qgsvaluerelationfieldformatter.cpp.
|
static |
Create a cache for a value relation field.
This can be used to keep the value map in the local memory if doing multiple lookups in a loop.
Definition at line 102 of file qgsvaluerelationfieldformatter.cpp.
|
overridevirtual |
Return 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 34 of file qgsvaluerelationfieldformatter.cpp.
|
overridevirtual |
Create a pretty String representation of the value.
Reimplemented from QgsFieldFormatter.
Definition at line 39 of file qgsvaluerelationfieldformatter.cpp.
|
overridevirtual |
If the default sort order should be overwritten for this widget, you can transform the value in here.
Reimplemented from QgsFieldFormatter.
Definition at line 89 of file qgsvaluerelationfieldformatter.cpp.