[−][src]Struct gdnative::api::VSlider
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:
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
[src]
pub fn new() -> Ref<VSlider, Unique>
[src]
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
[src]
Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers.
pub fn ticks_on_borders(&self) -> bool
[src]
If [code]true[/code], the slider will display ticks for minimum and maximum values.
pub fn is_editable(&self) -> bool
[src]
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
[src]
If [code]true[/code], the value can be changed using the mouse wheel.
pub fn set_editable(&self, editable: bool)
[src]
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)
[src]
If [code]true[/code], the value can be changed using the mouse wheel.
pub fn set_ticks(&self, count: i64)
[src]
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)
[src]
If [code]true[/code], the slider will display ticks for minimum and maximum values.
Trait Implementations
impl Debug for VSlider
[src]
impl Deref for VSlider
[src]
impl DerefMut for VSlider
[src]
impl GodotObject for VSlider
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for VSlider
[src]
impl QueueFree for VSlider
[src]
unsafe fn godot_queue_free(obj: *mut c_void)
[src]
impl SubClass<CanvasItem> for VSlider
[src]
impl SubClass<Control> for VSlider
[src]
impl SubClass<Node> for VSlider
[src]
impl SubClass<Object> for VSlider
[src]
impl SubClass<Range> for VSlider
[src]
impl SubClass<Slider> for VSlider
[src]
Auto Trait Implementations
impl RefUnwindSafe for VSlider
impl !Send for VSlider
impl !Sync for VSlider
impl Unpin for VSlider
impl UnwindSafe for VSlider
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,