QGIS API Documentation 3.38.0-Grenoble (exported)
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
46
50 virtual ~QgsSettingsRegistry();
51
55 QList<const QgsSettingsEntryBase *> settingEntries() const;
56
62 const QgsSettingsEntryBase *settingsEntry( const QString &key, bool searchChildRegistries = true ) const;
63
67 void addSubRegistry( const QgsSettingsRegistry *settingsRegistry );
68
72 void removeSubRegistry( const QgsSettingsRegistry *settingsRegistry );
73
77 QList<const QgsSettingsRegistry *> subRegistries() const;
78
79 protected:
80
84 bool addSettingsEntry( const QgsSettingsEntryBase *settingsEntry );
85
91 Q_DECL_DEPRECATED void addSettingsEntryGroup( const QgsSettingsEntryGroup *settingsGroup ) SIP_DEPRECATED;
92
93 private:
94
95 QMap<QString, const QgsSettingsEntryBase *> mSettingsEntriesMap;
96
98 QMap<const QgsSettingsEntryBase *, const QgsSettingsEntryGroup *> mSettingsEntriesGroupMap;
100
101 QList<const QgsSettingsRegistry *> mSettingsRegistryChildList;
102
104
105};
106
107#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:6022
#define Q_NOWARN_DEPRECATED_PUSH
Definition qgis.h:6021
#define SIP_DEPRECATED
Definition qgis_sip.h:106