godot-docs/classes/class_control.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Control.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Control:

Control
=======

**Inherits:** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Inherited By:** :ref:`TextureRect<class_texturerect>`, :ref:`ColorRect<class_colorrect>`, :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`GraphEdit<class_graphedit>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`NinePatchRect<class_ninepatchrect>`, :ref:`LineEdit<class_lineedit>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`ReferenceRect<class_referencerect>`, :ref:`Container<class_container>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`ItemList<class_itemlist>`

**Category:** Core

Brief Description
-----------------

Base node for all User Interface components.

Member Functions
----------------

+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`_get_minimum_size<class_Control__get_minimum_size>`  **(** **)** virtual                                                                                                                                                       |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`_gui_input<class_Control__gui_input>`  **(** :ref:`InputEvent<class_inputevent>` event  **)** virtual                                                                                                                          |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`accept_event<class_Control_accept_event>`  **(** **)**                                                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`add_color_override<class_Control_add_color_override>`  **(** :ref:`String<class_string>` name, :ref:`Color<class_color>` color  **)**                                                                                          |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`add_constant_override<class_Control_add_constant_override>`  **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant  **)**                                                                                     |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`add_font_override<class_Control_add_font_override>`  **(** :ref:`String<class_string>` name, :ref:`Font<class_font>` font  **)**                                                                                               |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`add_icon_override<class_Control_add_icon_override>`  **(** :ref:`String<class_string>` name, :ref:`Texture<class_texture>` texture  **)**                                                                                      |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`add_shader_override<class_Control_add_shader_override>`  **(** :ref:`String<class_string>` name, :ref:`Shader<class_shader>` shader  **)**                                                                                     |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`add_style_override<class_Control_add_style_override>`  **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox  **)**                                                                                 |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`can_drop_data<class_Control_can_drop_data>`  **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data  **)** virtual                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`drop_data<class_Control_drop_data>`  **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data  **)** virtual                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`force_drag<class_Control_force_drag>`  **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview  **)**                                                                                                  |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_anchor<class_Control_get_anchor>`  **(** :ref:`int<class_int>` margin  **)** const                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_begin<class_Control_get_begin>`  **(** **)** const                                                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`        | :ref:`get_color<class_Control_get_color>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                                  |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_combined_minimum_size<class_Control_get_combined_minimum_size>`  **(** **)** const                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_constant<class_Control_get_constant>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                            |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_cursor_shape<class_Control_get_cursor_shape>`  **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 )  **)** const                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_custom_minimum_size<class_Control_get_custom_minimum_size>`  **(** **)** const                                                                                                                                             |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_default_cursor_shape<class_Control_get_default_cursor_shape>`  **(** **)** const                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>`      | :ref:`get_drag_data<class_Control_get_drag_data>`  **(** :ref:`Vector2<class_vector2>` position  **)** virtual                                                                                                                       |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_end<class_Control_get_end>`  **(** **)** const                                                                                                                                                                             |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_focus_mode<class_Control_get_focus_mode>`  **(** **)** const                                                                                                                                                               |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>`  | :ref:`get_focus_neighbour<class_Control_get_focus_neighbour>`  **(** :ref:`int<class_int>` margin  **)** const                                                                                                                       |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_control>`    | :ref:`get_focus_owner<class_Control_get_focus_owner>`  **(** **)** const                                                                                                                                                             |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Font<class_font>`          | :ref:`get_font<class_Control_get_font>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_global_position<class_Control_get_global_position>`  **(** **)** const                                                                                                                                                     |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>`        | :ref:`get_global_rect<class_Control_get_global_rect>`  **(** **)** const                                                                                                                                                             |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_h_grow_direction<class_Control_get_h_grow_direction>`  **(** **)** const                                                                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_h_size_flags<class_Control_get_h_size_flags>`  **(** **)** const                                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`    | :ref:`get_icon<class_Control_get_icon>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_margin<class_Control_get_margin>`  **(** :ref:`int<class_int>` margin  **)** const                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_minimum_size<class_Control_get_minimum_size>`  **(** **)** const                                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_mouse_filter<class_Control_get_mouse_filter>`  **(** **)** const                                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_parent_area_size<class_Control_get_parent_area_size>`  **(** **)** const                                                                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Control<class_control>`    | :ref:`get_parent_control<class_Control_get_parent_control>`  **(** **)** const                                                                                                                                                       |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_pivot_offset<class_Control_get_pivot_offset>`  **(** **)** const                                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_position<class_Control_get_position>`  **(** **)** const                                                                                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>`        | :ref:`get_rect<class_Control_get_rect>`  **(** **)** const                                                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_rotation<class_Control_get_rotation>`  **(** **)** const                                                                                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_rotation_deg<class_Control_get_rotation_deg>`  **(** **)** const                                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_scale<class_Control_get_scale>`  **(** **)** const                                                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`    | :ref:`get_size<class_Control_get_size>`  **(** **)** const                                                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_stretch_ratio<class_Control_get_stretch_ratio>`  **(** **)** const                                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StyleBox<class_stylebox>`  | :ref:`get_stylebox<class_Control_get_stylebox>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                            |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Theme<class_theme>`        | :ref:`get_theme<class_Control_get_theme>`  **(** **)** const                                                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`      | :ref:`get_tooltip<class_Control_get_tooltip>`  **(** :ref:`Vector2<class_vector2>` at_position=Vector2( 0, 0 )  **)** const                                                                                                          |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_v_grow_direction<class_Control_get_v_grow_direction>`  **(** **)** const                                                                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_v_size_flags<class_Control_get_v_size_flags>`  **(** **)** const                                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`grab_click_focus<class_Control_grab_click_focus>`  **(** **)**                                                                                                                                                                 |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`grab_focus<class_Control_grab_focus>`  **(** **)**                                                                                                                                                                             |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_color<class_Control_has_color>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                                  |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_color_override<class_Control_has_color_override>`  **(** :ref:`String<class_string>` name  **)** const                                                                                                                     |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_constant<class_Control_has_constant>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                            |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_constant_override<class_Control_has_constant_override>`  **(** :ref:`String<class_string>` name  **)** const                                                                                                               |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_focus<class_Control_has_focus>`  **(** **)** const                                                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_font<class_Control_has_font>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_font_override<class_Control_has_font_override>`  **(** :ref:`String<class_string>` name  **)** const                                                                                                                       |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_icon<class_Control_has_icon>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_icon_override<class_Control_has_icon_override>`  **(** :ref:`String<class_string>` name  **)** const                                                                                                                       |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_point<class_Control_has_point>`  **(** :ref:`Vector2<class_vector2>` point  **)** virtual                                                                                                                                  |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_stylebox<class_Control_has_stylebox>`  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const                                                                                            |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`has_stylebox_override<class_Control_has_stylebox_override>`  **(** :ref:`String<class_string>` name  **)** const                                                                                                               |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`is_clipping_contents<class_Control_is_clipping_contents>`  **(** **)**                                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`minimum_size_changed<class_Control_minimum_size_changed>`  **(** **)**                                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`release_focus<class_Control_release_focus>`  **(** **)**                                                                                                                                                                       |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_anchor<class_Control_set_anchor>`  **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=false, :ref:`bool<class_bool>` push_opposite_anchor=true  **)**               |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_anchor_and_margin<class_Control_set_anchor_and_margin>`  **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=false  **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_anchors_preset<class_Control_set_anchors_preset>`  **(** :ref:`int<class_int>` preset, :ref:`bool<class_bool>` keep_margin=false  **)**                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_area_as_parent_rect<class_Control_set_area_as_parent_rect>`  **(** :ref:`int<class_int>` margin=0  **)**                                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_begin<class_Control_set_begin>`  **(** :ref:`Vector2<class_vector2>` position  **)**                                                                                                                                       |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_clip_contents<class_Control_set_clip_contents>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                               |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_custom_minimum_size<class_Control_set_custom_minimum_size>`  **(** :ref:`Vector2<class_vector2>` size  **)**                                                                                                               |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_default_cursor_shape<class_Control_set_default_cursor_shape>`  **(** :ref:`int<class_int>` shape  **)**                                                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_drag_forwarding<class_Control_set_drag_forwarding>`  **(** :ref:`Control<class_control>` target  **)**                                                                                                                     |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_drag_preview<class_Control_set_drag_preview>`  **(** :ref:`Control<class_control>` control  **)**                                                                                                                          |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_end<class_Control_set_end>`  **(** :ref:`Vector2<class_vector2>` position  **)**                                                                                                                                           |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_focus_mode<class_Control_set_focus_mode>`  **(** :ref:`int<class_int>` mode  **)**                                                                                                                                         |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_focus_neighbour<class_Control_set_focus_neighbour>`  **(** :ref:`int<class_int>` margin, :ref:`NodePath<class_nodepath>` neighbour  **)**                                                                                  |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_global_position<class_Control_set_global_position>`  **(** :ref:`Vector2<class_vector2>` position  **)**                                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_h_grow_direction<class_Control_set_h_grow_direction>`  **(** :ref:`int<class_int>` direction  **)**                                                                                                                        |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_h_size_flags<class_Control_set_h_size_flags>`  **(** :ref:`int<class_int>` flags  **)**                                                                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_margin<class_Control_set_margin>`  **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset  **)**                                                                                                             |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_mouse_filter<class_Control_set_mouse_filter>`  **(** :ref:`int<class_int>` filter  **)**                                                                                                                                   |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_pivot_offset<class_Control_set_pivot_offset>`  **(** :ref:`Vector2<class_vector2>` pivot_offset  **)**                                                                                                                     |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_position<class_Control_set_position>`  **(** :ref:`Vector2<class_vector2>` position  **)**                                                                                                                                 |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_rotation<class_Control_set_rotation>`  **(** :ref:`float<class_float>` radians  **)**                                                                                                                                      |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_rotation_deg<class_Control_set_rotation_deg>`  **(** :ref:`float<class_float>` degrees  **)**                                                                                                                              |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_scale<class_Control_set_scale>`  **(** :ref:`Vector2<class_vector2>` scale  **)**                                                                                                                                          |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_size<class_Control_set_size>`  **(** :ref:`Vector2<class_vector2>` size  **)**                                                                                                                                             |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_stretch_ratio<class_Control_set_stretch_ratio>`  **(** :ref:`float<class_float>` ratio  **)**                                                                                                                              |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_theme<class_Control_set_theme>`  **(** :ref:`Theme<class_theme>` theme  **)**                                                                                                                                              |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_tooltip<class_Control_set_tooltip>`  **(** :ref:`String<class_string>` tooltip  **)**                                                                                                                                      |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_v_grow_direction<class_Control_set_v_grow_direction>`  **(** :ref:`int<class_int>` direction  **)**                                                                                                                        |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_v_size_flags<class_Control_set_v_size_flags>`  **(** :ref:`int<class_int>` flags  **)**                                                                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`show_modal<class_Control_show_modal>`  **(** :ref:`bool<class_bool>` exclusive=false  **)**                                                                                                                                    |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`warp_mouse<class_Control_warp_mouse>`  **(** :ref:`Vector2<class_vector2>` to_position  **)**                                                                                                                                  |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

