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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/settings/qgssettingsregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsSettingsRegistry
{
%Docstring(signature="appended")
:py:class:`QgsSettingsRegistry` is used for settings introspection and
collects a list of child :py:class:`QgsSettingsRegistry` and a list of
child :py:class:`QgsSettingsRegistry`
.. versionadded:: 3.20
.. deprecated:: 3.30
Use :py:func:`QgsSettings.treeRoot()` instead.
%End
%TypeHeaderCode
#include "qgssettingsregistry.h"
%End
public:
QgsSettingsRegistry();
virtual ~QgsSettingsRegistry();
QList<const QgsSettingsEntryBase *> settingEntries() const;
%Docstring
Returns the list of registered :py:class:`QgsSettingsEntryBase`.
%End
const QgsSettingsEntryBase *settingsEntry( const QString &key, bool searchChildRegistries = true ) const;
%Docstring
Returns the :py:class:`QgsSettingsEntry` with the given ``key`` or None
if not found.
The ``searchChildRegistries`` parameter specifies if child registries
should be included in the search
%End
void addSubRegistry( const QgsSettingsRegistry *settingsRegistry );
%Docstring
Append a child ``settingsRegistry`` to the register.
%End
void removeSubRegistry( const QgsSettingsRegistry *settingsRegistry );
%Docstring
Remove a child ``settingsRegistry`` from the register.
%End
QList<const QgsSettingsRegistry *> subRegistries() const;
%Docstring
Returns the list of registered child QgsSettingsRegistry.
%End
protected:
bool addSettingsEntry( const QgsSettingsEntryBase *settingsEntry );
%Docstring
Adds ``settingsEntry`` to the registry.
%End
void addSettingsEntryGroup( const QgsSettingsEntryGroup *settingsGroup ) /Deprecated/;
%Docstring
Adds a group of setting to the registry
.. versionadded:: 3.26
.. deprecated:: 3.30
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/settings/qgssettingsregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
