Struct gdnative::api::SpinBox

pub struct SpinBox { /* fields omitted */ }

core class SpinBox inherits Range (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.

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

SpinBox inherits methods from:

• 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 SpinBox

pub fn new() -> Ref<SpinBox, 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 apply(&self)

Applies the current value of this [SpinBox].

pub fn align(&self) -> Align

Sets the text alignment of the [SpinBox].

pub fn get_line_edit(&self) -> Option<Ref<LineEdit, Shared>>

Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit].

pub fn prefix(&self) -> GodotString

Adds the specified [code]prefix[/code] string before the numerical value of the [SpinBox].

pub fn suffix(&self) -> GodotString

Adds the specified [code]suffix[/code] string after the numerical value of the [SpinBox].

pub fn is_editable(&self) -> bool

If [code]true[/code], the [SpinBox] will be editable. Otherwise, it will be read only.

pub fn set_align(&self, align: i64)

Sets the text alignment of the [SpinBox].

pub fn set_editable(&self, editable: bool)

If [code]true[/code], the [SpinBox] will be editable. Otherwise, it will be read only.

pub fn set_prefix(&self, prefix: impl Into<GodotString>)

Adds the specified [code]prefix[/code] string before the numerical value of the [SpinBox].

pub fn set_suffix(&self, suffix: impl Into<GodotString>)

Adds the specified [code]suffix[/code] string after the numerical value of the [SpinBox].

Methods from Deref<Target = Range>

pub fn as_ratio(&self) -> f64

The value mapped between 0 and 1.

pub fn max(&self) -> f64

Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code].

pub fn min(&self) -> f64

Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code].

pub fn page(&self) -> f64

Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code].

pub fn step(&self) -> f64

If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer.

pub fn value(&self) -> f64

Range's current value.

pub fn is_greater_allowed(&self) -> bool

If [code]true[/code], [member value] may be greater than [member max_value].

pub fn is_lesser_allowed(&self) -> bool

If [code]true[/code], [member value] may be less than [member min_value].

pub fn is_ratio_exp(&self) -> bool

If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly.

pub fn is_using_rounded_values(&self) -> bool

If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer.

pub fn set_allow_greater(&self, allow: bool)

If [code]true[/code], [member value] may be greater than [member max_value].

pub fn set_allow_lesser(&self, allow: bool)

If [code]true[/code], [member value] may be less than [member min_value].

pub fn set_as_ratio(&self, value: f64)

The value mapped between 0 and 1.

pub fn set_exp_ratio(&self, enabled: bool)

If [code]true[/code], and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly.

pub fn set_max(&self, maximum: f64)

Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code].

pub fn set_min(&self, minimum: f64)

Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code].

pub fn set_page(&self, pagesize: f64)

Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code].

pub fn set_step(&self, step: f64)

If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer.

pub fn set_use_rounded_values(&self, enabled: bool)

If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer.

pub fn set_value(&self, value: f64)

Range's current value.

pub fn share(&self, with: impl AsArg<Node>)

Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group.

pub fn unshare(&self)

Stops range from sharing its member variables with any other.

Trait Implementations

impl Debug for SpinBox

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

Formats the value using the given formatter.

impl Deref for SpinBox

type Target = Range

The resulting type after dereferencing.

fn deref(&self) -> &Range

Dereferences the value.

impl DerefMut for SpinBox

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

Mutably dereferences the value.

impl GodotObject for SpinBox

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 SpinBox

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

impl QueueFree for SpinBox

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for SpinBox

impl SubClass<Control> for SpinBox

impl SubClass<Node> for SpinBox

impl SubClass<Object> for SpinBox

impl SubClass<Range> for SpinBox