Struct OverlayModalWidget 

pub struct OverlayModalWidget { /* private fields */ }

The retained widget for an OverlayModalView.

Implementations

impl OverlayModalWidget

pub fn panel_rect(&self) -> Rect

The panel rect in the widget’s own coordinate space.

pub fn close_rect(&self) -> Option<Rect>

The close affordance’s hit box, when the config shows one.

pub fn handle_rect(&self) -> Option<Rect>

The drag handle’s hit box, when the config shows one.

pub fn progress(&self) -> f64

The ramp’s progress: 0.0 off-screen/transparent, 1.0 fully shown.

pub fn is_exiting(&self) -> bool

Whether an exit ramp is running (the panel is on its way out, and the barrier is still swallowing input).

pub fn open_progress(&self) -> f64

The progress an open panel rests at: the first snap point, or fully open with none authored.

Floored above [PROGRESS_EPSILON]: a first point that normalizes to 0.0 (an explicit snap_points(&[0.0]), or a 0.0-fraction point on an as-yet-unmeasured extent) is treated as absent rather than as “open to closed” — the entrance ramp always has a nonzero target to animate toward, matching Self::settle_drag’s own floor for a panel that cannot dismiss. There is no fallible surface here (OverlayModalView::snap_points is a plain builder call), so an unreachable configuration silently falls back to fully open instead of panicking.

Trait Implementations

impl Widget for OverlayModalWidget

fn layout(&mut self, ctx: &mut LayoutCtx<'_>, bc: &BoxConstraints) -> Size

Choose a size within bc and return it. Under a render root the call may be skipped (see ChildPod::layout_child), so the result must depend only on bc, the context’s globals and state changed through a pod-dirtying channel: a LAYOUT rebuild, request_layout, an unpaced frame request, or a handled / redraw-requesting event.

fn paint(&mut self, ctx: &mut PaintCtx<'_>, scene: &mut dyn PaintScene)

Emit draw commands into scene. Paint may advance animation state; it must then call PaintCtx::request_frame until the animation rests.

fn event(&mut self, ctx: &mut EventCtx<'_>, event: &InputEvent) -> EventResult

Handle an input event and report whether it was consumed; defaults to EventResult::Ignored. Containers forward via ChildPod::event_child.

fn semantics(&self, ctx: &mut SemanticsCtx)

Contribute accessibility node(s) after layout; defaults to none. A container forwards via ChildPod::semantics_child.

fn visit_children(&self, visitor: &mut dyn FnMut(&ChildPod))

Visit this widget’s owned ChildPods in paint order, for read-only tooling; defaults to none and must not mutate pass state.

fn type_name(&self) -> &'static str

This widget’s concrete type name, for diagnostics only (docs/LIMITATIONS.md focus-wrapper-erasure-swap-blind); override only in a transparent wrapper.

fn is_focusable(&self) -> bool

Whether keyboard traversal (Tab / Shift+Tab at the root) may stop on this widget’s pod.

fn visit_focus_children(&self, visitor: &mut dyn FnMut(&ChildPod))

Visit the children traversal may enter, in focus order; defaults to Widget::visit_children. A container showing only some children narrows it.

fn as_sliver(&mut self) -> Option<&mut (dyn SliverWidget + 'static)>

This widget as a sliver (crate::sliver), if it speaks that protocol. Defaults to None; transparent wrappers forward it.