Struct gdnative::OptionButton

pub struct OptionButton { /* fields omitted */ }

core class OptionButton 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.

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

Class hierarchy

OptionButton inherits methods from:

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

Methods

impl OptionButton

pub fn new() -> OptionButton

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _focused(&mut self, arg0: i64)

pub unsafe fn _get_items(&self) -> VariantArray

pub unsafe fn _select_int(&mut self, arg0: i64)

pub unsafe fn _selected(&mut self, arg0: i64)

pub unsafe fn _set_items(&mut self, arg0: VariantArray)

pub unsafe fn add_icon_item(
    &mut self,
    texture: Option<Texture>,
    label: GodotString,
    id: i64
)

pub unsafe fn add_item(&mut self, label: GodotString, id: i64)

pub unsafe fn add_separator(&mut self)

pub unsafe fn clear(&mut self)

pub unsafe fn get_item_count(&self) -> i64

pub unsafe fn get_item_icon(&self, idx: i64) -> Option<Texture>

pub unsafe fn get_item_id(&self, idx: i64) -> i64

pub unsafe fn get_item_index(&self, id: i64) -> i64

pub unsafe fn get_item_metadata(&self, idx: i64) -> Variant

pub unsafe fn get_item_text(&self, idx: i64) -> GodotString

pub unsafe fn get_popup(&self) -> Option<PopupMenu>

pub unsafe fn get_selected(&self) -> i64

pub unsafe fn get_selected_id(&self) -> i64

pub unsafe fn get_selected_metadata(&self) -> Variant

pub unsafe fn is_item_disabled(&self, idx: i64) -> bool

pub unsafe fn remove_item(&mut self, idx: i64)

pub unsafe fn select(&mut self, idx: i64)

pub unsafe fn set_item_disabled(&mut self, idx: i64, disabled: bool)

pub unsafe fn set_item_icon(&mut self, idx: i64, texture: Option<Texture>)

pub unsafe fn set_item_id(&mut self, idx: i64, id: i64)

pub unsafe fn set_item_metadata(&mut self, idx: i64, metadata: Variant)

pub unsafe fn set_item_text(&mut self, idx: i64, text: GodotString)

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

Generic dynamic cast.

Methods from Deref<Target = Button>

pub const ALIGN_LEFT: i64

pub const ALIGN_RIGHT: i64

pub const ALIGN_CENTER: 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_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.

Trait Implementations

impl Clone for OptionButton

fn clone(&self) -> OptionButton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OptionButton

impl Debug for OptionButton

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

Formats the value using the given formatter.

impl Deref for OptionButton

type Target = Button

The resulting type after dereferencing.

fn deref(&self) -> &Button

Dereferences the value.

impl DerefMut for OptionButton

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

Mutably dereferences the value.

impl Free for OptionButton

unsafe fn godot_free(self)

impl FromVariant for OptionButton

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

impl GodotObject for OptionButton

fn class_name() -> &'static str

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

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

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

impl Instanciable for OptionButton

fn construct() -> OptionButton

impl QueueFree for OptionButton

unsafe fn godot_queue_free(&mut self)

impl ToVariant for OptionButton

fn to_variant(&self) -> Variant