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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgssymbollayerreference.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsSymbolLayerId
{
%Docstring(signature="appended")
We may need stable references to symbol layers, when pointers to symbol
layers is not usable (when a symbol or a feature renderer is cloned for
example).
A symbol layer identifier consists of:
- an identifier to its symbol (given by the :py:class:`QgsFeatureRenderer`)
- a path of indexes inside its symbol and subsymbols.
For a symbol in a :py:class:`QgsSingleSymbolRenderer` that has two
symbol layers, it will give:
- "" for the symbol key
- [0] and [1] for the two symbol layer indexes
For a :py:class:`QgsRuleBasedRenderer` each rule key is the symbol key.
For a symbol with a symbol layer that has a sub symbol (say a
:py:class:`QgsArrowSymbolLayer`), path to symbol layers of the sub
symbol are given by a list of indexes:
- [0, 0] : first symbol layer of the sub symbol of the first symbol
layer
- [0, 1] : second symbol layer of the sub symbol of the first symbol
layer
- [2, 0] : first symbol layer of the sub symbol of the third symbol
layer, etc.
.. versionadded:: 3.12
.. deprecated:: 3.30
Replaced by QUuid to identify symbol layers.
%End
%TypeHeaderCode
#include "qgssymbollayerreference.h"
%End
public:
QgsSymbolLayerId();
QgsSymbolLayerId( const QString &key, int index );
%Docstring
QgsSymbolLayerId constructor with a symbol key and a unique symbol layer
index
%End
QgsSymbolLayerId( const QString &key, const QVector<int> &indexPath );
%Docstring
QgsSymbolLayerId constructor with a symbol key and an index path
%End
QgsSymbolLayerId( const QgsSymbolLayerId &other );
QString symbolKey() const;
%Docstring
Returns the key associated to the symbol
%End
QVector<int> symbolLayerIndexPath() const;
%Docstring
Returns the symbol layer index path inside the symbol
%End
bool operator==( const QgsSymbolLayerId &other ) const;
bool operator<( const QgsSymbolLayerId &other ) const;
SIP_PYOBJECT __repr__();
%MethodCode
QStringList pathString;
for ( int path : sipCpp->symbolLayerIndexPath() )
{
pathString.append( QString::number( path ) );
}
QString str = QStringLiteral( "<QgsSymbolLayerId: %1 (%2)>" ).arg( sipCpp->symbolKey(), pathString.join( ',' ) );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End
};
class QgsSymbolLayerReference
{
%Docstring(signature="appended")
Type used to refer to a specific symbol layer in a symbol of a layer.
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgssymbollayerreference.h"
%End
public:
QgsSymbolLayerReference();
QgsSymbolLayerReference( const QString &layerId, const QgsSymbolLayerId &symbolLayer ) /Deprecated/;
%Docstring
Constructor
:param layerId: layer id
:param symbolLayer: symbol layer id
.. deprecated:: 3.30
%End
QgsSymbolLayerReference( const QString &layerId, const QString &symbolLayerId );
%Docstring
Constructor
:param layerId: layer id
:param symbolLayerId: symbol layer id
.. versionadded:: 3.30
%End
QString layerId() const;
%Docstring
The referenced vector layer / feature renderer
%End
QgsSymbolLayerId symbolLayerId() const /Deprecated/;
%Docstring
The symbol layer's id
.. deprecated:: 3.30
Use symbolLayerIdV2 instead.
%End
QString symbolLayerIdV2() const;
%Docstring
The symbol layer's id
.. versionadded:: 3.30
%End
bool operator==( const QgsSymbolLayerReference &other ) const;
SIP_PYOBJECT __repr__();
%MethodCode
QStringList pathString;
for ( int path : sipCpp->symbolLayerId().symbolLayerIndexPath() )
{
pathString.append( QString::number( path ) );
}
QString str = QStringLiteral( "<QgsSymbolLayerReference: %1 - %2>" ).arg( sipCpp->layerId(), sipCpp->symbolLayerIdV2() );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End
};
uint qHash( const QgsSymbolLayerId &id );
uint qHash( const QgsSymbolLayerReference &r );
typedef QList<QgsSymbolLayerReference> QgsSymbolLayerReferenceList;
QString symbolLayerReferenceListToString( const QgsSymbolLayerReferenceList & );
%Docstring
Utilitary function to turn a :py:class:`QgsSymbolLayerReferenceList`
into a string
.. seealso:: :py:func:`stringToSymbolLayerReferenceList`
.. versionadded:: 3.12
%End
QgsSymbolLayerReferenceList stringToSymbolLayerReferenceList( const QString & );
%Docstring
Utilitary function to parse a string originated from
symbolLayerReferenceListToString into a
:py:class:`QgsSymbolLayerReferenceList`
.. seealso:: :py:func:`symbolLayerReferenceListToString`
.. versionadded:: 3.12
%End
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgssymbollayerreference.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
