QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
fieldformatter
qgsrelationreferencefieldformatter.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsrelationreferencefieldformatter.h - QgsRelationReferenceFieldFormatter
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 QGSRELATIONREFERENCEFIELDKIT_H
17
#define QGSRELATIONREFERENCEFIELDKIT_H
18
19
#include "qgis_core.h"
20
#include "
qgsfieldformatter.h
"
21
30
class
CORE_EXPORT
QgsRelationReferenceFieldFormatter
:
public
QgsFieldFormatter
31
{
32
public
:
36
QgsRelationReferenceFieldFormatter
();
37
38
QString
id
()
const override
;
39
40
QString
representValue
(
QgsVectorLayer
*layer,
int
fieldIndex,
const
QVariantMap &config,
const
QVariant &cache,
const
QVariant &value )
const override
;
41
42
QVariant
sortValue
(
QgsVectorLayer
*layer,
int
fieldIndex,
const
QVariantMap &config,
const
QVariant &cache,
const
QVariant &value )
const override
;
43
44
QVariant
createCache
(
QgsVectorLayer
*layer,
int
fieldIndex,
const
QVariantMap &config )
const override
;
45
46
QList<QgsVectorLayerRef>
layerDependencies
(
const
QVariantMap &config )
const
override
SIP_SKIP
;
47
48
QVariantList
availableValues
(
const
QVariantMap &config,
int
countLimit,
const
QgsFieldFormatterContext
&context )
const override
;
49
50
//friend class TestQgsRelationReferenceFieldFormatter;
51
};
52
53
#endif
// QGSRELATIONREFERENCEFIELDKIT_H
QgsFieldFormatterContext
A context for field formatter containing information like the project.
Definition
qgsfieldformatter.h:34
QgsFieldFormatter::createCache
virtual QVariant createCache(QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
Create a cache for a given field.
Definition
qgsfieldformatter.cpp:78
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::layerDependencies
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 conf...
Definition
qgsfieldformatter.cpp:87
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
QgsRelationReferenceFieldFormatter::QgsRelationReferenceFieldFormatter
QgsRelationReferenceFieldFormatter()
Default constructor of field formatter for a relation reference field.
Definition
qgsrelationreferencefieldformatter.cpp:30
QgsVectorLayer
Represents a vector layer which manages a vector based dataset.
Definition
qgsvectorlayer.h:414
SIP_SKIP
#define SIP_SKIP
Definition
qgis_sip.h:138
qgsfieldformatter.h
Generated on
for QGIS API Documentation by
1.17.0