Struct StatusLine 

pub struct StatusLine { /* private fields */ }

A widget to show information, usually about a Buffer

This widget is updated whenever any of its parts needs to be updated, and it also automatically adjusts to where it was pushed. For example, if you push it to a buffer (via hook::add::<Buffer>, for example), it’s information will point to the Buffer to which it was pushed. However, if you push it with WindowCreated, it will always point to the currently active Buffer:

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

fn setup() {
    opts::one_line_footer();
    opts::set_status(|pa| status!("{AlignRight}{} {sels_txt} {main_txt}", mode_txt()));

    hook::add::<Buffer>(|pa, handle| {
        status!("{AlignCenter}{name_txt}")
            .above()
            .push_on(pa, handle);
        Ok(())
    });
}

In the code above, I’m modifying the “global” StatusLine through opts::set_status (this can be done with hooks as well, but this method is added for convenience’s sake). This is in conjunction with opts::one_line_footer, which will place the PromptLine and StatusLine on the same line.

After that, I’m also pushing a new StatusLine above every opened Buffer, showing that Buffer]’s name, centered.

You will usually want to create StatusLines via the [status!] macro, since that is how you can customize it. Although, if you want the regular status line, you can call StatusLine::builder:

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

fn setup() {
    hook::add::<Buffer>(|pa, handle| {
        StatusLine::builder().above().push_on(pa, handle);
        Ok(())
    });
}

Implementations

impl StatusLine

pub fn fmt(&mut self, new: StatusLineFmt)

Replaces this StatusLine with a new one

pub fn builder() -> StatusLineFmt

Returns a StatusLineFmt, which can be used to push around StatusLines

The same can be done more conveniently with the [status!] macro, which is imported by default in the configuration crate.

Trait Implementations

impl Widget for StatusLine

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

Updates the widget alongside its RwArea in the Handle

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

Tells Duat that this Widget should be updated

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 on_focus(pa: &mut Pass, handle: &Handle<Self>)

where Self: Sized,

Actions to do whenever this Widget is focused

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

where Self: Sized,

Actions to do whenever this Widget is unfocused

fn on_mouse_event(pa: &mut Pass, handle: &Handle<Self>, event: MouseEvent)

where Self: Sized,

How to handle a MouseEvent

fn get_print_opts(&self) -> PrintOpts

The configuration for how to print Text

fn print(&self, pa: &Pass, painter: Painter, area: &RwArea)

Prints the widget