Struct Notifications

pub struct Notifications<U> { /* private fields */ }

A Widget to show notifications

With the FooterWidgets (a WidgetAlias), this Widget can be conveniently placed alongside a PromptLine and a StatusLine, in a combination that hides the PromptLine when it is not in use, covering it with the Notifications, and vice-versa. This is the default behaviour of Duat.

use duat_core::{hook::OnWindowOpen, prelude::*};
use duat_utils::{state::*, widgets::*};

fn setup_generic_over_ui<U: Ui>() {
    hook::remove("WindowWidgets");
    hook::add::<OnWindowOpen<U>, U>(|pa, builder| {
        let footer = FooterWidgets::default().notifs(Notifications::cfg().formatted(|rec| {
            Some(txt!(
                "[notifs.bracket]([notifs.target]{}[notifs.bracket]) {}",
                rec.target(),
                rec.text().clone()
            ))
        }));
        builder.push(pa, footer);
    });
}

Trait Implementations

impl<U: Ui> Widget<U> for Notifications<U>

type Cfg = NotificationsCfg<U>

The configuration type

fn cfg() -> Self::Cfg

Returns a WidgetCfg, for use in layout construction

fn update(pa: &mut Pass, handle: Handle<Self, U>)

Updates the widget, allowing the modification of its RawArea

fn text(&self) -> &Text

The text that this widget prints out

fn text_mut(&mut self) -> &mut Text

A mutable reference to the Text that is printed

fn once() -> Result<(), Text>

Actions taken when this widget opens for the first time

fn needs_update(&self) -> bool

Tells Duat that this Widget should be updated

fn print(&mut self, painter: Painter, area: &<U as Ui>::Area)

Prints the widget

fn on_focus(pa: &mut Pass, handle: Handle<Self, U>)

where Self: Sized,

Actions to do whenever this Widget is focused

fn on_unfocus(pa: &mut Pass, handle: Handle<Self, U>)

where Self: Sized,

Actions to do whenever this Widget is unfocused

fn print_cfg(&self) -> PrintCfg

The configuration for how to print Text