Skip to main content

MenuItem

Struct MenuItem 

Source
pub struct MenuItem { /* private fields */ }
Expand description

A single selectable row inside a Menu.

Add with ui.add(MenuItem::new("…")) inside a menu body. The returned Response’s .clicked() fires on activation.

The optional icon, checked, and radio builders all reserve the same leading gutter, so toggle items in a menu align cleanly with action items as long as every item in that menu opts into one of them.

Implementations§

Source§

impl MenuItem

Source

pub fn new(label: impl Into<WidgetText>) -> Self

Create a menu item with the given label.

Source

pub fn shortcut(self, shortcut: impl Into<String>) -> Self

Display a keyboard-shortcut hint on the right (informational only — the actual shortcut is not bound).

Source

pub fn danger(self) -> Self

Render the item in the danger tone — red label, red hover highlight. Use for destructive actions.

Source

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

Disable the item. Disabled items do not fire clicked() and render with muted text.

Source

pub fn icon(self, icon: impl Into<WidgetText>) -> Self

Show a leading icon (any text, typically a unicode glyph) in the gutter to the left of the label. Reserves the gutter even when the glyph is narrow, so adjacent items align.

Source

pub fn checked(self, on: bool) -> Self

Render the item as a checkbox toggle: a checkmark in the leading gutter when on, an empty gutter when off. The item is announced via accesskit as a checkbox with the given selected state.

Source

pub fn radio(self, on: bool) -> Self

Render the item as a radio-button toggle: a filled dot in the leading gutter when on, an empty gutter when off. Use within a group of mutually-exclusive choices. Announced via accesskit as a radio button.

Trait Implementations§

Source§

impl Debug for MenuItem

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Widget for MenuItem

Source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.