/ 
FLTK-0.532009
River stage zero No dependents
/ FLTK::ProgressBar

NAME

FLTK::ProgressBar - Widget meant to display progress of some operation

Description

ProgressBar is an indicator with a bar that fills up and text showing the job being done and expected time to go. maximum( ) and optionally minimum( ) values should be set, and for each step of operation step( ) should be called.

Functions

maximum

$progressbar->maximum( $maximum );

Set maximum value for the progess widget. It should represent operation length.

my $min = $progressbar->maximum( );

Returns maximum value for the progress widget.

minimum

$progressbar->minimum( $minimum );

Set minimal value for the progess widget.

my $min = $progressbar->minimum( );

Returns theminimal value for the progress widget.

new

my $self = $progressbar->new( $x, $y, $w, $h, $label );

Creates a new FLTK::ProgressBar object.

position

$progressbar->position( $value );

Set position of bar in progress widget and redraw it. If $value goes out of minimum( ) and maximum( ) bounds, it will be ignored.

my $min = $progressbar->position( );

Returns position value for the progress widget.

range

$progressbar->range( $min, $max, $step );

A shorthand for minimum( ), maximum( ), and step( ).

showtext

$progressbar->showtext( $show );

Shows completition percentage inside progress widget.

my $shown = $progressbar->showtext( );

Returns wheather or not completion percentage is displayed inside progress widget.

step

$progressbar->step( $step );

Increase bar length with given step and redraw widget. If value goes out of minimum( ) and maximum( ) bounds, it will be ignored.

my $step = $progressbar->step( );

Returns the bar length.

text_color

$progressbar->text_color( $color );

Changes the color of text hiddien/displayed by showtext( ).

my $color = $progressbar->text_color( );

Returns the color of text hiddien/displayed by showtext( ).

Author

Sanko Robinson <sanko@cpan.org> - http://sankorobinson.com/

License and Legal

Copyright (C) 2008-2010 by Sanko Robinson <sanko@cpan.org>

This program is free software; you can redistribute it and/or modify it under the terms of The Artistic License 2.0. See the LICENSE file included with this distribution or notes on the Artistic License 2.0 for clarification.

When separated from the distribution, all original POD documentation is covered by the Creative Commons Attribution-Share Alike 3.0 License. See the clarification of the CCA-SA3.0.