TreeItem

继承

Object

简要描述

控制[树]中的单个项目。

描述

控制[树]中的单个项目。 可能有子项TreeItem并被设置样式以及包含按钮。

成员

类型	属性名	默认值
bool	collapsed
int	custom_minimum_height
bool	disable_folding

方法

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

枚举

enum TreeCellMode:

• **CELL_MODE_STRING = 0**

单元格包含一个字符串。

• **CELL_MODE_CHECK = 1**

可以检查单元格。

• **CELL_MODE_RANGE = 2**

单元格包含一个范围。

• **CELL_MODE_ICON = 3**

单元格包含一个图标。

• **CELL_MODE_CUSTOM = 4**

---

enum TextAlign:

• **ALIGN_LEFT = 0**

将文本向左对齐。

• **ALIGN_CENTER = 1**

居中文字。

• **ALIGN_RIGHT = 2**

将文本向右对齐。

---

常量

成员说明

• bool collapsed

setter	set_collapsed(value)
getter	is_collapsed

• int custom_minimum_height

setter	set_custom_minimum_height(value)
getter	get_custom_minimum_height

• bool disable_folding

setter	set_disable_folding(value)
getter	is_folding_disabled

方法说明

• add_button add_button(column: int, button: Texture, button_idx: int = -1, disabled: bool = false, tooltip: String = "")

在列列中添加带有Texture button的按钮。 button_idx索引用于在调用其他方法时标识按钮。 如果未指定，则使用下一个可用索引，可以通过在此方法后立即调用get_button_count来检索该索引。 可选地，该按钮可以禁用`，并具有 tooltip`。

---

• call_recursive call_recursive(method: String, ...) vararg

递归地调用实际TreeItem及其子元素上的方法。 将参数作为逗号分隔的列表传递。

---

• clear_custom_bg_color clear_custom_bg_color(column: int)

将给定列的背景颜色重置为默认值。

---

• clear_custom_color clear_custom_color(column: int)

将给定列的颜色重置为默认值。

---

• deselect deselect(column: int)

取消选择给定的列。

---

• erase_button erase_button(column: int, button_idx: int)

删除列column中索引button_idx处的按钮。

---

• get_button get_button(column: int, button_idx: int) const

返回列column中索引button_idx处按钮的Texture。

---

• get_button_count get_button_count(column: int) const

返回列列中的按钮数。 如果未指定索引，则可用于获取最近添加的按钮的索引。

---

• get_button_tooltip get_button_tooltip(column: int, button_idx: int) const

返回列column中索引button_idx处按钮的工具提示字符串。

---

• get_cell_mode get_cell_mode(column: int) const

返回列的单元格模式。

---

• get_children get_children()

返回TreeItem的子项。

---

• get_custom_bg_color get_custom_bg_color(column: int) const

返回列column的自定义背景色。

---

• get_custom_color get_custom_color(column: int) const

返回列column的自定义颜色。

---

• get_expand_right get_expand_right(column: int) const

如果设置了expand_right，则返回true。

---

• get_icon get_icon(column: int) const

返回给定列的图标[纹理]。

---

• get_icon_max_width get_icon_max_width(column: int) const

返回列图标的最大宽度。

---

• get_icon_modulate get_icon_modulate(column: int) const

返回调制列图标的[颜色]。

---

• get_icon_region get_icon_region(column: int) const

将图标[纹理]区域返回为Rect2。

---

• get_metadata get_metadata(column: int) const

---

• get_next get_next()

返回树中的下一个TreeItem。

---

• get_next_visible get_next_visible(wrap: bool = false)

返回树中的下一个可见TreeItem。

如果启用wrap，则在最后一个可见元素上调用该方法时，该方法将环绕在树中的第一个可见元素上，否则将返回null。

---

• get_parent get_parent()

返回父级TreeItem。

---

• get_prev get_prev()

返回树中的上一个TreeItem。

---

• get_prev_visible get_prev_visible(wrap: bool = false)

返回树中先前可见的TreeItem。

如果启用wrap，则在第一个可见元素上调用该方法时，该方法将环绕树中的最后一个可见元素，否则将返回null。

---

• get_range get_range(column: int) const

---

• get_range_config get_range_config(column: int)

---

• get_text get_text(column: int) const

返回给定列的文本。

---

• get_text_align get_text_align(column: int) const

返回给定列的文本对齐方式。

---

• get_tooltip get_tooltip(column: int) const

返回给定列的工具提示。

---

• is_button_disabled is_button_disabled(column: int, button_idx: int) const

如果给定列的索引button_idx处的按钮被禁用，则返回true。

---

• is_checked is_checked(column: int) const

如果选中给定的列，则返回true。

---

• is_custom_set_as_button is_custom_set_as_button(column: int) const

---

• is_editable is_editable(column: int)

如果列列是可编辑的，则返回true。

---

• is_selectable is_selectable(column: int) const

如果列column是可选的，则返回true。

---

• is_selected is_selected(column: int)

如果选择了列列，则返回true。

---

• move_to_bottom move_to_bottom()

将此TreeItem移动到Tree层次结构的底部。

---

• move_to_top move_to_top()

将此TreeItem移动到Tree层次结构的顶部。

---

• remove_child remove_child(child: Object)

删除给定的子TreeItem。

---

• select select(column: int)

选择列列。

---

• set_button set_button(column: int, button_idx: int, button: Texture)

将索引button_idx处给定列的按钮Texture设置为button。

---

• set_button_disabled set_button_disabled(column: int, button_idx: int, disabled: bool)

如果true，则禁用列column中索引button_idx处的按钮。

---

• set_cell_mode set_cell_mode(column: int, mode: int)

将给定列的单元格模式设置为mode。

---

• set_checked set_checked(column: int, checked: bool)

如果true，则检查列列。

---

• set_custom_as_button set_custom_as_button(column: int, enable: bool)

---

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

设置给定列的自定义背景色，以及是否仅将其用作轮廓。

---

• set_custom_color set_custom_color(column: int, color: Color)

设置给定列的自定义颜色。

---

• set_custom_draw set_custom_draw(column: int, object: Object, callback: String)

将给定列的自定义绘制回调设置为object上的callback方法。

callback应该接受两个参数：绘制的TreeItem及其位置和大小（作为Rect2）。

---

• set_editable set_editable(column: int, enabled: bool)

如果true，则列列是可编辑的。

---

• set_expand_right set_expand_right(column: int, enable: bool)

如果true，则列列将向右扩展。

---

• set_icon set_icon(column: int, texture: Texture)

设置给定列的图标[纹理]。

---

• set_icon_max_width set_icon_max_width(column: int, width: int)

设置给定列图标的最大宽度。

---

• set_icon_modulate set_icon_modulate(column: int, modulate: Color)

使用modulate调制给定列的图标。

---

• set_icon_region set_icon_region(column: int, region: Rect2)

设置给定列的图标的纹理区域。

---

• set_metadata set_metadata(column: int, meta: Variant)

---

• set_range set_range(column: int, value: float)

---

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

---

• set_selectable set_selectable(column: int, selectable: bool)

如果true，则给定的列是可选的。

---

• set_text set_text(column: int, text: String)

---

• set_text_align set_text_align(column: int, text_align: int)

设置给定列的文本对齐方式。

---

• set_tooltip set_tooltip(column: int, tooltip: String)

设置给定列的工具提示文本。

---