Struct gdnative::api::ScrollContainer

pub struct ScrollContainer { /* fields omitted */ }

core class ScrollContainer inherits Container (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.

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

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

pub fn new() -> Ref<ScrollContainer, 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 deadzone(&self) -> i64

pub fn h_scroll(&self) -> i64

The current horizontal scroll value.

pub fn get_h_scrollbar(&self) -> Option<Ref<HScrollBar, Shared>>

Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer].

pub fn v_scroll(&self) -> i64

The current vertical scroll value.

pub fn get_v_scrollbar(&self) -> Option<Ref<VScrollBar, Shared>>

Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer].

pub fn is_following_focus(&self) -> bool

If [code]true[/code], the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.

pub fn is_h_scroll_enabled(&self) -> bool

If [code]true[/code], enables horizontal scrolling.

pub fn is_v_scroll_enabled(&self) -> bool

If [code]true[/code], enables vertical scrolling.

pub fn set_deadzone(&self, deadzone: i64)

pub fn set_enable_h_scroll(&self, enable: bool)

If [code]true[/code], enables horizontal scrolling.

pub fn set_enable_v_scroll(&self, enable: bool)

If [code]true[/code], enables vertical scrolling.

pub fn set_follow_focus(&self, enabled: bool)

If [code]true[/code], the ScrollContainer will automatically scroll to focused children (including indirect children) to make sure they are fully visible.

pub fn set_h_scroll(&self, value: i64)

The current horizontal scroll value.

pub fn set_v_scroll(&self, value: i64)

The current vertical scroll value.

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 ScrollContainer

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

Formats the value using the given formatter.

impl Deref for ScrollContainer

type Target = Container

The resulting type after dereferencing.

fn deref(&self) -> &Container

Dereferences the value.

impl DerefMut for ScrollContainer

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

Mutably dereferences the value.

impl GodotObject for ScrollContainer

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 ScrollContainer

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

impl QueueFree for ScrollContainer

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for ScrollContainer

impl SubClass<Container> for ScrollContainer

impl SubClass<Control> for ScrollContainer

impl SubClass<Node> for ScrollContainer

impl SubClass<Object> for ScrollContainer

impl SubClass<ScrollContainer> for EditorInspector