1Curses::UI::ProgressbarU(s3e)r Contributed Perl DocumentaCtuirosnes::UI::Progressbar(3)
2
3
4

NAME

6       Curses::UI::Progressbar - Create and manipulate progressbar widgets
7

CLASS HIERARCHY

9        Curses::UI::Widget
10           |
11           +----Curses::UI::Progressbar
12

SYNOPSIS

14           use Curses::UI;
15           my $cui = new Curses::UI;
16           my $win = $cui->add('window_id', 'Window');
17
18           my $progressbar = $win->add(
19               'myprogressbar', 'Progressbar',
20               -max       => 250,
21               -pos       => 42,
22           );
23
24           $progressbar->draw;
25

DESCRIPTION

27       Curses::UI::Progressbar is a widget that can be used to provide some
28       sort of progress information to the user of your program. The
29       progressbar looks like this:
30
31        +------------------------------------------+
32        |||||||||---------- 14% ------------------ |
33        +------------------------------------------+
34
35       See exampes/demo-Curses::UI::Progressbar in the distribution for a
36       short demo.
37

STANDARD OPTIONS

39       -parent, -x, -y, -width, -height, -pad, -padleft, -padright, -padtop,
40       -padbottom, -ipad, -ipadleft, -ipadright, -ipadtop, -ipadbottom,
41       -title, -titlefullwidth, -titlereverse
42
43       For an explanation of these standard options, see Curses::UI::Widget.
44

WIDGET-SPECIFIC OPTIONS

46       •   -min < VALUE >
47
48           This opion sets the minimum value for the progress bar.  Default is
49           0.
50
51       •   -max < VALUE >
52
53           This opion sets the maximum value for the progress bar.
54
55       •   -pos < VALUE >
56
57           This option sets the startposition for the progress bar.
58
59       •   -nopercentage < BOOLEAN >
60
61           This option controls if a percentage indicator should be drawn in
62           the widget. The default for the BOOLEAN value is false, so a
63           percentage incdicator will be drawn.
64
65       •   -showvalue < BOOLEAN >
66
67           If this option is set to a true value, the current position value
68           will be drawn in the widget.
69
70       •   -nocenterline < BOOLEAN >
71
72           This option controls if a horizontal line should be drawn in the
73           widget. The default for the BOOLEAN value is false, so a horizontal
74           line will be drawn.
75

METHODS

77       •   new ( OPTIONS )
78
79       •   layout ( )
80
81       •   draw ( BOOLEAN )
82
83       •   intellidraw ( )
84
85       •   focus ( )
86
87           These are standard methods. See Curses::UI::Widget for an
88           explanation of these.
89
90       •   get ( )
91
92           This method will return the current -pos value of the widget.
93
94       •   pos ( VALUE )
95
96           This method will set the -pos value of the widget to SCALAR.
97

DEFAULT BINDINGS

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

SEE ALSO

103       Curses::UI, Curses::UI::Widget, Curses::UI::Common
104

AUTHOR

106       Copyright (c) 2001-2002 Maurice Makaay. All rights reserved.
107
108       Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)
109
110       This package is free software and is provided "as is" without express
111       or implied warranty. It may be used, redistributed and/or modified
112       under the same terms as perl itself.
113
114
115
116perl v5.36.0                      2023-01-20        Curses::UI::Progressbar(3)
Impressum