Tabs

Tabs Control.

Simple tabs control, similar to TabContainer but is only in charge of drawing tabs, not interact with children.

@GodotBaseClass
struct Tabs {}

Members

Aliases

BaseClasses
alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses)
Undocumented in source.

Enums

CloseButtonDisplayPolicy
enum CloseButtonDisplayPolicy
Constants
enum Constants
TabAlign
enum TabAlign

Functions

_guiInput
void _guiInput(InputEvent arg0)
_updateHover
void _updateHover()
addTab
void addTab(StringArg0 title, Texture icon)

Adds a new tab.

ensureTabVisible
void ensureTabVisible(long idx)

Moves the Scroll view to make the tab visible.

getCurrentTab
long getCurrentTab()
getDragToRearrangeEnabled
bool getDragToRearrangeEnabled()
getOffsetButtonsVisible
bool getOffsetButtonsVisible()
getScrollingEnabled
bool getScrollingEnabled()
getSelectWithRmb
bool getSelectWithRmb()

Returns true if select with right mouse button is enabled.

getTabAlign
Tabs.TabAlign getTabAlign()
getTabCloseDisplayPolicy
Tabs.CloseButtonDisplayPolicy getTabCloseDisplayPolicy()
getTabCount
long getTabCount()

Returns the number of tabs.

getTabDisabled
bool getTabDisabled(long tab_idx)

Returns true if the tab at index tab_idx is disabled.

getTabIcon
Ref!Texture getTabIcon(long tab_idx)

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

getTabOffset
long getTabOffset()
getTabRect
Rect2 getTabRect(long tab_idx)

Returns tab Rect2 with local position and size.

getTabTitle
String getTabTitle(long tab_idx)

Returns the title of the tab at index tab_idx. Tab titles default to the name of the indexed child node, but this can be overridden with setTabTitle.

getTabsRearrangeGroup
long getTabsRearrangeGroup()

Returns the Tabs rearrange group id.

moveTab
void moveTab(long from, long to)

Rearrange tab.

opAssign
Tabs opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Tabs other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
removeTab
void removeTab(long tab_idx)

Removes tab at index tab_idx

setCurrentTab
void setCurrentTab(long tab_idx)
setDragToRearrangeEnabled
void setDragToRearrangeEnabled(bool enabled)
setScrollingEnabled
void setScrollingEnabled(bool enabled)
setSelectWithRmb
void setSelectWithRmb(bool enabled)

If true enables selecting a tab with right mouse button.

setTabAlign
void setTabAlign(long _align)
setTabCloseDisplayPolicy
void setTabCloseDisplayPolicy(long policy)
setTabDisabled
void setTabDisabled(long tab_idx, bool disabled)

If disabled is false, hides the tab at index tab_idx. Note that its title text will remain, unless also removed with setTabTitle.

setTabIcon
void setTabIcon(long tab_idx, Texture icon)

Sets an icon for the tab at index tab_idx.

setTabTitle
void setTabTitle(long tab_idx, StringArg1 title)

Sets a title for the tab at index tab_idx.

setTabsRearrangeGroup
void setTabsRearrangeGroup(long group_id)

Defines rearrange group id, choose for each Tabs the same value to enable tab drag between Tabs. Enable drag with set_drag_to_rearrange_enabled(true).

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

currentTab
long currentTab [@property getter]
long currentTab [@property setter]

Select tab at index tab_idx.

dragToRearrangeEnabled
bool dragToRearrangeEnabled [@property getter]
bool dragToRearrangeEnabled [@property setter]

If true, tabs can be rearranged with mouse drag.

scrollingEnabled
bool scrollingEnabled [@property getter]
bool scrollingEnabled [@property setter]
tabAlign
Tabs.TabAlign tabAlign [@property getter]
long tabAlign [@property setter]

The alignment of all tabs. See enum TabAlign constants for details.

tabCloseDisplayPolicy
Tabs.CloseButtonDisplayPolicy tabCloseDisplayPolicy [@property getter]
long tabCloseDisplayPolicy [@property setter]

Static functions

_new
Tabs _new()
Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized
bool _classBindingInitialized;
Undocumented in source.

Structs

_classBinding
struct _classBinding
Undocumented in source.

Unions

__anonymous
union __anonymous
Undocumented in source.

Variables

_GODOT_internal_name
enum string _GODOT_internal_name;
Undocumented in source.

Mixed In Members

From mixin baseCasts

as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
To as()
Undocumented in source. Be warned that the author may not have intended to support it.
as
ToRef as()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(To)
Undocumented in source.
opCast
template opCast(ToRef)
Undocumented in source.
opCast
void* opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
godot_object opCast()
Undocumented in source. Be warned that the author may not have intended to support it.
opCast
bool opCast()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta