/usr/share/perl5/Curses/UI/Dialog/Progress.pm is in libcurses-ui-perl 0.9609-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | # ----------------------------------------------------------------------
# Curses::UI::Dialog::Progress
#
# (c) 2001-2002 by Maurice Makaay. All rights reserved.
# This file is part of Curses::UI. Curses::UI is free software.
# You can redistribute it and/or modify it under the same terms
# as perl itself.
#
# Currently maintained by Marcus Thiesen
# e-mail: marcus@cpan.thiesenweb.de
# ----------------------------------------------------------------------
package Curses::UI::Dialog::Progress;
use strict;
use Curses;
use Curses::UI::Common;
use Curses::UI::Window;
use vars qw(
$VERSION
@ISA
);
@ISA = qw(
Curses::UI::Window
Curses::UI::Common
);
$VERSION = '1.10';
sub new ()
{
my $class = shift;
my %userargs = @_;
keys_to_lowercase(\%userargs);
my %args = (
-nomessage => 0, # Do we want a message or not?
-message => '', # The message to show
-min => undef, # Arguments for the progressbar
-max => undef,
-pos => undef,
-nocenterline => undef,
-nopercentage => undef,
-ipad => 1, # Default widget settings
-border => 1,
-width => 60,
-height => undef,
-fg => -1,
-bg => -1,
%userargs,
-centered => 1,
);
my $this = $class->SUPER::new(%args);
unless ($args{-nomessage})
{
$this->add(
'label', 'Label',
-width => -1,
-text => $this->{-message},
-intellidraw => 0,
);
}
# Create the progress bar arguments.
my %pb_args = ();
foreach my $var (qw(-min -max -pos -nopercentage -nocenterline))
{
if (defined $this->{$var}) {
$pb_args{$var} = $this->{$var};
}
}
$this->add(
'progressbar', 'Progressbar',
-y => -1,
-width => -1,
-fg => $this->{-fg},
-bg => $this->{-bg},
%pb_args,
-intellidraw => 0,
);
$this->layout();
bless $this, $class;
}
# There is no need to focus a progress dialog
sub focus() {} ;
sub layout()
{
my $this = shift;
if (not defined $this->{-height}
and defined $this->getobj('progressbar'))
{
# Space between progressbar and message.
my $need = ($this->{-nomessage} ? 0 : 1);
# The height for the message.
if (defined $this->getobj('label')) {
$need += $this->getobj('label')->height;
}
# The height for the progressbar.
if (defined $this->getobj('progressbar')) {
my $pbheight = $this->getobj('progressbar')->height;
$need += $pbheight;
}
my $height = $this->height_by_windowscrheight($need, %$this);
$this->{-height} = $height;
}
$this->SUPER::layout or return;
return $this;
}
sub pos($;)
{
my $this = shift;
my $pos = shift;
$this->getobj('progressbar')->pos($pos);
return $this;
}
sub message()
{
my $this = shift;
return $this if $this->{-nomessage};
my $msg = shift;
$this->getobj('label')->text($msg);
return $this;
}
1;
=pod
=head1 NAME
Curses::UI::Dialog::Progress - Create and manipulate progress dialogs
=head1 CLASS HIERARCHY
Curses::UI::Widget
|
+----Curses::UI::Container
|
+----Curses::UI::Window
|
+----Curses::UI::Dialog::Progress
=head1 SYNOPSIS
use Curses::UI;
my $cui = new Curses::UI;
my $win = $cui->add('window_id', 'Window');
# The hard way.
# -------------
my $dialog = $win->add(
'mydialog', 'Dialog::Progress',
-max => 100,
-message => 'Some message',
);
$dialog->pos(10);
$dialog->message('Some other message');
$dialog->draw();
$win->delete('mydialog');
# The easy way (see Curses::UI documentation).
# --------------------------------------------
$cui->progress(
-max => 100,
-message => 'Some message',
);
$cui->setprogress(10, 'Some other message');
$cui->noprogress;
=head1 DESCRIPTION
Curses::UI::Dialog::Progress is not really a dialog, since
the user has no way of interacting with it. It is merely
a way of presenting progress information to the user of
your program.
See exampes/demo-Curses::UI::Dialog::Progress in the
distribution for a short demo.
=head1 OPTIONS
=over 4
=item * B<-title> < TEXT >
Set the title of the dialog window to TEXT.
=item * B<-message> < TEXT >
This option sets the initial message to show to TEXT.
This message is displayed using a L<Curses::UI::Label|Curses::UI::Label>,
so it can not contain any newline (\n) characters.
=item * B<-nomessage> < BOOLEAN >
If BOOLEAN has a true value, the dialog window will not contain
a message label. By default B<-nomessage> has a false value.
=item * B<-min> < VALUE >
=item * B<-max> < VALUE >
=item * B<-pos> < VALUE >
=item * B<-nopercentage> < BOOLEAN >
=item * B<-nocenterline> < BOOLEAN >
These options control the progressbar of the dialog. For an explanation
of these options, see L<Curses::UI::Progressbar|Curses::UI::Progressbar>.
=back
=head1 METHODS
=over 4
=item * B<new> ( OPTIONS )
=item * B<layout> ( )
=item * B<draw> ( BOOLEAN )
These are standard methods. See L<Curses::UI::Container|Curses::UI::Container>
for an explanation of these.
=item * B<pos> ( VALUE )
This method will update the position of the progressbar
to SCALAR. You will have to call the B<draw> method to see the changes.
=item * B<message> ( TEXT )
This method will update the message of the progress dialog
to TEXT. You will have to call the B<draw> method to see the changes.
=back
=head1 SEE ALSO
L<Curses::UI|Curses::UI>,
L<Curses::UI::Container|Curses::UI::Container>,
L<Curses::UI::Progressbar|Curses::UI::Progressbar>
=head1 AUTHOR
Copyright (c) 2001-2002 Maurice Makaay. All rights reserved.
Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)
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.
|