Control

Inherits: CanvasItem < Node < Object

Inherited By: BaseButton, ColorRect, Container, GraphEdit, ItemList, JamClientUI, JamEditorPluginPage, Label, LineEdit, MenuBar, NinePatchRect, Panel, Range, ReferenceRect, RichTextLabel, Separator, TabBar, TextEdit, TextureRect, Tree, VideoStreamPlayer

There is currently no description for this class. Please help us by contributing one!

Properties

float	anchor_bottom	`0.0`
float	anchor_left	`0.0`
float	anchor_right	`0.0`
float	anchor_top	`0.0`
bool	auto_translate
bool	clip_contents	`false`
Vector2	custom_minimum_size	`Vector2(0, 0)`
FocusMode	focus_mode	`0`
NodePath	focus_neighbor_bottom	`NodePath("")`
NodePath	focus_neighbor_left	`NodePath("")`
NodePath	focus_neighbor_right	`NodePath("")`
NodePath	focus_neighbor_top	`NodePath("")`
NodePath	focus_next	`NodePath("")`
NodePath	focus_previous	`NodePath("")`
Vector2	global_position
GrowDirection	grow_horizontal	`1`
GrowDirection	grow_vertical	`1`
LayoutDirection	layout_direction	`0`
bool	localize_numeral_system	`true`
CursorShape	mouse_default_cursor_shape	`0`
MouseFilter	mouse_filter	`0`
bool	mouse_force_pass_scroll_events	`true`
float	offset_bottom	`0.0`
float	offset_left	`0.0`
float	offset_right	`0.0`
float	offset_top	`0.0`
PhysicsInterpolationMode	physics_interpolation_mode	`2` (overrides Node)
Vector2	pivot_offset	`Vector2(0, 0)`
Vector2	position	`Vector2(0, 0)`
float	rotation	`0.0`
float	rotation_degrees
Vector2	scale	`Vector2(1, 1)`
Node	shortcut_context
Vector2	size	`Vector2(0, 0)`
BitField<SizeFlags>	size_flags_horizontal	`1`
float	size_flags_stretch_ratio	`1.0`
BitField<SizeFlags>	size_flags_vertical	`1`
Theme	theme
StringName	theme_type_variation	`&""`
String	tooltip_text	`""`

Methods

