Struct gdnative_bindings_lily::tab_container::TabContainer

pub struct TabContainer { /* fields omitted */ }

core class TabContainer inherits Container (unsafe).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

TabContainer is a reference-only type. Persistent references can only exist in the unsafe Ref<TabContainer> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

TabContainer inherits methods from:

• Container
• Control
• CanvasItem
• Node
• Object

Safety

All types in the Godot API have “interior mutability” in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl TabContainer

Constants

pub const ALIGN_CENTER: i64

pub const ALIGN_LEFT: i64

pub const ALIGN_RIGHT: i64

impl TabContainer

pub fn new() -> Ref<Self, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn are_tabs_visible(&self) -> bool

If true, tabs are visible. If false, tabs’ content and titles are hidden.

pub fn current_tab(&self) -> i64

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.

pub fn get_current_tab_control(&self) -> Option<Ref<Control, Shared>>

Returns the child Control node located at the active tab index.

pub fn drag_to_rearrange_enabled(&self) -> bool

If true, tabs can be rearranged with mouse drag.

pub fn get_popup(&self) -> Option<Ref<Popup, Shared>>

Returns the Popup node instance if one has been set already with [method set_popup].

pub fn get_previous_tab(&self) -> i64

Returns the previously active tab index.

pub fn tab_align(&self) -> TabAlign

The alignment of all tabs in the tab container. See the [enum TabAlign] constants for details.

pub fn get_tab_control(&self, tab_idx: i64) -> Option<Ref<Control, Shared>>

Returns the Control node from the tab at index tab_idx.

pub fn get_tab_count(&self) -> i64

Returns the number of tabs.

pub fn get_tab_disabled(&self, tab_idx: i64) -> bool

Returns true if the tab at index tab_idx is disabled.

pub fn get_tab_icon(&self, tab_idx: i64) -> Option<Ref<Texture, Shared>>

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

pub fn get_tab_title(&self, tab_idx: i64) -> GodotString

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 [method set_tab_title].

pub fn get_tabs_rearrange_group(&self) -> i64

Returns the TabContainer rearrange group id.

pub fn use_hidden_tabs_for_min_size(&self) -> bool

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.

pub fn is_all_tabs_in_front(&self) -> bool

pub fn set_all_tabs_in_front(&self, is_front: bool)

pub fn set_current_tab(&self, tab_idx: i64)

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.

pub fn set_drag_to_rearrange_enabled(&self, enabled: bool)

If true, tabs can be rearranged with mouse drag.

pub fn set_popup(&self, popup: impl AsArg<Node>)

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.

pub fn set_tab_align(&self, align: i64)

The alignment of all tabs in the tab container. See the [enum TabAlign] constants for details.

pub fn set_tab_disabled(&self, tab_idx: i64, disabled: bool)

If disabled is false, hides the tab at index tab_idx. Note: Its title text will remain, unless also removed with [method set_tab_title].

pub fn set_tab_icon(&self, tab_idx: i64, icon: impl AsArg<Texture>)

Sets an icon for the tab at index tab_idx.

pub fn set_tab_title(&self, tab_idx: i64, title: impl Into<GodotString>)

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 [method set_tab_title].

pub fn set_tabs_rearrange_group(&self, group_id: i64)

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

pub fn set_tabs_visible(&self, visible: bool)

If true, tabs are visible. If false, tabs’ content and titles are hidden.

pub fn set_use_hidden_tabs_for_min_size(&self, enabled: bool)

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.

Methods from Deref<Target = Container>

pub const NOTIFICATION_SORT_CHILDREN: i64

pub fn fit_child_in_rect(&self, child: impl AsArg<Control>, rect: Rect2)

Fit a child control in a given rect. This is mainly a helper for creating custom container classes.

pub fn queue_sort(&self)

Queue resort of the contained children. This is called automatically anyway, but can be called upon request.

Trait Implementations

impl Debug for TabContainer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for TabContainer

type Target = Container

The resulting type after dereferencing.

fn deref(&self) -> &Container

Dereferences the value.

impl DerefMut for TabContainer

fn deref_mut(&mut self) -> &mut Container

Mutably dereferences the value.

impl GodotObject for TabContainer

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for TabContainer

fn construct() -> Ref<Self, Unique>

impl QueueFree for TabContainer

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for TabContainer

impl SubClass<CanvasItem> for TabContainer

impl SubClass<Container> for TabContainer

impl SubClass<Control> for TabContainer

impl SubClass<Node> for TabContainer

impl SubClass<Object> for TabContainer