The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

The following documentation is automatically generated. Please do not edit this file, but rather the original, inline with Tickit::Widget::Statusbar at lib/Tickit/Widget/Statusbar.pm (on the system that originally ran this). If you do edit this file, and don't want your changes to be removed, make sure you change the first line.

NAME

Tickit::Widget::Statusbar - provides a simple status bar implementation

SYNOPSIS

 my $statusbar = Tickit::Widget::Statusbar->new;
 $statusbar->update_status('Ready to start');

DESCRIPTION

Provides a status bar, typically for use at the bottom of the terminal to indicate when we're busy doing something. You'll probably want this as the last widget in a Tickit::Widget::VBox with expand omitted or set to 0.

Currently the statusbar contains the status text, a memory usage indicator (VSZ), CPU usage, and a clock. It should also allow progress bars, sparklines, and the ability to configure things, but as yet it does not.

METHODS

Not too many user-serviceable parts inside as yet. This is likely to change in future.

new

Instantiates the status bar.

update_status

Set current status. Takes a single parameter - the string to set the status to.

Returns $self.

INHERITED METHODS

Tickit::ContainerWidget

child_opts, child_resized, find_child, focus_next, remove, set_child_opts, window_lost

Tickit::Widget

get_style_pen, get_style_text, get_style_values, key_focus_next_after, key_focus_next_before, parent, pen, redraw, requested_cols, requested_lines, requested_size, resized, set_parent, set_requested_size, set_style, set_style_tag, set_window, style_classes, take_focus, window

AUTHOR

Tom Molesworth <TEAM@cpan.org>

LICENSE

Copyright Tom Molesworth 2011-2020. Licensed under the same terms as Perl itself.