bool	_can_drop_data ( Vector2 at_position, Variant data ) virtual const
void	_drop_data ( Vector2 at_position, Variant data ) virtual
Variant	_get_drag_data ( Vector2 at_position ) virtual
Vector2	_get_minimum_size ( ) virtual const
String	_get_tooltip ( Vector2 at_position ) virtual const
void	_gui_input ( InputEvent event ) virtual
bool	_has_point ( Vector2 point ) virtual const
Object	_make_custom_tooltip ( String for_text ) virtual const
Vector3i[]	_structured_text_parser ( Array args, String text ) virtual const
void	accept_event ( )
void	add_theme_color_override ( StringName name, Color color )
void	add_theme_constant_override ( StringName name, int constant )
void	add_theme_font_override ( StringName name, Font font )
void	add_theme_font_size_override ( StringName name, int font_size )
void	add_theme_icon_override ( StringName name, Texture2D texture )
void	add_theme_stylebox_override ( StringName name, StyleBox stylebox )
void	begin_bulk_theme_override ( )
void	end_bulk_theme_override ( )
Control	find_next_valid_focus ( ) const
Control	find_prev_valid_focus ( ) const
Control	find_valid_focus_neighbor ( Side side ) const
void	force_drag ( Variant data, Control preview )
float	get_anchor ( Side side ) const
Vector2	get_begin ( ) const
Vector2	get_combined_minimum_size ( ) const
CursorShape	get_cursor_shape ( Vector2 position=Vector2(0, 0) ) const
Vector2	get_end ( ) const
NodePath	get_focus_neighbor ( Side side ) const
Rect2	get_global_rect ( ) const
Vector2	get_minimum_size ( ) const
float	get_offset ( Side offset ) const
Vector2	get_parent_area_size ( ) const
Control	get_parent_control ( ) const
Rect2	get_rect ( ) const
Vector2	get_screen_position ( ) const
Color	get_theme_color ( StringName name, StringName theme_type=&”” ) const
int	get_theme_constant ( StringName name, StringName theme_type=&”” ) const
float	get_theme_default_base_scale ( ) const
Font	get_theme_default_font ( ) const
int	get_theme_default_font_size ( ) const
Font	get_theme_font ( StringName name, StringName theme_type=&”” ) const
int	get_theme_font_size ( StringName name, StringName theme_type=&”” ) const
Texture2D	get_theme_icon ( StringName name, StringName theme_type=&”” ) const
StyleBox	get_theme_stylebox ( StringName name, StringName theme_type=&”” ) const
String	get_tooltip ( Vector2 at_position=Vector2(0, 0) ) const
void	grab_click_focus ( )
void	grab_focus ( )
bool	has_focus ( ) const
bool	has_theme_color ( StringName name, StringName theme_type=&”” ) const
bool	has_theme_color_override ( StringName name ) const
bool	has_theme_constant ( StringName name, StringName theme_type=&”” ) const
bool	has_theme_constant_override ( StringName name ) const
bool	has_theme_font ( StringName name, StringName theme_type=&”” ) const
bool	has_theme_font_override ( StringName name ) const
bool	has_theme_font_size ( StringName name, StringName theme_type=&”” ) const
bool	has_theme_font_size_override ( StringName name ) const
bool	has_theme_icon ( StringName name, StringName theme_type=&”” ) const
bool	has_theme_icon_override ( StringName name ) const
bool	has_theme_stylebox ( StringName name, StringName theme_type=&”” ) const
bool	has_theme_stylebox_override ( StringName name ) const
bool	is_drag_successful ( ) const
bool	is_layout_rtl ( ) const
void	release_focus ( )
void	remove_theme_color_override ( StringName name )
void	remove_theme_constant_override ( StringName name )
void	remove_theme_font_override ( StringName name )
void	remove_theme_font_size_override ( StringName name )
void	remove_theme_icon_override ( StringName name )
void	remove_theme_stylebox_override ( StringName name )
void	reset_size ( )
void	set_anchor ( Side side, float anchor, bool keep_offset=false, bool push_opposite_anchor=true )
void	set_anchor_and_offset ( Side side, float anchor, float offset, bool push_opposite_anchor=false )
void	set_anchors_and_offsets_preset ( LayoutPreset preset, LayoutPresetMode resize_mode=0, int margin=0 )
void	set_anchors_preset ( LayoutPreset preset, bool keep_offsets=false )
void	set_begin ( Vector2 position )
void	set_drag_forwarding ( Callable drag_func, Callable can_drop_func, Callable drop_func )
void	set_drag_preview ( Control control )
void	set_end ( Vector2 position )
void	set_focus_neighbor ( Side side, NodePath neighbor )
void	set_global_position ( Vector2 position, bool keep_offsets=false )
void	set_offset ( Side side, float offset )
void	set_offsets_preset ( LayoutPreset preset, LayoutPresetMode resize_mode=0, int margin=0 )
void	set_position ( Vector2 position, bool keep_offsets=false )
void	set_size ( Vector2 size, bool keep_offsets=false )
void	update_minimum_size ( )
void	warp_mouse ( Vector2 position )

Signals

focus_entered ( )

There is currently no description for this signal. Please help us by contributing one!

focus_exited ( )

There is currently no description for this signal. Please help us by contributing one!

gui_input ( InputEvent event )

There is currently no description for this signal. Please help us by contributing one!

minimum_size_changed ( )

There is currently no description for this signal. Please help us by contributing one!

mouse_entered ( )

There is currently no description for this signal. Please help us by contributing one!

mouse_exited ( )

There is currently no description for this signal. Please help us by contributing one!

resized ( )

There is currently no description for this signal. Please help us by contributing one!

size_flags_changed ( )

There is currently no description for this signal. Please help us by contributing one!

theme_changed ( )

There is currently no description for this signal. Please help us by contributing one!

Enumerations

enum FocusMode:

