QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
QgsDateTimeFieldFormatter Class Reference

Field formatter for a date time field. More...

#include <qgsdatetimefieldformatter.h>

Inheritance diagram for QgsDateTimeFieldFormatter:
Inheritance graph
[legend]

Public Member Functions

 QgsDateTimeFieldFormatter ()=default
 Default constructor of field formatter for a date time 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 QString id () const =0
 Returns a unique id for this field formatter. More...
 
virtual QList< QgsVectorLayerReflayerDependencies (const QVariantMap &config) const SIP_SKIP
 Returns a list of weak layer references to other layers required by this formatter for the given config. More...
 
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. 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...
 

Static Public Member Functions

static void applyLocaleChange ()
 Adjusts the date time formats according to locale. More...
 
static QString defaultFormat (QVariant::Type type)
 Gets the default format in function of the type. More...
 

Public Attributes

 SIP_SKIP
 

Static Public Attributes

static QString DATE_FORMAT = QStringLiteral( "yyyy-MM-dd" )
 
static QString DATETIME_FORMAT = QStringLiteral( "yyyy-MM-dd HH:mm:ss" )
 
static const QString DISPLAY_FOR_ISO_FORMAT = QStringLiteral( "yyyy-MM-dd HH:mm:ss+t" )
 
static const QString QT_ISO_FORMAT = QStringLiteral( "Qt ISO Date" )
 
static const QString TIME_FORMAT = QStringLiteral( "HH:mm:ss" )
 

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 date time field.

This represents a date, time or datetime value based on the field configuration.

Since
QGIS 3.0

Definition at line 31 of file qgsdatetimefieldformatter.h.

Constructor & Destructor Documentation

◆ QgsDateTimeFieldFormatter()

QgsDateTimeFieldFormatter::QgsDateTimeFieldFormatter ( )
default

Default constructor of field formatter for a date time field.

Member Function Documentation

◆ applyLocaleChange()

void QgsDateTimeFieldFormatter::applyLocaleChange ( )
static

Adjusts the date time formats according to locale.

Since
QGIS 3.22.2

Definition at line 120 of file qgsdatetimefieldformatter.cpp.

◆ defaultFormat()

QString QgsDateTimeFieldFormatter::defaultFormat ( QVariant::Type  type)
static

Gets the default format in function of the type.

The type is expected to be one of

  • QVariant::DateTime
  • QVariant::Date
  • QVariant::Time

Definition at line 107 of file qgsdatetimefieldformatter.cpp.

◆ id()

QString QgsDateTimeFieldFormatter::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 33 of file qgsdatetimefieldformatter.cpp.

◆ representValue()

QString QgsDateTimeFieldFormatter::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 38 of file qgsdatetimefieldformatter.cpp.

Member Data Documentation

◆ DATE_FORMAT

QString QgsDateTimeFieldFormatter::DATE_FORMAT = QStringLiteral( "yyyy-MM-dd" )
static

Definition at line 34 of file qgsdatetimefieldformatter.h.

◆ DATETIME_FORMAT

QString QgsDateTimeFieldFormatter::DATETIME_FORMAT = QStringLiteral( "yyyy-MM-dd HH:mm:ss" )
static

Definition at line 36 of file qgsdatetimefieldformatter.h.

◆ DISPLAY_FOR_ISO_FORMAT

const QString QgsDateTimeFieldFormatter::DISPLAY_FOR_ISO_FORMAT = QStringLiteral( "yyyy-MM-dd HH:mm:ss+t" )
static

Definition at line 38 of file qgsdatetimefieldformatter.h.

◆ QT_ISO_FORMAT

const QString QgsDateTimeFieldFormatter::QT_ISO_FORMAT = QStringLiteral( "Qt ISO Date" )
static

Definition at line 37 of file qgsdatetimefieldformatter.h.

◆ SIP_SKIP

QgsDateTimeFieldFormatter::SIP_SKIP

Definition at line 64 of file qgsdatetimefieldformatter.h.

◆ TIME_FORMAT

const QString QgsDateTimeFieldFormatter::TIME_FORMAT = QStringLiteral( "HH:mm:ss" )
static

Definition at line 35 of file qgsdatetimefieldformatter.h.


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