Struct gdnative::Button

pub struct Button { /* fields omitted */ }

core class Button inherits BaseButton (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.

Button is an unsafe pointer, and all of its methods are unsafe.

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

Class hierarchy

Button inherits methods from:

• BaseButton
• Control
• CanvasItem
• Node
• Object

Methods

impl Button

Constants

pub const ALIGN_LEFT: i64

pub const ALIGN_CENTER: i64

pub const ALIGN_RIGHT: i64

impl Button

pub fn new() -> Button

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 unsafe fn get_button_icon(&self) -> Option<Texture>

pub unsafe fn get_clip_text(&self) -> bool

pub unsafe fn get_text(&self) -> GodotString

pub unsafe fn get_text_align(&self) -> ButtonTextAlign

pub unsafe fn is_expand_icon(&self) -> bool

pub unsafe fn is_flat(&self) -> bool

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

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

pub unsafe fn set_expand_icon(&mut self, arg0: bool)

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

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

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

pub unsafe fn to_base_button(&self) -> BaseButton

Up-cast.

pub unsafe fn to_control(&self) -> Control

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = BaseButton>

pub const ACTION_MODE_BUTTON_PRESS: i64

pub const DRAW_PRESSED: i64

pub const DRAW_DISABLED: i64

pub const ACTION_MODE_BUTTON_RELEASE: i64

pub const DRAW_HOVER: i64

pub const DRAW_HOVER_PRESSED: i64

pub const DRAW_NORMAL: i64

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

pub unsafe fn _pressed(&mut self)

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

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

pub unsafe fn get_action_mode(&self) -> BaseButtonActionMode

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

pub unsafe fn get_button_mask(&self) -> i64

pub unsafe fn get_draw_mode(&self) -> BaseButtonDrawMode

pub unsafe fn get_enabled_focus_mode(&self) -> ControlFocusMode

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

pub unsafe fn is_disabled(&self) -> bool

pub unsafe fn is_hovered(&self) -> bool

pub unsafe fn is_keep_pressed_outside(&self) -> bool

pub unsafe fn is_pressed(&self) -> bool

pub unsafe fn is_shortcut_in_tooltip_enabled(&self) -> bool

pub unsafe fn is_toggle_mode(&self) -> bool

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

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

pub unsafe fn set_button_mask(&mut self, mask: i64)

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

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

pub unsafe fn set_keep_pressed_outside(&mut self, enabled: bool)

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

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

pub unsafe fn set_shortcut_in_tooltip(&mut self, enabled: bool)

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

pub unsafe fn to_control(&self) -> Control

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Trait Implementations

impl Clone for Button

fn clone(&self) -> Button

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Button

impl Debug for Button

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

Formats the value using the given formatter.

impl Deref for Button

type Target = BaseButton

The resulting type after dereferencing.

fn deref(&self) -> &BaseButton

Dereferences the value.

impl DerefMut for Button

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

Mutably dereferences the value.

impl Free for Button

unsafe fn godot_free(self)

impl FromVariant for Button

fn from_variant(variant: &Variant) -> Result<Button, FromVariantError>

impl GodotObject for Button

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> Button

unsafe fn from_return_position_sys(obj: *mut c_void) -> Button

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

impl Instanciable for Button

fn construct() -> Button

impl QueueFree for Button

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Button

fn to_variant(&self) -> Variant