class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeCanvasItemControl TabBar
A control that provides a horizontal bar with tabs.

A control that provides a horizontal bar with tabs. Similar to TabContainer but is only in charge of drawing tabs, not interacting with children.

 Signal active_tab_rearranged<>( int idx_to=, idx_to:int=, ):Signal

Emitted when the active tab is rearranged via mouse drag. See drag_to_rearrange_enabled.

 Signal tab_button_pressed<>( int tab=, tab:int=, ):Signal

Emitted when a tab's right button is pressed. See set_tab_button_icon().

 Signal tab_changed<>( int tab=, tab:int=, ):Signal

Emitted when switching to another tab.

 Signal tab_clicked<>( int tab=, tab:int=, ):Signal

Emitted when a tab is clicked, even if it is the current tab.

 Signal tab_close_pressed<>( int tab=, tab:int=, ):Signal

Emitted when a tab's close button is pressed.

Note: Tabs are not removed automatically once the close button is pressed, this behavior needs to be programmed manually. For example:

$TabBar.tab_close_pressed.connect($TabBar.remove_tab)
Signal tab_hovered<>( int tab=, tab:int=, ):Signal

Emitted when a tab is hovered by the mouse.

 Signal tab_rmb_clicked<>( int tab=, tab:int=, ):Signal

Emitted when a tab is right-clicked. select_with_rmb must be enabled.

 Signal tab_selected<>( int tab=, tab:int=, ):Signal

Emitted when a tab is selected via click, directional input, or script, even if it is the current tab.

 Enum AlignmentMode<>():Enum

ALIGNMENT_LEFT = 0

Places tabs to the left.


ALIGNMENT_CENTER = 1

Places tabs in the middle.


ALIGNMENT_RIGHT = 2

Places tabs to the right.


ALIGNMENT_MAX = 3

Represents the size of the AlignmentMode enum.

 Enum CloseButtonDisplayPolicy<>():Enum

CLOSE_BUTTON_SHOW_NEVER = 0

Never show the close buttons.


CLOSE_BUTTON_SHOW_ACTIVE_ONLY = 1

Only show the close button on the currently active tab.


CLOSE_BUTTON_SHOW_ALWAYS = 2

Show the close button on all tabs.


CLOSE_BUTTON_MAX = 3

Represents the size of the CloseButtonDisplayPolicy enum.

 bool clip_tabs<>():bool

If true, tabs overflowing this node's width will be hidden, displaying two navigation buttons instead. Otherwise, this node's minimum size is updated so that all tabs are visible.

 int current_tab<>():int

The index of the current selected tab. A value of -1 means that no tab is selected and can only be set when deselect_enabled is true or if all tabs are hidden or disabled.

 bool deselect_enabled<>():bool

If true, all tabs can be deselected so that no tab is selected. Click on the current tab to deselect it.

 bool drag_to_rearrange_enabled<>():bool

If true, tabs can be rearranged with mouse drag.

 int max_tab_width<>():int

Sets the maximum width which all tabs should be limited to. Unlimited if set to 0.

 bool scroll_to_selected<>():bool

If true, the tab offset will be changed to keep the currently selected tab visible.

 bool scrolling_enabled<>():bool

if true, the mouse's scroll wheel can be used to navigate the scroll view.

 bool select_with_rmb<>():bool

If true, enables selecting a tab with the right mouse button.

 AlignmentMode tab_alignment<>():AlignmentMode

Sets the position at which tabs will be placed. See AlignmentMode for details.

 CloseButtonDisplayPolicy tab_close_display_policy<>():CloseButtonDisplayPolicy

Sets when the close button will appear on the tabs. See CloseButtonDisplayPolicy for details.

 int tab_count<>():int

The number of tabs currently in the bar.

 int tabs_rearrange_group<>():int

TabBars with the same rearrange group ID will allow dragging the tabs between them. Enable drag with drag_to_rearrange_enabled.

Setting this to -1 will disable rearranging between TabBars.

 void add_tab<>( String title="", title:String="", Texture2D icon=null, icon:Texture2D=null, ):void

Adds a new tab.

 void clear_tabs<>():void

Clears all tabs.

 void ensure_tab_visible<>( int idx=, idx:int=, ):void

Moves the scroll view to make the tab visible.

 bool get_offset_buttons_visible<>():bool

Returns true if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible.

 int get_previous_tab<>():int

Returns the previously active tab index.

 Texture2D get_tab_button_icon<>( int tab_idx=, tab_idx:int=, ):Texture2D

