summaryrefslogtreecommitdiff
path: root/doc/classes/Control.xml
blob: 5d77f3a45007092d81a45a0dea4e6707208734c4 (plain)
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Control" inherits="CanvasItem" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Base node for all User Interface components.
	</brief_description>
	<description>
		The base class Node for all User Interface components. Every UI node inherits from it. Any scene or portion of a scene tree composed of Control nodes is a User Interface.
		Controls use anchors and margins to place themselves relative to their parent. They adapt automatically when their parent or the screen size changes. To build flexible UIs, use built-in [Container] nodes or create your own.
		Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range.
		Godot sends Input events to the root node first, via [method Node._input]. The method distributes it through the node tree and delivers the input events to the node under the mouse cursor or on focus with the keyboard. To do so, it calls [method MainLoop._input_event]. No need to enable [method Node.set_process_input] on Controls to receive input events. Call [method accept_event] to ensure no other node receives the event, not even [method Node._unhandled_input].
		Only the one Control node in focus receives keyboard events. To do so, the Control must get the focus mode with [method set_focus_mode]. It loses focus when another Control gets it, or if the current Control in focus is hidden.
		You'll sometimes want Controls to ignore mouse or touch events. For example, if you place an icon on top of a button. Call [method set_ignore_mouse] for that.
		[Theme] resources change the Control's appearance. If you change the [Theme] on a parent Control node, it will propagate to all of its children. You can override parts of the theme on each Control with the add_*_override methods, like [method add_font_override]. You can also override the theme from the editor.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="_get_minimum_size" qualifiers="virtual">
			<return type="Vector2">
			</return>
			<description>
				Returns the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
			</description>
		</method>
		<method name="_gui_input" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="event" type="InputEvent">
			</argument>
			<description>
			</description>
		</method>
		<method name="accept_event">
			<return type="void">
			</return>
			<description>
				Marks the input event as handled. No other Control will receive it, and the input event will not propagate. Not even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input].
			</description>
		</method>
		<method name="add_color_override">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="color" type="Color">
			</argument>
			<description>
			</description>
		</method>
		<method name="add_constant_override">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="constant" type="int">
			</argument>
			<description>
				Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared.
			</description>
		</method>
		<method name="add_font_override">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="font" type="Font">
			</argument>
			<description>
				Override a single font (font) in the theme of this Control. If font is empty, override is cleared.
			</description>
		</method>
		<method name="add_icon_override">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="texture" type="Texture">
			</argument>
			<description>
				Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared.
			</description>
		</method>
		<method name="add_shader_override">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="shader" type="Shader">
			</argument>
			<description>
			</description>
		</method>
		<method name="add_style_override">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="stylebox" type="StyleBox">
			</argument>
			<description>
				Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared.
			</description>
		</method>
		<method name="can_drop_data" qualifiers="virtual">
			<return type="bool">
			</return>
			<argument index="0" name="pos" type="Vector2">
			</argument>
			<argument index="1" name="data" type="Variant">
			</argument>
			<description>
			</description>
		</method>
		<method name="drop_data" qualifiers="virtual">
			<return type="void">
			</return>
			<argument index="0" name="pos" type="Vector2">
			</argument>
			<argument index="1" name="data" type="Variant">
			</argument>
			<description>
			</description>
		</method>
		<method name="force_drag">
			<return type="void">
			</return>
			<argument index="0" name="data" type="Variant">
			</argument>
			<argument index="1" name="preview" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_anchor" qualifiers="const">
			<return type="float">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<description>
				Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
			</description>
		</method>
		<method name="get_begin" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_combined_minimum_size" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_cursor_shape" qualifiers="const">
			<return type="int" enum="Control.CursorShape">
			</return>
			<argument index="0" name="pos" type="Vector2" default="Vector2( 0, 0 )">
			</argument>
			<description>
				Return the cursor shape at a certain position in the control.
			</description>
		</method>
		<method name="get_custom_minimum_size" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</description>
		</method>
		<method name="get_default_cursor_shape" qualifiers="const">
			<return type="int" enum="Control.CursorShape">
			</return>
			<description>
				Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
			</description>
		</method>
		<method name="get_drag_data" qualifiers="virtual">
			<return type="Object">
			</return>
			<argument index="0" name="pos" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_end" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
			</description>
		</method>
		<method name="get_focus_mode" qualifiers="const">
			<return type="int" enum="Control.FocusMode">
			</return>
			<description>
				Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]).
			</description>
		</method>
		<method name="get_focus_neighbour" qualifiers="const">
			<return type="NodePath">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<description>
				Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
			</description>
		</method>
		<method name="get_focus_owner" qualifiers="const">
			<return type="Control">
			</return>
			<description>
				Return which control is owning the keyboard focus, or null if no one.
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_global_position" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
			</description>
		</method>
		<method name="get_global_rect" qualifiers="const">
			<return type="Rect2">
			</return>
			<description>
				Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_position], [method get_size]).
			</description>
		</method>
		<method name="get_h_grow_direction" qualifiers="const">
			<return type="int" enum="Control.GrowDirection">
			</return>
			<description>
			</description>
		</method>
		<method name="get_h_size_flags" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Hint for containers, return horizontal positioning flags.
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_margin" qualifiers="const">
			<return type="float">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<description>
				Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode.
			</description>
		</method>
		<method name="get_minimum_size" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.
			</description>
		</method>
		<method name="get_mouse_filter" qualifiers="const">
			<return type="int" enum="Control.MouseFilter">
			</return>
			<description>
				Return when the control is ignoring mouse events (even touchpad events send mouse events).
			</description>
		</method>
		<method name="get_parent_area_size" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</description>
		</method>
		<method name="get_parent_control" qualifiers="const">
			<return type="Control">
			</return>
			<description>
			</description>
		</method>
		<method name="get_pivot_offset" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</description>
		</method>
		<method name="get_position" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
			</description>
		</method>
		<method name="get_rect" qualifiers="const">
			<return type="Rect2">
			</return>
			<description>
				Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_position], [method get_size]).
			</description>
		</method>
		<method name="get_rotation" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the rotation (in radians)
			</description>
		</method>
		<method name="get_rotation_deg" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the rotation (in degrees)
			</description>
		</method>
		<method name="get_scale" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
			</description>
		</method>
		<method name="get_size" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by[/b] [method get_minimum_size]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]).
			</description>
		</method>
		<method name="get_stretch_ratio" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_theme" qualifiers="const">
			<return type="Theme">
			</return>
			<description>
				Return a [Theme] override, if one exists (see [method set_theme]).
			</description>
		</method>
		<method name="get_tooltip" qualifiers="const">
			<return type="String">
			</return>
			<argument index="0" name="atpos" type="Vector2" default="Vector2( 0, 0 )">
			</argument>
			<description>
				Return the tooltip, which will appear when the cursor is resting over this control.
			</description>
		</method>
		<method name="get_v_grow_direction" qualifiers="const">
			<return type="int" enum="Control.GrowDirection">
			</return>
			<description>
			</description>
		</method>
		<method name="get_v_size_flags" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Hint for containers, return vertical positioning flags.
			</description>
		</method>
		<method name="grab_click_focus">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
		<method name="grab_focus">
			<return type="void">
			</return>
			<description>
				Steal the focus from another control and become the focused control (see [method set_focus_mode]).
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="has_color_override" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="has_constant_override" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
			</description>
		</method>
		<method name="has_focus" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Return whether the Control is the current focused control (see [method set_focus_mode]).
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="has_font_override" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="has_icon_override" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
			</description>
		</method>
		<method name="has_point" qualifiers="virtual">
			<return type="bool">
			</return>
			<argument index="0" name="point" type="Vector2">
			</argument>
			<description>
			</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" default="&quot;&quot;">
			</argument>
			<description>
			</description>
		</method>
		<method name="has_stylebox_override" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
			</description>
		</method>
		<method name="is_clipping_contents">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="minimum_size_changed">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
		<method name="release_focus">
			<return type="void">
			</return>
			<description>
				Give up the focus, no other control will be able to receive keyboard input.
			</description>
		</method>
		<method name="set_anchor">
			<return type="void">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<argument index="1" name="anchor" type="float">
			</argument>
			<argument index="2" name="keep_margin" type="bool" default="false">
			</argument>
			<argument index="3" name="push_opposite_anchor" type="bool" default="true">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_anchor_and_margin">
			<return type="void">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<argument index="1" name="anchor" type="float">
			</argument>
			<argument index="2" name="offset" type="float">
			</argument>
			<argument index="3" name="push_opposite_anchor" type="bool" default="false">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_anchors_preset">
			<return type="void">
			</return>
			<argument index="0" name="preset" type="int" enum="Control.LayoutPreset">
			</argument>
			<argument index="1" name="keep_margin" type="bool" default="false">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_area_as_parent_rect">
			<return type="void">
			</return>
			<argument index="0" name="margin" type="int" default="0">
			</argument>
			<description>
				Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]).
			</description>
		</method>
		<method name="set_begin">
			<return type="void">
			</return>
			<argument index="0" name="pos" type="Vector2">
			</argument>
			<description>
				Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]).
			</description>
		</method>
		<method name="set_clip_contents">
			<return type="void">
			</return>
			<argument index="0" name="enable" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_custom_minimum_size">
			<return type="void">
			</return>
			<argument index="0" name="size" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_default_cursor_shape">
			<return type="void">
			</return>
			<argument index="0" name="shape" type="int" enum="Control.CursorShape">
			</argument>
			<description>
				Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes.
			</description>
		</method>
		<method name="set_drag_forwarding">
			<return type="void">
			</return>
			<argument index="0" name="target" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_drag_preview">
			<return type="void">
			</return>
			<argument index="0" name="control" type="Control">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_end">
			<return type="void">
			</return>
			<argument index="0" name="pos" type="Vector2">
			</argument>
			<description>
				Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]).
			</description>
		</method>
		<method name="set_focus_mode">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="Control.FocusMode">
			</argument>
			<description>
				Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals.
			</description>
		</method>
		<method name="set_focus_neighbour">
			<return type="void">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<argument index="1" name="neighbour" type="NodePath">
			</argument>
			<description>
				Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
			</description>
		</method>
		<method name="set_global_position">
			<return type="void">
			</return>
			<argument index="0" name="pos" type="Vector2">
			</argument>
			<description>
				Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]).
			</description>
		</method>
		<method name="set_h_grow_direction">
			<return type="void">
			</return>
			<argument index="0" name="direction" type="int" enum="Control.GrowDirection">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_h_size_flags">
			<return type="void">
			</return>
			<argument index="0" name="flags" type="int">
			</argument>
			<description>
				Hint for containers, set horizontal positioning flags.
			</description>
		</method>
		<method name="set_margin">
			<return type="void">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<argument index="1" name="offset" type="float">
			</argument>
			<description>
				Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode.
			</description>
		</method>
		<method name="set_mouse_filter">
			<return type="void">
			</return>
			<argument index="0" name="filter" type="int" enum="Control.MouseFilter">
			</argument>
			<description>
				Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER_* constants)
			</description>
		</method>
		<method name="set_pivot_offset">
			<return type="void">
			</return>
			<argument index="0" name="pivot_offset" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_position">
			<return type="void">
			</return>
			<argument index="0" name="pos" type="Vector2">
			</argument>
			<description>
				Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]).
			</description>
		</method>
		<method name="set_rotation">
			<return type="void">
			</return>
			<argument index="0" name="radians" type="float">
			</argument>
			<description>
				Set the rotation (in radians).
			</description>
		</method>
		<method name="set_rotation_deg">
			<return type="void">
			</return>
			<argument index="0" name="degrees" type="float">
			</argument>
			<description>
				Set the rotation (in degrees).
			</description>
		</method>
		<method name="set_scale">
			<return type="void">
			</return>
			<argument index="0" name="scale" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_size">
			<return type="void">
			</return>
			<argument index="0" name="size" type="Vector2">
			</argument>
			<description>
				Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]).
			</description>
		</method>
		<method name="set_stretch_ratio">
			<return type="void">
			</return>
			<argument index="0" name="ratio" type="float">
			</argument>
			<description>
				Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big.
			</description>
		</method>
		<method name="set_theme">
			<return type="void">
			</return>
			<argument index="0" name="theme" type="Theme">
			</argument>
			<description>
				Override whole the [Theme] for this Control and all its children controls.
			</description>
		</method>
		<method name="set_tooltip">
			<return type="void">
			</return>
			<argument index="0" name="tooltip" type="String">
			</argument>
			<description>
				Set a tooltip, which will appear when the cursor is resting over this control.
			</description>
		</method>
		<method name="set_v_grow_direction">
			<return type="void">
			</return>
			<argument index="0" name="direction" type="int" enum="Control.GrowDirection">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_v_size_flags">
			<return type="void">
			</return>
			<argument index="0" name="flags" type="int">
			</argument>
			<description>
				Hint for containers, set vertical positioning flags.
			</description>
		</method>
		<method name="show_modal">
			<return type="void">
			</return>
			<argument index="0" name="exclusive" type="bool" default="false">
			</argument>
			<description>
				Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus.
			</description>
		</method>
		<method name="warp_mouse">
			<return type="void">
			</return>
			<argument index="0" name="to_pos" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="anchor_bottom" type="float" setter="_set_anchor" getter="get_anchor">
		</member>
		<member name="anchor_left" type="float" setter="_set_anchor" getter="get_anchor">
		</member>
		<member name="anchor_right" type="float" setter="_set_anchor" getter="get_anchor">
		</member>
		<member name="anchor_top" type="float" setter="_set_anchor" getter="get_anchor">
		</member>
		<member name="focus_neighbour_bottom" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour">
		</member>
		<member name="focus_neighbour_left" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour">
		</member>
		<member name="focus_neighbour_right" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour">
		</member>
		<member name="focus_neighbour_top" type="NodePath" setter="set_focus_neighbour" getter="get_focus_neighbour">
		</member>
		<member name="grow_horizontal" type="int" setter="set_h_grow_direction" getter="get_h_grow_direction" enum="Control.GrowDirection">
		</member>
		<member name="grow_vertical" type="int" setter="set_v_grow_direction" getter="get_v_grow_direction" enum="Control.GrowDirection">
		</member>
		<member name="hint_tooltip" type="String" setter="set_tooltip" getter="_get_tooltip">
		</member>
		<member name="margin_bottom" type="float" setter="set_margin" getter="get_margin">
		</member>
		<member name="margin_left" type="float" setter="set_margin" getter="get_margin">
		</member>
		<member name="margin_right" type="float" setter="set_margin" getter="get_margin">
		</member>
		<member name="margin_top" type="float" setter="set_margin" getter="get_margin">
		</member>
		<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" enum="Control.MouseFilter">
		</member>
		<member name="rect_clip_content" type="bool" setter="set_clip_contents" getter="is_clipping_contents">
		</member>
		<member name="rect_min_size" type="Vector2" setter="set_custom_minimum_size" getter="get_custom_minimum_size">
		</member>
		<member name="rect_pivot_offset" type="Vector2" setter="set_pivot_offset" getter="get_pivot_offset">
		</member>
		<member name="rect_position" type="Vector2" setter="set_position" getter="get_position">
		</member>
		<member name="rect_rotation" type="float" setter="set_rotation_deg" getter="get_rotation_deg">
		</member>
		<member name="rect_scale" type="Vector2" setter="set_scale" getter="get_scale">
		</member>
		<member name="rect_size" type="Vector2" setter="set_size" getter="get_size">
		</member>
		<member name="size_flags_horizontal" type="int" setter="set_h_size_flags" getter="get_h_size_flags">
		</member>
		<member name="size_flags_stretch_ratio" type="float" setter="set_stretch_ratio" getter="get_stretch_ratio">
		</member>
		<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags">
		</member>
		<member name="theme" type="Theme" setter="set_theme" getter="get_theme">
		</member>
	</members>
	<signals>
		<signal name="focus_entered">
			<description>
				Emitted when the node gains keyboard focus.
			</description>
		</signal>
		<signal name="focus_exited">
			<description>
				Emitted when the node loses keyboard focus.
			</description>
		</signal>
		<signal name="gui_input">
			<argument index="0" name="ev" type="Object">
			</argument>
			<description>
			</description>
		</signal>
		<signal name="minimum_size_changed">
			<description>
				Emitted when the node's minimum size changes.
			</description>
		</signal>
		<signal name="modal_closed">
			<description>
			</description>
		</signal>
		<signal name="mouse_entered">
			<description>
				Emitted when the mouse enters the control's area.
			</description>
		</signal>
		<signal name="mouse_exited">
			<description>
				Emitted when the mouse leaves the control's area.
			</description>
		</signal>
		<signal name="resized">
			<description>
				Emitted when the control changes size.
			</description>
		</signal>
		<signal name="size_flags_changed">
			<description>
				Emitted when the size flags change.
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="FOCUS_NONE" value="0">
			Control can't acquire focus.
		</constant>
		<constant name="FOCUS_CLICK" value="1">
			Control can acquire focus only if clicked.
		</constant>
		<constant name="FOCUS_ALL" value="2">
			Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control.
		</constant>
		<constant name="NOTIFICATION_RESIZED" value="40" enum="">
			Control changed size (get_size() reports the new size).
		</constant>
		<constant name="NOTIFICATION_MOUSE_ENTER" value="41" enum="">
			Mouse pointer entered the area of the Control.
		</constant>
		<constant name="NOTIFICATION_MOUSE_EXIT" value="42" enum="">
			Mouse pointer exited the area of the Control.
		</constant>
		<constant name="NOTIFICATION_FOCUS_ENTER" value="43" enum="">
			Control gained focus.
		</constant>
		<constant name="NOTIFICATION_FOCUS_EXIT" value="44" enum="">
			Control lost focus.
		</constant>
		<constant name="NOTIFICATION_THEME_CHANGED" value="45" enum="">
			Theme changed. Redrawing is desired.
		</constant>
		<constant name="NOTIFICATION_MODAL_CLOSE" value="46" enum="">
			Modal control was closed.
		</constant>
		<constant name="CURSOR_ARROW" value="0">
		</constant>
		<constant name="CURSOR_IBEAM" value="1">
		</constant>
		<constant name="CURSOR_POINTING_HAND" value="2">
		</constant>
		<constant name="CURSOR_CROSS" value="3">
		</constant>
		<constant name="CURSOR_WAIT" value="4">
		</constant>
		<constant name="CURSOR_BUSY" value="5">
		</constant>
		<constant name="CURSOR_DRAG" value="6">
		</constant>
		<constant name="CURSOR_CAN_DROP" value="7">
		</constant>
		<constant name="CURSOR_FORBIDDEN" value="8">
		</constant>
		<constant name="CURSOR_VSIZE" value="9">
		</constant>
		<constant name="CURSOR_HSIZE" value="10">
		</constant>
		<constant name="CURSOR_BDIAGSIZE" value="11">
		</constant>
		<constant name="CURSOR_FDIAGSIZE" value="12">
		</constant>
		<constant name="CURSOR_MOVE" value="13">
		</constant>
		<constant name="CURSOR_VSPLIT" value="14">
		</constant>
		<constant name="CURSOR_HSPLIT" value="15">
		</constant>
		<constant name="CURSOR_HELP" value="16">
		</constant>
		<constant name="PRESET_TOP_LEFT" value="0">
		</constant>
		<constant name="PRESET_TOP_RIGHT" value="1">
		</constant>
		<constant name="PRESET_BOTTOM_LEFT" value="2">
		</constant>
		<constant name="PRESET_BOTTOM_RIGHT" value="3">
		</constant>
		<constant name="PRESET_CENTER_LEFT" value="4">
		</constant>
		<constant name="PRESET_CENTER_TOP" value="5">
		</constant>
		<constant name="PRESET_CENTER_RIGHT" value="6">
		</constant>
		<constant name="PRESET_CENTER_BOTTOM" value="7">
		</constant>
		<constant name="PRESET_CENTER" value="8">
		</constant>
		<constant name="PRESET_LEFT_WIDE" value="9">
		</constant>
		<constant name="PRESET_TOP_WIDE" value="10">
		</constant>
		<constant name="PRESET_RIGHT_WIDE" value="11">
		</constant>
		<constant name="PRESET_BOTTOM_WIDE" value="12">
		</constant>
		<constant name="PRESET_VCENTER_WIDE" value="13">
		</constant>
		<constant name="PRESET_HCENTER_WIDE" value="14">
		</constant>
		<constant name="PRESET_WIDE" value="15">
		</constant>
		<constant name="SIZE_EXPAND" value="2">
		</constant>
		<constant name="SIZE_FILL" value="1">
		</constant>
		<constant name="SIZE_EXPAND_FILL" value="3">
		</constant>
		<constant name="SIZE_SHRINK_CENTER" value="4">
		</constant>
		<constant name="SIZE_SHRINK_END" value="8">
		</constant>
		<constant name="MOUSE_FILTER_STOP" value="0">
		</constant>
		<constant name="MOUSE_FILTER_PASS" value="1">
		</constant>
		<constant name="MOUSE_FILTER_IGNORE" value="2">
		</constant>
		<constant name="GROW_DIRECTION_BEGIN" value="0">
		</constant>
		<constant name="GROW_DIRECTION_END" value="1">
		</constant>
		<constant name="ANCHOR_BEGIN" value="0">
			X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP.
		</constant>
		<constant name="ANCHOR_END" value="1">
			X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM.
		</constant>
	</constants>
</class>