GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CURSES::UI::DIALOG::PROGRESS (3)

.ds Aq ’

NAME

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

CONTENTS

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 <B>-titleB> < TEXT >

Set the title of the dialog window to TEXT.

o <B>-messageB> < 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 <B>-nomessageB> < BOOLEAN >

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

o <B>-minB> < VALUE >
o <B>-maxB> < VALUE >
o <B>-posB> < VALUE >
o <B>-nopercentageB> < BOOLEAN >
o <B>-nocenterlineB> < BOOLEAN >

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

METHODS

o <B>newB> ( OPTIONS )
o <B>layoutB> ( )
o <B>drawB> ( BOOLEAN )

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

o <B>posB> ( VALUE )

This method will update the position of the progressbar to SCALAR. You will have to call the <B>drawB> method to see the changes.

o <B>messageB> ( TEXT )

This method will update the message of the progress dialog to TEXT. You will have to call the <B>drawB> 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@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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 CURSES::UI::DIALOG::PROGRESS (3) 2011-09-01

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.