Struct gdnative::api::VSlider

pub struct VSlider { /* fields omitted */ }

core class VSlider inherits Slider (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.

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

VSlider inherits methods from:

• Slider
• Range
• 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 VSlider

pub fn new() -> Ref<VSlider, 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 = Slider>

pub fn ticks(&self) -> i64

Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.

pub fn ticks_on_borders(&self) -> bool

If [code]true[/code], the slider will display ticks for minimum and maximum values.

pub fn is_editable(&self) -> bool

If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code.

pub fn is_scrollable(&self) -> bool

If [code]true[/code], the value can be changed using the mouse wheel.

pub fn set_editable(&self, editable: bool)

If [code]true[/code], the slider can be interacted with. If [code]false[/code], the value can be changed only by code.

pub fn set_scrollable(&self, scrollable: bool)

If [code]true[/code], the value can be changed using the mouse wheel.

pub fn set_ticks(&self, count: i64)

Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.

pub fn set_ticks_on_borders(&self, ticks_on_border: bool)

If [code]true[/code], the slider will display ticks for minimum and maximum values.

Trait Implementations

impl Debug for VSlider

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

Formats the value using the given formatter.

impl Deref for VSlider

type Target = Slider

The resulting type after dereferencing.

fn deref(&self) -> &Slider

Dereferences the value.

impl DerefMut for VSlider

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

Mutably dereferences the value.

impl GodotObject for VSlider

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 VSlider

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

impl QueueFree for VSlider

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for VSlider

impl SubClass<Control> for VSlider

impl SubClass<Node> for VSlider

impl SubClass<Object> for VSlider

impl SubClass<Range> for VSlider

impl SubClass<Slider> for VSlider