A numeric formatter which returns a text representation of a currency value. More...

#include <qgscurrencynumericformat.h>

Inheritance diagram for QgsCurrencyNumericFormat:

[legend]

Public Member Functions
	QgsCurrencyNumericFormat ()
	Default constructor.

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

QString	prefix () const
	Returns the currency prefix, e.g.

void	setPrefix (const QString &prefix)
	Sets the currency prefix, e.g.

void	setSuffix (const QString &suffix)
	Sets the currency suffix, e.g.

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

QString	suffix () const
	Returns the currency suffix, e.g.

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
Public Types inherited from QgsBasicNumericFormat
enum	RoundingType { DecimalPlaces , SignificantFigures }
	Sets rounding type and behavior of the numberDecimalPlaces() setting. More...

Protected Member Functions inherited from QgsBasicNumericFormat
virtual void	setConfiguration (const QVariantMap &configuration, const QgsReadWriteContext &context)
	Sets the format's configuration.

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

Since: QGIS 3.12

Definition at line 28 of file qgscurrencynumericformat.h.

Constructor & Destructor Documentation

◆ QgsCurrencyNumericFormat()

QgsCurrencyNumericFormat::QgsCurrencyNumericFormat ( )

Default constructor.

Definition at line 21 of file qgscurrencynumericformat.cpp.

Member Function Documentation

◆ clone()

QgsNumericFormat * QgsCurrencyNumericFormat::clone ( ) const

overridevirtual

Clones the format, returning a new object.

The caller takes ownership of the returned object.

Reimplemented from QgsBasicNumericFormat.

Definition at line 57 of file qgscurrencynumericformat.cpp.

◆ configuration()

QVariantMap QgsCurrencyNumericFormat::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 77 of file qgscurrencynumericformat.cpp.

◆ create()

QgsNumericFormat * QgsCurrencyNumericFormat::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 62 of file qgscurrencynumericformat.cpp.

◆ formatDouble()

QString QgsCurrencyNumericFormat::formatDouble	(	double	value,
		const QgsNumericFormatContext &	context
	)		const

overridevirtual

Returns a formatted string representation of a numeric double value.

Reimplemented from QgsBasicNumericFormat.

Definition at line 48 of file qgscurrencynumericformat.cpp.

◆ id()

QString QgsCurrencyNumericFormat::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 28 of file qgscurrencynumericformat.cpp.

◆ prefix()

QString QgsCurrencyNumericFormat::prefix ( ) const

Returns the currency prefix, e.g.

"$".

See also: setPrefix()

Definition at line 85 of file qgscurrencynumericformat.cpp.

◆ setPrefix()

void QgsCurrencyNumericFormat::setPrefix ( const QString & prefix )

Sets the currency prefix, e.g.

"$".

See also: prefix()

Definition at line 90 of file qgscurrencynumericformat.cpp.

◆ setSuffix()

void QgsCurrencyNumericFormat::setSuffix ( const QString & suffix )

Sets the currency suffix, e.g.

"AUD".

See also: suffix()

Definition at line 100 of file qgscurrencynumericformat.cpp.

◆ sortKey()

int QgsCurrencyNumericFormat::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 38 of file qgscurrencynumericformat.cpp.

◆ suffix()

QString QgsCurrencyNumericFormat::suffix ( ) const

Returns the currency suffix, e.g.

"AUD".

See also: setSuffix()

Definition at line 95 of file qgscurrencynumericformat.cpp.

◆ suggestSampleValue()

double QgsCurrencyNumericFormat::suggestSampleValue ( ) const

overridevirtual

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

Reimplemented from QgsNumericFormat.

Definition at line 43 of file qgscurrencynumericformat.cpp.

◆ visibleName()

QString QgsCurrencyNumericFormat::visibleName ( ) const

overridevirtual

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

Reimplemented from QgsBasicNumericFormat.

Definition at line 33 of file qgscurrencynumericformat.cpp.

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

/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/numericformats/qgscurrencynumericformat.h
/build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/core/numericformats/qgscurrencynumericformat.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsCurrencyNumericFormat()

Member Function Documentation

◆ clone()

◆ configuration()

◆ create()

◆ formatDouble()

◆ id()

◆ prefix()

◆ setPrefix()

◆ setSuffix()

◆ sortKey()

◆ suffix()

◆ suggestSampleValue()

◆ visibleName()