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);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(TabContainer other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static TabContainer _new();

enum Constants;

void _childRenamedCallback();

void _guiInput(InputEvent arg0);

void _onMouseExited();

void _onThemeChanged();

void _updateCurrentTab();

bool areTabsVisible();

long getCurrentTab();

Control getCurrentTabControl();

bool getDragToRearrangeEnabled();

Popup getPopup();

long getPreviousTab();

TabContainer.TabAlign getTabAlign();

Control getTabControl(long tab_idx);

long getTabCount();

bool getTabDisabled(long tab_idx);

Ref!Texture getTabIcon(long tab_idx);

String getTabTitle(long tab_idx);

long getTabsRearrangeGroup();

bool getUseHiddenTabsForMinSize();

bool isAllTabsInFront();

void setAllTabsInFront(bool is_front);

void setCurrentTab(long tab_idx);

void setDragToRearrangeEnabled(bool enabled);

void setPopup(Node popup);

void setTabAlign(long _align);

void setTabDisabled(long tab_idx, bool disabled);

void setTabIcon(long tab_idx, Texture icon);

void setTabTitle(long tab_idx, String title);

void setTabsRearrangeGroup(long group_id);

void setTabsVisible(bool visible);

void setUseHiddenTabsForMinSize(bool enabled);

bool allTabsInFront [@property getter];

bool allTabsInFront [@property setter];

long currentTab [@property getter];

long currentTab [@property setter];

bool dragToRearrangeEnabled [@property getter];

bool dragToRearrangeEnabled [@property setter];

TabContainer.TabAlign tabAlign [@property getter];

long tabAlign [@property setter];

bool tabsVisible [@property getter];

bool tabsVisible [@property setter];

bool useHiddenTabsForMinSize [@property getter];

bool useHiddenTabsForMinSize [@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)
_onMouseExited void _onMouseExited()
_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 tab_idx): Returns the Control node from the tab at index tab_idx.
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.
getUseHiddenTabsForMinSize bool getUseHiddenTabsForMinSize()
isAllTabsInFront bool isAllTabsInFront()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(TabContainer other)
opEquals bool opEquals(typeof(null) n)
setAllTabsInFront void setAllTabsInFront(bool is_front)
setCurrentTab void setCurrentTab(long tab_idx)
setDragToRearrangeEnabled void setDragToRearrangeEnabled(bool enabled)
setPopup void setPopup(Node 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: 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, String 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)
setUseHiddenTabsForMinSize void setUseHiddenTabsForMinSize(bool enabled)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

allTabsInFront bool allTabsInFront [@property getter]
bool allTabsInFront [@property setter]: If true, all tabs are drawn in front of the panel. If false, inactive tabs are drawn behind the panel.
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 getter]
bool dragToRearrangeEnabled [@property setter]: 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 tabalign 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.
useHiddenTabsForMinSize bool useHiddenTabsForMinSize [@property getter]
bool useHiddenTabsForMinSize [@property setter]: If true, children Control nodes that are hidden have their minimum size take into account in the total, instead of only the currently visible one.

Static functions

_new TabContainer _new(): Construct a new instance of TabContainer. Note: use memnew!TabContainer instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: 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 inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(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