Tabs
继承
简要描述
标签控件。
描述
简单的标签控件,类似于TabContainer,但仅负责绘制标签页,而不与子级交互。
成员
类型 | 属性名 | 默认值 |
---|---|---|
int | current_tab | 0 |
bool | drag_to_rearrange_enabled | false |
bool | scrolling_enabled | true |
int | tab_align | 1 |
int | tab_close_display_policy | 0 |
方法
返回值类型 | 方法名称 |
---|---|
void | add_tab(title: String = "", icon: Texture = null) |
void | ensure_tab_visible(idx: int) |
bool | get_offset_buttons_visible() const |
bool | get_select_with_rmb() const |
int | get_tab_count() const |
bool | get_tab_disabled(tab_idx: int) const |
Texture | get_tab_icon(tab_idx: int) const |
int | get_tab_offset() const |
Rect2 | get_tab_rect(tab_idx: int) const |
String | get_tab_title(tab_idx: int) const |
int | get_tabs_rearrange_group() const |
void | move_tab(from: int, to: int) |
void | remove_tab(tab_idx: int) |
void | set_select_with_rmb(enabled: bool) |
void | set_tab_disabled(tab_idx: int, disabled: bool) |
void | set_tab_icon(tab_idx: int, icon: Texture) |
void | set_tab_title(tab_idx: int, title: String) |
void | set_tabs_rearrange_group(group_id: int) |
信号
- **reposition_active_tab_request**
通过鼠标拖动重新排列活动标签时发出。
右键单击标签时发出。
- **tab_changed**
切换到另一个标签时发出。
- **tab_clicked**
单击选标签时发出,即使它是当前标签也是如此。
- **tab_close**
关闭标签时发出。
- **tab_hover**
当鼠标悬停一个标签时发出。
枚举
enum TabAlign:
- **ALIGN_LEFT = 0**
将标签向左对齐。
- **ALIGN_CENTER = 1**
将标签对准中心。
- **ALIGN_RIGHT = 2**
将标签向右对齐。
- **ALIGN_MAX = 3**
表示TabAlign枚举的大小。
enum CloseButtonDisplayPolicy:
- **CLOSE_BUTTON_SHOW_NEVER = 0**
不显示关闭按钮。
- **CLOSE_BUTTON_SHOW_ACTIVE_ONLY = 1**
仅在当前活动的标签上显示关闭按钮。
- **CLOSE_BUTTON_SHOW_ALWAYS = 2**
在所有标签上显示关闭按钮。
- **CLOSE_BUTTON_MAX = 3**
表示CloseButtonDisplayPolicy枚举的大小。
常量
成员说明
- int current_tab
Default | 0 |
---|---|
setter | set_current_tab(value) |
getter | get_current_tab |
- bool drag_to_rearrange_enabled
Default | false |
---|---|
setter | set_drag_to_rearrange_enabled(value) |
getter | get_drag_to_rearrange_enabled |
- bool scrolling_enabled
Default | true |
---|---|
setter | set_scrolling_enabled(value) |
getter | get_scrolling_enabled |
- int tab_align
Default | 1 |
---|---|
setter | set_tab_align(value) |
getter | get_tab_align |
- int tab_close_display_policy
Default | 0 |
---|---|
setter | set_tab_close_display_policy(value) |
getter | get_tab_close_display_policy |
方法说明
- add_tab add_tab(title: String = "", icon: Texture = null)
添加一个新标签。
- ensure_tab_visible ensure_tab_visible(idx: int)
移动滚动视图以使标签可见。
- get_offset_buttons_visible () const
如果偏移按钮(当所有标签的空间不足时显示的按钮)可见,则返回true
。
- get_select_with_rmb get_select_with_rmb() const
如果启用了使用鼠标右键进行选择,则返回true
。
- get_tab_count get_tab_count() const
返回标签的数量。
- get_tab_disabled get_tab_disabled(tab_idx: int) const
如果索引tab_idx
处的标签被禁用,则返回true
。
- get_tab_icon get_tab_icon(tab_idx: int) const
返回索引为tab_idx
的标签页的Texture,如果没有Texture,则返回null
。
- get_tab_offset get_tab_offset() const
返回隐藏标签向左偏移的数量。
- get_tab_rect get_tab_rect(tab_idx: int) const
返回标签带有本地位置和大小的Rect2。
- get_tab_title get_tab_title(tab_idx: int) const
返回索引为tab_idx
的标签的标题。
- get_tabs_rearrange_group get_tabs_rearrange_group() const
返回Tabs的重排组ID。
- move_tab move_tab(from: int, to: int)
将标签从from
移至to
。
- remove_tab remove_tab(tab_idx: int)
删除索引为tab_idx
的标签。
- set_select_with_rmb set_select_with_rmb(enabled: bool)
如果true
,则可以使用鼠标右键选择标签。
- set_tab_disabled set_tab_disabled(tab_idx: int, disabled: bool)
如果disabled
为false
,则隐藏索引tab_idx
处的标签。
注意:除非使用set_tab_title删除标题文本,否则将保留其标题文本。
- set_tab_icon set_tab_icon(tab_idx: int, icon: Texture)
为索引tab_idx
处标签设置icon
。
- set_tab_title set_tab_title(tab_idx: int, title: String)
为索引tab_idx
处标签设置title
。
- set_tabs_rearrange_group set_tabs_rearrange_group(group_id: int)
定义重新排列的组ID。