Field formatter for a checkbox field. More...

#include <qgscheckboxfieldformatter.h>

Inheritance diagram for QgsCheckBoxFieldFormatter:

Public Types
enum	TextDisplayMethod { ShowTrueFalse , ShowStoredValues }
	Method to use when displaying the checkbox values as plain text. More...

Public Types inherited from QgsFieldFormatter
enum	Flag { CanProvideAvailableValues = 1 }
	Flags for the abilities of the formatter. More...

Public Member Functions
	QgsCheckBoxFieldFormatter ()=default
	Constructor for QgsCheckBoxFieldFormatter.

QString	id () const override
	Returns a unique id for this field formatter.

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.

Public Member Functions inherited from QgsFieldFormatter
	QgsFieldFormatter ()=default
	Default constructor.

virtual	~QgsFieldFormatter ()=default

virtual Qt::AlignmentFlag	alignmentFlag (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
	Returns the alignment for a particular field.

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 RelationReference that would be the parents ids or on ValueMap all the configured keys according to the settings in the config.

virtual QVariant	createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
	Create a cache for a given field.

Flags	flags () const
	Returns the flags.

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 config.

void	setFlags (const Flags &flags)
	Sets the flags.

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.

Detailed Description

Field formatter for a checkbox field.

Since: QGIS 3.10

Definition at line 29 of file qgscheckboxfieldformatter.h.

Member Enumeration Documentation

◆ TextDisplayMethod

enum QgsCheckBoxFieldFormatter::TextDisplayMethod

Method to use when displaying the checkbox values as plain text.

Since: QGIS 3.18

Enumerator
ShowTrueFalse	Shows "True" or "False" strings.
ShowStoredValues	Shows actual stored field value.

Definition at line 38 of file qgscheckboxfieldformatter.h.

Constructor & Destructor Documentation

◆ QgsCheckBoxFieldFormatter()

QgsCheckBoxFieldFormatter::QgsCheckBoxFieldFormatter ( )

default

Constructor for QgsCheckBoxFieldFormatter.

Member Function Documentation

◆ id()

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.

◆ representValue()

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.34.0+99sid/src/core/fieldformatter/qgscheckboxfieldformatter.h
/build/qgis-3.34.0+99sid/src/core/fieldformatter/qgscheckboxfieldformatter.cpp

Public Types

Public Member Functions