The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

IUP::ProgressBar - [GUI element] shows a percent value that can be updated to simulate a progression

DESCRIPTION

Creates a progress bar control. Shows a percent value that can be updated to simulate a progression.

DASHED=NO DASHED=YES MARQUEE=YES
Motif (same as DASHED=NO)
Windows Classic (same as DASHED)
Windows w/ Styles (same as DASHED=YES)
Windows Vista (same as DASHED=NO)
GTK

USAGE

CREATION - new() method

 $progressbar = IUP::ProgressBar->new( MIN=>0, MAX=>100 );

Returns: the identifier of the created element, or undef if an error occurs.

NOTE: You can pass to new() other ATTRIBUTE=>'value' or CALLBACKNAME=>\&func pairs relevant to this element - see IUP::Manual::02_Elements.

ATTRIBUTES

For more info about concept of attributes (setting/getting values etc.) see IUP::Manual::03_Attributes. Attributes specific to this element:

  • BGCOLOR [Windows Classic and Motif only]

    Controls the background color. Default: the global attribute DLGBGCOLOR.

  • DASHED (creation only in Windows) [Windows and GTK only]

    Changes the style of the progress bar for a dashed pattern. Default is "NO".

  • FGCOLOR [Windows Classic and Motif only]

    Controls the bar color. Default: the global attribute DLGFGCOLOR.

  • MARQUEE (creation)

    Displays an undefined state. Default: NO. You can set the attribute after map but only to start or stop the animation.

  • MAX (non inheritable)

    Contains the maximum value. Default is "1". The control display is not updated, must set VALUE attribute to update.

  • MIN (non inheritable)

    Contains the minimum value. Default is "0". The control display is not updated, must set VALUE attribute to update.

  • ORIENTATION (creation only)

    Can be "VERTICAL" or "HORIZONTAL". Default: "HORIZONTAL". Horizontal goes from left to right, and vertical from bottom to top.

  • RASTERSIZE

    The initial size is defined as "200x30". Set to undef to allow the use of smaller values in the layout computation.

  • VALUE (non inheritable)

    Contains a number between "MIN" and "MAX", controlling the current position.

The following common attributes are also accepted:

CALLBACKS

The following common callbacks are also accepted:

EXAMPLES

The element IUP::ProgressBar is used in the following sample scripts:

The original doc: iupprogressbar.html