Struct StatusLine

pub struct StatusLine<U: Ui> { /* private fields */ }

A widget to show information, usually about a File

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 with OnFileOpen, it’s information will point to the File to which it was pushed. However, if you push it with OnWindowOpen, it will always point to the currently active File:

hooks::remove("FileWidgets");
hooks::add::<OnFileOpen<U>>(|builder| {
    builder.push(LineNumbers::cfg());
    builder.push(status!([File] { File::name }));
});

hooks::remove("WindowWidgets");
hooks::add::<OnWindowOpen<U>>(|builder| {
    let (status_area, _) = builder.push(status!(
        [File] { File::name } " " selections_fmt " " main_fmt
    ));
    builder.push_to(CmdLine::cfg().left_ratioed(2, 3), status_area);
});

In the above example, each file would have a status line with the name of the file, and there would be a global status line, showing more information about the currently active file.

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 just:

hooks::remove("FileWidgets");
hooks::add::<OnFileOpen<U>>(|builder| {
    builder.push(LineNumbers::cfg());
    builder.push(StatusLine::cfg());
});

Trait Implementations

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

type Cfg = StatusLineCfg<U>

The configuration type

fn cfg() -> Self::Cfg

Returns a WidgetCfg, for use in layout construction

fn update(&mut self, _area: &U::Area)

Updates the widget, allowing the modification of its Area

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<(), ()>

Actions taken when this widget opens for the first time

fn print_cfg(&self) -> PrintCfg

The configuration for how to print Text

fn cursors(&self) -> Option<&Cursors>

The Cursors that are used on the Text, if they exist

fn cursors_mut(&mut self) -> Option<&mut Cursors>

A mutable reference to the Cursors, if they exist

fn on_focus(&mut self, area: &U::Area)

Actions to do whenever this Widget is focused.

fn on_unfocus(&mut self, area: &U::Area)

Actions to do whenever this Widget is unfocused.

fn print(&mut self, area: &U::Area)

Prints the widget