.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Curses::UI::Progressbar 3"
.TH Curses::UI::Progressbar 3 2023-07-25 "perl v5.38.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::UI::Progressbar \- Create and manipulate progressbar widgets
.SH "CLASS HIERARCHY"
.IX Header "CLASS HIERARCHY"
.Vb 3
\& Curses::UI::Widget
\&    |
\&    +\-\-\-\-Curses::UI::Progressbar
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    use Curses::UI;
\&    my $cui = new Curses::UI;
\&    my $win = $cui\->add(\*(Aqwindow_id\*(Aq, \*(AqWindow\*(Aq);
\&
\&    my $progressbar = $win\->add(
\&        \*(Aqmyprogressbar\*(Aq, \*(AqProgressbar\*(Aq,
\&        \-max       => 250,
\&        \-pos       => 42,
\&    );
\&
\&    $progressbar\->draw;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
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:
.PP
.Vb 3
\& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
\& |||||||||\-\-\-\-\-\-\-\-\-\- 14% \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- |
\& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
.Ve
.PP
See exampes/demo\-Curses::UI::Progressbar in the distribution
for a short demo.
.SH "STANDARD OPTIONS"
.IX Header "STANDARD OPTIONS"
\&\fB\-parent\fR, \fB\-x\fR, \fB\-y\fR, \fB\-width\fR, \fB\-height\fR, 
\&\fB\-pad\fR, \fB\-padleft\fR, \fB\-padright\fR, \fB\-padtop\fR, \fB\-padbottom\fR,
\&\fB\-ipad\fR, \fB\-ipadleft\fR, \fB\-ipadright\fR, \fB\-ipadtop\fR, \fB\-ipadbottom\fR,
\&\fB\-title\fR, \fB\-titlefullwidth\fR, \fB\-titlereverse\fR
.PP
For an explanation of these standard options, see 
Curses::UI::Widget.
.SH "WIDGET-SPECIFIC OPTIONS"
.IX Header "WIDGET-SPECIFIC OPTIONS"
.IP \(bu 4
\&\fB\-min\fR < VALUE >
.Sp
This opion sets the minimum value for the progress bar. 
Default is 0.
.IP \(bu 4
\&\fB\-max\fR < VALUE >
.Sp
This opion sets the maximum value for the progress bar.
.IP \(bu 4
\&\fB\-pos\fR < VALUE >
.Sp
This option sets the startposition for the progress
bar.
.IP \(bu 4
\&\fB\-nopercentage\fR < BOOLEAN >
.Sp
This option controls if a percentage indicator should
be drawn in the widget. The default for the BOOLEAN 
value is false, so a percentage incdicator will be drawn.
.IP \(bu 4
\&\fB\-showvalue\fR < BOOLEAN >
.Sp
If this option is set to a true value, the current
position value will be drawn in the widget.
.IP \(bu 4
\&\fB\-nocenterline\fR < BOOLEAN >
.Sp
This option controls if a horizontal line should
be drawn in the widget. The default for the BOOLEAN 
value is false, so a horizontal line will be drawn.
.SH METHODS
.IX Header "METHODS"
.IP \(bu 4
\&\fBnew\fR ( OPTIONS )
.IP \(bu 4
\&\fBlayout\fR ( )
.IP \(bu 4
\&\fBdraw\fR ( BOOLEAN )
.IP \(bu 4
\&\fBintellidraw\fR ( )
.IP \(bu 4
\&\fBfocus\fR ( )
.Sp
These are standard methods. See Curses::UI::Widget 
for an explanation of these.
.IP \(bu 4
\&\fBget\fR ( )
.Sp
This method will return the current \fB\-pos\fR value of the widget.
.IP \(bu 4
\&\fBpos\fR ( VALUE )
.Sp
This method will set the \fB\-pos\fR value of the widget to SCALAR.
.SH "DEFAULT BINDINGS"
.IX Header "DEFAULT BINDINGS"
Since a Progressbar is a non-interacting widget, it does not have
any bindings.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Curses::UI, 
Curses::UI::Widget, 
Curses::UI::Common
.SH AUTHOR
.IX Header "AUTHOR"
Copyright (c) 2001\-2002 Maurice Makaay. All rights reserved.
.PP
Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)
.PP
This package is free software and is provided "as is" without express
or implied warranty. It may be used, redistributed and/or modified
under the same terms as perl itself.