FocusMode FOCUS_NONE = 0

There is currently no description for this enum. Please help us by contributing one!

FocusMode FOCUS_CLICK = 1

There is currently no description for this enum. Please help us by contributing one!

FocusMode FOCUS_ALL = 2

There is currently no description for this enum. Please help us by contributing one!

enum CursorShape:

CursorShape CURSOR_ARROW = 0

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_IBEAM = 1

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_POINTING_HAND = 2

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_CROSS = 3

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_WAIT = 4

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_BUSY = 5

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_DRAG = 6

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_CAN_DROP = 7

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_FORBIDDEN = 8

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_VSIZE = 9

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HSIZE = 10

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_BDIAGSIZE = 11

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_FDIAGSIZE = 12

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_MOVE = 13

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_VSPLIT = 14

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HSPLIT = 15

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HELP = 16

There is currently no description for this enum. Please help us by contributing one!

enum LayoutPreset:

LayoutPreset PRESET_TOP_LEFT = 0

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_TOP_RIGHT = 1

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_BOTTOM_LEFT = 2

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_BOTTOM_RIGHT = 3

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_CENTER_LEFT = 4

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_CENTER_TOP = 5

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_CENTER_RIGHT = 6

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_CENTER_BOTTOM = 7

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_CENTER = 8

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_LEFT_WIDE = 9

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_TOP_WIDE = 10

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_RIGHT_WIDE = 11

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_BOTTOM_WIDE = 12

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_VCENTER_WIDE = 13

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_HCENTER_WIDE = 14

There is currently no description for this enum. Please help us by contributing one!

LayoutPreset PRESET_FULL_RECT = 15

There is currently no description for this enum. Please help us by contributing one!

enum LayoutPresetMode:

LayoutPresetMode PRESET_MODE_MINSIZE = 0

There is currently no description for this enum. Please help us by contributing one!

LayoutPresetMode PRESET_MODE_KEEP_WIDTH = 1

There is currently no description for this enum. Please help us by contributing one!

LayoutPresetMode PRESET_MODE_KEEP_HEIGHT = 2

There is currently no description for this enum. Please help us by contributing one!

LayoutPresetMode PRESET_MODE_KEEP_SIZE = 3

There is currently no description for this enum. Please help us by contributing one!

flags SizeFlags:

SizeFlags SIZE_SHRINK_BEGIN = 0

There is currently no description for this enum. Please help us by contributing one!

SizeFlags SIZE_FILL = 1

There is currently no description for this enum. Please help us by contributing one!

SizeFlags SIZE_EXPAND = 2

There is currently no description for this enum. Please help us by contributing one!

SizeFlags SIZE_EXPAND_FILL = 3

There is currently no description for this enum. Please help us by contributing one!

SizeFlags SIZE_SHRINK_CENTER = 4

There is currently no description for this enum. Please help us by contributing one!

SizeFlags SIZE_SHRINK_END = 8

There is currently no description for this enum. Please help us by contributing one!

enum MouseFilter:

MouseFilter MOUSE_FILTER_STOP = 0

There is currently no description for this enum. Please help us by contributing one!

MouseFilter MOUSE_FILTER_PASS = 1

There is currently no description for this enum. Please help us by contributing one!

MouseFilter MOUSE_FILTER_IGNORE = 2

There is currently no description for this enum. Please help us by contributing one!

enum GrowDirection:

GrowDirection GROW_DIRECTION_BEGIN = 0

There is currently no description for this enum. Please help us by contributing one!

GrowDirection GROW_DIRECTION_END = 1

There is currently no description for this enum. Please help us by contributing one!

GrowDirection GROW_DIRECTION_BOTH = 2

There is currently no description for this enum. Please help us by contributing one!

enum Anchor:

Anchor ANCHOR_BEGIN = 0

There is currently no description for this enum. Please help us by contributing one!

Anchor ANCHOR_END = 1

There is currently no description for this enum. Please help us by contributing one!

enum LayoutDirection:

LayoutDirection LAYOUT_DIRECTION_INHERITED = 0

There is currently no description for this enum. Please help us by contributing one!

