QGIS API Documentation 3.41.0-Master (3291e9ff48b)
Loading...
Searching...
No Matches
qgsvaluemapfieldformatter.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsvaluemapfieldformatter.h - QgsValueMapFieldFormatter
3
4 ---------------------
5 begin : 3.12.2016
6 copyright : (C) 2016 by Matthias Kuhn
8 ***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16#ifndef QGSVALUEMAPFIELDKIT_H
17#define QGSVALUEMAPFIELDKIT_H
18
19#include "qgis_core.h"
20#include "qgsfieldformatter.h"
21
40{
41 public:
42
47 static const QString NULL_VALUE;
48
53
54 QString id() const override;
55
56 QString representValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const override;
57
58 QVariant sortValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const override;
59
60 QVariantList availableValues( const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context ) const override;
61};
62
63#endif // QGSVALUEMAPFIELDKIT_H
A context for field formatter containing information like the project.
A field formatter helps to handle and display values for a field.
virtual QString id() const =0
Returns a unique id for this field formatter.
virtual QVariantList availableValues(const QVariantMap &config, int countLimit, const QgsFieldFormatterContext &context) const
Returns a list of the values that would be possible to select with this widget type On a RelationRefe...
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.
virtual QString representValue(QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const
Create a pretty String representation of the value.
Field formatter for a ValueMap field.
static const QString NULL_VALUE
Will be saved in the configuration when a value is NULL.
Represents a vector layer which manages a vector based data sets.