Struct Menu 

pub struct Menu { /* private fields */ }

A list of commands, opened from a trigger.

Implementations

impl Menu

pub fn new( ident: impl Into<Ident>, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn trigger(self, label: impl Into<SharedString>) -> Self

The label of the control that opens the menu.

pub fn trigger_icon(self, glyph: Icon) -> Self

pub fn trigger_name(self, name: impl Into<SharedString>) -> Self

What the trigger is called when it has no label of its own, for a menu opened from a glyph such as the arrow of a split button.

pub fn set_trigger_name( &mut self, name: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

pub fn trigger_variant(self, variant: ButtonVariant) -> Self

How the trigger is painted, for a menu that sits inside another control and has to look like part of it.

pub fn trigger_join(self, join: ButtonJoin) -> Self

Where the trigger sits in a joined run of buttons.

pub fn set_trigger_style( &mut self, variant: ButtonVariant, size: ControlSize, cx: &mut Context<'_, Self>, )

Repaints the trigger for an owner whose own paint is decided after the menu is built.

pub fn items(self, items: impl IntoIterator<Item = MenuItem>) -> Self

pub fn placement(self, placement: Placement) -> Self

pub fn offered(&self) -> &[MenuItem]

The rows the menu currently offers, so an owner that maintains them can tell whether a replacement would change anything.

pub fn set_items(&mut self, items: Vec<MenuItem>, cx: &mut Context<'_, Self>)

Replaces the items from the host side, dropping a cursor that pointed into what is no longer offered.

pub fn is_open(&self) -> bool

pub fn open(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

pub fn open_submenu( &mut self, id: &str, window: &mut Window, cx: &mut Context<'_, Self>, ) -> bool

Opens the menu with the submenu carrying id already expanded, and reports whether such a submenu exists.

pub fn close(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Closes the menu and every submenu under it, and gives the keyboard back to the trigger.

pub fn dismiss(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

pub fn toggle(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Trait Implementations

impl Debug for Menu

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

Formats the value using the given formatter.

impl EventEmitter<MenuEvent> for Menu

impl Focusable for Menu

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for Menu

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

impl Sizable for Menu

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self