QGIS API Documentation  3.12.1-BucureČ™ti (121cc00ff0)
qgsfallbacknumericformat.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsfallbacknumericformat.h
3  --------------------------
4  begin : January 2020
5  copyright : (C) 2020 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 #ifndef QGSFALLBACKNUMERICFORMAT_H
16 #define QGSFALLBACKNUMERICFORMAT_H
17 
18 #include "qgis_core.h"
19 #include "qgis_sip.h"
20 #include "qgsnumericformat.h"
21 
28 class CORE_EXPORT QgsFallbackNumericFormat : public QgsNumericFormat
29 {
30  public:
31 
35  QgsFallbackNumericFormat() = default;
36  QString id() const override;
37  QString visibleName() const override;
38  int sortKey() override;
39  QString formatDouble( double value, const QgsNumericFormatContext &context ) const override;
40  QgsNumericFormat *clone() const override SIP_FACTORY;
41  QgsNumericFormat *create( const QVariantMap &configuration, const QgsReadWriteContext &context ) const override SIP_FACTORY;
42  QVariantMap configuration( const QgsReadWriteContext &context ) const override;
43 };
44 
45 #endif // QGSFALLBACKNUMERICFORMAT_H
The class is used as a container of context for various read/write operations on other objects...
virtual QgsNumericFormat * clone() const =0
Clones the format, returning a new object.
virtual QString id() const =0
Returns a unique id for this numeric format.
virtual QgsNumericFormat * create(const QVariantMap &configuration, const QgsReadWriteContext &context) const =0
Creates a new copy of the format, using the supplied configuration.
A numeric formatter allows for formatting a numeric value for display, using a variety of different f...
virtual QString formatDouble(double value, const QgsNumericFormatContext &context) const =0
Returns a formatted string representation of a numeric double value.
#define SIP_FACTORY
Definition: qgis_sip.h:76
virtual QVariantMap configuration(const QgsReadWriteContext &context) const =0
Returns the current configuration of the formatter.
A context for numeric formats.
virtual int sortKey()
Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists...
virtual QString visibleName() const =0
Returns the translated, user-visible name for this format.
A basic numeric formatter which returns a simple text representation of a value.