-  **focus_entered**  **(** **)**
Emitted when the node gains keyboard focus.

-  **focus_exited**  **(** **)**
Emitted when the node loses keyboard focus.

-  **gui_input**  **(** :ref:`Object<class_object>` ev  **)**
-  **minimum_size_changed**  **(** **)**
Emitted when the node's minimum size changes.

-  **modal_closed**  **(** **)**
-  **mouse_entered**  **(** **)**
Emitted when the mouse enters the control's area.

-  **mouse_exited**  **(** **)**
Emitted when the mouse leaves the control's area.

-  **resized**  **(** **)**
Emitted when the control changes size.

-  **size_flags_changed**  **(** **)**
Emitted when the size flags change.


Member Variables
----------------

- :ref:`float<class_float>` **anchor_bottom**
- :ref:`float<class_float>` **anchor_left**
- :ref:`float<class_float>` **anchor_right**
- :ref:`float<class_float>` **anchor_top**
- :ref:`NodePath<class_nodepath>` **focus_neighbour_bottom**
- :ref:`NodePath<class_nodepath>` **focus_neighbour_left**
- :ref:`NodePath<class_nodepath>` **focus_neighbour_right**
- :ref:`NodePath<class_nodepath>` **focus_neighbour_top**
- :ref:`int<class_int>` **grow_horizontal**
- :ref:`int<class_int>` **grow_vertical**
- :ref:`String<class_string>` **hint_tooltip**
- :ref:`float<class_float>` **margin_bottom**
- :ref:`float<class_float>` **margin_left**
- :ref:`float<class_float>` **margin_right**
- :ref:`float<class_float>` **margin_top**
- :ref:`int<class_int>` **mouse_filter**
- :ref:`bool<class_bool>` **rect_clip_content**
- :ref:`Vector2<class_vector2>` **rect_min_size**
- :ref:`Vector2<class_vector2>` **rect_pivot_offset**
- :ref:`Vector2<class_vector2>` **rect_position**
- :ref:`float<class_float>` **rect_rotation**
- :ref:`Vector2<class_vector2>` **rect_scale**
- :ref:`Vector2<class_vector2>` **rect_size**
- :ref:`int<class_int>` **size_flags_horizontal**
- :ref:`float<class_float>` **size_flags_stretch_ratio**
- :ref:`int<class_int>` **size_flags_vertical**
- :ref:`Theme<class_theme>` **theme**

