Struct AlertHost 

pub struct AlertHost<'a, Modal, const MAX_ACTIONS: usize> { /* private fields */ }

High-level modal alert presenter owned by the framework.

Implementations

impl<'a, Modal, const MAX_ACTIONS: usize> AlertHost<'a, Modal, MAX_ACTIONS>

where Modal: Copy + Eq,

pub const fn new() -> Self

Creates an empty alert host.

Examples found in repository

examples/alerts.rs (line 26)

fn main() {
    let bounds = Rectangle::new(Point::zero(), Size::new(320, 240));
    let theme = support::theme();
    let i18n = support::i18n();
    let mut canvas = support::NullCanvas::new(bounds.size);

    let spec = AlertSpec::confirm(
        Localized::new("alert.title", "Delete item?"),
        Localized::new("alert.message", "This action cannot be undone."),
    );
    let mut alert = AlertView::new(spec);
    let panel = alert.panel(bounds, &theme, &i18n);
    alert.draw(&mut canvas, panel, &theme, &i18n);
    let _ = alert.handle_touch(TouchEvent::new(panel.center(), TouchPhase::Start, 1), panel);

    let mut host = AlertHost::<u8, 2>::new();
    let _ = host.present(7, spec);
    let _ = host.layer(bounds, &theme, &i18n);
    host.draw(&mut canvas, bounds, &theme, &i18n);
    let _ = host.handle_touch(
        TouchEvent::new(Point::new(160, 160), TouchPhase::End, 2),
        bounds,
        &theme,
        &i18n,
    );

    let mut modal = ModalHost::new();
    modal.show(3_u8);
    let _ = modal.current(bounds, &theme);
    let _ = Rgb565::BLACK;
}

