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

An item in a menu.

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

Implementations§

§

impl<T> MenuItem<T>where T: Data,

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 ) -> MenuItem<T>

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

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

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 ) -> MenuItem<T>

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 ) -> MenuItem<T>

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 ) -> MenuItem<T>

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) -> MenuItem<T>

Enable or disable this menu item.

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

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) -> MenuItem<T>

Select or deselect this menu item.

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

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

Trait Implementations§

§

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

§

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

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for MenuItem<T>

§

impl<T> !Send for MenuItem<T>

§

impl<T> !Sync for MenuItem<T>

§

impl<T> Unpin for MenuItem<T>

§

impl<T> !UnwindSafe for MenuItem<T>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> RoundFrom<T> for T

§

fn round_from(x: T) -> T

Performs the conversion.
§

impl<T, U> RoundInto<U> for Twhere U: RoundFrom<T>,

§

fn round_into(self) -> U

Performs the conversion.
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more