The QgsFieldFormatterRegistry manages registered classes of QgsFieldFormatter. More...
#include <qgsfieldformatterregistry.h>
Signals | |
| void | fieldFormatterAdded (QgsFieldFormatter *formatter) |
| Will be emitted after a new field formatter has been added. More... | |
| void | fieldFormatterRemoved (QgsFieldFormatter *formatter) |
| Will be emitted just before a field formatter is removed and deleted. More... | |
Public Member Functions | |
| QgsFieldFormatterRegistry (QObject *parent=nullptr) | |
| You should not normally need to create your own field formatter registry. More... | |
| ~QgsFieldFormatterRegistry () override | |
| void | addFieldFormatter (QgsFieldFormatter *formatter) |
| They will take precedence in order of adding them. More... | |
| QgsFieldFormatter * | fallbackFieldFormatter () const |
| Returns a basic fallback field formatter which can be used to represent any field in an unspectacular manner. More... | |
| QgsFieldFormatter * | fieldFormatter (const QString &id) const |
| Gets a field formatter by its id. More... | |
| void | removeFieldFormatter (QgsFieldFormatter *formatter) |
| Remove a field formatter from the registry. More... | |
| void | removeFieldFormatter (const QString &id) |
| Remove the field formatter with the specified id. More... | |
Detailed Description
The QgsFieldFormatterRegistry manages registered classes of QgsFieldFormatter.
A reference to the QgsFieldFormatterRegistry can be obtained from QgsApplication::fieldFormatterRegistry().
- Since
- QGIS 3.0
Definition at line 36 of file qgsfieldformatterregistry.h.
Constructor & Destructor Documentation
◆ QgsFieldFormatterRegistry()
|
explicit |
You should not normally need to create your own field formatter registry.
Use the one provided by QgsApplication::fieldFormatterRegistry() instead.
Definition at line 29 of file qgsfieldformatterregistry.cpp.
◆ ~QgsFieldFormatterRegistry()
|
override |
Definition at line 43 of file qgsfieldformatterregistry.cpp.
Member Function Documentation
◆ addFieldFormatter()
| void QgsFieldFormatterRegistry::addFieldFormatter | ( | QgsFieldFormatter * | formatter | ) |
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.
Definition at line 49 of file qgsfieldformatterregistry.cpp.
◆ fallbackFieldFormatter()
| QgsFieldFormatter * QgsFieldFormatterRegistry::fallbackFieldFormatter | ( | ) | const |
Returns a basic fallback field formatter which can be used to represent any field in an unspectacular manner.
Definition at line 74 of file qgsfieldformatterregistry.cpp.
◆ fieldFormatter()
| QgsFieldFormatter * QgsFieldFormatterRegistry::fieldFormatter | ( | const QString & | id | ) | const |
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.
Definition at line 69 of file qgsfieldformatterregistry.cpp.
◆ fieldFormatterAdded
|
signal |
Will be emitted after a new field formatter has been added.
◆ fieldFormatterRemoved
|
signal |
Will be emitted just before a field formatter is removed and deleted.
◆ removeFieldFormatter() [1/2]
| void QgsFieldFormatterRegistry::removeFieldFormatter | ( | QgsFieldFormatter * | formatter | ) |
Remove a field formatter from the registry.
The field formatter will be deleted.
Definition at line 55 of file qgsfieldformatterregistry.cpp.
◆ removeFieldFormatter() [2/2]
| void QgsFieldFormatterRegistry::removeFieldFormatter | ( | const QString & | id | ) |
Remove the field formatter with the specified id.
Definition at line 60 of file qgsfieldformatterregistry.cpp.
The documentation for this class was generated from the following files:
- /tmp/buildd/qgis-3.2.0+99unstable/src/core/qgsfieldformatterregistry.h
- /tmp/buildd/qgis-3.2.0+99unstable/src/core/qgsfieldformatterregistry.cpp
