TabContainer

package
v0.0.0-...-ff35923 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2025 License: MIT Imports: 30 Imported by: 0

Documentation

Overview

Arranges child controls into a tabbed view, creating a tab for each one. The active tab's corresponding control is made visible, while all other child controls are hidden. Ignores non-control children.

Note: The drawing of the clickable tabs is handled by this node; graphics.gd/classdb/TabBar is not needed.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any 

type Any interface {
	gd.IsClass
	AsTabContainer() Instance
}

type Extension 

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsCanvasItem 

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsContainer 

func (self *Extension[T]) AsContainer() Container.Instance

func (*Extension[T]) AsControl 

func (self *Extension[T]) AsControl() Control.Instance

func (*Extension[T]) AsNode 

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject 

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsTabContainer 

func (self *Extension[T]) AsTabContainer() Instance

type ID 

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance 

func (id ID) Instance() (Instance, bool)

type Instance 

type Instance [1]gdclass.TabContainer

Instance of the class with convieniently typed arguments and results. 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) AllTabsInFront 

func (self Instance) AllTabsInFront() bool

func (Instance) AsCanvasItem 

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsContainer 

func (self Instance) AsContainer() Container.Instance

func (Instance) AsControl 

func (self Instance) AsControl() Control.Instance

func (Instance) AsNode 

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsTabContainer 

func (self Instance) AsTabContainer() Instance

func (Instance) ClipTabs 

func (self Instance) ClipTabs() bool

func (Instance) CurrentTab 

func (self Instance) CurrentTab() int

func (Instance) DeselectEnabled 

func (self Instance) DeselectEnabled() bool

func (Instance) DragToRearrangeEnabled 

func (self Instance) DragToRearrangeEnabled() bool

func (Instance) GetCurrentTabControl 

func (self Instance) GetCurrentTabControl() Control.Instance

Returns the child graphics.gd/classdb/Control node located at the active tab index.

func (Instance) GetPopup 

func (self Instance) GetPopup() Popup.Instance

Returns the graphics.gd/classdb/Popup node instance if one has been set already with Instance.SetPopup.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their graphics.gd/classdb/Window.Instance.Visible property.

func (Instance) GetPreviousTab 

func (self Instance) GetPreviousTab() int

Returns the previously active tab index.

func (Instance) GetTabBar 

func (self Instance) GetTabBar() TabBar.Instance

Returns the graphics.gd/classdb/TabBar contained in this container.

Warning: This is a required internal node, removing and freeing it or editing its tabs may cause a crash. If you wish to edit the tabs, use the methods provided in graphics.gd/classdb/TabContainer.

func (Instance) GetTabButtonIcon 

func (self Instance) GetTabButtonIcon(tab_idx int) Texture2D.Instance

Returns the button icon from the tab at index 'tab_idx'.

func (Instance) GetTabControl 

func (self Instance) GetTabControl(tab_idx int) Control.Instance

Returns the graphics.gd/classdb/Control node from the tab at index 'tab_idx'.

func (Instance) GetTabCount 

func (self Instance) GetTabCount() int

Returns the number of tabs.

func (Instance) GetTabIcon 

func (self Instance) GetTabIcon(tab_idx int) Texture2D.Instance

Returns the graphics.gd/classdb/Texture2D for the tab at index 'tab_idx' or null if the tab has no graphics.gd/classdb/Texture2D.

func (Instance) GetTabIconMaxWidth 

func (self Instance) GetTabIconMaxWidth(tab_idx int) int

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

func (Instance) GetTabIdxAtPoint 

func (self Instance) GetTabIdxAtPoint(point Vector2.XY) 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.

func (Instance) GetTabIdxFromControl 

func (self Instance) GetTabIdxFromControl(control Control.Instance) int

Returns the index of the tab tied to the given 'control'. The control must be a child of the graphics.gd/classdb/TabContainer.

func (Instance) GetTabMetadata 

func (self Instance) GetTabMetadata(tab_idx int) any

Returns the metadata value set to the tab at index 'tab_idx' using Instance.SetTabMetadata. If no metadata was previously set, returns null by default.

func (Instance) GetTabTitle 

func (self Instance) GetTabTitle(tab_idx int) string

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 Instance.SetTabTitle.

func (Instance) GetTabTooltip 

func (self Instance) GetTabTooltip(tab_idx int) string

Returns the tooltip text of the tab at index 'tab_idx'.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) IsTabDisabled 

func (self Instance) IsTabDisabled(tab_idx int) bool

Returns true if the tab at index 'tab_idx' is disabled.

func (Instance) IsTabHidden 

func (self Instance) IsTabHidden(tab_idx int) bool

Returns true if the tab at index 'tab_idx' is hidden.

func (Instance) OnActiveTabRearranged 

func (self Instance) OnActiveTabRearranged(cb func(idx_to int), flags ...Signal.Flags)

func (Instance) OnPrePopupPressed 

