QGIS API Documentation
3.20.0-Odense (decaadbb31)
|
A numeric formatter which returns a text representation of a direction/bearing. More...
#include <qgsbearingnumericformat.h>
Public Types | |
enum | FormatDirectionOption { UseRange0To180WithEWDirectionalSuffix = 0 , UseRangeNegative180ToPositive180 , UseRange0To360 } |
Directional formatting option, which controls how bearing direction is described in the returned strings. More... | |
Public Types inherited from QgsBasicNumericFormat | |
enum | RoundingType { DecimalPlaces , SignificantFigures } |
Sets rounding type and behavior of the numberDecimalPlaces() setting. More... | |
Public Member Functions | |
QgsBearingNumericFormat () | |
Default constructor. More... | |
QgsBearingNumericFormat * | 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... | |
FormatDirectionOption | directionFormat () const |
Returns the directional formatting option, which controls how bearing direction is described in the returned strings. 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... | |
void | setConfiguration (const QVariantMap &configuration, const QgsReadWriteContext &context) override |
Sets the format's configuration. More... | |
void | setDirectionFormat (FormatDirectionOption format) |
Sets the directional formatting option, which controls how bearing direction is described in the returned strings. 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... | |
Public Member Functions inherited from QgsBasicNumericFormat | |
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... | |
Public Member Functions inherited from QgsNumericFormat | |
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 | |
Protected Attributes inherited from QgsBasicNumericFormat | |
bool | mUseScientific = false |
A numeric formatter which returns a text representation of a direction/bearing.
Definition at line 28 of file qgsbearingnumericformat.h.
Directional formatting option, which controls how bearing direction is described in the returned strings.
Definition at line 36 of file qgsbearingnumericformat.h.
QgsBearingNumericFormat::QgsBearingNumericFormat | ( | ) |
Default constructor.
Definition at line 21 of file qgsbearingnumericformat.cpp.
|
overridevirtual |
Clones the format, returning a new object.
The caller takes ownership of the returned object.
Reimplemented from QgsBasicNumericFormat.
Definition at line 87 of file qgsbearingnumericformat.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 100 of file qgsbearingnumericformat.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 92 of file qgsbearingnumericformat.cpp.
QgsBearingNumericFormat::FormatDirectionOption QgsBearingNumericFormat::directionFormat | ( | ) | const |
Returns the directional formatting option, which controls how bearing direction is described in the returned strings.
Definition at line 107 of file qgsbearingnumericformat.cpp.
|
overridevirtual |
Returns a formatted string representation of a numeric double value.
Reimplemented from QgsBasicNumericFormat.
Definition at line 45 of file qgsbearingnumericformat.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 qgsbearingnumericformat.cpp.
|
overridevirtual |
Sets the format's configuration.
Reimplemented from QgsBasicNumericFormat.
Definition at line 117 of file qgsbearingnumericformat.cpp.
void QgsBearingNumericFormat::setDirectionFormat | ( | FormatDirectionOption | format | ) |
Sets the directional formatting option, which controls how bearing direction is described in the returned strings.
Definition at line 112 of file qgsbearingnumericformat.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 qgsbearingnumericformat.cpp.
|
overridevirtual |
Returns a suggested sample value which nicely represents the current format configuration.
Reimplemented from QgsNumericFormat.
Definition at line 40 of file qgsbearingnumericformat.cpp.
|
overridevirtual |
Returns the translated, user-visible name for this format.
Reimplemented from QgsBasicNumericFormat.
Definition at line 30 of file qgsbearingnumericformat.cpp.