-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgssettingsregistry.h
90 lines (71 loc) · 2.7 KB
/
qgssettingsregistry.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/***************************************************************************
qgssettingsregistry.h
--------------------------------------
Date : February 2021
Copyright : (C) 2021 by Damiano Lombardi
Email : damiano at opengis dot ch
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSSETTINGSREGISTRY_H
#define QGSSETTINGSREGISTRY_H
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgssettingsentry.h"
#include <QMap>
/**
* \ingroup core
* \class QgsSettingsRegistry
* QgsSettingsRegistry is used for settings introspection and collects a
* list of child QgsSettingsRegistry and a list of child QgsSettingsRegistry
*
* \since QGIS 3.20
*/
class CORE_EXPORT QgsSettingsRegistry
{
public:
/**
* Constructor for QgsSettingsRegistry.
*/
QgsSettingsRegistry();
/**
* Destructor for QgsSettingsRegistry.
*/
virtual ~QgsSettingsRegistry();
/**
* Returns the list of registered QgsSettingsEntryBase.
*/
QList<const QgsSettingsEntryBase *> settingEntries() const;
/**
* Returns the QgsSettingsEntry with the given \a key or nullptr if not found.
*
* The \a searchChildRegistries parameter specifies if child registries should be included in the search
*/
const QgsSettingsEntryBase *settingsEntry( const QString &key, bool searchChildRegistries = true ) const;
/**
* Append a child \a settingsRegistry to the register.
*/
void addSubRegistry( const QgsSettingsRegistry *settingsRegistry );
/**
* Remove a child \a settingsRegistry from the register.
*/
void removeSubRegistry( const QgsSettingsRegistry *settingsRegistry );
/**
* Returns the list of registered child QgsSettingsRegistry.
*/
QList<const QgsSettingsRegistry *> subRegistries() const;
protected:
/**
* Add \a settingsEntry to the register.
*/
void addSettingsEntry( const QgsSettingsEntryBase *settingsEntry );
private:
QMap<QString, const QgsSettingsEntryBase *> mSettingsEntriesMap;
QList<const QgsSettingsRegistry *> mSettingsRegistryChildList;
};
#endif // QGSSETTINGSREGISTRY_H