QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
A numeric formatter which returns a text representation of a geographic coordinate (latitude or longitude). More...
#include <qgscoordinatenumericformat.h>
Public Types | |
enum class | AngleFormat { DegreesMinutesSeconds , DegreesMinutes , DecimalDegrees } |
Angle format options. More... | |
Public Types inherited from QgsBasicNumericFormat | |
enum | RoundingType { DecimalPlaces , SignificantFigures } |
Sets rounding type and behavior of the numberDecimalPlaces() setting. More... | |
Public Member Functions | |
QgsGeographicCoordinateNumericFormat () | |
Default constructor. | |
AngleFormat | angleFormat () const |
Returns the angle format, which controls how bearing the angles are formatted described in the returned strings. | |
QgsGeographicCoordinateNumericFormat * | clone () const override |
Clones the format, returning a new object. | |
QVariantMap | configuration (const QgsReadWriteContext &context) const override |
Returns the current configuration of the formatter. | |
QgsNumericFormat * | create (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. | |
void | setAngleFormat (AngleFormat format) |
Sets the directional formatting option, which controls how bearing the angles are formatted described in the returned strings. | |
void | setConfiguration (const QVariantMap &configuration, const QgsReadWriteContext &context) override |
Sets the format's configuration. | |
void | setShowDegreeLeadingZeros (bool show) |
Sets whether leading zeros for the degree values should be shown. | |
void | setShowDirectionalSuffix (bool show) |
Sets whether directional suffixes (e.g. | |
void | setShowLeadingZeros (bool show) |
Sets whether leading zeros in the minutes or seconds values should be shown. | |
bool | showDegreeLeadingZeros () const |
Returns true if leading zeros for the degree values should be shown. | |
bool | showDirectionalSuffix () const |
Returns true if directional suffixes (e.g. | |
bool | showLeadingZeros () const |
Returns true if leading zeros in the minutes or seconds values should be shown. | |
int | sortKey () override |
Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists. | |
double | suggestSampleValue () const override |
Returns a suggested sample value which nicely represents the current format configuration. | |
QString | visibleName () const override |
Returns the translated, user-visible name for this format. | |
Public Member Functions inherited from QgsBasicNumericFormat | |
QgsBasicNumericFormat () | |
Default constructor. | |
QChar | decimalSeparator () const |
Returns any override for the decimal separator character. | |
int | numberDecimalPlaces () const |
Returns the maximum number of decimal places to show. | |
RoundingType | roundingType () const |
Returns the rounding type, which controls the behavior of the numberDecimalPlaces() setting. | |
void | setDecimalSeparator (QChar character) |
Sets an override character for the decimal separator character. | |
virtual void | setNumberDecimalPlaces (int places) |
Sets the maximum number of decimal places to show. | |
void | setRoundingType (RoundingType type) |
Sets the rounding type, which controls the behavior of the numberDecimalPlaces() setting. | |
void | setShowPlusSign (bool show) |
Sets whether a leading plus sign will be shown for positive values. | |
void | setShowThousandsSeparator (bool show) |
Sets whether the thousands grouping separator will be shown. | |
void | setShowTrailingZeros (bool show) |
Sets whether trailing zeros will be shown (up to the specified numberDecimalPlaces()). | |
void | setThousandsSeparator (QChar character) |
Sets an override character for the thousands separator character. | |
bool | showPlusSign () const |
Returns true if a leading plus sign will be shown for positive values. | |
bool | showThousandsSeparator () const |
Returns true if the thousands grouping separator will be shown. | |
bool | showTrailingZeros () const |
Returns true if trailing zeros will be shown (up to the specified numberDecimalPlaces()). | |
QChar | thousandsSeparator () const |
Returns any override for the thousands separator character. | |
Public Member Functions inherited from QgsNumericFormat | |
QgsNumericFormat ()=default | |
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. | |
Additional Inherited Members | |
Protected Attributes inherited from QgsBasicNumericFormat | |
bool | mUseScientific = false |
Static Protected Attributes inherited from QgsNumericFormat | |
static constexpr int | DEFAULT_SORT_KEY = 100 |
A numeric formatter which returns a text representation of a geographic coordinate (latitude or longitude).
Definition at line 28 of file qgscoordinatenumericformat.h.
|
strong |
Angle format options.
Definition at line 37 of file qgscoordinatenumericformat.h.
QgsGeographicCoordinateNumericFormat::QgsGeographicCoordinateNumericFormat | ( | ) |
Default constructor.
Definition at line 43 of file qgscoordinatenumericformat.cpp.
QgsGeographicCoordinateNumericFormat::AngleFormat QgsGeographicCoordinateNumericFormat::angleFormat | ( | ) | const |
Returns the angle format, which controls how bearing the angles are formatted described in the returned strings.
Definition at line 113 of file qgscoordinatenumericformat.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 qgscoordinatenumericformat.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 103 of file qgscoordinatenumericformat.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 qgscoordinatenumericformat.cpp.
|
overridevirtual |
Returns a formatted string representation of a numeric double value.
Reimplemented from QgsBasicNumericFormat.
Definition at line 67 of file qgscoordinatenumericformat.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 47 of file qgscoordinatenumericformat.cpp.
void QgsGeographicCoordinateNumericFormat::setAngleFormat | ( | QgsGeographicCoordinateNumericFormat::AngleFormat | format | ) |
Sets the directional formatting option, which controls how bearing the angles are formatted described in the returned strings.
Definition at line 118 of file qgscoordinatenumericformat.cpp.
|
overridevirtual |
Sets the format's configuration.
Reimplemented from QgsBasicNumericFormat.
Definition at line 123 of file qgscoordinatenumericformat.cpp.
void QgsGeographicCoordinateNumericFormat::setShowDegreeLeadingZeros | ( | bool | show | ) |
Sets whether leading zeros for the degree values should be shown.
Definition at line 147 of file qgscoordinatenumericformat.cpp.
void QgsGeographicCoordinateNumericFormat::setShowDirectionalSuffix | ( | bool | show | ) |
Sets whether directional suffixes (e.g.
"N") should be included.
Definition at line 157 of file qgscoordinatenumericformat.cpp.
void QgsGeographicCoordinateNumericFormat::setShowLeadingZeros | ( | bool | show | ) |
Sets whether leading zeros in the minutes or seconds values should be shown.
Definition at line 137 of file qgscoordinatenumericformat.cpp.
bool QgsGeographicCoordinateNumericFormat::showDegreeLeadingZeros | ( | ) | const |
Returns true
if leading zeros for the degree values should be shown.
Definition at line 142 of file qgscoordinatenumericformat.cpp.
bool QgsGeographicCoordinateNumericFormat::showDirectionalSuffix | ( | ) | const |
Returns true
if directional suffixes (e.g.
"N") should be included.
Definition at line 152 of file qgscoordinatenumericformat.cpp.
bool QgsGeographicCoordinateNumericFormat::showLeadingZeros | ( | ) | const |
Returns true
if leading zeros in the minutes or seconds values should be shown.
Definition at line 132 of file qgscoordinatenumericformat.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 57 of file qgscoordinatenumericformat.cpp.
|
overridevirtual |
Returns a suggested sample value which nicely represents the current format configuration.
Reimplemented from QgsNumericFormat.
Definition at line 62 of file qgscoordinatenumericformat.cpp.
|
overridevirtual |
Returns the translated, user-visible name for this format.
Reimplemented from QgsBasicNumericFormat.
Definition at line 52 of file qgscoordinatenumericformat.cpp.