QGIS API Documentation 3.39.0-Master (3783037d301)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsFallbackNumericFormat Class Reference

A basic numeric formatter which returns a simple text representation of a value. More...

#include <qgsfallbacknumericformat.h>

Inheritance diagram for QgsFallbackNumericFormat:
Inheritance graph
[legend]

Public Member Functions

 QgsFallbackNumericFormat ()=default
 
QgsNumericFormatclone () const override
 Clones the format, returning a new object.
 
QVariantMap configuration (const QgsReadWriteContext &context) const override
 Returns the current configuration of the formatter.
 
QgsNumericFormatcreate (const QVariantMap &configuration, const QgsReadWriteContext &context) const override
 Creates a new copy of the format, using the supplied configuration.
 
QString formatDouble (double value, const QgsNumericFormatContext &context) const override
 Returns a formatted string representation of a numeric double value.
 
QString id () const override
 Returns a unique id for this numeric format.
 
int sortKey () override
 Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists.
 
QString visibleName () const override
 Returns the translated, user-visible name for this format.
 
- Public Member Functions inherited from QgsNumericFormat
 QgsNumericFormat ()=default
 
virtual ~QgsNumericFormat ()=default
 
bool operator!= (const QgsNumericFormat &other) const
 
bool operator== (const QgsNumericFormat &other) const
 
virtual double suggestSampleValue () const
 Returns a suggested sample value which nicely represents the current format configuration.
 
void writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
 Writes the format to an XML element.
 

Additional Inherited Members

- Static Protected Attributes inherited from QgsNumericFormat
static constexpr int DEFAULT_SORT_KEY = 100
 

Detailed Description

A basic numeric formatter which returns a simple text representation of a value.

Since
QGIS 3.12

Definition at line 28 of file qgsfallbacknumericformat.h.

Constructor & Destructor Documentation

◆ QgsFallbackNumericFormat()

QgsFallbackNumericFormat::QgsFallbackNumericFormat ( )
default

Member Function Documentation

◆ clone()

QgsNumericFormat * QgsFallbackNumericFormat::clone ( ) const
overridevirtual

Clones the format, returning a new object.

The caller takes ownership of the returned object.

Implements QgsNumericFormat.

Definition at line 40 of file qgsfallbacknumericformat.cpp.

◆ configuration()

QVariantMap QgsFallbackNumericFormat::configuration ( const QgsReadWriteContext context) const
overridevirtual

Returns the current configuration of the formatter.

This value can be used in a call to create() in order to recreate this formatter in its current state.

Implements QgsNumericFormat.

Definition at line 50 of file qgsfallbacknumericformat.cpp.

◆ create()

QgsNumericFormat * QgsFallbackNumericFormat::create ( const QVariantMap &  configuration,
const QgsReadWriteContext context 
) const
overridevirtual

Creates a new copy of the format, using the supplied configuration.

The caller takes ownership of the returned object.

Implements QgsNumericFormat.

Definition at line 45 of file qgsfallbacknumericformat.cpp.

◆ formatDouble()

QString QgsFallbackNumericFormat::formatDouble ( double  value,
const QgsNumericFormatContext context 
) const
overridevirtual

Returns a formatted string representation of a numeric double value.

Implements QgsNumericFormat.

Definition at line 35 of file qgsfallbacknumericformat.cpp.

◆ id()

QString QgsFallbackNumericFormat::id ( ) const
overridevirtual

Returns a unique id for this numeric format.

This id is used to identify this numeric format in the registry with QgsNumericFormatRegistry::format().

Implements QgsNumericFormat.

Definition at line 20 of file qgsfallbacknumericformat.cpp.

◆ sortKey()

int QgsFallbackNumericFormat::sortKey ( )
overridevirtual

Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists.

Generally, subclasses should return QgsNumericFormat::sortKey() as their sorting key.

Reimplemented from QgsNumericFormat.

Definition at line 30 of file qgsfallbacknumericformat.cpp.

◆ visibleName()

QString QgsFallbackNumericFormat::visibleName ( ) const
overridevirtual

Returns the translated, user-visible name for this format.

Implements QgsNumericFormat.

Definition at line 25 of file qgsfallbacknumericformat.cpp.


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