Struct druid::menu::MenuItem

pub struct MenuItem<T> { /* private fields */ }

An item in a menu.

See the module level documentation for more on how to use menus.

Implementations

impl<T: Data> MenuItem<T>

pub fn new(title: impl Into<LabelText<T>>) -> MenuItem<T>

Create a new menu item with a given name.

pub fn on_activate(
    self,
    on_activate: impl FnMut(&mut MenuEventCtx<'_>, &mut T, &Env) + 'static
) -> Self

Provide a callback that will be invoked when this menu item is chosen.

pub fn command(self, cmd: impl Into<Command>) -> Self

Provide a Command that will be sent when this menu item is chosen.

This is equivalent to self.on_activate(move |ctx, _data, _env| ctx.submit_command(cmd)). If the command’s target is Target::Auto, it will be sent to the menu’s window if the menu is associated with a window, or to Target::Global if the menu is not associated with a window.

pub fn hotkey(self, mods: impl Into<Option<RawMods>>, key: impl IntoKey) -> Self

Provide a hotkey for activating this menu item.

This is equivalent to self.dynamic_hotkey(move |_, _| Some(HotKey::new(mods, key))

pub fn dynamic_hotkey(
    self,
    hotkey: impl FnMut(&T, &Env) -> Option<HotKey> + 'static
) -> Self

Provide a dynamic hotkey for activating this menu item.

The hotkey can change depending on the data.

pub fn enabled_if(self, enabled: impl FnMut(&T, &Env) -> bool + 'static) -> Self

Provide a callback for determining whether this menu item should be enabled.

Whenever the callback returns true, the item will be enabled.

pub fn enabled(self, enabled: bool) -> Self

Enable or disable this menu item.

pub fn selected_if(
    self,
    selected: impl FnMut(&T, &Env) -> bool + 'static
) -> Self

Provide a callback for determining whether this menu item should be selected.

Whenever the callback returns true, the item will be selected.

pub fn selected(self, selected: bool) -> Self

Select or deselect this menu item.

pub fn lens<S: Data>(self, lens: impl Lens<S, T> + 'static) -> MenuEntry<S>

Wraps this menu item in a lens, so that it can be added to a Menu<S>.

Trait Implementations

impl<T: Data> From<MenuItem<T>> for MenuEntry<T>

fn from(i: MenuItem<T>) -> MenuEntry<T>

Converts to this type from the input type.