Struct ContextMenu 

pub struct ContextMenu<V: 'static, K: 'static = ()>(/* private fields */);

A view’s menu: closed, or open with its rows and what choosing one does.

Implementations

impl<V: 'static, K: PartialEq + 'static> ContextMenu<V, K>

pub fn open( &mut self, key: K, place: Place, items: Vec<Item>, on_choose: impl Fn(&mut V, &[usize], &mut Window, &mut Context<'_, V>) + 'static, window: &mut Window, cx: &mut Context<'_, V>, )

Open items as the menu key, standing at place and taking the keyboard. A menu already open is replaced.

pub fn toggle<F>( view: &mut V, slot: Slot<V, K>, key: K, place: Place, build: impl FnOnce(&mut V, &mut Window, &mut Context<'_, V>) -> (Vec<Item>, F), window: &mut Window, cx: &mut Context<'_, V>, )

where F: Fn(&mut V, &[usize], &mut Window, &mut Context<'_, V>) + 'static,

Open the menu key, or close it when it is the one up or the press that led here found it up — see Self::note_press. build makes the rows and what choosing one does, and runs only when the menu opens.

pub fn note_press(&mut self, key: &K)

Note, from a trigger’s press, whether the menu key is on screen. The open card dismisses on that same press, so by click time the menu reads as closed, and Self::toggle would open it straight back without this.

pub fn trigger<E: StatefulInteractiveElement>( el: E, slot: Slot<V, K>, key: K, cx: &Context<'_, V>, ) -> E

el, noting its presses for the menu key — see Self::note_press. Every trigger that calls Self::toggle needs it.

pub fn key(&self) -> Option<&K>

Which menu is open. None while none is, or the last one is on its way out.

pub fn is_open(&self) -> bool

pub fn showing(&self, key: &K) -> bool

Whether the menu key is on screen, open or on its way out.

pub fn point_at(&mut self, path: &[usize]) -> bool

Light the row at path, as the pointer would. Whether that moved the cursor.

pub fn clear_cursor(&mut self)

Light no row.

pub fn close(view: &mut V, slot: Slot<V, K>, cx: &mut Context<'_, V>)

Close the menu, leaving the focus where it is.

pub fn card( &self, id: impl Into<SharedString>, slot: Slot<V, K>, window: &mut Window, cx: &mut Context<'_, V>, ) -> Option<Div>

The menu’s card while it is on screen, not yet placed: for a caller that sizes it before Self::place. id prefixes its rows’ element ids and debug selectors — see menu::card.

pub fn place( &self, id: impl Into<SharedString>, card: impl IntoElement, ) -> AnyElement

Stand card where the menu opened. For every Place but Place::At, draw it as a child of the trigger.

pub fn render( &self, id: impl Into<SharedString>, slot: Slot<V, K>, window: &mut Window, cx: &mut Context<'_, V>, ) -> Option<AnyElement>

The menu, placed, while it is on screen.

pub fn render_for( &self, key: &K, id: impl Into<SharedString>, slot: Slot<V, K>, window: &mut Window, cx: &mut Context<'_, V>, ) -> Option<AnyElement>

Self::render for the menu key alone: what a trigger hangs beside itself.

Trait Implementations

impl<V: 'static, K: 'static> Default for ContextMenu<V, K>

fn default() -> Self

Returns the “default value” for a type.