Curses::UI::Progressbar (3pm)

 Curses::UI::Widget
    |
    +----Curses::UI::Progressbar

use Curses::UI; my $cui = new Curses::UI; my $win = $cui->add('window_id', 'Window');

my $progressbar = $win->add( 'myprogressbar', 'Progressbar', -max => 250, -pos => 42, );

$progressbar->draw;

Curses::UI::Progressbar is a widget that can be used to provide some sort of progress information to the user of your program. The progressbar looks like this:

+------------------------------------------+ |||||||||---------- 14% ------------------ | +------------------------------------------+

See exampes/demo-Curses::UI::Progressbar in the distribution for a short demo.

-parent, -x, -y, -width, -height, -pad, -padleft, -padright, -padtop, -padbottom, -ipad, -ipadleft, -ipadright, -ipadtop, -ipadbottom, -title, -titlefullwidth, -titlereverse

For an explanation of these standard options, see Curses::UI::Widget.

• -min < \s-1VALUE\s0 > This opion sets the minimum value for the progress bar. Default is 0.

• -max < \s-1VALUE\s0 > This opion sets the maximum value for the progress bar.

• -pos < \s-1VALUE\s0 > This option sets the startposition for the progress bar.

• -nopercentage < \s-1BOOLEAN\s0 > This option controls if a percentage indicator should be drawn in the widget. The default for the \s-1BOOLEAN\s0 value is false, so a percentage incdicator will be drawn.

• -showvalue < \s-1BOOLEAN\s0 > If this option is set to a true value, the current position value will be drawn in the widget.

• -nocenterline < \s-1BOOLEAN\s0 > This option controls if a horizontal line should be drawn in the widget. The default for the \s-1BOOLEAN\s0 value is false, so a horizontal line will be drawn.

• new ( \s-1OPTIONS\s0 )

• layout ( )

• draw ( \s-1BOOLEAN\s0 )

• intellidraw ( )

• focus ( ) These are standard methods. See Curses::UI::Widget for an explanation of these.

• get ( ) This method will return the current -pos value of the widget.

• pos ( \s-1VALUE\s0 ) This method will set the -pos value of the widget to \s-1SCALAR\s0.

Since a Progressbar is a non-interacting widget, it does not have any bindings.

Curses::UI, Curses::UI::Widget, Curses::UI::Common

Copyright (c) 2001-2002 Maurice Makaay. All rights reserved.

Maintained by Marcus Thiesen ([email protected])

This package is free software and is provided \*(L"as is\*(R" without express or implied warranty. It may be used, redistributed and/or modified under the same terms as perl itself.