Tree

Inherits: Control < CanvasItem < Node < Object

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

Properties

bool	allow_reselect	`false`
bool	allow_rmb_select	`false`
bool	allow_search	`true`
bool	clip_contents	`true` (overrides Control)
bool	column_titles_visible	`false`
int	columns	`1`
int	drop_mode_flags	`0`
bool	enable_recursive_folding	`true`
FocusMode	focus_mode	`2` (overrides Control)
bool	hide_folding	`false`
bool	hide_root	`false`
bool	scroll_horizontal_enabled	`true`
bool	scroll_vertical_enabled	`true`
SelectMode	select_mode	`0`

Methods

void	clear ( )
TreeItem	create_item ( TreeItem parent=null, int index=-1 )
void	deselect_all ( )
bool	edit_selected ( bool force_edit=false )
void	ensure_cursor_is_visible ( )
int	get_button_id_at_position ( Vector2 position ) const
int	get_column_at_position ( Vector2 position ) const
int	get_column_expand_ratio ( int column ) const
String	get_column_title ( int column ) const
HorizontalAlignment	get_column_title_alignment ( int column ) const
TextDirection	get_column_title_direction ( int column ) const
String	get_column_title_language ( int column ) const
int	get_column_width ( int column ) const
Rect2	get_custom_popup_rect ( ) const
int	get_drop_section_at_position ( Vector2 position ) const
TreeItem	get_edited ( ) const
int	get_edited_column ( ) const
Rect2	get_item_area_rect ( TreeItem item, int column=-1, int button_index=-1 ) const
TreeItem	get_item_at_position ( Vector2 position ) const
TreeItem	get_next_selected ( TreeItem from )
int	get_pressed_button ( ) const
TreeItem	get_root ( ) const
Vector2	get_scroll ( ) const
TreeItem	get_selected ( ) const
int	get_selected_column ( ) const
bool	is_column_clipping_content ( int column ) const
bool	is_column_expanding ( int column ) const
void	scroll_to_item ( TreeItem item, bool center_on_item=false )
void	set_column_clip_content ( int column, bool enable )
void	set_column_custom_minimum_width ( int column, int min_width )
void	set_column_expand ( int column, bool expand )
void	set_column_expand_ratio ( int column, int ratio )
void	set_column_title ( int column, String title )
void	set_column_title_alignment ( int column, HorizontalAlignment title_alignment )
void	set_column_title_direction ( int column, TextDirection direction )
void	set_column_title_language ( int column, String language )
void	set_selected ( TreeItem item, int column )

Theme Properties

Color	children_hl_line_color	`Color(0.27, 0.27, 0.27, 1)`
Color	custom_button_font_highlight	`Color(0.95, 0.95, 0.95, 1)`
Color	drop_position_color	`Color(1, 1, 1, 1)`
Color	font_color	`Color(0.7, 0.7, 0.7, 1)`
Color	font_disabled_color	`Color(0.875, 0.875, 0.875, 0.5)`
Color	font_outline_color	`Color(0, 0, 0, 1)`
Color	font_selected_color	`Color(1, 1, 1, 1)`
Color	guide_color	`Color(0.7, 0.7, 0.7, 0.25)`
Color	parent_hl_line_color	`Color(0.27, 0.27, 0.27, 1)`
Color	relationship_line_color	`Color(0.27, 0.27, 0.27, 1)`
Color	title_button_color	`Color(0.875, 0.875, 0.875, 1)`
int	button_margin	`4`
int	children_hl_line_width	`1`
int	draw_guides	`1`
int	draw_relationship_lines	`0`
int	h_separation	`4`
int	icon_max_width	`0`
int	inner_item_margin_bottom	`0`
int	inner_item_margin_left	`0`
int	inner_item_margin_right	`0`
int	inner_item_margin_top	`0`
int	item_margin	`16`
int	outline_size	`0`
int	parent_hl_line_margin	`0`
int	parent_hl_line_width	`1`
int	relationship_line_width	`1`
int	scroll_border	`4`
int	scroll_speed	`12`
int	scrollbar_h_separation	`4`
int	scrollbar_margin_bottom	`-1`
int	scrollbar_margin_left	`-1`
int	scrollbar_margin_right	`-1`
int	scrollbar_margin_top	`-1`
int	scrollbar_v_separation	`4`
int	v_separation	`4`
Font	font
Font	title_button_font
int	font_size
int	title_button_font_size
Texture2D	arrow
Texture2D	arrow_collapsed
Texture2D	arrow_collapsed_mirrored
Texture2D	checked
Texture2D	checked_disabled
Texture2D	indeterminate
Texture2D	indeterminate_disabled
Texture2D	select_arrow
Texture2D	unchecked
Texture2D	unchecked_disabled
Texture2D	updown
StyleBox	button_pressed
StyleBox	cursor
StyleBox	cursor_unfocused
StyleBox	custom_button
StyleBox	custom_button_hover
StyleBox	custom_button_pressed
StyleBox	focus
StyleBox	panel
StyleBox	selected
StyleBox	selected_focus
StyleBox	title_button_hover
StyleBox	title_button_normal
StyleBox	title_button_pressed

