Guide API
Skip to main content

ModalFrame

Struct ModalFrame 

Source
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§

Source§

impl ModalFrame

Source

pub fn new(id: ViewId, bounds: Rect) -> Self

Create a modal frame for the view id occupying bounds (in the root group’s coordinate frame).

Trait Implementations§

Source§

impl CaptureHandler for ModalFrame

Source§

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

Offered an event before normal routing. May read/mutate ctx (post commands, schedule timers, push a nested capture via Context::push_capture). Read more
Source§

fn view(&self) -> Option<ViewId>

The view this handler is associated with, if any. Identity is ViewId.
Source§

fn is_modal_gate(&self) -> bool

Returns 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 menu_help_ctx(&self) -> Option<HelpCtx>

Returns the help context of the currently highlighted menu item, if this handler is a MenuSession. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.