Class: QgsFieldFormatterRegistry¶

A registry which manages classes of QgsFieldFormatter.

A reference to the QgsFieldFormatterRegistry can be obtained from QgsApplication.fieldFormatterRegistry().

Class Hierarchy¶

Methods

`addFieldFormatter`	They will take precedence in order of adding them.
`fallbackFieldFormatter`	Returns a basic fallback field formatter which can be used to represent any field in an unspectacular manner.
`fieldFormatter`	Gets a field formatter by its id.
`removeFieldFormatter`	Remove a field formatter from the registry.

Signals

`fieldFormatterAdded`	Will be emitted after a new field formatter has been added.
`fieldFormatterRemoved`	Will be emitted just before a field formatter is removed and deleted.

class qgis.core.QgsFieldFormatterRegistry[source]¶

Bases: QObject

__init__(parent: QObject | None = None)

You should not normally need to create your own field formatter registry.

Use the one provided by :py:func:`QgsApplication.fieldFormatterRegistry()` instead.

addFieldFormatter(self, formatter: QgsFieldFormatter | None)[source]¶

They will take precedence in order of adding them. The later they are added, the more weight they have.

Ownership is transferred to the registry.

fallbackFieldFormatter(self) → QgsFieldFormatter | None[source]¶

Returns a basic fallback field formatter which can be used to represent any field in an unspectacular manner.

fieldFormatter(self, id: str | None) → QgsFieldFormatter | None[source]¶

Gets a field formatter by its id. If there is no such id registered, a default QgsFallbackFieldFormatter with a null id will be returned instead.

signal fieldFormatterAdded(formatter: QgsFieldFormatter)[source]¶

Will be emitted after a new field formatter has been added.

signal fieldFormatterRemoved(formatter: QgsFieldFormatter)[source]¶

Will be emitted just before a field formatter is removed and deleted.

removeFieldFormatter(self, formatter: QgsFieldFormatter | None)[source]¶

Remove a field formatter from the registry. The field formatter will be deleted.

removeFieldFormatter(self, id: str | None)[source]

Remove the field formatter with the specified id.