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

.ds Aq ’

NAME

Curses::Widgets::ProgressBar - Progress Bar Widgets

CONTENTS

MODULE VERSION

$Id: ProgressBar.pm,v 1.103 2002/11/03 23:40:04 corliss Exp corliss $

SYNOPSIS



  use Curses::Widgets::ProgressBar;

  $progress = Curses::Widgets::ProgessBar->({
    CAPTION     => Progress,
    CAPTIONCOL  => yellow,
    LENGTH      => 10,
    VALUE       => 0,
    FOREGROUND  => undef,
    BACKGROUND  => black,
    BORDER      => 1,
    BORDERCOL   => undef,
    HORIZONTAL  => 1,
    X           => 1,
    Y           => 1,
    MIN         => 0,
    MAX         => 100,
    });

  $progress->draw($mwh);

  $progress->input(5);

  See the Curses::Widgets pod for other methods.



REQUIREMENTS

Curses
Curses::Widgets

DESCRIPTION

Curses::Widgets::ProgressBar provides simplified OO access to Curses-based progress bar. Each object maintains it’s own state information.

Note that this widget is designed for rendering, not interactive input. The application should update the the value of the bar by either calling the <B>inputB> method, which will add the passed value to the widget’s current value, or by setting the value directly via the <B>setFieldB> method.

METHODS

    new (inherited from Curses::Widgets)



  $progress = Curses::Widgets::ProgressBar->({
    CAPTION     => Progress,
    CAPTIONCOL  => yellow,
    LENGTH      => 10,
    VALUE       => 0,
    FOREGROUND  => undef,
    BACKGROUND  => black,
    BORDER      => 1,
    BORDERCOL   => undef,
    HORIZONTAL  => 1,
    X           => 1,
    Y           => 1,
    MIN         => 0,
    MAX         => 100,
    });



The new method instantiates a new Progress Bar object. The only mandatory key/value pairs in the configuration hash are <B>XB> and <B>YB>. All others have the following defaults:



  Key         Default   Description
  ============================================================
  CAPTION       undef   Caption superimposed on border
  CAPTIONCOL    undef   Foreground colour for caption text
  LENGTH           10   Number of columns for the bar
  VALUE             0   Current value
  FOREGROUND    undef   Default foreground colour
  BACKGROUND    undef   Default blackground colour
  BORDER            1   Display border around the set
  BORDERCOL     undef   Foreground colour for border
  HORIZONTAL        1   Horizontal orientation for bar
  MIN               0   Low value for bar (0%)
  MAX             100   High vlaue for bar (100%)



Setting the value will change the length of the bar, based on the bounds set with <B>MINB> and <B>MAXB>. The <B>CAPTIONB> is only rendered on the border of a horizontal progress bar.

    draw



  $progress->draw($mwh);



The draw method renders the progress bar in its current state. This requires a valid handle to a curses window in which it will render itself.

    input



  $progress->input(5);



The argument is added to the progress bar’s current value.

HISTORY

2001/07/05 — First implementation

AUTHOR/COPYRIGHT

(c) 2001 Arthur Corliss (corliss@digitalmages.com)
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 WIDGETS::PROGRESSBAR (3) 2002-11-14

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