Struct gdnative_bindings::BoxContainer

pub struct BoxContainer { /* fields omitted */ }

core class BoxContainer inherits Container (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Class hierarchy

BoxContainer 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 BoxContainer

Constants

pub const ALIGN_BEGIN: i64

pub const ALIGN_CENTER: i64

pub const ALIGN_END: i64

impl BoxContainer

pub fn add_spacer(&self, begin: bool)

Adds a control to the box as a spacer. If [code]true[/code], [code]begin[/code] will insert the spacer control in front of other children.

pub fn alignment(&self) -> AlignMode

The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]).

pub fn set_alignment(&self, alignment: i64)

The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]).

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 BoxContainer

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

Formats the value using the given formatter.

impl Deref for BoxContainer

type Target = Container

The resulting type after dereferencing.

fn deref(&self) -> &Container

Dereferences the value.

impl DerefMut for BoxContainer

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

Mutably dereferences the value.

impl GodotObject for BoxContainer

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.

impl QueueFree for BoxContainer

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for BoxContainer

impl SubClass<BoxContainer> for HBoxContainer

impl SubClass<BoxContainer> for FileSystemDock

impl SubClass<BoxContainer> for ColorPicker

impl SubClass<BoxContainer> for VBoxContainer

impl SubClass<CanvasItem> for BoxContainer

impl SubClass<Container> for BoxContainer

impl SubClass<Control> for BoxContainer

impl SubClass<Node> for BoxContainer

impl SubClass<Object> for BoxContainer