pub struct ModalFrame { /* private fields */ }Expand description
A capture handler that realizes modality: while it is on the
CaptureStack, positional (mouse) events are gated by bounds. Inside,
they Pass to normal routing; outside, the frame
returns Consumed. In practice an outside click
never reaches the frame: pump_once runs an outside-click redirect first,
which hands the event, localized, to the modal view alone (a history window
closes on it, a plain dialog ignores it).
Every other event Passes. Keys, commands, pastes and
the mouse wheel then go to the modal view alone: program_handle_event
reads CaptureStack::modal_view and hands them to Group::deliver_to_modal,
as C++ TGroup::execute does, and drops a command the modal leaves
unhandled. Broadcasts keep the root route and fan out to all views
(deviation D9). This is the “a handler that consumes every
otherwise-unhandled event is the modal loop” realization.
It holds the modal view’s ViewId (identity, per the capture contract) and
its bounds in the root group’s frame, so positional events can be hit-tested
without holding a view reference. The root group covers the whole screen at
(0,0), so group-local == absolute == this bounds frame.
exec_view is the blocking wrapper that pushes this
frame, runs the pump until Program::end_modal sets the end state, then
pops it (the one place a frame is popped other than a handler self-popping via
CaptureFlow::ConsumedPop) and marshals dialog data.
§Turbo Vision heritage
Replaces the nested blocking modal loop run by TGroup::execute /
TGroup::execView (tgroup.cpp). The single non-recursive loop plus this
capture handler stands in for that nesting (deviation D9), and the handler
holds a ViewId rather than a view pointer (deviation D3).
Implementations§
Trait Implementations§
Source§impl CaptureHandler for ModalFrame
impl CaptureHandler for ModalFrame
Source§fn set_gate_bounds(&mut self, bounds: Rect)
fn set_gate_bounds(&mut self, bounds: Rect)
Follow the modal view when it is moved/resized (a dragged dialog). Without
this the gate keeps the bounds captured at push time, so after a drag any
positional event on the moved dialog that falls outside the stale bounds
is swallowed — the dialog goes mouse-dead. The loop calls this from
CaptureStack::sync_gate_bounds before every dispatch.
Source§fn handle(&mut self, ev: &mut Event, _ctx: &mut Context<'_>) -> CaptureFlow
fn handle(&mut self, ev: &mut Event, _ctx: &mut Context<'_>) -> CaptureFlow
ctx (post
commands, schedule timers, push a nested capture via
Context::push_capture). Read moreSource§fn view(&self) -> Option<ViewId>
fn view(&self) -> Option<ViewId>
ViewId.Source§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.MenuSession. Read moreAuto Trait Implementations§
impl Freeze for ModalFrame
impl RefUnwindSafe for ModalFrame
impl Send for ModalFrame
impl Sync for ModalFrame
impl Unpin for ModalFrame
impl UnsafeUnpin for ModalFrame
impl UnwindSafe for ModalFrame
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.