Struct gdnative::api::HSplitContainer

pub struct HSplitContainer { /* fields omitted */ }

core class HSplitContainer inherits SplitContainer (unsafe).

Official documentation

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

Memory management

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

HSplitContainer is a reference-only type. Persistent references can only exist in the unsafe Ref<HSplitContainer> 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

HSplitContainer inherits methods from:

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

pub fn new() -> Ref<HSplitContainer, 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.

Methods from Deref<Target = SplitContainer>

pub const DRAGGER_HIDDEN: i64

pub const DRAGGER_HIDDEN_COLLAPSED: i64

pub const DRAGGER_VISIBLE: i64

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

Trait Implementations

impl Debug for HSplitContainer

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

Formats the value using the given formatter.

impl Deref for HSplitContainer

type Target = SplitContainer

The resulting type after dereferencing.

fn deref(&self) -> &SplitContainer

Dereferences the value.

impl DerefMut for HSplitContainer

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

Mutably dereferences the value.

impl GodotObject for HSplitContainer

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 Instanciable for HSplitContainer

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

impl QueueFree for HSplitContainer

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for HSplitContainer

impl SubClass<Container> for HSplitContainer

impl SubClass<Control> for HSplitContainer

impl SubClass<Node> for HSplitContainer

impl SubClass<Object> for HSplitContainer

impl SubClass<SplitContainer> for HSplitContainer