pub struct MenuSession { /* private fields */ }Expand description
The modal menu interaction, run as one capture handler on the single event loop.
Pushed at activation (via
Deferred::PushCapture) alongside the
first OpenMenuBox — or, for a bar
activation, with only the bar level on the stack and no box yet (the first key
opens a box). Consumes every event it is offered; pops itself
(CaptureFlow::ConsumedPop) when the last level closes, restoring the
pre-menu focus.
§Turbo Vision heritage
Flattens TMenuView::execute() (tmnuview.cpp/menus.h). The nested modal
loops (one per open box) become a single capture handler on the one event loop
(deviation D9).
Implementations§
Source§impl MenuSession
impl MenuSession
Sourcepub fn help_ctx(&self) -> HelpCtx
pub fn help_ctx(&self) -> HelpCtx
The help context of the currently highlighted menu item, as seen by the status line while the session is open.
Walks the open levels from the deepest (top of stack) toward the bar.
For the first level whose highlighted item is a named Command or SubMenu
with help_ctx != HelpCtx::NO_CONTEXT, returns that help_ctx. Skips
Separator items and levels with no current highlight. If no level
qualifies, returns HelpCtx::NO_CONTEXT.
This mirrors TMenuView::getHelpCtx (tmnuview.cpp:453-468), which walks
the parentMenu chain to find the first active level with a named, non-null
helpCtx. Here the parentMenu chain is the level stack (deviation D9 /
D3); the walk is equivalent.
Trait Implementations§
Source§impl CaptureHandler for MenuSession
impl CaptureHandler for MenuSession
Source§fn handle(&mut self, ev: &mut Event, ctx: &mut Context<'_>) -> CaptureFlow
fn handle(&mut self, ev: &mut Event, ctx: &mut Context<'_>) -> CaptureFlow
One pass per offered event. Consumes every menu-directed event; keyboard, mouse, and the menu-toggle command share the flat re-apply loop, a non-menu command ends the session and is re-posted to the view tree, and everything else is swallowed to keep the session modal.
Source§fn view(&self) -> Option<ViewId>
fn view(&self) -> Option<ViewId>
ViewId.MenuSession. Read moreSource§fn is_modal_gate(&self) -> bool
fn is_modal_gate(&self) -> bool
true if this handler is a modal-bounds gate (a ModalFrame
equivalent). Used by the pump’s outside-modal redirect to distinguish a
true modal frame from other capture handlers that also have a view()
(drag, menu-box, etc.). Default is false — only ModalFrame
overrides this.Source§fn set_gate_bounds(&mut self, _bounds: Rect)
fn set_gate_bounds(&mut self, _bounds: Rect)
CaptureStack::sync_gate_bounds before each dispatch so a handler
that gates events by the view’s position (e.g. a modal frame) follows
the view when it is moved/resized (a dragged dialog). Read moreAuto Trait Implementations§
impl Freeze for MenuSession
impl RefUnwindSafe for MenuSession
impl Send for MenuSession
impl Sync for MenuSession
impl Unpin for MenuSession
impl UnsafeUnpin for MenuSession
impl UnwindSafe for MenuSession
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.