QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Field formatter for a ValueMap field. More...
#include <qgsvaluemapfieldformatter.h>
Public Member Functions | |
QgsValueMapFieldFormatter () | |
Default constructor of field formatter for a value map field. | |
QVariantList | availableValues (const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context) const override |
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. | |
QString | id () const override |
Returns a unique id for this field formatter. | |
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. | |
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. | |
Public Member Functions inherited from QgsFieldFormatter | |
QgsFieldFormatter ()=default | |
virtual | ~QgsFieldFormatter ()=default |
virtual Qt::AlignmentFlag | alignmentFlag (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const |
Returns the alignment for a particular field. | |
virtual QVariant | createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const |
Create a cache for a given field. | |
Flags | flags () const |
Returns the flags. | |
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. | |
void | setFlags (const Flags &flags) |
Sets the flags. | |
enum Flag | SIP_ENUM_BASETYPE (IntFlag) |
Flags for the abilities of the formatter. | |
Static Public Attributes | |
static const QString | NULL_VALUE = QStringLiteral( "{2839923C-8B7D-419E-B84B-CA2FE9B80EC7}" ) |
Will be saved in the configuration when a value is NULL. | |
Additional Inherited Members | |
Public Types inherited from QgsFieldFormatter | |
typedef QFlags< Flag > | Flags |
Field formatter for a ValueMap field.
A value relation field formatter looks up the values a map.
The map is defined in the configuration as dictionary under the key "map".
{ "map": { 1: "one", 2: "two", 3: "three" } }
Values that are not on the map will be wrapped in parentheses. So with the above configuration:
Definition at line 39 of file qgsvaluemapfieldformatter.h.
QgsValueMapFieldFormatter::QgsValueMapFieldFormatter | ( | ) |
Default constructor of field formatter for a value map field.
Definition at line 23 of file qgsvaluemapfieldformatter.cpp.
|
overridevirtual |
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.
Reimplemented from QgsFieldFormatter.
Definition at line 72 of file qgsvaluemapfieldformatter.cpp.
|
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 28 of file qgsvaluemapfieldformatter.cpp.
|
overridevirtual |
Create a pretty String representation of the value.
Reimplemented from QgsFieldFormatter.
Definition at line 33 of file qgsvaluemapfieldformatter.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 67 of file qgsvaluemapfieldformatter.cpp.
|
static |
Will be saved in the configuration when a value is NULL.
It's the magic UUID {2839923C-8B7D-419E-B84B-CA2FE9B80EC7}
Definition at line 47 of file qgsvaluemapfieldformatter.h.