Numeric Constants
-----------------

- **FOCUS_NONE** = **0** --- Control can't acquire focus.
- **FOCUS_CLICK** = **1** --- Control can acquire focus only if clicked.
- **FOCUS_ALL** = **2** --- Control can acquire focus if clicked, or by pressing TAB/Directionals in the keyboard from another Control.
- **NOTIFICATION_RESIZED** = **40** --- Control changed size (get_size() reports the new size).
- **NOTIFICATION_MOUSE_ENTER** = **41** --- Mouse pointer entered the area of the Control.
- **NOTIFICATION_MOUSE_EXIT** = **42** --- Mouse pointer exited the area of the Control.
- **NOTIFICATION_FOCUS_ENTER** = **43** --- Control gained focus.
- **NOTIFICATION_FOCUS_EXIT** = **44** --- Control lost focus.
- **NOTIFICATION_THEME_CHANGED** = **45** --- Theme changed. Redrawing is desired.
- **NOTIFICATION_MODAL_CLOSE** = **46** --- Modal control was closed.
- **CURSOR_ARROW** = **0**
- **CURSOR_IBEAM** = **1**
- **CURSOR_POINTING_HAND** = **2**
- **CURSOR_CROSS** = **3**
- **CURSOR_WAIT** = **4**
- **CURSOR_BUSY** = **5**
- **CURSOR_DRAG** = **6**
- **CURSOR_CAN_DROP** = **7**
- **CURSOR_FORBIDDEN** = **8**
- **CURSOR_VSIZE** = **9**
- **CURSOR_HSIZE** = **10**
- **CURSOR_BDIAGSIZE** = **11**
- **CURSOR_FDIAGSIZE** = **12**
- **CURSOR_MOVE** = **13**
- **CURSOR_VSPLIT** = **14**
- **CURSOR_HSPLIT** = **15**
- **CURSOR_HELP** = **16**
- **PRESET_TOP_LEFT** = **0**
- **PRESET_TOP_RIGHT** = **1**
- **PRESET_BOTTOM_LEFT** = **2**
- **PRESET_BOTTOM_RIGHT** = **3**
- **PRESET_CENTER_LEFT** = **4**
- **PRESET_CENTER_TOP** = **5**
- **PRESET_CENTER_RIGHT** = **6**
- **PRESET_CENTER_BOTTOM** = **7**
- **PRESET_CENTER** = **8**
- **PRESET_LEFT_WIDE** = **9**
- **PRESET_TOP_WIDE** = **10**
- **PRESET_RIGHT_WIDE** = **11**
- **PRESET_BOTTOM_WIDE** = **12**
- **PRESET_VCENTER_WIDE** = **13**
- **PRESET_HCENTER_WIDE** = **14**
- **PRESET_WIDE** = **15**
- **SIZE_EXPAND** = **2**
- **SIZE_FILL** = **1**
- **SIZE_EXPAND_FILL** = **3**
- **SIZE_SHRINK_CENTER** = **4**
- **SIZE_SHRINK_END** = **8**
- **MOUSE_FILTER_STOP** = **0**
- **MOUSE_FILTER_PASS** = **1**
- **MOUSE_FILTER_IGNORE** = **2**
- **GROW_DIRECTION_BEGIN** = **0**
- **GROW_DIRECTION_END** = **1**
- **ANCHOR_BEGIN** = **0** --- X is relative to MARGIN_LEFT, Y is relative to MARGIN_TOP.
- **ANCHOR_END** = **1** --- X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM.

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 :ref:`Container<class_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 :ref:`Node._input<class_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 :ref:`MainLoop._input_event<class_MainLoop__input_event>`. No need to enable :ref:`Node.set_process_input<class_Node_set_process_input>` on Controls to receive input events. Call :ref:`accept_event<class_Control_accept_event>` to ensure no other node receives the event, not even :ref:`Node._unhandled_input<class_Node__unhandled_input>`.

