Curses::UI::Dialog::Progress(3pm) - phpMan

Command: man perldoc info search(apropos)  


Curses::UI::Dialog::Progress(3)User Contributed Perl DocumentationCurses::UI::Dialog::Progress(3)



NAME
       Curses::UI::Dialog::Progress - Create and manipulate progress dialogs

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
       o   -title < TEXT >

           Set the title of the dialog window to TEXT.

       o   -message < TEXT >

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

       o   -nomessage < BOOLEAN >

           If BOOLEAN has a true value, the dialog window will not contain a message label. By
           default -nomessage has a false value.

       o   -min < VALUE >

       o   -max < VALUE >

       o   -pos < VALUE >

       o   -nopercentage < BOOLEAN >

       o   -nocenterline < BOOLEAN >

           These options control the progressbar of the dialog. For an explanation of these
           options, see Curses::UI::Progressbar.

METHODS
       o   new ( OPTIONS )

       o   layout ( )

       o   draw ( BOOLEAN )

           These are standard methods. See Curses::UI::Container for an explanation of these.

       o   pos ( VALUE )

           This method will update the position of the progressbar to SCALAR. You will have to
           call the draw method to see the changes.

       o   message ( TEXT )

           This method will update the message of the progress dialog to TEXT. You will have to
           call the draw method to see the changes.

SEE ALSO
       Curses::UI, Curses::UI::Container, Curses::UI::Progressbar

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

       Maintained by Marcus Thiesen (marcus AT cpan.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.



perl v5.16.3                                2011-09-01            Curses::UI::Dialog::Progress(3)

Generated by $Id: phpMan.php,v 4.55 2007/09/05 04:42:51 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2024-04-25 16:03 @3.147.67.54 CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
Valid XHTML 1.0!Valid CSS!