/
qgstextmasksettings.sip.in
244 lines (168 loc) · 5.76 KB
/
qgstextmasksettings.sip.in
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/textrenderer/qgstextmasksettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsTextMaskSettings
{
%Docstring
Container for settings relating to a selective masking around a text.
A selective masking only makes sense in contexts where the text is rendered over some other map layers, especially for labeling.
.. note::
QgsTextMaskSettings objects are implicitly shared.
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgstextmasksettings.h"
%End
public:
enum MaskType
{
MaskBuffer
};
QgsTextMaskSettings();
QgsTextMaskSettings( const QgsTextMaskSettings &other );
%Docstring
Copy constructor.
:param other: source settings
%End
~QgsTextMaskSettings();
bool operator==( const QgsTextMaskSettings &other ) const;
bool operator!=( const QgsTextMaskSettings &other ) const;
bool enabled() const;
%Docstring
Returns whether the mask is enabled.
%End
void setEnabled( bool );
%Docstring
Returns whether the mask is enabled.
%End
MaskType type() const;
%Docstring
Returns the type of mask shape.
.. seealso:: :py:func:`setType`
%End
void setType( MaskType type );
%Docstring
Sets the type of mask shape.
:param type: shape type
.. seealso:: :py:func:`type`
%End
double size() const;
%Docstring
Returns the size of the buffer.
.. seealso:: :py:func:`sizeUnit`
.. seealso:: :py:func:`setSize`
%End
void setSize( double size );
%Docstring
Sets the size of the buffer. The size units are specified using :py:func:`~QgsTextMaskSettings.setSizeUnit`.
:param size: buffer size
.. seealso:: :py:func:`size`
.. seealso:: :py:func:`setSizeUnit`
%End
QgsUnitTypes::RenderUnit sizeUnit() const;
%Docstring
Returns the units for the buffer size.
.. seealso:: :py:func:`size`
.. seealso:: :py:func:`setSizeUnit`
%End
void setSizeUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units used for the buffer size.
:param unit: size unit
.. seealso:: :py:func:`setSize`
.. seealso:: :py:func:`sizeUnit`
%End
QgsMapUnitScale sizeMapUnitScale() const;
%Docstring
Returns the map unit scale object for the buffer size. This is only used if the
buffer size is set to QgsUnitTypes.RenderMapUnit.
.. seealso:: :py:func:`setSizeMapUnitScale`
.. seealso:: :py:func:`sizeUnit`
%End
void setSizeMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit scale object for the buffer size. This is only used if the
buffer size is set to QgsUnitTypes.RenderMapUnit.
:param scale: scale for buffer size
.. seealso:: :py:func:`sizeMapUnitScale`
.. seealso:: :py:func:`setSizeUnit`
%End
Qt::PenJoinStyle joinStyle() const;
%Docstring
Returns the buffer join style.
.. seealso:: :py:func:`setJoinStyle`
%End
void setJoinStyle( Qt::PenJoinStyle style );
%Docstring
Sets the join style used for drawing the buffer.
:param style: join style
.. seealso:: :py:func:`joinStyle`
%End
double opacity() const;
%Docstring
Returns the mask's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally
opaque).
.. seealso:: :py:func:`setOpacity`
%End
void setOpacity( double opacity );
%Docstring
Sets the mask's opacity.
:param opacity: opacity as a double value between 0 (fully transparent) and 1 (totally
opaque)
.. seealso:: :py:func:`opacity`
%End
QgsPaintEffect *paintEffect() const;
%Docstring
Returns the current paint effect for the mask.
:return: paint effect
.. seealso:: :py:func:`setPaintEffect`
%End
void setPaintEffect( QgsPaintEffect *effect /Transfer/ );
%Docstring
Sets the current paint ``effect`` for the mask.
:param effect: paint effect. Ownership is transferred to the mask settings.
.. seealso:: :py:func:`paintEffect`
%End
void readXml( const QDomElement &elem );
%Docstring
Read settings from a DOM element.
.. seealso:: :py:func:`writeXml`
%End
QDomElement writeXml( QDomDocument &doc ) const;
%Docstring
Write settings into a DOM element.
.. seealso:: :py:func:`readXml`
%End
QgsSymbolLayerReferenceList maskedSymbolLayers() const;
%Docstring
Returns a list of references to symbol layers that are masked by this buffer.
:return: a list of references to masked symbol layers
.. seealso:: :py:func:`setMaskedSymbolLayers`
%End
void setMaskedSymbolLayers( QgsSymbolLayerReferenceList maskedLayers );
%Docstring
Sets the symbol layers that will be masked by this buffer.
:param maskedLayers: list of references to symbol layers
.. seealso:: :py:func:`setMaskedSymbolLayers`
%End
void updateDataDefinedProperties( QgsRenderContext &context, const QgsPropertyCollection &properties );
%Docstring
Updates the format by evaluating current values of data defined properties.
%End
QSet<QString> referencedFields( const QgsRenderContext &context ) const;
%Docstring
Returns all field names referenced by the configuration (e.g. from data defined properties).
.. versionadded:: 3.14
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/textrenderer/qgstextmasksettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/