QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
qgssettingsregistry.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssettingsregistry.h
3 --------------------------------------
4 Date : February 2021
5 Copyright : (C) 2021 by Damiano Lombardi
6 Email : damiano at opengis dot ch
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16
17#ifndef QGSSETTINGSREGISTRY_H
18#define QGSSETTINGSREGISTRY_H
19
20#include "qgis.h"
21#include "qgis_core.h"
22#include "qgis_sip.h"
23
24#include <QMap>
25
28
38class CORE_DEPRECATED_EXPORT QgsSettingsRegistry
39{
40 public:
41
43 virtual ~QgsSettingsRegistry();
44
48 QList<const QgsSettingsEntryBase *> settingEntries() const;
49
55 const QgsSettingsEntryBase *settingsEntry( const QString &key, bool searchChildRegistries = true ) const;
56
60 void addSubRegistry( const QgsSettingsRegistry *settingsRegistry );
61
65 void removeSubRegistry( const QgsSettingsRegistry *settingsRegistry );
66
70 QList<const QgsSettingsRegistry *> subRegistries() const;
71
72 protected:
73
77 bool addSettingsEntry( const QgsSettingsEntryBase *settingsEntry );
78
84 Q_DECL_DEPRECATED void addSettingsEntryGroup( const QgsSettingsEntryGroup *settingsGroup ) SIP_DEPRECATED;
85
86 private:
87
88 QMap<QString, const QgsSettingsEntryBase *> mSettingsEntriesMap;
89
91 QMap<const QgsSettingsEntryBase *, const QgsSettingsEntryGroup *> mSettingsEntriesGroupMap;
93
94 QList<const QgsSettingsRegistry *> mSettingsRegistryChildList;
95
97
98};
99
100#endif // QGSSETTINGSREGISTRY_H
Represent settings entry and provides methods for reading and writing settings values.
Creates a group of setting which have a common definition of base key.
QgsSettingsRegistry is used for settings introspection and collects a list of child QgsSettingsRegist...
#define Q_NOWARN_DEPRECATED_POP
Definition qgis.h:6535
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:6534
#define SIP_DEPRECATED
Definition qgis_sip.h:106