TreeItem¶

Inherits: Object

Control for a single item inside a Tree.

Description¶

Control for a single item inside a Tree. May have child TreeItems and be styled as well as contain buttons.

You can remove a TreeItem by using Object.free.

Note: The ID values used for buttons are limited to 32 bits, not full 64 bits of int. This has a range of -2^32 to 2^32 - 1, i.e. -2147483648 to 2147483647.

Properties¶

bool	collapsed
int	custom_minimum_height
bool	disable_folding

Methods¶

void	add_button ( int column, Texture button, int id=-1, bool disabled=false, String tooltip="" )
Variant	call_recursive ( String method, ... ) vararg
void	clear_custom_bg_color ( int column )
void	clear_custom_color ( int column )
void	deselect ( int column )
void	erase_button ( int column, int button_idx )
Texture	get_button ( int column, int button_idx ) const
int	get_button_by_id ( int column, int id ) const
int	get_button_count ( int column ) const
int	get_button_id ( int column, int button_idx ) const
String	get_button_tooltip ( int column, int button_idx ) const
TreeCellMode	get_cell_mode ( int column ) const
TreeItem	get_children ( )
Color	get_custom_bg_color ( int column ) const
Color	get_custom_color ( int column ) const
bool	get_expand_right ( int column ) const
Texture	get_icon ( int column ) const
int	get_icon_max_width ( int column ) const
Color	get_icon_modulate ( int column ) const
Rect2	get_icon_region ( int column ) const
Variant	get_metadata ( int column ) const
TreeItem	get_next ( )
TreeItem	get_next_visible ( bool wrap=false )
TreeItem	get_parent ( )
TreeItem	get_prev ( )
TreeItem	get_prev_visible ( bool wrap=false )
float	get_range ( int column ) const
Dictionary	get_range_config ( int column )
String	get_suffix ( int column ) const
String	get_text ( int column ) const
TextAlign	get_text_align ( int column ) const
String	get_tooltip ( int column ) const
bool	is_button_disabled ( int column, int button_idx ) const
bool	is_checked ( int column ) const
bool	is_custom_set_as_button ( int column ) const
bool	is_editable ( int column )
bool	is_selectable ( int column ) const
bool	is_selected ( int column )
void	move_to_bottom ( )
void	move_to_top ( )
void	remove_child ( Object child )
void	select ( int column )
void	set_button ( int column, int button_idx, Texture button )
void	set_button_disabled ( int column, int button_idx, bool disabled )
void	set_cell_mode ( int column, TreeCellMode mode )
void	set_checked ( int column, bool checked )
void	set_custom_as_button ( int column, bool enable )
void	set_custom_bg_color ( int column, Color color, bool just_outline=false )
void	set_custom_color ( int column, Color color )
void	set_custom_draw ( int column, Object object, String callback )
void	set_editable ( int column, bool enabled )
void	set_expand_right ( int column, bool enable )
void	set_icon ( int column, Texture texture )
void	set_icon_max_width ( int column, int width )
void	set_icon_modulate ( int column, Color modulate )
void	set_icon_region ( int column, Rect2 region )
void	set_metadata ( int column, Variant meta )
void	set_range ( int column, float value )
void	set_range_config ( int column, float min, float max, float step, bool expr=false )
void	set_selectable ( int column, bool selectable )
void	set_suffix ( int column, String text )
void	set_text ( int column, String text )
void	set_text_align ( int column, TextAlign text_align )
void	set_tooltip ( int column, String tooltip )

Enumerations¶

enum TreeCellMode:

TreeCellMode CELL_MODE_STRING = 0

Cell contains a string.

TreeCellMode CELL_MODE_CHECK = 1

Cell contains a checkbox.

TreeCellMode CELL_MODE_RANGE = 2

Cell contains a range.

TreeCellMode CELL_MODE_ICON = 3

Cell contains an icon.

TreeCellMode CELL_MODE_CUSTOM = 4

enum TextAlign:

TextAlign ALIGN_LEFT = 0

Align text to the left. See set_text_align().

TextAlign ALIGN_CENTER = 1

Center text. See set_text_align().

TextAlign ALIGN_RIGHT = 2

Align text to the right. See set_text_align().

Property Descriptions¶

bool collapsed

void set_collapsed ( bool value )
bool is_collapsed ( )

If true, the TreeItem is collapsed.

int custom_minimum_height

void set_custom_minimum_height ( int value )
int get_custom_minimum_height ( )

The custom minimum height.

bool disable_folding

void set_disable_folding ( bool value )
bool is_folding_disabled ( )

If true, folding is disabled for this TreeItem.

Method Descriptions¶

void add_button ( int column, Texture button, int id=-1, bool disabled=false, String tooltip="" )

Adds a button with Texture button at column column. The id is used to identify the button. If not specified, the next available index is used, which may be retrieved by calling get_button_count immediately before this method. Optionally, the button can be disabled and have a tooltip.

Variant call_recursive ( String method, ... ) vararg

Calls the method on the actual TreeItem and its children recursively. Pass parameters as a comma separated list.

void clear_custom_bg_color ( int column )

Resets the background color for the given column to default.

void clear_custom_color ( int column )

Resets the color for the given column to default.

void deselect ( int column )

Deselects the given column.

void erase_button ( int column, int button_idx )

Removes the button at index button_idx in column column.

