Tabs¶
Inherits: Control < CanvasItem < Node < Object
选项卡控件。
描述¶
简单的选项卡控制,类似于TabContainer,但只负责绘制选项卡,不与子节点互动。
属性¶
|
||
|
||
|
||
|
||
|
方法¶
void |
|
void |
ensure_tab_visible ( int idx ) |
get_offset_buttons_visible ( ) const |
|
get_previous_tab ( ) const |
|
get_select_with_rmb ( ) const |
|
get_tab_count ( ) const |
|
get_tab_disabled ( int tab_idx ) const |
|
get_tab_icon ( int tab_idx ) const |
|
get_tab_offset ( ) const |
|
get_tab_rect ( int tab_idx ) const |
|
get_tab_title ( int tab_idx ) const |
|
get_tabs_rearrange_group ( ) const |
|
void |
|
void |
remove_tab ( int tab_idx ) |
void |
set_select_with_rmb ( bool enabled ) |
void |
set_tab_disabled ( int tab_idx, bool disabled ) |
void |
set_tab_icon ( int tab_idx, Texture icon ) |
void |
set_tab_title ( int tab_idx, String title ) |
void |
set_tabs_rearrange_group ( int group_id ) |
主题属性¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
信号¶
reposition_active_tab_request ( int idx_to )
通过鼠标拖动重新排列活动选项卡时发出。参阅 drag_to_rearrange_enabled。
right_button_pressed ( int tab )
当选项卡被右键单击时发出。
tab_changed ( int tab )
切换到另一个选项卡时发出。
tab_clicked ( int tab )
单击选项卡时发出,即使它是当前选项卡。
tab_close ( int tab )
当选项卡关闭时发出。
tab_hover ( int tab )
当鼠标悬停选项卡时发出。
枚举¶
enum TabAlign:
ALIGN_LEFT = 0 --- 将选项卡对齐到左侧。
ALIGN_CENTER = 1 --- 将选项卡对齐到中心。
ALIGN_RIGHT = 2 --- 将标签对齐到右侧。
ALIGN_MAX = 3 --- 表示 TabAlign 枚举的大小。
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 |
|
Setter |
set_current_tab(value) |
Getter |
get_current_tab() |
选择索引 tab_idx
处的选项卡。
bool drag_to_rearrange_enabled
Default |
|
Setter |
set_drag_to_rearrange_enabled(value) |
Getter |
get_drag_to_rearrange_enabled() |
如果 true
,可以通过鼠标拖动重新排列选项卡。
bool scrolling_enabled
Default |
|
Setter |
set_scrolling_enabled(value) |
Getter |
get_scrolling_enabled() |
如果 true
,鼠标的滚轮可用于导航滚动视图。
TabAlign tab_align
Default |
|
Setter |
set_tab_align(value) |
Getter |
get_tab_align() |
所有选项卡的对齐方式。有关详细信息,请参阅 TabAlign。
CloseButtonDisplayPolicy tab_close_display_policy
Default |
|
Setter |
set_tab_close_display_policy(value) |
Getter |
get_tab_close_display_policy() |
设置关闭按钮何时出现在选项卡上。有关详细信息,请参阅 CloseButtonDisplayPolicy。
方法说明¶
添加新选项卡。
void ensure_tab_visible ( int idx )
移动滚动视图,使标签可见。
bool get_offset_buttons_visible ( ) const
如果偏移按钮(所有选项卡没有足够空间时出现的按钮)可见,则返回 true
。
int get_previous_tab ( ) const
返回上一个活动选项卡的索引。
bool get_select_with_rmb ( ) const
如果启用鼠标右键选择,则返回 true
。
int get_tab_count ( ) const
返回选项卡的数量。
如果索引 tab_idx
处的选项卡被禁用,则返回 true
。
返回索引 tab_idx
处选项卡的 Texture,如果该选项卡没有 Texture 的话则返回 null
。
int get_tab_offset ( ) const
返回向左偏移的隐藏选项卡的数量。
返回带有局部位置和大小的选项卡 Rect2。
返回索引 tab_idx
处的选项卡的标题。
int get_tabs_rearrange_group ( ) const
返回 Tabs
的重新排列组 ID。
将选项卡从 from
移动到 to
。
void remove_tab ( int tab_idx )
删除索引 tab_idx
处的选项卡。
void set_select_with_rmb ( bool enabled )
如果 true
,启用鼠标右键选择选项卡。
如果 disabled
是 true
,则禁用索引 tab_idx
处的选项卡,使其不可交互。
为索引 tab_idx
处的选项卡设置 icon
。
为索引 tab_idx
处的选项卡设置 title
。
void set_tabs_rearrange_group ( int group_id )
定义重新排列组的ID。为每个Tabs
选择相同的值,以便在Tabs
之间拖动标签。用drag_to_rearrange_enabled启用拖动。
Theme Property Descriptions¶
Color font_color_bg
Default |
|
非活动标签的字体颜色。
Color font_color_disabled
Default |
|
禁用选项卡的字体颜色。
Color font_color_fg
Default |
|
当前所选选项卡的字体颜色。
int hseparation
Default |
|
选项卡之间的水平间隔。
int label_valign_bg
Default |
|
int label_valign_fg
Default |
|
int top_margin
Default |
|
Font font
用于绘制选项卡名称的字体。
Texture close
关闭按钮的图标(参阅 tab_close_display_policy)。
Texture decrement
左边的箭头按钮的图标,当有太多的标签无法容纳在容器的宽度内时出现。当该按钮被禁用时(即第一个标签是可见的),它显示为半透明的。
Texture decrement_highlight
当标签太多无法适应容器宽度时出现的左箭头按钮图标。当鼠标悬停在按钮上时使用。
Texture increment
右箭头按钮的图标,当有太多的标签无法容纳在容器的宽度内时出现。当该按钮被禁用时(即最后一个标签是可见的),它显示为半透明的。
Texture increment_highlight
当标签太多无法适应容器宽度时出现的右箭头按钮图标。当鼠标悬停在按钮上时使用。
StyleBox button
当光标悬停时关闭按钮的背景。
StyleBox button_pressed
按下关闭按钮时的背景。
StyleBox tab_bg
非活动选项卡的样式。
StyleBox tab_disabled
禁用选项卡的样式
StyleBox tab_fg
当前所选标签的样式。