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
impl Menu
Sourcepub fn new(entries: impl IntoProp<Vec<MenuEntry>>) -> Menu
pub fn new(entries: impl IntoProp<Vec<MenuEntry>>) -> Menu
A menu of entries: a list, or a closure that returns one.
Sourcepub fn style(self, style: impl IntoProp<Style>) -> Menu
pub fn style(self, style: impl IntoProp<Style>) -> Menu
Sets the style of the menu’s box: its background, border and padding.
Sourcepub fn item_style(self, style: impl IntoProp<Style>) -> Menu
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.
Sourcepub fn hover_style(self, style: impl IntoProp<Style>) -> Menu
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.
Sourcepub fn separator_style(self, style: impl IntoProp<Style>) -> Menu
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.
Sourcepub fn on_activate(self, handler: impl Fn(&Cx, i32) + 'static) -> Menu
pub fn on_activate(self, handler: impl Fn(&Cx, i32) + 'static) -> Menu
Runs handler with an entry’s id when that entry is clicked.
Runs handler with an entry’s id when its submenu opens, as a tray
menu tells its app with open_submenu.
Sourcepub fn visible(self, visible: impl IntoProp<bool>) -> Self
pub fn visible(self, visible: impl IntoProp<bool>) -> Self
Shows or hides the widget. Hidden, it is taken out of the layout, so its space goes to the others, and it isn’t drawn, hit or reached by Tab; it drops the keyboard focus and the pointer. Its bindings and state stay, so it shows again as it was. Shown by default.
Sourcepub fn geometry(self, geometry: Signal<Rect>) -> Self
pub fn geometry(self, geometry: Signal<Rect>) -> Self
Shares where the widget is: after each layout that moves or
resizes it, its laid-out rectangle in the window’s logical
pixels, scrolled with any scroll view around it but not moved by
a style’s translate, scale or rotate, is written to geometry. A
hidden widget writes nothing. An effect that reads it may change
the layout: the window is laid out again at once, until nothing
moves.
Sourcepub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self
pub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self
Shares where the widget is drawn: the box around it once its own and its ancestors’ translate, scale and rotate have moved it, in the window’s logical pixels, scrolled with any scroll view around it. It is written after each layout that moves it and after each change of a transform or an offset that does, every frame of an animated one. A hidden widget writes nothing. Where the window itself is on its output is unknown: Wayland doesn’t tell a client.
Sourcepub fn accessible_name(self, name: impl IntoProp<String>) -> Self
pub fn accessible_name(self, name: impl IntoProp<String>) -> Self
What a screen reader calls the widget, instead of what it shows: a button’s text, a text’s own, or a field’s placeholder. An icon button needs one to be read at all.
Sourcepub fn mask_region(self, region: impl IntoProp<Option<Region>>) -> Self
pub fn mask_region(self, region: impl IntoProp<Option<Region>>) -> Self
Keeps the widget and everything inside it only within region,
given in the widget’s own logical pixels from its top-left
corner, with antialiased edges and rounded corners. Nothing shows
outside the widget’s box, as with a style’s
mask, and both apply when both are set.
None, the default, keeps it all.
It changes only what is drawn: the pointer still hits the whole
widget, so a click in a hole reaches it. A window’s own
mask is what lets clicks through.
A new region repaints the widget’s painted area, its box unless its children overflow it, and never lays the window out, so a region that changes every frame of an animation costs a repaint of that area each frame. A full-screen 1080p picture with a few rounded holes took about 6 to 8 ms a frame at scale 1 and 22 to 25 ms at scale 2 on a 12-core laptop, most of it in the tiles a hole’s edge crosses.