QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgspercentagenumericformat.h>
Public Types | |
enum | InputValues { ValuesArePercentage, ValuesAreFractions } |
Input value format, which specifies the format of the incoming values. More... | |
![]() | |
enum | RoundingType { DecimalPlaces, SignificantFigures } |
Sets rounding type and behavior of the numberDecimalPlaces() setting. More... | |
Public Member Functions | |
QgsPercentageNumericFormat () | |
Default constructor. More... | |
QgsNumericFormat * | clone () const override |
Clones the format, returning a new object. More... | |
QVariantMap | configuration (const QgsReadWriteContext &context) const override |
Returns the current configuration of the formatter. More... | |
QgsNumericFormat * | create (const QVariantMap &configuration, const QgsReadWriteContext &context) const override |
Creates a new copy of the format, using the supplied configuration. More... | |
QString | formatDouble (double value, const QgsNumericFormatContext &context) const override |
Returns a formatted string representation of a numeric double value. More... | |
QString | id () const override |
Returns a unique id for this numeric format. More... | |
InputValues | inputValues () const |
Returns the format of the incoming values. More... | |
void | setInputValues (InputValues format) |
Sets the format of the incoming values. More... | |
int | sortKey () override |
Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists. More... | |
double | suggestSampleValue () const override |
Returns a suggested sample value which nicely represents the current format configuration. More... | |
QString | visibleName () const override |
Returns the translated, user-visible name for this format. More... | |
![]() | |
QgsBasicNumericFormat () | |
Default constructor. More... | |
QChar | decimalSeparator () const |
Returns any override for the decimal separator character. More... | |
int | numberDecimalPlaces () const |
Returns the maximum number of decimal places to show. More... | |
RoundingType | roundingType () const |
Returns the rounding type, which controls the behavior of the numberDecimalPlaces() setting. More... | |
void | setDecimalSeparator (QChar character) |
Sets an override character for the decimal separator character. More... | |
virtual void | setNumberDecimalPlaces (int places) |
Sets the maximum number of decimal places to show. More... | |
void | setRoundingType (RoundingType type) |
Sets the rounding type, which controls the behavior of the numberDecimalPlaces() setting. More... | |
void | setShowPlusSign (bool show) |
Sets whether a leading plus sign will be shown for positive values. More... | |
void | setShowThousandsSeparator (bool show) |
Sets whether the thousands grouping separator will be shown. More... | |
void | setShowTrailingZeros (bool show) |
Sets whether trailing zeros will be shown (up to the specified numberDecimalPlaces()). More... | |
void | setThousandsSeparator (QChar character) |
Sets an override character for the thousands separator character. More... | |
bool | showPlusSign () const |
Returns true if a leading plus sign will be shown for positive values. More... | |
bool | showThousandsSeparator () const |
Returns true if the thousands grouping separator will be shown. More... | |
bool | showTrailingZeros () const |
Returns true if trailing zeros will be shown (up to the specified numberDecimalPlaces()). More... | |
QChar | thousandsSeparator () const |
Returns any override for the thousands separator character. More... | |
![]() | |
QgsNumericFormat ()=default | |
Default constructor. More... | |
virtual | ~QgsNumericFormat ()=default |
bool | operator!= (const QgsNumericFormat &other) const |
bool | operator== (const QgsNumericFormat &other) const |
void | writeXml (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const |
Writes the format to an XML element. More... | |
Additional Inherited Members | |
![]() | |
virtual void | setConfiguration (const QVariantMap &configuration, const QgsReadWriteContext &context) |
Sets the format's configuration. More... | |
![]() | |
bool | mUseScientific = false |
A numeric formatter which returns a text representation of a percentage value.
Definition at line 28 of file qgspercentagenumericformat.h.
Input value format, which specifies the format of the incoming values.
Enumerator | |
---|---|
ValuesArePercentage | Incoming values are percentage values (e.g. 50 for 50%) |
ValuesAreFractions | Incoming values are numeric fractions (e.g. 0.5 for 50%) |
Definition at line 46 of file qgspercentagenumericformat.h.
QgsPercentageNumericFormat::QgsPercentageNumericFormat | ( | ) |
Default constructor.
Definition at line 21 of file qgspercentagenumericformat.cpp.
|
overridevirtual |
Clones the format, returning a new object.
The caller takes ownership of the returned object.
Reimplemented from QgsBasicNumericFormat.
Definition at line 68 of file qgspercentagenumericformat.cpp.
|
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.
Reimplemented from QgsBasicNumericFormat.
Definition at line 82 of file qgspercentagenumericformat.cpp.
|
overridevirtual |
Creates a new copy of the format, using the supplied configuration.
The caller takes ownership of the returned object.
Reimplemented from QgsBasicNumericFormat.
Definition at line 73 of file qgspercentagenumericformat.cpp.
|
overridevirtual |
Returns a formatted string representation of a numeric double value.
Reimplemented from QgsBasicNumericFormat.
Definition at line 53 of file qgspercentagenumericformat.cpp.
|
overridevirtual |
Returns a unique id for this numeric format.
This id is used to identify this numeric format in the registry with QgsNumericFormatRegistry::format().
Reimplemented from QgsBasicNumericFormat.
Definition at line 25 of file qgspercentagenumericformat.cpp.
QgsPercentageNumericFormat::InputValues QgsPercentageNumericFormat::inputValues | ( | ) | const |
Returns the format of the incoming values.
Definition at line 89 of file qgspercentagenumericformat.cpp.
void QgsPercentageNumericFormat::setInputValues | ( | InputValues | format | ) |
Sets the format of the incoming values.
Definition at line 94 of file qgspercentagenumericformat.cpp.
|
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 QgsBasicNumericFormat.
Definition at line 35 of file qgspercentagenumericformat.cpp.
|
overridevirtual |
Returns a suggested sample value which nicely represents the current format configuration.
Reimplemented from QgsNumericFormat.
Definition at line 40 of file qgspercentagenumericformat.cpp.
|
overridevirtual |
Returns the translated, user-visible name for this format.
Reimplemented from QgsBasicNumericFormat.
Definition at line 30 of file qgspercentagenumericformat.cpp.