CLASS HIERARCHY

 Curses::UI::Widget
    |
    +----Curses::UI::Container
            |
            +----Curses::UI::Window
                    |
                    +----Curses::UI::Dialog::Progress

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;

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.

OPTIONS

  • -title < \s-1TEXT\s0 > Set the title of the dialog window to \s-1TEXT\s0.

  • -message < \s-1TEXT\s0 > This option sets the initial message to show to \s-1TEXT\s0. This message is displayed using a Curses::UI::Label, so it can not contain any newline (\n) characters.

  • -nomessage < \s-1BOOLEAN\s0 > If \s-1BOOLEAN\s0 has a true value, the dialog window will not contain a message label. By default -nomessage has a false value.

  • -min < \s-1VALUE\s0 >

  • -max < \s-1VALUE\s0 >

  • -pos < \s-1VALUE\s0 >

  • -nopercentage < \s-1BOOLEAN\s0 >

  • -nocenterline < \s-1BOOLEAN\s0 > These options control the progressbar of the dialog. For an explanation of these options, see Curses::UI::Progressbar.

METHODS

  • new ( \s-1OPTIONS\s0 )

  • layout ( )

  • draw ( \s-1BOOLEAN\s0 ) These are standard methods. See Curses::UI::Container for an explanation of these.

  • pos ( \s-1VALUE\s0 ) This method will update the position of the progressbar to \s-1SCALAR\s0. You will have to call the draw method to see the changes.

  • message ( \s-1TEXT\s0 ) This method will update the message of the progress dialog to \s-1TEXT\s0. You will have to call the draw method to see the changes.

RELATED TO Curses::UI::Dialog::Progress…

Curses::UI, Curses::UI::Container, Curses::UI::Progressbar

AUTHOR

Copyright (c) 2001-2002 Maurice Makaay. All rights reserved.

Maintained by Marcus Thiesen ([email protected])

This package is free software and is provided \*(L"as is\*(R" without express or implied warranty. It may be used, redistributed and/or modified under the same terms as perl itself.