QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
fieldformatter
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
7
email : matthias@opengis.ch
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
41
class
CORE_EXPORT
QgsValueMapFieldFormatter
:
public
QgsFieldFormatter
42
{
43
public
:
48
static
const
QString
NULL_VALUE
;
49
53
QgsValueMapFieldFormatter
();
54
55
QString
id
()
const override
;
56
57
QString
representValue
(
QgsVectorLayer
*layer,
int
fieldIndex,
const
QVariantMap &config,
const
QVariant &cache,
const
QVariant &value )
const override
;
58
59
QVariant
sortValue
(
QgsVectorLayer
*layer,
int
fieldIndex,
const
QVariantMap &config,
const
QVariant &cache,
const
QVariant &value )
const override
;
60
61
QVariantList
availableValues
(
const
QVariantMap &config,
int
countLimit,
const
QgsFieldFormatterContext
&context )
const override
;
62
};
63
64
#endif
// QGSVALUEMAPFIELDKIT_H
QgsFieldFormatterContext
A context for field formatter containing information like the project.
Definition
qgsfieldformatter.h:34
QgsFieldFormatter::QgsFieldFormatter
QgsFieldFormatter()=default
QgsFieldFormatter::id
virtual QString id() const =0
Returns a unique id for this field formatter.
QgsFieldFormatter::availableValues
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...
Definition
qgsfieldformatter.cpp:93
QgsFieldFormatter::sortValue
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.
Definition
qgsfieldformatter.cpp:50
QgsFieldFormatter::representValue
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.
Definition
qgsfieldformatter.cpp:24
QgsValueMapFieldFormatter::QgsValueMapFieldFormatter
QgsValueMapFieldFormatter()
Default constructor of field formatter for a value map field.
Definition
qgsvaluemapfieldformatter.cpp:27
QgsValueMapFieldFormatter::NULL_VALUE
static const QString NULL_VALUE
Will be saved in the configuration when a value is NULL.
Definition
qgsvaluemapfieldformatter.h:48
QgsVectorLayer
Represents a vector layer which manages a vector based dataset.
Definition
qgsvectorlayer.h:414
qgsfieldformatter.h
Generated on
for QGIS API Documentation by
1.17.0