Struct ModalSheet 

pub struct ModalSheet { /* private fields */ }

The immediate-mode sheet for a painted host that keeps its own state (a question with three answers, a confirmation over a canvas): it lays the sheet out, paints it with hover, press and keyboard focus on its actions, keeps the layout of its last paint for hit-testing, and turns input into a SheetResponse. The host paints only its body.

// draw_overlay:
let window = presence.viewport.get().unwrap_or(self.rect);
let spec = ModalSpec::new("Save changes to notes.md?").actions(&[
    ModalAction::primary("Save"),
    ModalAction::alternate_danger("Don't save"),
    ModalAction::secondary("Cancel"),
]);
self.sheet.paint_message(scene, transform, text, theme, window, &spec, "Your changes will be lost.");
// handle_event:
match self.sheet.handle(event, ctx.scale_factor) {
    Some(SheetResponse::Action(0)) => self.save(),
    Some(SheetResponse::Action(1)) => self.discard(),
    Some(SheetResponse::Action(_) | SheetResponse::Dismiss) => self.cancel(),
    None => {}
}
*ctx.handled = true;

Implementations

impl ModalSheet

pub fn new() -> ModalSheet

pub fn reset(&mut self)

Forget the last paint and any focus: call when the sheet closes, so the next question starts fresh.

pub fn layout(&self) -> Option<&ModalLayout>

The geometry of the last paint, for hit-testing without a renderer.

pub fn hit(&self, point: Point) -> Option<ModalHit>

What point lands on in the last paint.

pub fn message_height( text_renderer: &mut TextRenderer, theme: &Theme, window: Rect, max_width: f64, message: &str, ) -> f64

Height a plain message takes as the body of a sheet in window.

pub fn paint_message( &mut self, scene: &mut Scene, transform: Affine, text_renderer: &mut TextRenderer, theme: &Theme, window: Rect, spec: &ModalSpec<'_>, message: &str, )

Paint the sheet for spec over window with message as its body, in secondary ink. The body height is measured here.

pub fn paint( &mut self, scene: &mut Scene, transform: Affine, text_renderer: &mut TextRenderer, theme: &Theme, window: Rect, spec: &ModalSpec<'_>, body: impl FnOnce(&mut Scene, Affine, &mut TextRenderer, &Theme, Rect), )

Paint the sheet for spec over window, calling body to draw the host’s content inside the body rect (spec.body_height tall). The actions show this sheet’s hover, press and focus.

pub fn handle( &mut self, event: &WindowEvent, scale_factor: f64, ) -> Option<SheetResponse>

Route event to the sheet. Returns what it was answered with; the host consumes every event while the sheet is up either way.

pub fn focused_action(&self) -> Option<usize>

The action keyboard focus is on, if any.

Trait Implementations

impl Clone for ModalSheet

fn clone(&self) -> ModalSheet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModalSheet

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ModalSheet

fn default() -> ModalSheet

Returns the “default value” for a type.