Struct gdnative::Button

pub struct Button { /* fields omitted */ }

core class Button : BaseButton (manually managed)

Base class

Button inherits BaseButton and all of its methods.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine. In the cases where Rust code owns an object of this type, ownership should be either passed to the engine or the object must be manually destroyed using Button::free.

Methods

impl Button

pub fn as_base_button(&self) -> BaseButton

Up-cast.

pub fn new() -> Self

Constructor.

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 Button::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub fn set_text(&mut self, text: GodotString)

pub fn get_text(&self) -> GodotString

pub fn set_button_icon(&mut self, texture: Option<Texture>)

pub fn get_button_icon(&self) -> Option<Texture>

pub fn set_flat(&mut self, enabled: bool)

pub fn set_clip_text(&mut self, enabled: bool)

pub fn get_clip_text(&self) -> bool

pub fn set_text_align(&mut self, align: i64)

pub fn is_flat(&self) -> bool

pub fn cast<T: GodotObject>(&self) -> Option<T>

Methods from Deref<Target = BaseButton>

pub fn as_control(&self) -> Control

Up-cast.

pub fn _pressed(&mut self)

pub fn _toggled(&mut self, button_pressed: bool)

pub fn _gui_input(&mut self, arg0: Option<InputEvent>)

pub fn _unhandled_input(&mut self, arg0: Option<InputEvent>)

pub fn set_pressed(&mut self, pressed: bool)

pub fn is_pressed(&self) -> bool

pub fn is_hovered(&self) -> bool

pub fn set_toggle_mode(&mut self, enabled: bool)

pub fn is_toggle_mode(&self) -> bool

pub fn set_disabled(&mut self, disabled: bool)

pub fn is_disabled(&self) -> bool

pub fn set_action_mode(&mut self, mode: i64)

pub fn set_enabled_focus_mode(&mut self, mode: i64)

pub fn set_shortcut(&mut self, shortcut: Option<ShortCut>)

pub fn get_shortcut(&self) -> Option<ShortCut>

pub fn set_button_group(&mut self, button_group: Option<ButtonGroup>)

pub fn get_button_group(&self) -> Option<ButtonGroup>

pub fn cast<T: GodotObject>(&self) -> Option<T>

Trait Implementations

impl GodotObject for Button

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Deref for Button

type Target = BaseButton

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Button

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.