Struct gdnative::prelude::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 a reference-only type. Persistent references can only exist in the unsafe Ref<Button> 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

Button inherits methods from:

• BaseButton
• 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 Button

Constants

pub const ALIGN_CENTER: i64

pub const ALIGN_LEFT: i64

pub const ALIGN_RIGHT: i64

impl Button

pub fn new() -> Ref<Button, 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 button_icon(&self) -> Option<Ref<Texture, Shared>>

Button's icon, if text is present the icon will be placed before the text.

pub fn clip_text(&self) -> bool

When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.

pub fn text(&self) -> GodotString

The button's text that will be displayed inside the button's area.

pub fn text_align(&self) -> TextAlign

Text alignment policy for the button's text, use one of the [enum TextAlign] constants.

pub fn is_expand_icon(&self) -> bool

When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect.

pub fn is_flat(&self) -> bool

Flat buttons don't display decoration.

pub fn set_button_icon(&self, texture: impl AsArg<Texture>)

Button's icon, if text is present the icon will be placed before the text.

pub fn set_clip_text(&self, enabled: bool)

When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text.

pub fn set_expand_icon(&self, arg0: bool)

When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect.

pub fn set_flat(&self, enabled: bool)

Flat buttons don't display decoration.

pub fn set_text(&self, text: impl Into<GodotString>)

The button's text that will be displayed inside the button's area.

pub fn set_text_align(&self, align: i64)

Text alignment policy for the button's text, use one of the [enum TextAlign] constants.

Methods from Deref<Target = BaseButton>

pub const ACTION_MODE_BUTTON_PRESS: i64

pub const ACTION_MODE_BUTTON_RELEASE: i64

pub const DRAW_DISABLED: i64

pub const DRAW_HOVER: i64

pub const DRAW_HOVER_PRESSED: i64

pub const DRAW_NORMAL: i64

pub const DRAW_PRESSED: i64

pub fn action_mode(&self) -> ActionMode

Determines when the button is considered clicked, one of the [enum ActionMode] constants.

pub fn button_group(&self) -> Option<Ref<ButtonGroup, Shared>>

[ButtonGroup] associated to the button.

pub fn button_mask(&self) -> i64

Binary mask to choose which mouse buttons this button will respond to.
			To allow both left-click and right-click, use [code]BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT[/code].

pub fn get_draw_mode(&self) -> DrawMode

Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the [enum DrawMode] enum.

pub fn enabled_focus_mode(&self) -> FocusMode

Focus access mode to use when switching between enabled/disabled (see [member Control.focus_mode] and [member disabled]).

pub fn shortcut(&self) -> Option<Ref<ShortCut, Shared>>

[ShortCut] associated to the button.

pub fn is_disabled(&self) -> bool

If [code]true[/code], the button is in disabled state and can't be clicked or toggled.

pub fn is_hovered(&self) -> bool

Returns [code]true[/code] if the mouse has entered the button and has not left it yet.

pub fn is_keep_pressed_outside(&self) -> bool

If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it.
			[b]Note:[/b] This property only affects the button's visual appearance. Signals will be emitted at the same moment regardless of this property's value.

pub fn is_pressed(&self) -> bool

If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active).

pub fn is_shortcut_in_tooltip_enabled(&self) -> bool

If [code]true[/code], the button will add information about its shortcut in the tooltip.

pub fn is_toggle_mode(&self) -> bool

If [code]true[/code], the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.

pub fn set_action_mode(&self, mode: i64)

Determines when the button is considered clicked, one of the [enum ActionMode] constants.

pub fn set_button_group(&self, button_group: impl AsArg<ButtonGroup>)

[ButtonGroup] associated to the button.

pub fn set_button_mask(&self, mask: i64)

Binary mask to choose which mouse buttons this button will respond to.
			To allow both left-click and right-click, use [code]BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT[/code].

pub fn set_disabled(&self, disabled: bool)

If [code]true[/code], the button is in disabled state and can't be clicked or toggled.

pub fn set_enabled_focus_mode(&self, mode: i64)

Focus access mode to use when switching between enabled/disabled (see [member Control.focus_mode] and [member disabled]).

pub fn set_keep_pressed_outside(&self, enabled: bool)

If [code]true[/code], the button stays pressed when moving the cursor outside the button while pressing it.
			[b]Note:[/b] This property only affects the button's visual appearance. Signals will be emitted at the same moment regardless of this property's value.

pub fn set_pressed(&self, pressed: bool)

If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if [member toggle_mode] is active).

pub fn set_shortcut(&self, shortcut: impl AsArg<ShortCut>)

[ShortCut] associated to the button.

pub fn set_shortcut_in_tooltip(&self, enabled: bool)

If [code]true[/code], the button will add information about its shortcut in the tooltip.

pub fn set_toggle_mode(&self, enabled: bool)

If [code]true[/code], the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.

Trait Implementations

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 GodotObject for Button

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 Button

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

impl QueueFree for Button

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<BaseButton> for Button

impl SubClass<Button> for ColorPickerButton

impl SubClass<Button> for OptionButton

impl SubClass<Button> for CheckButton

impl SubClass<Button> for MenuButton

impl SubClass<Button> for CheckBox

impl SubClass<Button> for ToolButton

impl SubClass<CanvasItem> for Button

impl SubClass<Control> for Button

impl SubClass<Node> for Button

impl SubClass<Object> for Button