func (self Instance) OnPrePopupPressed(cb func(), flags ...Signal.Flags)

func (Instance) OnTabButtonPressed 

func (self Instance) OnTabButtonPressed(cb func(tab int), flags ...Signal.Flags)

func (Instance) OnTabChanged 

func (self Instance) OnTabChanged(cb func(tab int), flags ...Signal.Flags)

func (Instance) OnTabClicked 

func (self Instance) OnTabClicked(cb func(tab int), flags ...Signal.Flags)

func (Instance) OnTabHovered 

func (self Instance) OnTabHovered(cb func(tab int), flags ...Signal.Flags)

func (Instance) OnTabSelected 

func (self Instance) OnTabSelected(cb func(tab int), flags ...Signal.Flags)

func (Instance) SelectNextAvailable 

func (self Instance) SelectNextAvailable() bool

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

func (Instance) SelectPreviousAvailable 

func (self Instance) SelectPreviousAvailable() bool

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

func (Instance) SetAllTabsInFront 

func (self Instance) SetAllTabsInFront(value bool)

func (Instance) SetClipTabs 

func (self Instance) SetClipTabs(value bool)

func (Instance) SetCurrentTab 

func (self Instance) SetCurrentTab(value int)

func (Instance) SetDeselectEnabled 

func (self Instance) SetDeselectEnabled(value bool)

func (Instance) SetDragToRearrangeEnabled 

func (self Instance) SetDragToRearrangeEnabled(value bool)

func (*Instance) SetObject 

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPopup 

func (self Instance) SetPopup(popup Node.Instance)

If set on a graphics.gd/classdb/Popup node instance, a popup menu icon appears in the top-right corner of the graphics.gd/classdb/TabContainer (setting it to null will make it go away). Clicking it will expand the graphics.gd/classdb/Popup node.

func (Instance) SetTabAlignment 

func (self Instance) SetTabAlignment(value TabBar.AlignmentMode)

func (Instance) SetTabButtonIcon 

func (self Instance) SetTabButtonIcon(tab_idx int, icon Texture2D.Instance)

Sets the button icon from the tab at index 'tab_idx'.

func (Instance) SetTabDisabled 

func (self Instance) SetTabDisabled(tab_idx int, disabled bool)

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

func (Instance) SetTabFocusMode 

func (self Instance) SetTabFocusMode(value Control.FocusMode)

func (Instance) SetTabHidden 

func (self Instance) SetTabHidden(tab_idx int, hidden bool)

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

func (Instance) SetTabIcon 

func (self Instance) SetTabIcon(tab_idx int, icon Texture2D.Instance)

Sets an icon for the tab at index 'tab_idx'.

func (Instance) SetTabIconMaxWidth 

func (self Instance) SetTabIconMaxWidth(tab_idx int, width int)

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 theme's 'icon_max_width'. The height is adjusted according to the icon's ratio.

func (Instance) SetTabMetadata 

func (self Instance) SetTabMetadata(tab_idx int, metadata any)

Sets the metadata value for the tab at index 'tab_idx', which can be retrieved later using Instance.GetTabMetadata.

func (Instance) SetTabTitle 

func (self Instance) SetTabTitle(tab_idx int, title string)

Sets a custom title for the tab at index 'tab_idx' (tab titles default to the name of the indexed child node). Set it back to the child's name to make the tab default to it again.

func (Instance) SetTabTooltip 

func (self Instance) SetTabTooltip(tab_idx int, tooltip string)

Sets a custom tooltip text 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.

func (Instance) SetTabsPosition 

func (self Instance) SetTabsPosition(value TabPosition)

func (Instance) SetTabsRearrangeGroup 

func (self Instance) SetTabsRearrangeGroup(value int)

func (Instance) SetTabsVisible 

func (self Instance) SetTabsVisible(value bool)

func (Instance) SetUseHiddenTabsForMinSize 

func (self Instance) SetUseHiddenTabsForMinSize(value bool)

func (Instance) TabAlignment 

func (self Instance) TabAlignment() TabBar.AlignmentMode

func (Instance) TabFocusMode 

func (self Instance) TabFocusMode() Control.FocusMode

func (Instance) TabsPosition 

func (self Instance) TabsPosition() TabPosition

func (Instance) TabsRearrangeGroup 

func (self Instance) TabsRearrangeGroup() int

func (Instance) TabsVisible 

func (self Instance) TabsVisible() bool

func (Instance) UseHiddenTabsForMinSize 

func (self Instance) UseHiddenTabsForMinSize() bool

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

type TabPosition 

type TabPosition int //gd:TabContainer.TabPosition

const (
	// Places the tab bar at the top.
	PositionTop TabPosition = 0
	// Places the tab bar at the bottom. The tab bar's [graphics.gd/classdb/StyleBox] will be flipped vertically.
	PositionBottom TabPosition = 1
	// Represents the size of the [TabPosition] enum.
	PositionMax TabPosition = 2
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.