Struct gdnative::PopupMenu

pub struct PopupMenu { /* fields omitted */ }

core class PopupMenu inherits Popup (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.

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

Class hierarchy

PopupMenu inherits methods from:

• Popup
• Control
• CanvasItem
• Node
• Object

Methods

impl PopupMenu

pub fn new() -> PopupMenu

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _get_items(&self) -> VariantArray

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

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

pub unsafe fn _submenu_timeout(&mut self)

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

pub unsafe fn add_check_shortcut(
    &mut self,
    shortcut: Option<ShortCut>,
    id: i64,
    global: bool
)

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

pub unsafe fn add_icon_check_shortcut(
    &mut self,
    texture: Option<Texture>,
    shortcut: Option<ShortCut>,
    id: i64,
    global: bool
)

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

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

pub unsafe fn add_icon_radio_check_shortcut(
    &mut self,
    texture: Option<Texture>,
    shortcut: Option<ShortCut>,
    id: i64,
    global: bool
)

pub unsafe fn add_icon_shortcut(
    &mut self,
    texture: Option<Texture>,
    shortcut: Option<ShortCut>,
    id: i64,
    global: bool
)

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

pub unsafe fn add_multistate_item(
    &mut self,
    label: GodotString,
    max_states: i64,
    default_state: i64,
    id: i64,
    accel: i64
)

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

pub unsafe fn add_radio_check_shortcut(
    &mut self,
    shortcut: Option<ShortCut>,
    id: i64,
    global: bool
)

pub unsafe fn add_separator(&mut self, label: GodotString)

pub unsafe fn add_shortcut(
    &mut self,
    shortcut: Option<ShortCut>,
    id: i64,
    global: bool
)

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

pub unsafe fn clear(&mut self)

pub unsafe fn get_allow_search(&self) -> bool

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

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_shortcut(&self, idx: i64) -> Option<ShortCut>

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

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

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

pub unsafe fn get_submenu_popup_delay(&self) -> f64

pub unsafe fn is_hide_on_checkable_item_selection(&self) -> bool

pub unsafe fn is_hide_on_item_selection(&self) -> bool

pub unsafe fn is_hide_on_state_item_selection(&self) -> bool

pub unsafe fn is_hide_on_window_lose_focus(&self) -> bool

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

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

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

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

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

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

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

pub unsafe fn set_allow_search(&mut self, allow: bool)

pub unsafe fn set_hide_on_checkable_item_selection(&mut self, enable: bool)

pub unsafe fn set_hide_on_item_selection(&mut self, enable: bool)

pub unsafe fn set_hide_on_state_item_selection(&mut self, enable: bool)

pub unsafe fn set_hide_on_window_lose_focus(&mut self, enable: bool)

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

pub unsafe fn set_item_as_checkable(&mut self, idx: i64, enable: bool)

pub unsafe fn set_item_as_radio_checkable(&mut self, idx: i64, enable: bool)

pub unsafe fn set_item_as_separator(&mut self, idx: i64, enable: bool)

pub unsafe fn set_item_checked(&mut self, idx: i64, checked: bool)

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

pub unsafe fn set_item_icon(&mut self, idx: i64, icon: 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_multistate(&mut self, idx: i64, state: i64)

pub unsafe fn set_item_shortcut(
    &mut self,
    idx: i64,
    shortcut: Option<ShortCut>,
    global: bool
)

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

pub unsafe fn set_item_submenu(&mut self, idx: i64, submenu: GodotString)

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

pub unsafe fn set_item_tooltip(&mut self, idx: i64, tooltip: GodotString)

pub unsafe fn set_submenu_popup_delay(&mut self, seconds: f64)

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

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

pub unsafe fn to_popup(&self) -> Popup

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 = Popup>

pub const NOTIFICATION_POST_POPUP: i64

pub const NOTIFICATION_POPUP_HIDE: i64

pub unsafe fn is_exclusive(&self) -> bool

pub unsafe fn popup(&mut self, bounds: Rect<f32, UnknownUnit>)

pub unsafe fn popup_centered(&mut self, size: Vector2D<f32, UnknownUnit>)

pub unsafe fn popup_centered_clamped(
    &mut self,
    size: Vector2D<f32, UnknownUnit>,
    fallback_ratio: f64
)

pub unsafe fn popup_centered_minsize(
    &mut self,
    minsize: Vector2D<f32, UnknownUnit>
)

pub unsafe fn popup_centered_ratio(&mut self, ratio: f64)

pub unsafe fn set_as_minsize(&mut self)

pub unsafe fn set_exclusive(&mut self, enable: 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 PopupMenu

fn clone(&self) -> PopupMenu

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PopupMenu

impl Debug for PopupMenu

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

Formats the value using the given formatter.

impl Deref for PopupMenu

type Target = Popup

The resulting type after dereferencing.

fn deref(&self) -> &Popup

Dereferences the value.

impl DerefMut for PopupMenu

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

Mutably dereferences the value.

impl Free for PopupMenu

unsafe fn godot_free(self)

impl FromVariant for PopupMenu

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

impl GodotObject for PopupMenu

fn class_name() -> &'static str

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

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

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

impl Instanciable for PopupMenu

fn construct() -> PopupMenu

impl QueueFree for PopupMenu

unsafe fn godot_queue_free(&mut self)

impl ToVariant for PopupMenu

fn to_variant(&self) -> Variant