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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Theme" inherits="Resource" version="3.2">
<brief_description>
Theme for controls.
</brief_description>
<description>
A theme for skinning controls. Controls can be skinned individually, but for complex applications, it's more practical to just create a global theme that defines everything. This theme can be applied to any [Control]; the Control and its children will automatically use it.
Theme resources can alternatively be loaded by writing them in a [code].theme[/code] file, see the documentation for more information.
</description>
<tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/gui/gui_skinning.html</link>
</tutorials>
<methods>
<method name="clear">
<return type="void">
</return>
<description>
Clears all values on the theme.
</description>
</method>
<method name="clear_color">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Clears the [Color] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="clear_constant">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Clears the constant at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="clear_font">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Clears the [Font] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="clear_icon">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Clears the icon at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="clear_stylebox">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Clears [StyleBox] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="copy_default_theme">
<return type="void">
</return>
<description>
Sets the theme's values to a copy of the default theme values.
</description>
</method>
<method name="copy_theme">
<return type="void">
</return>
<argument index="0" name="other" type="Theme">
</argument>
<description>
Sets the theme's values to a copy of a given theme.
</description>
</method>
<method name="get_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the [Color] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_color_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]type[/code].
</description>
</method>
<method name="get_constant" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the constant at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_constant_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]type[/code].
</description>
</method>
<method name="get_font" qualifiers="const">
<return type="Font">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the [Font] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_font_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]type[/code].
</description>
</method>
<method name="get_icon" qualifiers="const">
<return type="Texture">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the icon [Texture] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_icon_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox" qualifiers="const">
<return type="StyleBox">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns the icon [StyleBox] at [code]name[/code] if the theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox_types" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the theme has [code]type[/code].
</description>
</method>
<method name="get_type_list" qualifiers="const">
<return type="PoolStringArray">
</return>
<argument index="0" name="type" type="String">
</argument>
<description>
Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the [code]get_*[/code] functions, if the theme has [code]type[/code].
</description>
</method>
<method name="has_color" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="has_constant" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns [code]true[/code] if constant with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="has_font" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="has_icon" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="has_stylebox" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<description>
Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]type[/code].
Returns [code]false[/code] if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_color">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<argument index="2" name="color" type="Color">
</argument>
<description>
Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_constant">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<argument index="2" name="constant" type="int">
</argument>
<description>
Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_font">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<argument index="2" name="font" type="Font">
</argument>
<description>
Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_icon">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<argument index="2" name="texture" type="Texture">
</argument>
<description>
Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
<method name="set_stylebox">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<argument index="2" name="texture" type="StyleBox">
</argument>
<description>
Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]type[/code].
Does nothing if the theme does not have [code]type[/code].
</description>
</method>
</methods>
<members>
<member name="default_font" type="Font" setter="set_default_font" getter="get_default_font">
The theme's default font.
</member>
</members>
<constants>
</constants>
</class>
|
