Tabs

Tabs control.

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

@GodotBaseClass

struct Tabs {

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(Tabs other);

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

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Tabs _new();

enum CloseButtonDisplayPolicy;

enum Constants;

void _guiInput(InputEvent arg0);

void _onMouseExited();

void _updateHover();

void addTab(String title, Texture icon);

void ensureTabVisible(long idx);

long getCurrentTab();

bool getDragToRearrangeEnabled();

bool getOffsetButtonsVisible();

long getPreviousTab();

bool getScrollingEnabled();

bool getSelectWithRmb();

Tabs.TabAlign getTabAlign();

Tabs.CloseButtonDisplayPolicy getTabCloseDisplayPolicy();

long getTabCount();

bool getTabDisabled(long tab_idx);

Ref!Texture getTabIcon(long tab_idx);

long getTabOffset();

Rect2 getTabRect(long tab_idx);

String getTabTitle(long tab_idx);

long getTabsRearrangeGroup();

void moveTab(long from, long to);

void removeTab(long tab_idx);

void setCurrentTab(long tab_idx);

void setDragToRearrangeEnabled(bool enabled);

void setScrollingEnabled(bool enabled);

void setSelectWithRmb(bool enabled);

void setTabAlign(long _align);

void setTabCloseDisplayPolicy(long policy);

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

long currentTab [@property getter];

long currentTab [@property setter];

bool dragToRearrangeEnabled [@property getter];

bool dragToRearrangeEnabled [@property setter];

bool scrollingEnabled [@property getter];

bool scrollingEnabled [@property setter];

Tabs.TabAlign tabAlign [@property getter];

long tabAlign [@property setter];

Tabs.CloseButtonDisplayPolicy tabCloseDisplayPolicy [@property getter];

long tabCloseDisplayPolicy [@property setter];

}

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)
_onMouseExited void _onMouseExited()
_updateHover void _updateHover()
addTab void addTab(String 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(): Returns true if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible.
getPreviousTab long getPreviousTab(): Returns the previously active tab index.
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(): Returns the number of hidden tabs offsetted to the left.
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): Moves a tab from from to to.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(Tabs other)
opEquals bool opEquals(typeof(null) n)
removeTab void removeTab(long tab_idx): Removes the 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 the 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: Its title text will remain unless it is 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.
setTabsRearrangeGroup void setTabsRearrangeGroup(long group_id): Defines the rearrange group ID. Choose for each Tabs the same value to dragging tabs between Tabs. Enable drag with set_drag_to_rearrange_enabled(true).
toHash size_t toHash()

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]: if true, the mouse's scroll wheel can be used to navigate the scroll view.
tabAlign Tabs.TabAlign tabAlign [@property getter]
long tabAlign [@property setter]: The alignment of all tabs. See tabalign for details.
tabCloseDisplayPolicy Tabs.CloseButtonDisplayPolicy tabCloseDisplayPolicy [@property getter]
long tabCloseDisplayPolicy [@property setter]: Sets when the close button will appear on the tabs. See closebuttondisplaypolicy for details.

Static functions

_new Tabs _new(): Construct a new instance of Tabs. Note: use memnew!Tabs 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 tabs structs

Tabs