Class: QgsFieldFormatterRegistry

The QgsFieldFormatterRegistry manages registered classes of QgsFieldFormatter.

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

Class Hierarchy

Base classes

QObject

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

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.

Parameters:

parent (Optional[QObject] = None)

addFieldFormatter(self, formatter: QgsFieldFormatter | None)

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.

Parameters:

formatter (Optional[QgsFieldFormatter])

fallbackFieldFormatter(self) → QgsFieldFormatter | None

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

Return type:

Optional[QgsFieldFormatter]

fieldFormatter(self, id: str | None) → QgsFieldFormatter | None

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.

Parameters:

id (Optional[str])

Return type:

Optional[QgsFieldFormatter]

signal fieldFormatterAdded(formatter: QgsFieldFormatter)

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

Parameters:

formatter (QgsFieldFormatter)

signal fieldFormatterRemoved(formatter: QgsFieldFormatter)

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

Parameters:

formatter (QgsFieldFormatter)

removeFieldFormatter(self, formatter: QgsFieldFormatter | None)

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

Parameters:

formatter (Optional[QgsFieldFormatter])

removeFieldFormatter(self, id: str | None)

Remove the field formatter with the specified id.

Parameters:

id (Optional[str])