TabContainer

Tabbed Container.

Sets the active tab's visible property to the value true. Sets all other children's to false. Ignores non-Control children. Individual tabs are always visible unless you use setTabDisabled and setTabTitle to hide it. To hide only a tab's content, nest the content inside a child Control, so it receives the TabContainer's visibility setting instead.

@GodotBaseClass

struct TabContainer {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(TabContainer other);

TabContainer opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static TabContainer _new();

enum Constants;

void _guiInput(InputEvent arg0);

long getTabCount();

void setCurrentTab(long tab_idx);

long getCurrentTab();

long getPreviousTab();

Control getCurrentTabControl();

Control getTabControl(long idx);

void setTabAlign(long _align);

TabContainer.TabAlign getTabAlign();

void setTabsVisible(bool visible);

bool areTabsVisible();

void setTabTitle(long tab_idx, StringArg1 title);

String getTabTitle(long tab_idx);

void setTabIcon(long tab_idx, Texture icon);

Ref!Texture getTabIcon(long tab_idx);

void setTabDisabled(long tab_idx, bool disabled);

bool getTabDisabled(long tab_idx);

void setPopup(GodotObject popup);

Popup getPopup();

void setDragToRearrangeEnabled(bool enabled);

bool getDragToRearrangeEnabled();

void setTabsRearrangeGroup(long group_id);

long getTabsRearrangeGroup();

void _childRenamedCallback();

void _onThemeChanged();

void _updateCurrentTab();

TabContainer.TabAlign tabAlign [@property getter];

long tabAlign [@property setter];

long currentTab [@property getter];

long currentTab [@property setter];

bool tabsVisible [@property getter];

bool tabsVisible [@property setter];

bool dragToRearrangeEnabled [@property getter];

bool dragToRearrangeEnabled [@property setter];

}

Members

Aliases

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

Enums

Constants enum Constants
TabAlign enum TabAlign

Functions

_childRenamedCallback void _childRenamedCallback()
_guiInput void _guiInput(InputEvent arg0)
_onThemeChanged void _onThemeChanged()
_updateCurrentTab void _updateCurrentTab()
areTabsVisible bool areTabsVisible()
getCurrentTab long getCurrentTab()
getCurrentTabControl Control getCurrentTabControl(): Returns the child Control node located at the active tab index.
getDragToRearrangeEnabled bool getDragToRearrangeEnabled()
getPopup Popup getPopup(): Returns the Popup node instance if one has been set already with setPopup.
getPreviousTab long getPreviousTab(): Returns the previously active tab index.
getTabAlign TabContainer.TabAlign getTabAlign()
getTabControl Control getTabControl(long idx): Returns the currently visible tab's Control node.
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.
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 TabContainer rearrange group id.
opAssign TabContainer opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(TabContainer 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.
setCurrentTab void setCurrentTab(long tab_idx)
setDragToRearrangeEnabled void setDragToRearrangeEnabled(bool enabled)
setPopup void setPopup(GodotObject popup): If set on a Popup node instance, a popup menu icon appears in the top-right corner of the TabContainer. Clicking it will expand the Popup node.
setTabAlign void setTabAlign(long _align)
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. Tab titles default to the name of the indexed child node, but this can be overridden with setTabTitle.
setTabsRearrangeGroup void setTabsRearrangeGroup(long group_id): Defines rearrange group id, choose for each TabContainer the same value to enable tab drag between TabContainer. Enable drag with set_drag_to_rearrange_enabled(true).
setTabsVisible void setTabsVisible(bool visible)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

currentTab long currentTab [@property getter]
long currentTab [@property setter]: The current tab index. When set, this index's Control node's visible property is set to true and all others are set to false.
dragToRearrangeEnabled bool dragToRearrangeEnabled [@property setter]: If true, tabs can be rearranged with mouse drag.
dragToRearrangeEnabled bool dragToRearrangeEnabled [@property getter]: If true, tabs can be rearranged with mouse drag.
tabAlign TabContainer.TabAlign tabAlign [@property getter]
long tabAlign [@property setter]: The alignment of all tabs in the tab container. See the ALIGN_* constants for details.
tabsVisible bool tabsVisible [@property getter]
bool tabsVisible [@property setter]: If true tabs are visible. If false tabs' content and titles are hidden. Default value: true.

Static functions

_new TabContainer _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

Source

See Implementation

godot tabcontainer structs

TabContainer