Only the one Control node in focus receives keyboard events. To do so, the Control must get the focus mode with :ref:`set_focus_mode<class_Control_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 :ref:`set_ignore_mouse<class_Control_set_ignore_mouse>` for that.

:ref:`Theme<class_theme>` resources change the Control's appearance. If you change the :ref:`Theme<class_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 :ref:`add_font_override<class_Control_add_font_override>`. You can also override the theme from the editor.

Member Function Description
---------------------------

.. _class_Control__get_minimum_size:

- :ref:`Vector2<class_vector2>`  **_get_minimum_size**  **(** **)** virtual

Returns the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.

.. _class_Control__gui_input:

- void  **_gui_input**  **(** :ref:`InputEvent<class_inputevent>` event  **)** virtual

.. _class_Control_accept_event:

- void  **accept_event**  **(** **)**

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 :ref:`Node._unhandled_input<class_Node__unhandled_input>` or :ref:`Node._unhandled_key_input<class_Node__unhandled_key_input>`.

.. _class_Control_add_color_override:

- void  **add_color_override**  **(** :ref:`String<class_string>` name, :ref:`Color<class_color>` color  **)**

.. _class_Control_add_constant_override:

- void  **add_constant_override**  **(** :ref:`String<class_string>` name, :ref:`int<class_int>` constant  **)**

Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared.

.. _class_Control_add_font_override:

- void  **add_font_override**  **(** :ref:`String<class_string>` name, :ref:`Font<class_font>` font  **)**

Override a single font (font) in the theme of this Control. If font is empty, override is cleared.

.. _class_Control_add_icon_override:

- void  **add_icon_override**  **(** :ref:`String<class_string>` name, :ref:`Texture<class_texture>` texture  **)**

Override a single icon (:ref:`Texture<class_texture>`) in the theme of this Control. If texture is empty, override is cleared.

.. _class_Control_add_shader_override:

- void  **add_shader_override**  **(** :ref:`String<class_string>` name, :ref:`Shader<class_shader>` shader  **)**

.. _class_Control_add_style_override:

- void  **add_style_override**  **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox  **)**

Override a single stylebox (Stylebox) in the theme of this Control. If stylebox is empty, override is cleared.

.. _class_Control_can_drop_data:

- :ref:`bool<class_bool>`  **can_drop_data**  **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data  **)** virtual

.. _class_Control_drop_data:

- void  **drop_data**  **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data  **)** virtual

.. _class_Control_force_drag:

- void  **force_drag**  **(** :ref:`Variant<class_variant>` data, :ref:`Control<class_control>` preview  **)**

.. _class_Control_get_anchor:

- :ref:`float<class_float>`  **get_anchor**  **(** :ref:`int<class_int>` margin  **)** const

Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).

.. _class_Control_get_begin:

- :ref:`Vector2<class_vector2>`  **get_begin**  **(** **)** const

.. _class_Control_get_color:

- :ref:`Color<class_color>`  **get_color**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_get_combined_minimum_size:

- :ref:`Vector2<class_vector2>`  **get_combined_minimum_size**  **(** **)** const

.. _class_Control_get_constant:

- :ref:`int<class_int>`  **get_constant**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_get_cursor_shape:

- :ref:`int<class_int>`  **get_cursor_shape**  **(** :ref:`Vector2<class_vector2>` position=Vector2( 0, 0 )  **)** const

