QgsCheckBoxFieldFormatter Class Reference

Field formatter for a checkbox field. More...

#include <qgscheckboxfieldformatter.h>

Inheritance diagram for QgsCheckBoxFieldFormatter:

Public Member Functions
	QgsCheckBoxFieldFormatter ()=default
	Constructor for QgsCheckBoxFieldFormatter. More...
QString	id () const override
	Returns a unique id for this field formatter. More...
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. More...
Public Member Functions inherited from QgsFieldFormatter
	QgsFieldFormatter ()=default
	Default constructor. More...
virtual	~QgsFieldFormatter ()=default
virtual Qt::AlignmentFlag	alignmentFlag (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
	Returns the alignment for a particular field. More...
virtual QVariant	createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
	Create a cache for a given field. More...
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. More...

Detailed Description

Field formatter for a checkbox field.

Since

QGIS 3.10

Definition at line 29 of file qgscheckboxfieldformatter.h.

Constructor & Destructor Documentation

QgsCheckBoxFieldFormatter::QgsCheckBoxFieldFormatter ( )

default

Constructor for QgsCheckBoxFieldFormatter.

Member Function Documentation

QString QgsCheckBoxFieldFormatter::id ( ) const

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 24 of file qgscheckboxfieldformatter.cpp.

QString QgsCheckBoxFieldFormatter::representValue ( QgsVectorLayer *  layer, int  fieldIndex, const QVariantMap &  config, const QVariant &  cache, const QVariant &  value  ) const

overridevirtual

Create a pretty String representation of the value.

Returns

By default the string representation of the provided value as implied by the field definition is returned.

Since

QGIS 3.0

Reimplemented from QgsFieldFormatter.

Definition at line 29 of file qgscheckboxfieldformatter.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.4.15+24xenial/src/core/fieldformatter/qgscheckboxfieldformatter.h
• /build/qgis-3.4.15+24xenial/src/core/fieldformatter/qgscheckboxfieldformatter.cpp