Tom Molesworth

NAME

Tickit::Widget::Progressbar - simple progressbar implementation for Tickit

VERSION

version 0.100

SYNOPSIS

 use Tickit::Widget::Progressbar::Horizontal;
 my $bar = Tickit::Widget::Progressbar::Horizontal->new(
        completion      => 0.00,
 );
 $bar->completion($_ / 100.0) for 0..100;

DESCRIPTION

Provides support for a 'progress bar' widget. Use the Tickit::Widget::Progressbar::Horizontal or Tickit::Widget::Progressbar::Vertical subclasses depending on whether you want the progress bar to go from left to right or bottom to top.

METHODS

new

Instantiate a new Tickit::Widget::Progressbar object. Takes the following named parameters:

  • completion - a value from 0.0 to 1.0 indicating progress

  • orientation - 'vertical' or 'horizontal'

  • direction - whether progress goes forwards (left to right, bottom to top) or backwards (right to left, top to bottom).

Note that this is a base class, and the appropriate Tickit::Widget::Progressbar::Horizontal or Tickit::Widget::Progressbar::Vertical subclass should be used when instantiating a real widget.

completion

Accessor for the current progress bar completion state - call this with a float value from 0.00..1.00 to set completion and re-render.

SEE ALSO

Tickit

INHERITED METHODS

Tickit::Widget

get_style_pen, get_style_text, get_style_values, key_focus_next_after, key_focus_next_before, on_pen_changed, parent, pen, redraw, reshape, resized, set_parent, set_pen, set_style, set_style_tag, set_window, style_classes, take_focus, window, window_gained, window_lost

AUTHOR

Tom Molesworth <cpan@entitymodel.com>

LICENSE

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