Struct gdnative_bindings::ToolButton

pub struct ToolButton { /* fields omitted */ }

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

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

Class hierarchy

ToolButton inherits methods from:

• Button
• BaseButton
• Control
• CanvasItem
• Node
• Object

Methods

impl ToolButton

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn to_button(&self) -> Button

Up-cast.

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: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = Button>

pub const ALIGN_RIGHT: i64

pub const ALIGN_CENTER: i64

pub const ALIGN_LEFT: i64

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_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_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: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for ToolButton

fn clone(&self) -> ToolButton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ToolButton

impl Debug for ToolButton

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

Formats the value using the given formatter.

impl Deref for ToolButton

type Target = Button

The resulting type after dereferencing.

fn deref(&self) -> &Button

Dereferences the value.

impl DerefMut for ToolButton

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

Mutably dereferences the value.

impl Free for ToolButton

unsafe fn godot_free(self)

impl FromVariant for ToolButton

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for ToolButton

fn class_name() -> &'static str

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

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

impl Instanciable for ToolButton

fn construct() -> Self

impl QueueFree for ToolButton

unsafe fn godot_queue_free(&mut self)

impl ToVariant for ToolButton

fn to_variant(&self) -> Variant