Up to date
This page is up to date for Godot 4.0
.
If you still find outdated information, please open an issue.
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.
Properties¶
Methods¶
void |
add_button ( int column, Texture2D button, int id=-1, bool disabled=false, String tooltip_text="" ) |
void |
call_recursive ( StringName method, ... ) vararg |
void |
clear_custom_bg_color ( int column ) |
void |
clear_custom_color ( int column ) |
create_child ( int index=-1 ) |
|
void |
|
void |
erase_button ( int column, int button_index ) |
get_button ( int column, int button_index ) const |
|
get_button_by_id ( int column, int id ) const |
|
get_button_count ( int column ) const |
|
get_button_id ( int column, int button_index ) const |
|
get_button_tooltip_text ( int column, int button_index ) const |
|
get_cell_mode ( int column ) const |
|
get_child_count ( ) |
|
get_children ( ) |
|
get_custom_bg_color ( int column ) const |
|
get_custom_color ( int column ) const |
|
get_custom_font ( int column ) const |
|
get_custom_font_size ( int column ) const |
|
get_expand_right ( int column ) const |
|
get_first_child ( ) const |
|
get_icon_max_width ( int column ) const |
|
get_icon_modulate ( int column ) const |
|
get_icon_region ( int column ) const |
|
get_index ( ) |
|
get_language ( int column ) const |
|
get_metadata ( int column ) const |
|
get_next ( ) const |
|
get_next_visible ( bool wrap=false ) |
|
get_parent ( ) const |
|
get_prev ( ) |
|
get_prev_visible ( bool wrap=false ) |
|
get_range_config ( int column ) |
|
get_structured_text_bidi_override ( int column ) const |
|
get_structured_text_bidi_override_options ( int column ) const |
|
get_suffix ( int column ) const |
|
get_text_alignment ( int column ) const |
|
get_text_direction ( int column ) const |
|
get_tooltip_text ( int column ) const |
|
get_tree ( ) const |
|
is_any_collapsed ( bool only_visible=false ) |
|
is_button_disabled ( int column, int button_index ) const |
|
is_checked ( int column ) const |
|
is_custom_set_as_button ( int column ) const |
|
is_editable ( int column ) |
|
is_indeterminate ( int column ) const |
|
is_selectable ( int column ) const |
|
is_selected ( int column ) |
|
void |
move_after ( TreeItem item ) |
void |
move_before ( TreeItem item ) |
void |
propagate_check ( int column, bool emit_signal=true ) |
void |
remove_child ( TreeItem child ) |
void |
|
void |
set_button ( int column, int button_index, Texture2D button ) |
void |
set_button_color ( int column, int button_index, Color color ) |
void |
set_button_disabled ( int column, int button_index, bool disabled ) |
void |
set_cell_mode ( int column, TreeCellMode mode ) |
void |
set_checked ( int column, bool checked ) |
void |
set_collapsed_recursive ( bool enable ) |
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, StringName callback ) |
void |
set_custom_font ( int column, Font font ) |
void |
set_custom_font_size ( int column, int font_size ) |
void |
set_editable ( int column, bool enabled ) |
void |
set_expand_right ( int column, bool enable ) |
void |
|
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_indeterminate ( int column, bool indeterminate ) |
void |
set_language ( int column, String language ) |
void |
set_metadata ( int column, Variant meta ) |
void |
|
void |
set_range_config ( int column, float min, float max, float step, bool expr=false ) |
void |
set_selectable ( int column, bool selectable ) |
void |
set_structured_text_bidi_override ( int column, StructuredTextParser parser ) |
void |
set_structured_text_bidi_override_options ( int column, Array args ) |
void |
set_suffix ( int column, String text ) |
void |
|
void |
set_text_alignment ( int column, HorizontalAlignment text_alignment ) |
void |
set_text_direction ( int column, TextDirection direction ) |
void |
set_tooltip_text ( int column, String tooltip ) |
void |
uncollapse_tree ( ) |
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
Property Descriptions¶
bool collapsed
If true
, the TreeItem is collapsed.
int custom_minimum_height
The custom minimum height.
bool disable_folding
If true
, folding is disabled for this TreeItem.
bool visible
If true
, the TreeItem is visible (default).
Note that if a TreeItem is set to not be visible, none of its children will be visible either.
Method Descriptions¶
void add_button ( int column, Texture2D button, int id=-1, bool disabled=false, String tooltip_text="" )
Adds a button with Texture2D button
at column column
. The id
is used to identify the button in the according Tree.button_clicked signal and can be different from the buttons index. 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_text
.
void call_recursive ( StringName 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.
TreeItem create_child ( int index=-1 )
Creates an item and adds it as a child.
The new item will be inserted as position index
(the default value -1
means the last position), or it will be the last child if index
is higher than the child count.
void deselect ( int column )
Deselects the given column.
void erase_button ( int column, int button_index )
Removes the button at index button_index
in column column
.
Texture2D get_button ( int column, int button_index ) const
Returns the Texture2D of the button at index button_index
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_index ) const
Returns the ID for the button at index button_index
in column column
.
String get_button_tooltip_text ( int column, int button_index ) const
Returns the tooltip text for the button at index button_index
in column column
.
TreeCellMode get_cell_mode ( int column ) const
Returns the column's cell mode.
TreeItem get_child ( int index )
Returns a child item by its index
(see get_child_count). This method is often used for iterating all children of an item.
Negative indices access the children from the last one.
int get_child_count ( )
Returns the number of child items.
TreeItem[] get_children ( )
Returns an array of references to the item's children.
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
.
Font get_custom_font ( int column ) const
Returns custom font used to draw text in the column column
.
int get_custom_font_size ( int column ) const
Returns custom font size used to draw text in the column column
.
bool get_expand_right ( int column ) const
Returns true
if expand_right
is set.
TreeItem get_first_child ( ) const
Returns the TreeItem's first child.
Texture2D get_icon ( int column ) const
Returns the given column's icon Texture2D. 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 Texture2D region as Rect2.
int get_index ( )
Returns the node's order in the tree. For example, if called on the first child item the position is 0
.
String get_language ( int column ) const
Returns item's text language code.
Variant get_metadata ( int column ) const
Returns the metadata value that was set for the given column using set_metadata.
TreeItem get_next ( ) const
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 ( ) const
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".
StructuredTextParser get_structured_text_bidi_override ( int column ) const
There is currently no description for this method. Please help us by contributing one!
Array get_structured_text_bidi_override_options ( int column ) const
There is currently no description for this method. Please help us by contributing one!
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.
HorizontalAlignment get_text_alignment ( int column ) const
Returns the given column's text alignment.
TextDirection get_text_direction ( int column ) const
Returns item's text base writing direction.
String get_tooltip_text ( int column ) const
Returns the given column's tooltip text.
Tree get_tree ( ) const
Returns the Tree that owns this TreeItem.
bool is_any_collapsed ( bool only_visible=false )
Returns true
if this TreeItem, or any of its descendants, is collapsed.
If only_visible
is true
it ignores non-visible TreeItems.
bool is_button_disabled ( int column, int button_index ) const
Returns true
if the button at index button_index
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 the given column
is editable.
bool is_indeterminate ( int column ) const
Returns true
if the given column
is indeterminate.
bool is_selectable ( int column ) const
Returns true
if the given column
is selectable.
bool is_selected ( int column )
Returns true
if the given column
is selected.
void move_after ( TreeItem item )
Moves this TreeItem right after the given item
.
Note: You can't move to the root or move the root.