QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Types | Public Member Functions | List of all members
QgsBearingNumericFormat Class Reference

A numeric formatter which returns a text representation of a direction/bearing. More...

#include <qgsbearingnumericformat.h>

Inheritance diagram for QgsBearingNumericFormat:
Inheritance graph
[legend]

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...
 
QgsBearingNumericFormatclone () 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...
 
QgsNumericFormatcreate (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
 
- Static Protected Attributes inherited from QgsNumericFormat
static constexpr int DEFAULT_SORT_KEY = 100
 

Detailed Description

A numeric formatter which returns a text representation of a direction/bearing.

Since
QGIS 3.12

Definition at line 28 of file qgsbearingnumericformat.h.

Member Enumeration Documentation

◆ FormatDirectionOption

Directional formatting option, which controls how bearing direction is described in the returned strings.

Enumerator
UseRange0To180WithEWDirectionalSuffix 

Return values between 0 and 180, with a E or W directional suffix.

UseRangeNegative180ToPositive180 

Return values between -180 and 180.

UseRange0To360 

Return values between 0 to 360.

Definition at line 36 of file qgsbearingnumericformat.h.

Constructor & Destructor Documentation

◆ QgsBearingNumericFormat()

QgsBearingNumericFormat::QgsBearingNumericFormat ( )

Default constructor.

Definition at line 21 of file qgsbearingnumericformat.cpp.

Member Function Documentation

◆ clone()

QgsBearingNumericFormat * QgsBearingNumericFormat::clone ( ) const
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.

◆ configuration()

QVariantMap QgsBearingNumericFormat::configuration ( const QgsReadWriteContext context) const
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.

◆ create()

QgsNumericFormat * QgsBearingNumericFormat::create ( const QVariantMap &  configuration,
const QgsReadWriteContext context 
) const
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.

◆ directionFormat()

QgsBearingNumericFormat::FormatDirectionOption QgsBearingNumericFormat::directionFormat ( ) const

Returns the directional formatting option, which controls how bearing direction is described in the returned strings.

See also
setDirectionFormat()

Definition at line 107 of file qgsbearingnumericformat.cpp.

◆ formatDouble()

QString QgsBearingNumericFormat::formatDouble ( double  value,
const QgsNumericFormatContext context 
) const
overridevirtual

Returns a formatted string representation of a numeric double value.

Reimplemented from QgsBasicNumericFormat.

Definition at line 45 of file qgsbearingnumericformat.cpp.

◆ id()

QString QgsBearingNumericFormat::id ( ) const
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.

◆ setConfiguration()

void QgsBearingNumericFormat::setConfiguration ( const QVariantMap &  configuration,
const QgsReadWriteContext context 
)
overridevirtual

Sets the format's configuration.

Reimplemented from QgsBasicNumericFormat.

Definition at line 117 of file qgsbearingnumericformat.cpp.

◆ setDirectionFormat()

void QgsBearingNumericFormat::setDirectionFormat ( FormatDirectionOption  format)

Sets the directional formatting option, which controls how bearing direction is described in the returned strings.

See also
directionFormat()

Definition at line 112 of file qgsbearingnumericformat.cpp.

◆ sortKey()

int QgsBearingNumericFormat::sortKey ( )
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.

◆ suggestSampleValue()

double QgsBearingNumericFormat::suggestSampleValue ( ) const
overridevirtual

Returns a suggested sample value which nicely represents the current format configuration.

Reimplemented from QgsNumericFormat.

Definition at line 40 of file qgsbearingnumericformat.cpp.

◆ visibleName()

QString QgsBearingNumericFormat::visibleName ( ) const
overridevirtual

Returns the translated, user-visible name for this format.

Reimplemented from QgsBasicNumericFormat.

Definition at line 30 of file qgsbearingnumericformat.cpp.


The documentation for this class was generated from the following files: