QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Member Functions | List of all members
QgsRangeFieldFormatter Class Reference

Field formatter for a range (double) field with precision and locale. More...

#include <qgsrangefieldformatter.h>

Inheritance diagram for QgsRangeFieldFormatter:
Inheritance graph
[legend]

Public Member Functions

 QgsRangeFieldFormatter ()=default
 Default constructor of field formatter for a range (double)field. 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 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. More...
 
virtual QVariant createCache (QgsVectorLayer *layer, int fieldIndex, const QVariantMap &config) const
 Create a cache for a given field. More...
 
Flags flags () const
 Returns the flags. More...
 
virtual QList< QgsVectorLayerReflayerDependencies (const QVariantMap &config) const
 Returns a list of weak layer references to other layers required by this formatter for the given config. More...
 
void setFlags (const Flags &flags)
 Sets the flags. 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...
 

Additional Inherited Members

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

Detailed Description

Field formatter for a range (double) field with precision and locale.

Since
QGIS 3.0

Definition at line 28 of file qgsrangefieldformatter.h.

Constructor & Destructor Documentation

◆ QgsRangeFieldFormatter()

QgsRangeFieldFormatter::QgsRangeFieldFormatter ( )
default

Default constructor of field formatter for a range (double)field.

Member Function Documentation

◆ id()

QString QgsRangeFieldFormatter::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 27 of file qgsrangefieldformatter.cpp.

◆ representValue()

QString QgsRangeFieldFormatter::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 32 of file qgsrangefieldformatter.cpp.


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