.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Widgets::ProgressBar 3pm"
.TH Widgets::ProgressBar 3pm "2022-06-12" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Curses::Widgets::ProgressBar \- Progress Bar Widgets
.SH "MODULE VERSION"
.IX Header "MODULE VERSION"
\&\f(CW$Id:\fR ProgressBar.pm,v 1.103 2002/11/03 23:40:04 corliss Exp corliss $
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Curses::Widgets::ProgressBar;
\&
\&  $progress = Curses::Widgets::ProgessBar\->({
\&    CAPTION     => \*(AqProgress\*(Aq,
\&    CAPTIONCOL  => \*(Aqyellow\*(Aq,
\&    LENGTH      => 10,
\&    VALUE       => 0,
\&    FOREGROUND  => undef,
\&    BACKGROUND  => \*(Aqblack\*(Aq,
\&    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.
.Ve
.SH "REQUIREMENTS"
.IX Header "REQUIREMENTS"
.IP "Curses" 4
.IX Item "Curses"
.PD 0
.IP "Curses::Widgets" 4
.IX Item "Curses::Widgets"
.PD
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Curses::Widgets::ProgressBar provides simplified \s-1OO\s0 access to Curses-based
progress bar.  Each object maintains it's own state information.
.PP
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
\&\fBinput\fR method, which will add the passed value to the widget's current
value, or by setting the value directly via the \fBsetField\fR method.
.SH "METHODS"
.IX Header "METHODS"
.SS "new (inherited from Curses::Widgets)"
.IX Subsection "new (inherited from Curses::Widgets)"
.Vb 10
\&  $progress = Curses::Widgets::ProgressBar\->({
\&    CAPTION     => \*(AqProgress\*(Aq,
\&    CAPTIONCOL  => \*(Aqyellow\*(Aq,
\&    LENGTH      => 10,
\&    VALUE       => 0,
\&    FOREGROUND  => undef,
\&    BACKGROUND  => \*(Aqblack\*(Aq,
\&    BORDER      => 1,
\&    BORDERCOL   => undef,
\&    HORIZONTAL  => 1,
\&    X           => 1,
\&    Y           => 1,
\&    MIN         => 0,
\&    MAX         => 100,
\&    });
.Ve
.PP
The new method instantiates a new Progress Bar object.  The only mandatory
key/value pairs in the configuration hash are \fBX\fR and \fBY\fR.  
All others have the following defaults:
.PP
.Vb 10
\&  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%)
.Ve
.PP
Setting the value will change the length of the bar, based on the bounds set
with \fB\s-1MIN\s0\fR and \fB\s-1MAX\s0\fR.  The \fB\s-1CAPTION\s0\fR is only rendered on the border of a
horizontal progress bar.
.SS "draw"
.IX Subsection "draw"
.Vb 1
\&  $progress\->draw($mwh);
.Ve
.PP
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.
.SS "input"
.IX Subsection "input"
.Vb 1
\&  $progress\->input(5);
.Ve
.PP
The argument is added to the progress bar's current value.
.SH "HISTORY"
.IX Header "HISTORY"
.IP "2001/07/05 \*(-- First implementation" 4
.IX Item "2001/07/05 First implementation"
.SH "AUTHOR/COPYRIGHT"
.IX Header "AUTHOR/COPYRIGHT"
(c) 2001 Arthur Corliss (corliss@digitalmages.com)