Returns the icon for the right button of the tab at index tab_idx or null if the right button has no icon.

 Texture2D get_tab_icon<>( int tab_idx=, tab_idx:int=, ):Texture2D

Returns the icon for the tab at index tab_idx or null if the tab has no icon.

 int get_tab_icon_max_width<>( int tab_idx=, tab_idx:int=, ):int

Returns the maximum allowed width of the icon for the tab at index tab_idx.

 int get_tab_idx_at_point<>( Vector2 point=, point:Vector2=, ):int

Returns the index of the tab at local coordinates point. Returns -1 if the point is outside the control boundaries or if there's no tab at the queried position.

 String get_tab_language<>( int tab_idx=, tab_idx:int=, ):String

Returns tab title language code.

 Variant get_tab_metadata<>( int tab_idx=, tab_idx:int=, ):Variant

Returns the metadata value set to the tab at index tab_idx using set_tab_metadata(). If no metadata was previously set, returns null by default.

 int get_tab_offset<>():int

Returns the number of hidden tabs offsetted to the left.

 Rect2 get_tab_rect<>( int tab_idx=, tab_idx:int=, ):Rect2

Returns tab Rect2 with local position and size.

 TextDirection get_tab_text_direction<>( int tab_idx=, tab_idx:int=, ):TextDirection

Returns tab title text base writing direction.

 String get_tab_title<>( int tab_idx=, tab_idx:int=, ):String

Returns the title of the tab at index tab_idx.

 String get_tab_tooltip<>( int tab_idx=, tab_idx:int=, ):String

Returns the tooltip text of the tab at index tab_idx.

 bool is_tab_disabled<>( int tab_idx=, tab_idx:int=, ):bool

Returns true if the tab at index tab_idx is disabled.

 bool is_tab_hidden<>( int tab_idx=, tab_idx:int=, ):bool

Returns true if the tab at index tab_idx is hidden.

 void move_tab<>( int from=, from:int=, int to=, to:int=, ):void

Moves a tab from from to to.

 void remove_tab<>( int tab_idx=, tab_idx:int=, ):void

Removes the tab at index tab_idx.

 bool select_next_available<>():bool

Selects the first available tab with greater index than the currently selected. Returns true if tab selection changed.

 bool select_previous_available<>():bool

Selects the first available tab with lower index than the currently selected. Returns true if tab selection changed.

 void set_tab_button_icon<>( int tab_idx=, tab_idx:int=, Texture2D icon=, icon:Texture2D=, ):void

Sets an icon for the button of the tab at index tab_idx (located to the right, before the close button), making it visible and clickable (See tab_button_pressed). Giving it a null value will hide the button.

 void set_tab_disabled<>( int tab_idx=, tab_idx:int=, bool disabled=, disabled:bool=, ):void

If disabled is true, disables the tab at index tab_idx, making it non-interactable.

 void set_tab_hidden<>( int tab_idx=, tab_idx:int=, bool hidden=, hidden:bool=, ):void

If hidden is true, hides the tab at index tab_idx, making it disappear from the tab area.

 void set_tab_icon<>( int tab_idx=, tab_idx:int=, Texture2D icon=, icon:Texture2D=, ):void

Sets an icon for the tab at index tab_idx.

 void set_tab_icon_max_width<>( int tab_idx=, tab_idx:int=, int width=, width:int=, ):void

Sets the maximum allowed width of the icon for the tab at index tab_idx. This limit is applied on top of the default size of the icon and on top of icon_max_width. The height is adjusted according to the icon's ratio.

 void set_tab_language<>( int tab_idx=, tab_idx:int=, String language=, language:String=, ):void

Sets language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead.

 void set_tab_metadata<>( int tab_idx=, tab_idx:int=, Variant metadata=, metadata:Variant=, ):void

Sets the metadata value for the tab at index tab_idx, which can be retrieved later using get_tab_metadata().

 void set_tab_text_direction<>( int tab_idx=, tab_idx:int=, TextDirection direction=, direction:TextDirection=, ):void

Sets tab title base writing direction.

 void set_tab_title<>( int tab_idx=, tab_idx:int=, String title=, title:String=, ):void

Sets a title for the tab at index tab_idx.

 void set_tab_tooltip<>( int tab_idx=, tab_idx:int=, String tooltip=, tooltip:String=, ):void

Sets a tooltip for tab at index tab_idx.

Note: By default, if the tooltip is empty and the tab text is truncated (not all characters fit into the tab), the title will be displayed as a tooltip. To hide the tooltip, assign " " as the tooltip text.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...