QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
qgspercentagenumericformat.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgspercentagenumericformat.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 QGSPERCENTAGENUMERICFORMAT_H
16 #define QGSPERCENTAGENUMERICFORMAT_H
17 
18 #include "qgis_core.h"
19 #include "qgis_sip.h"
20 #include "qgsbasicnumericformat.h"
21 
29 {
30  public:
31 
34  {
37  };
38 
43 
44  QString id() const override;
45  QString visibleName() const override;
46  int sortKey() override;
47  double suggestSampleValue() const override;
48  QString formatDouble( double value, const QgsNumericFormatContext &context ) const override;
49  QgsNumericFormat *clone() const override SIP_FACTORY;
50  QgsNumericFormat *create( const QVariantMap &configuration, const QgsReadWriteContext &context ) const override SIP_FACTORY;
51  QVariantMap configuration( const QgsReadWriteContext &context ) const override;
52 
58  InputValues inputValues() const;
59 
65  void setInputValues( InputValues format );
66 
67  private:
68 
69  InputValues mInputValues = ValuesArePercentage;
70 
71 };
72 
73 #endif // QGSPERCENTAGENUMERICFORMAT_H
A numeric formatter which returns a simple text representation of a value.
QString id() const override
Returns a unique id for this numeric format.
QString visibleName() const override
Returns the translated, user-visible name for this format.
int sortKey() override
Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists.
QgsNumericFormat * clone() const override
Clones the format, returning a new object.
QString formatDouble(double value, const QgsNumericFormatContext &context) const override
Returns a formatted string representation of a numeric double value.
A context for numeric formats.
A numeric formatter allows for formatting a numeric value for display, using a variety of different f...
virtual double suggestSampleValue() const
Returns a suggested sample value which nicely represents the current format configuration.
A numeric formatter which returns a text representation of a percentage value.
InputValues
Input value format, which specifies the format of the incoming values.
@ ValuesAreFractions
Incoming values are numeric fractions (e.g. 0.5 for 50%)
@ ValuesArePercentage
Incoming values are percentage values (e.g. 50 for 50%)
The class is used as a container of context for various read/write operations on other objects.
#define SIP_FACTORY
Definition: qgis_sip.h:76