Class: QgsCurrencyNumericFormat

class qgis.core.QgsCurrencyNumericFormat

Bases: QgsBasicNumericFormat

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

New in version 3.12.

QgsCurrencyNumericFormat() Default constructor

QgsCurrencyNumericFormat(QgsCurrencyNumericFormat)

Methods

clone

rtype:

QgsNumericFormat

configuration

param context:

create

param configuration:

formatDouble

param value:

id

rtype:

str

prefix

Returns the currency prefix, e.g.

setConfiguration

Sets the format's configuration.

setPrefix

Sets the currency prefix, e.g.

setSuffix

Sets the currency suffix, e.g.

sortKey

rtype:

int

suffix

Returns the currency suffix, e.g.

suggestSampleValue

rtype:

float

visibleName

rtype:

str

clone(self) QgsNumericFormat
Return type:

QgsNumericFormat

configuration(self, context: QgsReadWriteContext) Dict[str, Any]
Parameters:

context (QgsReadWriteContext) –

Return type:

Dict[str, Any]

create(self, configuration: Dict[str, Any], context: QgsReadWriteContext) QgsNumericFormat
Parameters:
Return type:

QgsNumericFormat

formatDouble(self, value: float, context: QgsNumericFormatContext) str
Parameters:
Return type:

str

id(self) str
Return type:

str

prefix(self) str

Returns the currency prefix, e.g. “$”.

See also

setPrefix()

Return type:

str

setConfiguration(self, configuration: Dict[str, Any], context: QgsReadWriteContext)

Sets the format’s configuration.

setPrefix(self, prefix: str)

Sets the currency prefix, e.g. “$”.

See also

prefix()

Parameters:

prefix (str) –

setSuffix(self, suffix: str)

Sets the currency suffix, e.g. “AUD”.

See also

suffix()

Parameters:

suffix (str) –

sortKey(self) int
Return type:

int

suffix(self) str

Returns the currency suffix, e.g. “AUD”.

See also

setSuffix()

Return type:

str

suggestSampleValue(self) float
Return type:

float

visibleName(self) str
Return type:

str