Struct ActionItem

pub struct ActionItem { /* private fields */ }

An item that can be clicked on to perform an action

Implementations

impl ActionItem

pub fn new<S: Into<String>, H: MenuClickHandler>( name: S, handler: H, ) -> Result<Self, NulError>

Creates a new item

Returns an error if the name contains a null byte

Examples found in repository

examples/menus.rs (line 22)

    fn start() -> Result<Self, Self::Error> {
        let plugins_submenu = Menu::new("Menu Test Plugin").unwrap();
        plugins_submenu.add_child(CheckItem::new("Checkable 1", false, CheckHandler1).unwrap());
        plugins_submenu.add_child(ActionItem::new("Action 1", ActionHandler1).unwrap());
        plugins_submenu.add_to_plugins_menu();

        // The menu needs to be part of the plugin struct, or it will immediately get dropped and
        // will not appear
        Ok(MenuPlugin {
            _plugins_submenu: plugins_submenu,
        })
    }

pub fn name(&self) -> String

Returns the name of this item

pub fn set_name(&self, name: &str) -> Result<(), NulError>

Sets the name of this item

Returns an error if the name contains a null byte

Trait Implementations

impl Debug for ActionItem

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

Formats the value using the given formatter.

impl Drop for ActionItem

Removes this menu from X-Plane, to prevent the menu handler from running and accessing a dangling pointer

fn drop(&mut self)

Executes the destructor for this type.