pub fn present<const N: usize>( &mut self, key: Modal, spec: AlertSpec<'a, N>, ) -> Result<(), AlertHostError>

Presents a new alert.

Examples found in repository

examples/alerts.rs (line 27)

fn main() {
    let bounds = Rectangle::new(Point::zero(), Size::new(320, 240));
    let theme = support::theme();
    let i18n = support::i18n();
    let mut canvas = support::NullCanvas::new(bounds.size);

    let spec = AlertSpec::confirm(
        Localized::new("alert.title", "Delete item?"),
        Localized::new("alert.message", "This action cannot be undone."),
    );
    let mut alert = AlertView::new(spec);
    let panel = alert.panel(bounds, &theme, &i18n);
    alert.draw(&mut canvas, panel, &theme, &i18n);
    let _ = alert.handle_touch(TouchEvent::new(panel.center(), TouchPhase::Start, 1), panel);

    let mut host = AlertHost::<u8, 2>::new();
    let _ = host.present(7, spec);
    let _ = host.layer(bounds, &theme, &i18n);
    host.draw(&mut canvas, bounds, &theme, &i18n);
    let _ = host.handle_touch(
        TouchEvent::new(Point::new(160, 160), TouchPhase::End, 2),
        bounds,
        &theme,
        &i18n,
    );

    let mut modal = ModalHost::new();
    modal.show(3_u8);
    let _ = modal.current(bounds, &theme);
    let _ = Rgb565::BLACK;
}

pub fn dismiss_presented(&mut self)

Dismisses the currently presented alert, if any.

Examples found in repository

src/alert_host/mod.rs (line 63)

    pub fn dismiss(&mut self) {
        self.dismiss_presented();
    }

pub fn dismiss(&mut self)

Alias for Self::dismiss_presented.

pub fn clear_touch_state(&mut self)

Clears transient button state.

pub const fn is_animating(&self) -> bool

Returns whether the host is animating a modal transition.

pub fn advance(&mut self, dt_ms: u32) -> bool

Advances modal animation state.

pub fn presented_key(&self) -> Option<Modal>

Returns the currently presented modal key, if any.

pub fn presented_title(&self) -> Option<Localized<'a>>

Returns the title of the currently presented modal, if any.

pub fn layer( &self, bounds: Rectangle, theme: &FsTheme, i18n: &I18n<'a>, ) -> Option<ModalLayer<Modal>>

Returns the current modal layer geometry.

Examples found in repository

examples/alerts.rs (line 28)

fn main() {
    let bounds = Rectangle::new(Point::zero(), Size::new(320, 240));
    let theme = support::theme();
    let i18n = support::i18n();
    let mut canvas = support::NullCanvas::new(bounds.size);

    let spec = AlertSpec::confirm(
        Localized::new("alert.title", "Delete item?"),
        Localized::new("alert.message", "This action cannot be undone."),
    );
    let mut alert = AlertView::new(spec);
    let panel = alert.panel(bounds, &theme, &i18n);
    alert.draw(&mut canvas, panel, &theme, &i18n);
    let _ = alert.handle_touch(TouchEvent::new(panel.center(), TouchPhase::Start, 1), panel);

    let mut host = AlertHost::<u8, 2>::new();
    let _ = host.present(7, spec);
    let _ = host.layer(bounds, &theme, &i18n);
    host.draw(&mut canvas, bounds, &theme, &i18n);
    let _ = host.handle_touch(
        TouchEvent::new(Point::new(160, 160), TouchPhase::End, 2),
        bounds,
        &theme,
        &i18n,
    );

    let mut modal = ModalHost::new();
    modal.show(3_u8);
    let _ = modal.current(bounds, &theme);
    let _ = Rgb565::BLACK;
}

src/alert_host/mod.rs (line 159)

    pub fn draw<D>(&self, display: &mut D, bounds: Rectangle, theme: &FsTheme, i18n: &I18n<'a>)
    where
        D: UiCanvas,
    {
        let Some(alert) = self.alert.as_ref() else {
            return;
        };
        let Some(layer) = self.layer(bounds, theme, i18n) else {
            return;
        };

        display.dim_rect(bounds, layer.dim_alpha);
        alert.draw(display, layer.translated_panel(), theme, i18n);
    }

pub fn handle_touch( &mut self, touch: TouchEvent, bounds: Rectangle, theme: &FsTheme, i18n: &I18n<'a>, ) -> AlertHostResponse<Modal>

Routes one touch event to the alert host.

Examples found in repository

examples/alerts.rs (lines 30-35)

fn main() {
    let bounds = Rectangle::new(Point::zero(), Size::new(320, 240));
    let theme = support::theme();
    let i18n = support::i18n();
    let mut canvas = support::NullCanvas::new(bounds.size);

    let spec = AlertSpec::confirm(
        Localized::new("alert.title", "Delete item?"),
        Localized::new("alert.message", "This action cannot be undone."),
    );
    let mut alert = AlertView::new(spec);
    let panel = alert.panel(bounds, &theme, &i18n);
    alert.draw(&mut canvas, panel, &theme, &i18n);
    let _ = alert.handle_touch(TouchEvent::new(panel.center(), TouchPhase::Start, 1), panel);

    let mut host = AlertHost::<u8, 2>::new();
    let _ = host.present(7, spec);
    let _ = host.layer(bounds, &theme, &i18n);
    host.draw(&mut canvas, bounds, &theme, &i18n);
    let _ = host.handle_touch(
        TouchEvent::new(Point::new(160, 160), TouchPhase::End, 2),
        bounds,
        &theme,
        &i18n,
    );

    let mut modal = ModalHost::new();
    modal.show(3_u8);
    let _ = modal.current(bounds, &theme);
    let _ = Rgb565::BLACK;
}

pub fn draw<D>( &self, display: &mut D, bounds: Rectangle, theme: &FsTheme, i18n: &I18n<'a>, )

where D: UiCanvas,

Draws the current alert and dimming layer.

Examples found in repository

examples/alerts.rs (line 29)

fn main() {
    let bounds = Rectangle::new(Point::zero(), Size::new(320, 240));
    let theme = support::theme();
    let i18n = support::i18n();
    let mut canvas = support::NullCanvas::new(bounds.size);

    let spec = AlertSpec::confirm(
        Localized::new("alert.title", "Delete item?"),
        Localized::new("alert.message", "This action cannot be undone."),
    );
    let mut alert = AlertView::new(spec);
    let panel = alert.panel(bounds, &theme, &i18n);
    alert.draw(&mut canvas, panel, &theme, &i18n);
    let _ = alert.handle_touch(TouchEvent::new(panel.center(), TouchPhase::Start, 1), panel);

    let mut host = AlertHost::<u8, 2>::new();
    let _ = host.present(7, spec);
    let _ = host.layer(bounds, &theme, &i18n);
    host.draw(&mut canvas, bounds, &theme, &i18n);
    let _ = host.handle_touch(
        TouchEvent::new(Point::new(160, 160), TouchPhase::End, 2),
        bounds,
        &theme,
        &i18n,
    );

    let mut modal = ModalHost::new();
    modal.show(3_u8);
    let _ = modal.current(bounds, &theme);
    let _ = Rgb565::BLACK;
}