Struct gdnative::api::SplitContainer

pub struct SplitContainer { /* fields omitted */ }

core class SplitContainer inherits Container (unsafe).

Official documentation

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

Class hierarchy

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

Constants

pub const DRAGGER_HIDDEN: i64

pub const DRAGGER_HIDDEN_COLLAPSED: i64

pub const DRAGGER_VISIBLE: i64

impl SplitContainer

pub fn clamp_split_offset(&self)

Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values.

pub fn dragger_visibility(&self) -> DraggerVisibility

Determines the dragger's visibility. See [enum DraggerVisibility] for details.

pub fn split_offset(&self) -> i64

The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control].

pub fn is_collapsed(&self) -> bool

If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled.

pub fn set_collapsed(&self, collapsed: bool)

If [code]true[/code], the area of the first [Control] will be collapsed and the dragger will be disabled.

pub fn set_dragger_visibility(&self, mode: i64)

Determines the dragger's visibility. See [enum DraggerVisibility] for details.

pub fn set_split_offset(&self, offset: i64)

The initial offset of the splitting between the two [Control]s, with [code]0[/code] being at the end of the first [Control].

Methods from Deref<Target = Container>

pub const NOTIFICATION_SORT_CHILDREN: i64

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

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 SplitContainer

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

Formats the value using the given formatter.

impl Deref for SplitContainer

type Target = Container

The resulting type after dereferencing.

fn deref(&self) -> &Container

Dereferences the value.

impl DerefMut for SplitContainer

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

Mutably dereferences the value.

impl GodotObject for SplitContainer

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 SplitContainer

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for SplitContainer

impl SubClass<Container> for SplitContainer

impl SubClass<Control> for SplitContainer

impl SubClass<Node> for SplitContainer

impl SubClass<Object> for SplitContainer

impl SubClass<SplitContainer> for HSplitContainer

impl SubClass<SplitContainer> for VSplitContainer