Guide API
Skip to main content

MouseTrackCapture

Struct MouseTrackCapture 

Source
pub struct MouseTrackCapture { /* private fields */ }
Expand description

The hold-tracking router: while a mouse button is held, it localizes and forwards masked mouse events to the tracked view, swallows everything else, and pops on MouseUp (forwarding the localized up too — a button/frame reads the up position after the hold ends).

A pure router, not a strategy. The per-event handling logic stays in the widgets (their MouseMove/MouseAuto arms run while held, their MouseUp arm runs once at release): captures are 'static and hold no view borrow, and several tracked views (ListViewer, Outline) are trait objects the pump could not downcast — so the capture only routes, via Deferred::MouseTrack, which the pump applies by calling the view’s handle_event directly. Pushed via Context::start_mouse_track; because a capture push is itself applied through the deferred channel, the capture sees the next event — so the widget runs its handling once on the press before the first forwarded event.

origin is the absolute screen position of view-local (0, 0), cached by the widget’s last draw at push time (the Button::abs_origin pattern). Like the window drag capture, the origin is fixed for the duration of the hold: if the tracked view is moved / resized mid-hold the localization goes stale — acceptable, since a hold is short-lived and nothing moves the view while the (modal) hold swallows all other input.

§Turbo Vision heritage

Replaces the blocking mouse-hold loop do { … } while (mouseEvent(event, mask)) (tview.cpp:636-643; the cluster/frame post-loop reads at tcluster.cpp:181-184 / tframe.cpp:159-160) with a capture handler (deviation D9) that routes via the deferred channel instead of holding a view borrow (deviation D3). The do{}while running its body once before the first wait is why the capture is applied deferred (sees the next event).

Trait Implementations§

Source§

impl CaptureHandler for MouseTrackCapture

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

fn set_gate_bounds(&mut self, _bounds: Rect)

Update the handler’s cached gating bounds for its associated view, called by 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 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.