Struct xplm::menu::Menu

source ·

pub struct Menu { /* private fields */ }

Expand description

A menu, which contains zero or more items

Implementations§

source

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

Creates a new menu with the provided name

Returns an error if the name contains a null byte

Examples found in repository ?

examples/menus.rs (line 20)

    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,
        })
    }

source

pub fn name(&self) -> String

Returns the name of this menu

source

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

Sets the name of this menu

Returns an error if the name contains a null byte

source

pub fn add_child<R, C>(&self, child: R)
where R: Into<Rc<C>>, Rc<C>: Into<Item>,

Adds a child to this menu The child argument may be a Menu, ActionItem, CheckItem, or Separator, or an Rc containing one of these types.

Examples found in repository ?

examples/menus.rs (line 21)

    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,
        })
    }

source

pub fn add_to_plugins_menu(&self)

Adds this menu as a child of the plugins menu

Examples found in repository ?

examples/menus.rs (line 23)

    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,
        })
    }