Texture get_button ( int column, int button_idx ) const

Returns the Texture of the button at index button_idx in column column.

int get_button_by_id ( int column, int id ) const

Returns the button index if there is a button with id id in column column, otherwise returns -1.

int get_button_count ( int column ) const

Returns the number of buttons in column column.

int get_button_id ( int column, int button_idx ) const

Returns the id for the button at index button_idx in column column.

Returns the tooltip string for the button at index button_idx in column column.

TreeCellMode get_cell_mode ( int column ) const

Returns the column's cell mode.

TreeItem get_children ( )

Returns the TreeItem's first child item or a null object if there is none.

Color get_custom_bg_color ( int column ) const

Returns the custom background color of column column.

Color get_custom_color ( int column ) const

Returns the custom color of column column.

bool get_expand_right ( int column ) const

Returns true if expand_right is set.

Texture get_icon ( int column ) const

Returns the given column's icon Texture. Error if no icon is set.

int get_icon_max_width ( int column ) const

Returns the column's icon's maximum width.

Color get_icon_modulate ( int column ) const

Returns the Color modulating the column's icon.

Rect2 get_icon_region ( int column ) const

Returns the icon Texture region as Rect2.

Variant get_metadata ( int column ) const

Returns the metadata value that was set for the given column using set_metadata.

TreeItem get_next ( )

Returns the next sibling TreeItem in the tree or a null object if there is none.

TreeItem get_next_visible ( bool wrap=false )

Returns the next visible sibling TreeItem in the tree or a null object if there is none.

If wrap is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns null.

TreeItem get_parent ( )

Returns the parent TreeItem or a null object if there is none.

TreeItem get_prev ( )

Returns the previous sibling TreeItem in the tree or a null object if there is none.

TreeItem get_prev_visible ( bool wrap=false )

Returns the previous visible sibling TreeItem in the tree or a null object if there is none.

If wrap is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns null.

float get_range ( int column ) const

Returns the value of a CELL_MODE_RANGE column.

Dictionary get_range_config ( int column )

Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr".

String get_suffix ( int column ) const

Gets the suffix string shown after the column value.

String get_text ( int column ) const

Returns the given column's text.

TextAlign get_text_align ( int column ) const

Returns the given column's text alignment.

Returns the given column's tooltip.

bool is_button_disabled ( int column, int button_idx ) const

Returns true if the button at index button_idx for the given column is disabled.

bool is_checked ( int column ) const

Returns true if the given column is checked.

bool is_custom_set_as_button ( int column ) const

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

bool is_editable ( int column )

Returns true if column column is editable.

bool is_selectable ( int column ) const

Returns true if column column is selectable.

bool is_selected ( int column )

Returns true if column column is selected.

void move_to_bottom ( )

Moves this TreeItem to the bottom in the Tree hierarchy.

void move_to_top ( )

Moves this TreeItem to the top in the Tree hierarchy.

void remove_child ( Object child )

Removes the given child TreeItem and all its children from the Tree. Note that it doesn't free the item from memory, so it can be reused later. To completely remove a TreeItem use Object.free.

void select ( int column )

Selects the column column.

void set_button ( int column, int button_idx, Texture button )

Sets the given column's button Texture at index button_idx to button.

void set_button_disabled ( int column, int button_idx, bool disabled )

If true, disables the button at index button_idx in column column.

void set_cell_mode ( int column, TreeCellMode mode )

Sets the given column's cell mode to mode. See TreeCellMode constants.

void set_checked ( int column, bool checked )

If true, the column column is checked.

void set_custom_as_button ( int column, bool enable )

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

void set_custom_bg_color ( int column, Color color, bool just_outline=false )

Sets the given column's custom background color and whether to just use it as an outline.

void set_custom_color ( int column, Color color )

Sets the given column's custom color.

void set_custom_draw ( int column, Object object, String callback )

Sets the given column's custom draw callback to callback method on object.

The callback should accept two arguments: the TreeItem that is drawn and its position and size as a Rect2.

void set_editable ( int column, bool enabled )

If true, column column is editable.

void set_expand_right ( int column, bool enable )

If true, column column is expanded to the right.

void set_icon ( int column, Texture texture )

Sets the given column's icon Texture.

void set_icon_max_width ( int column, int width )

Sets the given column's icon's maximum width.

void set_icon_modulate ( int column, Color modulate )

Modulates the given column's icon with modulate.

void set_icon_region ( int column, Rect2 region )

Sets the given column's icon's texture region.

void set_metadata ( int column, Variant meta )

Sets the metadata value for the given column, which can be retrieved later using get_metadata. This can be used, for example, to store a reference to the original data.

void set_range ( int column, float value )

Sets the value of a CELL_MODE_RANGE column.

void set_range_config ( int column, float min, float max, float step, bool expr=false )

Sets the range of accepted values for a column. The column must be in the CELL_MODE_RANGE mode.

If expr is true, the edit mode slider will use an exponential scale as with Range.exp_edit.

void set_selectable ( int column, bool selectable )

If true, the given column is selectable.

void set_suffix ( int column, String text )

Sets a string to be shown after a column's value (for example, a unit abbreviation).

void set_text ( int column, String text )

Sets the given column's text value.

void set_text_align ( int column, TextAlign text_align )

Sets the given column's text alignment. See TextAlign for possible values.

Sets the given column's tooltip text.