QGIS API Documentation  3.17.0-Master (8af46bc54f)
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 class QgsFieldFormatter;
27 class QgsVectorLayer;
28 
37 class CORE_EXPORT QgsFieldFormatterRegistry : public QObject
38 {
39  Q_OBJECT
40 
41  public:
42 
48  explicit QgsFieldFormatterRegistry( QObject *parent SIP_TRANSFERTHIS = nullptr );
49  ~QgsFieldFormatterRegistry() override;
50 
57  void addFieldFormatter( QgsFieldFormatter *formatter SIP_TRANSFER );
58 
63  void removeFieldFormatter( QgsFieldFormatter *formatter );
64 
68  void removeFieldFormatter( const QString &id );
69 
74  QgsFieldFormatter *fieldFormatter( const QString &id ) const;
75 
80  QgsFieldFormatter *fallbackFieldFormatter() const;
81 
82  signals:
83 
87  void fieldFormatterAdded( QgsFieldFormatter *formatter );
88 
92  void fieldFormatterRemoved( QgsFieldFormatter *formatter );
93 
94  private:
95  QHash<QString, QgsFieldFormatter *> mFieldFormatters;
96  QgsFieldFormatter *mFallbackFieldFormatter = nullptr;
97 };
98 
99 #endif // QGSFIELDKITREGISTRY_H
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
The QgsFieldFormatterRegistry manages registered classes of QgsFieldFormatter.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
A field formatter helps to handle and display values for a field.
Represents a vector layer which manages a vector based data sets.