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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/settings/qgssettingsentrygroup.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsSettingsEntryGroup /Deprecated/
{
%Docstring(signature="appended")
Creates a group of setting which have a common definition of base key
.. versionadded:: 3.26
.. deprecated:: 3.30
Use :py:class:`QgsSettingsTreeNode` instead.
%End
%TypeHeaderCode
#include "qgssettingsentrygroup.h"
%End
public:
QgsSettingsEntryGroup( QList<const QgsSettingsEntryBase *> settings );
%Docstring
Constructor
%End
%MethodCode
sipCpp = new QgsSettingsEntryGroup( *a0, false );
sipIsErr = sipCpp->isValid() ? 0 : 1;
if ( sipIsErr )
PyErr_SetString( PyExc_ValueError, QStringLiteral( "Settings do not share the same base definition key for this group. This will lead to unpredictable results." ).toUtf8().constData() );
%End
bool isValid() const;
%Docstring
Returns if the group is valid (if settings share the same base key)
%End
QString baseKey( const QStringList &dynamicKeyPartList = QStringList() ) const;
%Docstring
Returns the base key for the given ``dynamicKeyPartList``
%End
const QList<const QgsSettingsEntryBase *> settings() const;
%Docstring
Returns all the settings
%End
void removeAllSettingsAtBaseKey( const QStringList &dynamicKeyPartList = QStringList() ) const;
%Docstring
Removes all the settings at the base key for the given
``dynamicKeyPartList`` This means it might remove more settings than the
ones registered in the group, use with caution
%End
void removeAllChildrenSettings( const QString &dynamicKeyPart = QString() ) const;
%Docstring
Removes all the settings from this group The ``dynamicKeyPart`` argument
specifies the dynamic part of the settings key.
%End
void removeAllChildrenSettings( const QStringList &dynamicKeyPartList ) const;
%Docstring
Removes all the settings from this group The ``dynamicKeyPartList``
argument specifies the dynamic part of the settings key.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/settings/qgssettingsentrygroup.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
