QGIS API Documentation  3.21.0-Master (5b68dc587e)
qgscheckboxfieldformatter.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgscheckboxfieldformatter.h - QgsCheckBoxFieldFormatter
3 
4  ---------------------
5  begin : 23.09.2019
6  copyright : (C) 2019 by Denis Rouzaud
7  email : [email protected]
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 QGSCHECKBOXFIELDFORMATTER_H
17 #define QGSCHECKBOXFIELDFORMATTER_H
18 
19 #include "qgis_core.h"
20 #include "qgsfieldformatter.h"
21 
22 
29 class CORE_EXPORT QgsCheckBoxFieldFormatter : public QgsFieldFormatter
30 {
31  public:
32 
39  {
42  };
43 
48 
49  QString id() const override;
50 
51  QString representValue( QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value ) const override;
52 };
53 
54 
55 #endif // QGSCHECKBOXFIELDFORMATTER_H
Field formatter for a checkbox field.
QgsCheckBoxFieldFormatter()=default
Constructor for QgsCheckBoxFieldFormatter.
TextDisplayMethod
Method to use when displaying the checkbox values as plain text.
@ ShowTrueFalse
Shows "True" or "False" strings.
@ ShowStoredValues
Shows actual stored field value.
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 QString representValue(QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config, const QVariant &cache, const QVariant &value) const
Create a pretty String representation of the value.
Represents a vector layer which manages a vector based data sets.