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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitemlabel.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutItemLabel: QgsLayoutItem
{
%Docstring(signature="appended")
A layout item subclass for text labels.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutitemlabel.h"
%End
public:
enum Mode
{
ModeFont,
ModeHtml,
};
QgsLayoutItemLabel( QgsLayout *layout );
%Docstring
Constructor for QgsLayoutItemLabel, with the specified parent ``layout``.
%End
static QgsLayoutItemLabel *create( QgsLayout *layout ) /Factory/;
%Docstring
Returns a new label item for the specified ``layout``.
The caller takes responsibility for deleting the returned object.
%End
virtual int type() const;
virtual QIcon icon() const;
virtual QString displayName() const;
void adjustSizeToText();
%Docstring
Resizes the item so that the label's text fits to the item. Keeps the top left point stationary.
.. seealso:: :py:func:`sizeForText`
%End
QSizeF sizeForText() const;
%Docstring
Returns the required item size (in layout units) for the label's text to fill the item.
.. seealso:: :py:func:`adjustSizeToText`
%End
QString text() const;
%Docstring
Returns the label's preset text.
.. seealso:: :py:func:`currentText`
.. seealso:: :py:func:`setText`
%End
void setText( const QString &text );
%Docstring
Sets the label's preset ``text``.
.. seealso:: :py:func:`text`
%End
QString currentText() const;
%Docstring
Returns the text as it appears on the label (with evaluated expressions
and other dynamic content).
.. seealso:: :py:func:`text`
%End
Mode mode() const;
%Docstring
Returns the label's current mode.
.. seealso:: :py:func:`setMode`
%End
void setMode( Mode mode );
%Docstring
Sets the label's current ``mode``, allowing the label
to switch between font based and HTML based rendering.
.. seealso:: :py:func:`mode`
%End
QFont font() const /Deprecated/;
%Docstring
Returns the label's current font.
.. seealso:: :py:func:`setFont`
.. deprecated::
use :py:func:`~QgsLayoutItemLabel.textFormat` instead (since QGIS 3.24)
%End
void setFont( const QFont &font ) /Deprecated/;
%Docstring
Sets the label's current ``font``.
.. seealso:: :py:func:`font`
.. deprecated::
use :py:func:`~QgsLayoutItemLabel.setTextFormat` instead (since QGIS 3.24)
%End
Qt::AlignmentFlag vAlign() const;
%Docstring
Returns for the vertical alignment of the label.
.. seealso:: :py:func:`setVAlign`
.. seealso:: :py:func:`hAlign`
%End
Qt::AlignmentFlag hAlign() const;
%Docstring
Returns the horizontal alignment of the label.
.. seealso:: :py:func:`vAlign`
.. seealso:: :py:func:`setHAlign`
%End
void setHAlign( Qt::AlignmentFlag alignment );
%Docstring
Sets the horizontal ``alignment`` of the label.
.. seealso:: :py:func:`hAlign`
.. seealso:: :py:func:`setVAlign`
%End
void setVAlign( Qt::AlignmentFlag alignment );
%Docstring
Sets for the vertical ``alignment`` of the label.
.. seealso:: :py:func:`vAlign`
.. seealso:: :py:func:`setHAlign`
%End
double marginX() const;
%Docstring
Returns the horizontal margin between the edge of the frame and the label
contents, in layout units.
.. seealso:: :py:func:`setMargin`
.. seealso:: :py:func:`marginY`
%End
double marginY() const;
%Docstring
Returns the vertical margin between the edge of the frame and the label
contents, in layout units.
.. seealso:: :py:func:`setMargin`
.. seealso:: :py:func:`marginX`
%End
void setMargin( double margin );
%Docstring
Sets the ``margin`` between the edge of the frame and the label contents.
This method sets both the horizontal and vertical margins to the same
value. The margins can be individually controlled using the :py:func:`~QgsLayoutItemLabel.setMarginX`
and :py:func:`~QgsLayoutItemLabel.setMarginY` methods.
Margins are set using the current layout units.
.. seealso:: :py:func:`setMarginX`
.. seealso:: :py:func:`setMarginY`
%End
void setMarginX( double margin );
%Docstring
Sets the horizontal ``margin`` between the edge of the frame and the label
contents, in layout units.
.. seealso:: :py:func:`setMargin`
.. seealso:: :py:func:`setMarginY`
%End
void setMarginY( double margin );
%Docstring
Sets the vertical ``margin`` between the edge of the frame and the label
contents, in layout units.
.. seealso:: :py:func:`setMargin`
.. seealso:: :py:func:`setMarginX`
%End
void setFontColor( const QColor &color ) /Deprecated/;
%Docstring
Sets the label font ``color``.
.. seealso:: :py:func:`fontColor`
.. deprecated::
Use :py:func:`~QgsLayoutItemLabel.setTextFormat` instead (since QGIS 3.24)
%End
QColor fontColor() const /Deprecated/;
%Docstring
Returns the label font color.
.. seealso:: :py:func:`setFontColor`
.. deprecated::
use :py:func:`~QgsLayoutItemLabel.textFormat` instead (since QGIS 3.24)
%End
virtual QRectF boundingRect() const;
virtual void setFrameEnabled( bool drawFrame );
virtual void setFrameStrokeWidth( QgsLayoutMeasurement strokeWidth );
QgsTextFormat textFormat() const;
%Docstring
Returns the text format used for drawing text in the label.
.. seealso:: :py:func:`setTextFormat`
.. versionadded:: 3.24
%End
void setTextFormat( const QgsTextFormat &format );
%Docstring
Sets the text ``format`` used for drawing text in the label.
.. seealso:: :py:func:`textFormat`
.. versionadded:: 3.24
%End
public slots:
virtual void refresh();
void convertToStaticText();
%Docstring
Converts the label's :py:func:`~QgsLayoutItemLabel.text` to a static string, by evaluating any expressions included in the text
and replacing them with their current values.
.. versionadded:: 3.20
%End
protected:
virtual void draw( QgsLayoutItemRenderContext &context );
virtual bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
virtual bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutitemlabel.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
