QGIS API Documentation  3.21.0-Master (56b4176581)
qgsfieldformatterregistry.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsfieldformatterregistry.h - QgsFieldFormatterRegistry
3 
4  ---------------------
5  begin : 2.12.2016
6  copyright : (C) 2016 by Matthias Kuhn
7  email : [email protected]
8  ***************************************************************************
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 #ifndef QGSFIELDKITREGISTRY_H
17 #define QGSFIELDKITREGISTRY_H
18 
19 #include <QHash>
20 #include <QString>
21 #include <QObject>
22 
23 #include "qgis_sip.h"
24 #include "qgis_core.h"
25 
26 #include <QReadWriteLock>
27 
28 class QgsFieldFormatter;
29 class QgsVectorLayer;
30 
40 class CORE_EXPORT QgsFieldFormatterRegistry : public QObject
41 {
42  Q_OBJECT
43 
44  public:
45 
51  explicit QgsFieldFormatterRegistry( QObject *parent SIP_TRANSFERTHIS = nullptr );
52  ~QgsFieldFormatterRegistry() override;
53 
60  void addFieldFormatter( QgsFieldFormatter *formatter SIP_TRANSFER );
61 
66  void removeFieldFormatter( QgsFieldFormatter *formatter );
67 
71  void removeFieldFormatter( const QString &id );
72 
77  QgsFieldFormatter *fieldFormatter( const QString &id ) const;
78 
83  QgsFieldFormatter *fallbackFieldFormatter() const;
84 
85  signals:
86 
91 
96 
97  private:
98  QHash<QString, QgsFieldFormatter *> mFieldFormatters;
99  QgsFieldFormatter *mFallbackFieldFormatter = nullptr;
100  mutable QReadWriteLock mLock;
101 };
102 
103 #endif // QGSFIELDKITREGISTRY_H
The QgsFieldFormatterRegistry manages registered classes of QgsFieldFormatter.
void fieldFormatterRemoved(QgsFieldFormatter *formatter)
Will be emitted just before a field formatter is removed and deleted.
void fieldFormatterAdded(QgsFieldFormatter *formatter)
Will be emitted after a new field formatter has been added.
A field formatter helps to handle and display values for a field.
Represents a vector layer which manages a vector based data sets.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
#define SIP_TRANSFER
Definition: qgis_sip.h:36