Return the cursor shape at a certain position in the control.

.. _class_Control_get_custom_minimum_size:

- :ref:`Vector2<class_vector2>`  **get_custom_minimum_size**  **(** **)** const

.. _class_Control_get_default_cursor_shape:

- :ref:`int<class_int>`  **get_default_cursor_shape**  **(** **)** const

Return the default cursor shape for this control. See enum CURSOR\_\* for the list of shapes.

.. _class_Control_get_drag_data:

- :ref:`Object<class_object>`  **get_drag_data**  **(** :ref:`Vector2<class_vector2>` position  **)** virtual

.. _class_Control_get_end:

- :ref:`Vector2<class_vector2>`  **get_end**  **(** **)** const

Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).

.. _class_Control_get_focus_mode:

- :ref:`int<class_int>`  **get_focus_mode**  **(** **)** const

Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see :ref:`set_focus_mode<class_Control_set_focus_mode>`).

.. _class_Control_get_focus_neighbour:

- :ref:`NodePath<class_nodepath>`  **get_focus_neighbour**  **(** :ref:`int<class_int>` margin  **)** const

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.

.. _class_Control_get_focus_owner:

- :ref:`Control<class_control>`  **get_focus_owner**  **(** **)** const

Return which control is owning the keyboard focus, or null if no one.

.. _class_Control_get_font:

- :ref:`Font<class_font>`  **get_font**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_get_global_position:

- :ref:`Vector2<class_vector2>`  **get_global_position**  **(** **)** const

Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.

.. _class_Control_get_global_rect:

- :ref:`Rect2<class_rect2>`  **get_global_rect**  **(** **)** const

Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_position<class_Control_get_global_position>`, :ref:`get_size<class_Control_get_size>`).

.. _class_Control_get_h_grow_direction:

- :ref:`int<class_int>`  **get_h_grow_direction**  **(** **)** const

.. _class_Control_get_h_size_flags:

- :ref:`int<class_int>`  **get_h_size_flags**  **(** **)** const

Hint for containers, return horizontal positioning flags.

.. _class_Control_get_icon:

- :ref:`Texture<class_texture>`  **get_icon**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_get_margin:

- :ref:`float<class_float>`  **get_margin**  **(** :ref:`int<class_int>` margin  **)** const

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.

.. _class_Control_get_minimum_size:

- :ref:`Vector2<class_vector2>`  **get_minimum_size**  **(** **)** const

Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size.

.. _class_Control_get_mouse_filter:

- :ref:`int<class_int>`  **get_mouse_filter**  **(** **)** const

Return when the control is ignoring mouse events (even touchpad events send mouse events).

.. _class_Control_get_parent_area_size:

- :ref:`Vector2<class_vector2>`  **get_parent_area_size**  **(** **)** const

.. _class_Control_get_parent_control:

- :ref:`Control<class_control>`  **get_parent_control**  **(** **)** const

.. _class_Control_get_pivot_offset:

- :ref:`Vector2<class_vector2>`  **get_pivot_offset**  **(** **)** const

.. _class_Control_get_position:

- :ref:`Vector2<class_vector2>`  **get_position**  **(** **)** const

Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.

.. _class_Control_get_rect:

- :ref:`Rect2<class_rect2>`  **get_rect**  **(** **)** const

Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see :ref:`get_position<class_Control_get_position>`, :ref:`get_size<class_Control_get_size>`).

.. _class_Control_get_rotation:

- :ref:`float<class_float>`  **get_rotation**  **(** **)** const

Return the rotation (in radians)

.. _class_Control_get_rotation_deg:

- :ref:`float<class_float>`  **get_rotation_deg**  **(** **)** const

Return the rotation (in degrees)

.. _class_Control_get_scale:

- :ref:`Vector2<class_vector2>`  **get_scale**  **(** **)** const

.. _class_Control_get_size:

- :ref:`Vector2<class_vector2>`  **get_size**  **(** **)** const

Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by** :ref:`get_minimum_size<class_Control_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, :ref:`get_minimum_size<class_Control_get_minimum_size>`, :ref:`set_margin<class_Control_set_margin>`, :ref:`set_anchor<class_Control_set_anchor>`).

