Skip to main content

Menu

Struct Menu 

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

A vertical list of buttons, one per entry, as a popup menu shows them.

A click on an entry calls on_activate with its id, then closes the popups it is in. A click on an entry with a submenu calls on_open_submenu and opens the submenu as a popup next to it, with the same styles and handlers. Disabled entries ignore clicks. Each style takes a value or a closure.

use crabshell_ui::{Menu, MenuEntry, PopupWindow};

let quit = MenuEntry {
    id: 1,
    label: "Quit".into(),
    separator: false,
    enabled: true,
    toggle: None,
    checked: false,
    submenu: false,
    children: Vec::new(),
};
let popup = PopupWindow::new().child(
    Menu::new(vec![quit]).on_activate(|_cx, id| println!("clicked {id}")),
);

Implementations§

Source§

impl Menu

Source

pub fn new(entries: impl IntoProp<Vec<MenuEntry>>) -> Menu

A menu of entries: a list, or a closure that returns one.

Source

pub fn style(self, style: impl IntoProp<Style>) -> Menu

Sets the style of the menu’s box: its background, border and padding.

Source

pub fn item_style(self, style: impl IntoProp<Style>) -> Menu

Sets each entry’s style. The default pads the text 4 px above and below and 12 px left and right.

Source

pub fn hover_style(self, style: impl IntoProp<Style>) -> Menu

Sets the style laid over an entry under the pointer. The default is a faint gray background.

Source

pub fn separator_style(self, style: impl IntoProp<Style>) -> Menu

Sets a separator’s style. A separator is as tall as the style’s vertical padding twice; the default is a 2 px gray line.

Source

pub fn on_activate(self, handler: impl Fn(&Cx, i32) + 'static) -> Menu

Runs handler with an entry’s id when that entry is clicked.

Source

pub fn on_open_submenu(self, handler: impl Fn(&Cx, i32) + 'static) -> Menu

Runs handler with an entry’s id when its submenu opens, as a tray menu tells its app with open_submenu.

Trait Implementations§

Source§

impl Widget for Menu

Source§

fn into_element(self: Box<Self>) -> Element

Turns the description, and everything inside it, into the element the window builds nodes from. It runs when the window is created or a list item first appears, before the window’s tree is touched and without recording what it reads, so it only describes.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Menu

§

impl !Send for Menu

§

impl !Sync for Menu

§

impl !UnwindSafe for Menu

§

impl Forget for Menu

§

impl Freeze for Menu

§

impl Move for Menu

§

impl Unpin for Menu

§

impl UnsafeUnpin for Menu

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> Instrument for T

Source§

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

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

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 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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