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::PROGRESSBAR (3)

.ds Aq ’

NAME

Curses::UI::Progressbar - Create and manipulate progressbar widgets

CONTENTS

CLASS HIERARCHY



 Curses::UI::Widget
    |
    +----Curses::UI::Progressbar



SYNOPSIS



    use Curses::UI;
    my $cui = new Curses::UI;
    my $win = $cui->add(window_id, Window);

    my $progressbar = $win->add(
        myprogressbar, Progressbar,
        -max       => 250,
        -pos       => 42,
    );

    $progressbar->draw;



DESCRIPTION

Curses::UI::Progressbar is a widget that can be used to provide some sort of progress information to the user of your program. The progressbar looks like this:



 +------------------------------------------+
 |||||||||---------- 14% ------------------ |
 +------------------------------------------+



See exampes/demo-Curses::UI::Progressbar in the distribution for a short demo.

STANDARD OPTIONS

<B>-parentB>, <B>-xB>, <B>-yB>, <B>-widthB>, <B>-heightB>, <B>-padB>, <B>-padleftB>, <B>-padrightB>, <B>-padtopB>, <B>-padbottomB>, <B>-ipadB>, <B>-ipadleftB>, <B>-ipadrightB>, <B>-ipadtopB>, <B>-ipadbottomB>, <B>-titleB>, <B>-titlefullwidthB>, <B>-titlereverseB>

For an explanation of these standard options, see Curses::UI::Widget.

WIDGET-SPECIFIC OPTIONS

o <B>-minB> < VALUE >

This opion sets the minimum value for the progress bar. Default is 0.

o <B>-maxB> < VALUE >

This opion sets the maximum value for the progress bar.

o <B>-posB> < VALUE >

This option sets the startposition for the progress bar.

o <B>-nopercentageB> < BOOLEAN >

This option controls if a percentage indicator should be drawn in the widget. The default for the BOOLEAN value is false, so a percentage incdicator will be drawn.

o <B>-showvalueB> < BOOLEAN >

If this option is set to a true value, the current position value will be drawn in the widget.

o <B>-nocenterlineB> < BOOLEAN >

This option controls if a horizontal line should be drawn in the widget. The default for the BOOLEAN value is false, so a horizontal line will be drawn.

METHODS

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

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

o <B>getB> ( )

This method will return the current <B>-posB> value of the widget.

o <B>posB> ( VALUE )

This method will set the <B>-posB> value of the widget to SCALAR.

DEFAULT BINDINGS

Since a Progressbar is a non-interacting widget, it does not have any bindings.

SEE ALSO

Curses::UI, Curses::UI::Widget, Curses::UI::Common

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::PROGRESSBAR (3) 2011-09-01

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