.. _class_Control_get_stretch_ratio:

- :ref:`float<class_float>`  **get_stretch_ratio**  **(** **)** const

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.

.. _class_Control_get_stylebox:

- :ref:`StyleBox<class_stylebox>`  **get_stylebox**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_get_theme:

- :ref:`Theme<class_theme>`  **get_theme**  **(** **)** const

Return a :ref:`Theme<class_theme>` override, if one exists (see :ref:`set_theme<class_Control_set_theme>`).

.. _class_Control_get_tooltip:

- :ref:`String<class_string>`  **get_tooltip**  **(** :ref:`Vector2<class_vector2>` at_position=Vector2( 0, 0 )  **)** const

Return the tooltip, which will appear when the cursor is resting over this control.

.. _class_Control_get_v_grow_direction:

- :ref:`int<class_int>`  **get_v_grow_direction**  **(** **)** const

.. _class_Control_get_v_size_flags:

- :ref:`int<class_int>`  **get_v_size_flags**  **(** **)** const

Hint for containers, return vertical positioning flags.

.. _class_Control_grab_click_focus:

- void  **grab_click_focus**  **(** **)**

.. _class_Control_grab_focus:

- void  **grab_focus**  **(** **)**

Steal the focus from another control and become the focused control (see :ref:`set_focus_mode<class_Control_set_focus_mode>`).

.. _class_Control_has_color:

- :ref:`bool<class_bool>`  **has_color**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_has_color_override:

- :ref:`bool<class_bool>`  **has_color_override**  **(** :ref:`String<class_string>` name  **)** const

.. _class_Control_has_constant:

- :ref:`bool<class_bool>`  **has_constant**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_has_constant_override:

- :ref:`bool<class_bool>`  **has_constant_override**  **(** :ref:`String<class_string>` name  **)** const

.. _class_Control_has_focus:

- :ref:`bool<class_bool>`  **has_focus**  **(** **)** const

Return whether the Control is the current focused control (see :ref:`set_focus_mode<class_Control_set_focus_mode>`).

.. _class_Control_has_font:

- :ref:`bool<class_bool>`  **has_font**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_has_font_override:

- :ref:`bool<class_bool>`  **has_font_override**  **(** :ref:`String<class_string>` name  **)** const

.. _class_Control_has_icon:

- :ref:`bool<class_bool>`  **has_icon**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_has_icon_override:

- :ref:`bool<class_bool>`  **has_icon_override**  **(** :ref:`String<class_string>` name  **)** const

.. _class_Control_has_point:

- :ref:`bool<class_bool>`  **has_point**  **(** :ref:`Vector2<class_vector2>` point  **)** virtual

.. _class_Control_has_stylebox:

- :ref:`bool<class_bool>`  **has_stylebox**  **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type=""  **)** const

.. _class_Control_has_stylebox_override:

- :ref:`bool<class_bool>`  **has_stylebox_override**  **(** :ref:`String<class_string>` name  **)** const

.. _class_Control_is_clipping_contents:

- :ref:`bool<class_bool>`  **is_clipping_contents**  **(** **)**

.. _class_Control_minimum_size_changed:

- void  **minimum_size_changed**  **(** **)**

.. _class_Control_release_focus:

- void  **release_focus**  **(** **)**

Give up the focus, no other control will be able to receive keyboard input.

.. _class_Control_set_anchor:

- void  **set_anchor**  **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`bool<class_bool>` keep_margin=false, :ref:`bool<class_bool>` push_opposite_anchor=true  **)**

.. _class_Control_set_anchor_and_margin:

