Notifications

Struct Notifications 

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

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.

setup_duat!(setup);
use duat::prelude::*;

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

Trait Implementations§

Source§

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

Source§

type Cfg = NotificationsCfg<U>

The configuration type Read more
Source§

fn cfg() -> Self::Cfg

Returns a WidgetCfg, for use in layout construction Read more
Source§

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

Updates the widget, allowing the modification of its Area Read more
Source§

fn text(&self) -> &Text

The text that this widget prints out
Source§

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

A mutable reference to the Text that is printed
Source§

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

Actions taken when this widget opens for the first time Read more
Source§

fn needs_update(&self, _: &Pass) -> bool

Tells Duat that this Widget should be updated Read more
Source§

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

Prints the widget Read more
Source§

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

Actions to do whenever this Widget is focused Read more
Source§

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

Actions to do whenever this Widget is unfocused Read more
Source§

fn print_cfg(&self) -> PrintCfg

The configuration for how to print Text Read more

Auto Trait Implementations§

§

impl<U> !Freeze for Notifications<U>

§

impl<U> !RefUnwindSafe for Notifications<U>

§

impl<U> Send for Notifications<U>
where U: Send,

§

impl<U> !Sync for Notifications<U>

§

impl<U> Unpin for Notifications<U>
where U: Unpin,

§

impl<U> !UnwindSafe for Notifications<U>

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<W, U> HookAlias<U, WidgetCreatedDummy<U>> for W
where W: Widget<U>, U: Ui,

Source§

type Hookable = WidgetCreated<W, U>

The actual Hookable that this HookAlias is supposed to map to
Source§

type Input<'h> = <WidgetCreated<W, U> as Hookable>::Input<'h>

Just a shorthand for less boilerplate in the function definition
Source§

type Output = <WidgetCreated<W, U> as Hookable>::Output

Just a shorthand for less boilerplate in the function definition
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.