LayoutDirection LAYOUT_DIRECTION_LOCALE = 1

There is currently no description for this enum. Please help us by contributing one!

LayoutDirection LAYOUT_DIRECTION_LTR = 2

There is currently no description for this enum. Please help us by contributing one!

LayoutDirection LAYOUT_DIRECTION_RTL = 3

There is currently no description for this enum. Please help us by contributing one!

enum TextDirection:

TextDirection TEXT_DIRECTION_INHERITED = 3

There is currently no description for this enum. Please help us by contributing one!

TextDirection TEXT_DIRECTION_AUTO = 0

There is currently no description for this enum. Please help us by contributing one!

TextDirection TEXT_DIRECTION_LTR = 1

There is currently no description for this enum. Please help us by contributing one!

TextDirection TEXT_DIRECTION_RTL = 2

There is currently no description for this enum. Please help us by contributing one!

Constants

NOTIFICATION_RESIZED = 40

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_MOUSE_ENTER = 41

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_MOUSE_EXIT = 42

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_MOUSE_ENTER_SELF = 60

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_MOUSE_EXIT_SELF = 61

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_FOCUS_ENTER = 43

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_FOCUS_EXIT = 44

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_THEME_CHANGED = 45

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_SCROLL_BEGIN = 47

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_SCROLL_END = 48

There is currently no description for this constant. Please help us by contributing one!

NOTIFICATION_LAYOUT_DIRECTION_CHANGED = 49

There is currently no description for this constant. Please help us by contributing one!

Property Descriptions

float anchor_bottom = 0.0

float get_anchor ( Side side ) const

There is currently no description for this property. Please help us by contributing one!

float anchor_left = 0.0

float get_anchor ( Side side ) const

There is currently no description for this property. Please help us by contributing one!

float anchor_right = 0.0

float get_anchor ( Side side ) const

There is currently no description for this property. Please help us by contributing one!

float anchor_top = 0.0

float get_anchor ( Side side ) const

There is currently no description for this property. Please help us by contributing one!

bool auto_translate

void set_auto_translate ( bool value )
bool is_auto_translating ( )

There is currently no description for this property. Please help us by contributing one!

bool clip_contents = false

void set_clip_contents ( bool value )
bool is_clipping_contents ( )

There is currently no description for this property. Please help us by contributing one!

Vector2 custom_minimum_size = Vector2(0, 0)

void set_custom_minimum_size ( Vector2 value )
Vector2 get_custom_minimum_size ( )

There is currently no description for this property. Please help us by contributing one!

FocusMode focus_mode = 0

void set_focus_mode ( FocusMode value )
FocusMode get_focus_mode ( )

There is currently no description for this property. Please help us by contributing one!

NodePath focus_neighbor_bottom = NodePath("")

void set_focus_neighbor ( Side side, NodePath neighbor )
NodePath get_focus_neighbor ( Side side ) const

There is currently no description for this property. Please help us by contributing one!

NodePath focus_neighbor_left = NodePath("")

void set_focus_neighbor ( Side side, NodePath neighbor )
NodePath get_focus_neighbor ( Side side ) const

There is currently no description for this property. Please help us by contributing one!

NodePath focus_neighbor_right = NodePath("")

void set_focus_neighbor ( Side side, NodePath neighbor )
NodePath get_focus_neighbor ( Side side ) const

There is currently no description for this property. Please help us by contributing one!

NodePath focus_neighbor_top = NodePath("")

void set_focus_neighbor ( Side side, NodePath neighbor )
NodePath get_focus_neighbor ( Side side ) const

There is currently no description for this property. Please help us by contributing one!

NodePath focus_next = NodePath("")

void set_focus_next ( NodePath value )
NodePath get_focus_next ( )

There is currently no description for this property. Please help us by contributing one!

NodePath focus_previous = NodePath("")

void set_focus_previous ( NodePath value )
NodePath get_focus_previous ( )

There is currently no description for this property. Please help us by contributing one!

Vector2 global_position

Vector2 get_global_position ( )

There is currently no description for this property. Please help us by contributing one!

GrowDirection grow_horizontal = 1