- void  **set_anchor_and_margin**  **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` anchor, :ref:`float<class_float>` offset, :ref:`bool<class_bool>` push_opposite_anchor=false  **)**

.. _class_Control_set_anchors_preset:

- void  **set_anchors_preset**  **(** :ref:`int<class_int>` preset, :ref:`bool<class_bool>` keep_margin=false  **)**

.. _class_Control_set_area_as_parent_rect:

- void  **set_area_as_parent_rect**  **(** :ref:`int<class_int>` margin=0  **)**

Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see :ref:`set_anchor<class_Control_set_anchor>`, :ref:`set_margin<class_Control_set_margin>`).

.. _class_Control_set_begin:

- void  **set_begin**  **(** :ref:`Vector2<class_vector2>` position  **)**

Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).

.. _class_Control_set_clip_contents:

- void  **set_clip_contents**  **(** :ref:`bool<class_bool>` enable  **)**

.. _class_Control_set_custom_minimum_size:

- void  **set_custom_minimum_size**  **(** :ref:`Vector2<class_vector2>` size  **)**

.. _class_Control_set_default_cursor_shape:

- void  **set_default_cursor_shape**  **(** :ref:`int<class_int>` shape  **)**

Set the default cursor shape for this control. See enum CURSOR\_\* for the list of shapes.

.. _class_Control_set_drag_forwarding:

- void  **set_drag_forwarding**  **(** :ref:`Control<class_control>` target  **)**

.. _class_Control_set_drag_preview:

- void  **set_drag_preview**  **(** :ref:`Control<class_control>` control  **)**

.. _class_Control_set_end:

- void  **set_end**  **(** :ref:`Vector2<class_vector2>` position  **)**

Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).

.. _class_Control_set_focus_mode:

- void  **set_focus_mode**  **(** :ref:`int<class_int>` mode  **)**

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.

.. _class_Control_set_focus_neighbour:

- void  **set_focus_neighbour**  **(** :ref:`int<class_int>` margin, :ref:`NodePath<class_nodepath>` neighbour  **)**

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.

.. _class_Control_set_global_position:

- void  **set_global_position**  **(** :ref:`Vector2<class_vector2>` position  **)**

Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin<class_Control_set_margin>`).

.. _class_Control_set_h_grow_direction:

- void  **set_h_grow_direction**  **(** :ref:`int<class_int>` direction  **)**

.. _class_Control_set_h_size_flags:

- void  **set_h_size_flags**  **(** :ref:`int<class_int>` flags  **)**

Hint for containers, set horizontal positioning flags.

.. _class_Control_set_margin:

- void  **set_margin**  **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` offset  **)**

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.

.. _class_Control_set_mouse_filter:

- void  **set_mouse_filter**  **(** :ref:`int<class_int>` filter  **)**

Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER\_\* constants)

.. _class_Control_set_pivot_offset:

- void  **set_pivot_offset**  **(** :ref:`Vector2<class_vector2>` pivot_offset  **)**

.. _class_Control_set_position:

- void  **set_position**  **(** :ref:`Vector2<class_vector2>` position  **)**

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 :ref:`set_margin<class_Control_set_margin>`).

.. _class_Control_set_rotation:

- void  **set_rotation**  **(** :ref:`float<class_float>` radians  **)**

Set the rotation (in radians).

.. _class_Control_set_rotation_deg:

- void  **set_rotation_deg**  **(** :ref:`float<class_float>` degrees  **)**

Set the rotation (in degrees).

.. _class_Control_set_scale:

- void  **set_scale**  **(** :ref:`Vector2<class_vector2>` scale  **)**

.. _class_Control_set_size:

- void  **set_size**  **(** :ref:`Vector2<class_vector2>` size  **)**

Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).

.. _class_Control_set_stretch_ratio:

- void  **set_stretch_ratio**  **(** :ref:`float<class_float>` ratio  **)**

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.

.. _class_Control_set_theme:

- void  **set_theme**  **(** :ref:`Theme<class_theme>` theme  **)**

Override whole the :ref:`Theme<class_theme>` for this Control and all its children controls.

.. _class_Control_set_tooltip:

- void  **set_tooltip**  **(** :ref:`String<class_string>` tooltip  **)**

Set a tooltip, which will appear when the cursor is resting over this control.

.. _class_Control_set_v_grow_direction:

- void  **set_v_grow_direction**  **(** :ref:`int<class_int>` direction  **)**

.. _class_Control_set_v_size_flags:

- void  **set_v_size_flags**  **(** :ref:`int<class_int>` flags  **)**

Hint for containers, set vertical positioning flags.

.. _class_Control_show_modal:

- void  **show_modal**  **(** :ref:`bool<class_bool>` exclusive=false  **)**

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.

.. _class_Control_warp_mouse:

- void  **warp_mouse**  **(** :ref:`Vector2<class_vector2>` to_position  **)**