1Curses::UI::Dialog::ProUgsreerssC(o3n)tributed Perl DocuCmuernsteast:i:oUnI::Dialog::Progress(3)
2
3
4

NAME

6       Curses::UI::Dialog::Progress - Create and manipulate progress dialogs
7

CLASS HIERARCHY

9        Curses::UI::Widget
10           |
11           +----Curses::UI::Container
12                   |
13                   +----Curses::UI::Window
14                           |
15                           +----Curses::UI::Dialog::Progress
16

SYNOPSIS

18           use Curses::UI;
19           my $cui = new Curses::UI;
20           my $win = $cui->add('window_id', 'Window');
21
22           # The hard way.
23           # -------------
24           my $dialog = $win->add(
25               'mydialog', 'Dialog::Progress',
26           -max       => 100,
27               -message   => 'Some message',
28           );
29
30           $dialog->pos(10);
31           $dialog->message('Some other message');
32           $dialog->draw();
33
34           $win->delete('mydialog');
35
36           # The easy way (see Curses::UI documentation).
37           # --------------------------------------------
38           $cui->progress(
39           -max       => 100,
40               -message   => 'Some message',
41           );
42           $cui->setprogress(10, 'Some other message');
43           $cui->noprogress;
44

DESCRIPTION

46       Curses::UI::Dialog::Progress is not really a dialog, since the user has
47       no way of interacting with it. It is merely a way of presenting
48       progress information to the user of your program.
49
50       See exampes/demo-Curses::UI::Dialog::Progress in the distribution for a
51       short demo.
52

OPTIONS

54       ·   -title < TEXT >
55
56           Set the title of the dialog window to TEXT.
57
58       ·   -message < TEXT >
59
60           This option sets the initial message to show to TEXT.  This message
61           is displayed using a Curses::UI::Label, so it can not contain any
62           newline (\n) characters.
63
64       ·   -nomessage < BOOLEAN >
65
66           If BOOLEAN has a true value, the dialog window will not contain a
67           message label. By default -nomessage has a false value.
68
69       ·   -min < VALUE >
70
71       ·   -max < VALUE >
72
73       ·   -pos < VALUE >
74
75       ·   -nopercentage < BOOLEAN >
76
77       ·   -nocenterline < BOOLEAN >
78
79           These options control the progressbar of the dialog. For an
80           explanation of these options, see Curses::UI::Progressbar.
81

METHODS

83       ·   new ( OPTIONS )
84
85       ·   layout ( )
86
87       ·   draw ( BOOLEAN )
88
89           These are standard methods. See Curses::UI::Container for an
90           explanation of these.
91
92       ·   pos ( VALUE )
93
94           This method will update the position of the progressbar to SCALAR.
95           You will have to call the draw method to see the changes.
96
97       ·   message ( TEXT )
98
99           This method will update the message of the progress dialog to TEXT.
100           You will have to call the draw method to see the changes.
101

SEE ALSO

103       Curses::UI, Curses::UI::Container, Curses::UI::Progressbar
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.12.0                      2008-12-21   Curses::UI::Dialog::Progress(3)
Impressum