|
|
progress bar
11-25-2002
|
|
Widgets::ProgressBar(3pm) User Contributed Perl Documentation Widgets::ProgressBar(3pm) NAME
Curses::Widgets::ProgressBar - Progress Bar Widgets MODULE VERSION
$Id: ProgressBar.pm,v 1.103 2002/11/03 23:40:04 corliss Exp corliss $ SYNOPSIS
use Curses::Widgets::ProgressBar; $progress = Curses::Widgets::ProgessBar->({ CAPTION => 'Progress', CAPTIONCOL => 'yellow', LENGTH => 10, VALUE => 0, FOREGROUND => undef, BACKGROUND => 'black', BORDER => 1, BORDERCOL => undef, HORIZONTAL => 1, X => 1, Y => 1, MIN => 0, MAX => 100, }); $progress->draw($mwh); $progress->input(5); See the Curses::Widgets pod for other methods. REQUIREMENTS
Curses Curses::Widgets DESCRIPTION
Curses::Widgets::ProgressBar provides simplified OO access to Curses-based progress bar. Each object maintains it's own state information. Note that this widget is designed for rendering, not interactive input. The application should update the the value of the bar by either calling the input method, which will add the passed value to the widget's current value, or by setting the value directly via the setField method. METHODS
new (inherited from Curses::Widgets) $progress = Curses::Widgets::ProgressBar->({ CAPTION => 'Progress', CAPTIONCOL => 'yellow', LENGTH => 10, VALUE => 0, FOREGROUND => undef, BACKGROUND => 'black', BORDER => 1, BORDERCOL => undef, HORIZONTAL => 1, X => 1, Y => 1, MIN => 0, MAX => 100, }); The new method instantiates a new Progress Bar object. The only mandatory key/value pairs in the configuration hash are X and Y. All oth- ers have the following defaults: Key Default Description ============================================================ CAPTION undef Caption superimposed on border CAPTIONCOL undef Foreground colour for caption text LENGTH 10 Number of columns for the bar VALUE 0 Current value FOREGROUND undef Default foreground colour BACKGROUND undef Default blackground colour BORDER 1 Display border around the set BORDERCOL undef Foreground colour for border HORIZONTAL 1 Horizontal orientation for bar MIN 0 Low value for bar (0%) MAX 100 High vlaue for bar (100%) Setting the value will change the length of the bar, based on the bounds set with MIN and MAX. The CAPTION is only rendered on the border of a horizontal progress bar. draw $progress->draw($mwh); The draw method renders the progress bar in its current state. This requires a valid handle to a curses window in which it will render itself. input $progress->input(5); The argument is added to the progress bar's current value. HISTORY
2001/07/05 -- First implementation AUTHOR
/COPYRIGHT (c) 2001 Arthur Corliss (corliss@digitalmages.com) perl v5.8.8 2006-09-14 Widgets::ProgressBar(3pm)