Signals

button_clicked ( TreeItem item, int column, int id, int mouse_button_index )

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

cell_selected ( )

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

check_propagated_to_item ( TreeItem item, int column )

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

column_title_clicked ( int column, int mouse_button_index )

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

custom_item_clicked ( int mouse_button_index )

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

empty_clicked ( Vector2 click_position, int mouse_button_index )

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

item_activated ( )

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

item_collapsed ( TreeItem item )

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

item_edited ( )

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

item_icon_double_clicked ( )

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

item_mouse_selected ( Vector2 mouse_position, int mouse_button_index )

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

item_selected ( )

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

multi_selected ( TreeItem item, int column, bool selected )

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

nothing_selected ( )

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

Enumerations

enum SelectMode:

SelectMode SELECT_SINGLE = 0

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

SelectMode SELECT_ROW = 1

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

SelectMode SELECT_MULTI = 2

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

enum DropModeFlags:

DropModeFlags DROP_MODE_DISABLED = 0

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

DropModeFlags DROP_MODE_ON_ITEM = 1

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

DropModeFlags DROP_MODE_INBETWEEN = 2

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

Property Descriptions

bool allow_reselect = false

void set_allow_reselect ( bool value )
bool get_allow_reselect ( )

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

bool allow_rmb_select = false

void set_allow_rmb_select ( bool value )
bool get_allow_rmb_select ( )

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

bool allow_search = true

void set_allow_search ( bool value )
bool get_allow_search ( )

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

bool column_titles_visible = false

void set_column_titles_visible ( bool value )
bool are_column_titles_visible ( )

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

int columns = 1

void set_columns ( int value )
int get_columns ( )

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

int drop_mode_flags = 0

void set_drop_mode_flags ( int value )
int get_drop_mode_flags ( )

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

bool enable_recursive_folding = true

void set_enable_recursive_folding ( bool value )
bool is_recursive_folding_enabled ( )

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

bool hide_folding = false

void set_hide_folding ( bool value )
bool is_folding_hidden ( )

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

bool hide_root = false

void set_hide_root ( bool value )
bool is_root_hidden ( )

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

bool scroll_horizontal_enabled = true

void set_h_scroll_enabled ( bool value )
bool is_h_scroll_enabled ( )

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

bool scroll_vertical_enabled = true

void set_v_scroll_enabled ( bool value )
bool is_v_scroll_enabled ( )

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

SelectMode select_mode = 0

void set_select_mode ( SelectMode value )
SelectMode get_select_mode ( )

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

Method Descriptions

void clear ( )

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

TreeItem create_item ( TreeItem parent=null, int index=-1 )

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

void deselect_all ( )

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

bool edit_selected ( bool force_edit=false )

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

void ensure_cursor_is_visible ( )

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

int get_button_id_at_position ( Vector2 position ) const

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

int get_column_at_position ( Vector2 position ) const

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

int get_column_expand_ratio ( int column ) const

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

String get_column_title ( int column ) const

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

HorizontalAlignment get_column_title_alignment ( int column ) const

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

TextDirection get_column_title_direction ( int column ) const

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

String get_column_title_language ( int column ) const

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

int get_column_width ( int column ) const

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

int get_drop_section_at_position ( Vector2 position ) const

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

TreeItem get_edited ( ) const

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

int get_edited_column ( ) const

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

Rect2 get_item_area_rect ( TreeItem item, int column=-1, int button_index=-1 ) const

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

TreeItem get_item_at_position ( Vector2 position ) const

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

TreeItem get_next_selected ( TreeItem from )

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

int get_pressed_button ( ) const

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

TreeItem get_root ( ) const

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

Vector2 get_scroll ( ) const

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

TreeItem get_selected ( ) const

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

int get_selected_column ( ) const

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

bool is_column_clipping_content ( int column ) const

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

bool is_column_expanding ( int column ) const

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

void scroll_to_item ( TreeItem item, bool center_on_item=false )

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

void set_column_clip_content ( int column, bool enable )

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

void set_column_custom_minimum_width ( int column, int min_width )

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

void set_column_expand ( int column, bool expand )

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

void set_column_expand_ratio ( int column, int ratio )

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

void set_column_title ( int column, String title )

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

void set_column_title_alignment ( int column, HorizontalAlignment title_alignment )

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

void set_column_title_direction ( int column, TextDirection direction )

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

void set_column_title_language ( int column, String language )

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

void set_selected ( TreeItem item, int column )

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