void set_h_grow_direction ( GrowDirection value )
GrowDirection get_h_grow_direction ( )

There is currently no description for this property. Please help us by contributing one!

GrowDirection grow_vertical = 1

void set_v_grow_direction ( GrowDirection value )
GrowDirection get_v_grow_direction ( )

There is currently no description for this property. Please help us by contributing one!

LayoutDirection layout_direction = 0

void set_layout_direction ( LayoutDirection value )
LayoutDirection get_layout_direction ( )

There is currently no description for this property. Please help us by contributing one!

bool localize_numeral_system = true

void set_localize_numeral_system ( bool value )
bool is_localizing_numeral_system ( )

There is currently no description for this property. Please help us by contributing one!

CursorShape mouse_default_cursor_shape = 0

void set_default_cursor_shape ( CursorShape value )
CursorShape get_default_cursor_shape ( )

There is currently no description for this property. Please help us by contributing one!

MouseFilter mouse_filter = 0

void set_mouse_filter ( MouseFilter value )
MouseFilter get_mouse_filter ( )

There is currently no description for this property. Please help us by contributing one!

bool mouse_force_pass_scroll_events = true

void set_force_pass_scroll_events ( bool value )
bool is_force_pass_scroll_events ( )

There is currently no description for this property. Please help us by contributing one!

float offset_bottom = 0.0

void set_offset ( Side side, float offset )
float get_offset ( Side offset ) const

There is currently no description for this property. Please help us by contributing one!

float offset_left = 0.0

void set_offset ( Side side, float offset )
float get_offset ( Side offset ) const

There is currently no description for this property. Please help us by contributing one!

float offset_right = 0.0

void set_offset ( Side side, float offset )
float get_offset ( Side offset ) const

There is currently no description for this property. Please help us by contributing one!

float offset_top = 0.0

void set_offset ( Side side, float offset )
float get_offset ( Side offset ) const

There is currently no description for this property. Please help us by contributing one!

Vector2 pivot_offset = Vector2(0, 0)

void set_pivot_offset ( Vector2 value )
Vector2 get_pivot_offset ( )

There is currently no description for this property. Please help us by contributing one!

Vector2 position = Vector2(0, 0)

Vector2 get_position ( )

There is currently no description for this property. Please help us by contributing one!

float rotation = 0.0

void set_rotation ( float value )
float get_rotation ( )

There is currently no description for this property. Please help us by contributing one!

float rotation_degrees

void set_rotation_degrees ( float value )
float get_rotation_degrees ( )

There is currently no description for this property. Please help us by contributing one!

Vector2 scale = Vector2(1, 1)

void set_scale ( Vector2 value )
Vector2 get_scale ( )

There is currently no description for this property. Please help us by contributing one!

Node shortcut_context

void set_shortcut_context ( Node value )
Node get_shortcut_context ( )

There is currently no description for this property. Please help us by contributing one!

Vector2 size = Vector2(0, 0)

Vector2 get_size ( )

There is currently no description for this property. Please help us by contributing one!

BitField<SizeFlags> size_flags_horizontal = 1

void set_h_size_flags ( BitField<SizeFlags> value )
BitField<SizeFlags> get_h_size_flags ( )

There is currently no description for this property. Please help us by contributing one!

float size_flags_stretch_ratio = 1.0

void set_stretch_ratio ( float value )
float get_stretch_ratio ( )

There is currently no description for this property. Please help us by contributing one!

BitField<SizeFlags> size_flags_vertical = 1

void set_v_size_flags ( BitField<SizeFlags> value )
BitField<SizeFlags> get_v_size_flags ( )

There is currently no description for this property. Please help us by contributing one!

Theme theme

void set_theme ( Theme value )
Theme get_theme ( )

There is currently no description for this property. Please help us by contributing one!

StringName theme_type_variation = &""

void set_theme_type_variation ( StringName value )
StringName get_theme_type_variation ( )

There is currently no description for this property. Please help us by contributing one!

String tooltip_text = ""

void set_tooltip_text ( String value )
String get_tooltip_text ( )

There is currently no description for this property. Please help us by contributing one!