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

#include <qgsbearingnumericformat.h>

Inheritance diagram for QgsBearingNumericFormat:

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...

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...

QChar	decimalSeparator () const
	Returns any override for the decimal separator character. 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...

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...

int	sortKey () override
	Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists. More...

QChar	thousandsSeparator () const
	Returns any override for the thousands separator character. More...

QString	visibleName () const override
	Returns the translated, user-visible name for this format. More...

Public Member Functions inherited from QgsNumericFormat
	QgsNumericFormat ()=default
	Default constructor. More...

virtual	~QgsNumericFormat ()=default

virtual QgsNumericFormat *	clone () const =0
	Clones the format, returning a new object. More...

virtual QVariantMap	configuration (const QgsReadWriteContext &context) const =0
	Returns the current configuration of the formatter. More...

virtual QgsNumericFormat *	create (const QVariantMap &configuration, const QgsReadWriteContext &context) const =0
	Creates a new copy of the format, using the supplied configuration. More...

virtual QString	formatDouble (double value, const QgsNumericFormatContext &context) const =0
	Returns a formatted string representation of a numeric double value. More...

virtual QString	id () const =0
	Returns a unique id for this numeric format. More...

bool	operator!= (const QgsNumericFormat &other) const

bool	operator== (const QgsNumericFormat &other) const

virtual int	sortKey ()
	Returns a sorting key value, where formats with a lower sort key will be shown earlier in lists. More...

virtual double	suggestSampleValue () const
	Returns a suggested sample value which nicely represents the current format configuration. More...

virtual QString	visibleName () const =0
	Returns the translated, user-visible name for this format. More...

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...

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

enum QgsBearingNumericFormat::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.