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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgslegendstyle.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsLegendStyle
{
%Docstring(signature="appended")
Contains detailed styling information relating to how a layout legend
should be rendered.
%End
%TypeHeaderCode
#include "qgslegendstyle.h"
%End
public:
enum Style /BaseType=IntEnum/
{
Undefined,
Hidden,
Title,
Group,
Subgroup,
Symbol,
SymbolLabel,
};
enum Side /BaseType=IntEnum/
{
Top,
Bottom,
Left,
Right,
};
QgsLegendStyle();
QFont font() const /Deprecated/;
%Docstring
Returns the font used for rendering this legend component.
.. seealso:: :py:func:`setFont`
.. deprecated:: 3.40
Use :py:func:`~QgsLegendStyle.textFormat` instead.
%End
void setFont( const QFont &font ) /Deprecated/;
%Docstring
Sets the ``font`` used for rendering this legend component.
.. seealso:: :py:func:`font`
.. deprecated:: 3.40
Use :py:func:`~QgsLegendStyle.setTextFormat` instead.
%End
QgsTextFormat &textFormat();
%Docstring
Returns the text format used for rendering this legend component.
.. seealso:: :py:func:`setTextFormat`
.. versionadded:: 3.30
%End
void setTextFormat( const QgsTextFormat &format );
%Docstring
Sets the text ``format`` used for rendering this legend component.
.. seealso:: :py:func:`textFormat`
.. versionadded:: 3.30
%End
double margin( Side side ) const;
%Docstring
Returns the margin (in mm) for the specified ``side`` of the component.
.. note::
Not all legend components respect all margin side settings!
.. seealso:: :py:func:`setMargin`
%End
void setMargin( Side side, double margin );
%Docstring
Sets the ``margin`` (in mm) for the specified ``side`` of the component.
.. note::
Not all legend components respect all margin side settings!
.. seealso:: :py:func:`margin`
%End
void setMargin( double margin );
%Docstring
Sets all margin sides to the same ``margin`` size (in mm).
.. seealso:: :py:func:`margin`
%End
Qt::Alignment alignment() const;
%Docstring
Returns the alignment for the legend component.
.. seealso:: :py:func:`setAlignment`
.. versionadded:: 3.10
%End
void setAlignment( Qt::Alignment alignment );
%Docstring
Sets the alignment for the legend component.
.. seealso:: :py:func:`alignment`
.. versionadded:: 3.10
%End
double indent() const;
%Docstring
Returns the indent (in mm) of a group or subgroup.
.. seealso:: :py:func:`indent`
.. versionadded:: 3.22
%End
void setIndent( double indent );
%Docstring
Sets the indent (in mm) of a group or subgroup.
.. seealso:: :py:func:`indent`
.. versionadded:: 3.22
%End
void writeXml( const QString &name, QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const;
%Docstring
Writes the component's style definition to an XML element.
.. seealso:: :py:func:`readXml`
%End
void readXml( const QDomElement &elem, const QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() );
%Docstring
Reads the component's style definition from an XML element.
.. seealso:: :py:func:`writeXml`
%End
void updateDataDefinedProperties( QgsRenderContext &context );
%Docstring
Updates any data-defined properties in the style, using the specified
render ``context``.
.. versionadded:: 3.42
%End
static QString styleName( Style s );
%Docstring
Returns the name for a style component as a string.
This is a non-localised version, for internal use.
.. seealso:: :py:func:`styleFromName`
.. seealso:: :py:func:`styleLabel`
%End
static Style styleFromName( const QString &styleName );
%Docstring
Returns the style from name string.
.. seealso:: :py:func:`styleName`
%End
static QString styleLabel( Style s );
%Docstring
Returns a translated string representing a style component, for use in
UI.
.. seealso:: :py:func:`styleName`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgslegendstyle.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
