Struct cursive_extras::StatusView

pub struct StatusView { /* private fields */ }

View that can be used to report an application’s status. It is meant to be placed at the bottom of the main Cursive layer

Examples

Reporting Application Status

let mut root = cursive::default();
root.add_fullscreen_layer(
    LinearLayout::vertical()
        .child(
            Dialog::text("Yes")
                .button("Quit", |v| v.quit())
                .title("StatusView Example")
        )
        .child(StatusView::new().with_name("status"))
);
root.set_fps(30);
root.set_global_callback(Event::Refresh, |view| {
    let mut status = view.find_name::<StatusView>("status").expect("StatusView does not exist!");
    status.info("Application Status");
    status.update();
});
root.run();

Reporting an Error

let mut root = cursive::default();
root.add_fullscreen_layer(
    LinearLayout::vertical()
        .child(
            Dialog::text("Yes")
                .button("Quit", |v| v.quit())
                .title("StatusView Example")
        )
        .child(StatusView::new().with_name("status"))
);
 
root.set_fps(30);
root.set_global_callback(Event::Refresh, |view| {
    let error: Result<&str, &str> = Err("Error: Houston, we have a problem!");
    let mut status = view.find_name::<StatusView>("status").expect("StatusView does not exist!");
    report_error!(status, error);
    status.update();
});
root.run();

Implementations

impl StatusView

pub fn new() -> StatusView

Create a new StatusView

pub fn update(&mut self)

This will clear the StatusView if called more than 5 seconds after the text was set

pub fn report_error<T: Display>(&mut self, text: T)

Set the text in the StatusView with error formatting (bright red text)

pub fn info<T: Display>(&mut self, text: T)

Set the text in the StatusView with normal formatting (white text)

Trait Implementations

impl View for StatusView

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn required_size(&mut self, constraint: Vec2) -> Vec2

Returns the minimum size the view requires with the given restrictions.

fn layout(&mut self, XY<usize>)

Called once the size for this view has been decided.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn on_event(&mut self, Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn call_on_any(
    &mut self,
    &Selector<'_>,
    &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

fn take_focus(&mut self, source: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible?

fn type_name(&self) -> &'static str

Returns the type of this view.