home *** CD-ROM | disk | FTP | other *** search
-
- <HTML>
- <HEAD>
- <TITLE>Tk::ProgressBar - A graphical progress bar</TITLE>
- <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
- <LINK REV="made" HREF="mailto:">
- </HEAD>
-
- <BODY>
- <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
- <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
- <STRONG><P CLASS=block> Tk::ProgressBar - A graphical progress bar</P></STRONG>
- </TD></TR>
- </TABLE>
-
- <A NAME="__index__"></A>
- <!-- INDEX BEGIN -->
-
- <UL>
-
- <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
-
- <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
- <LI><A HREF="#description">DESCRIPTION</A></LI>
- <LI><A HREF="#standard options">STANDARD OPTIONS</A></LI>
- <LI><A HREF="#widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></LI>
- <LI><A HREF="#widget methods">WIDGET METHODS</A></LI>
- <LI><A HREF="#author">AUTHOR</A></LI>
- <LI><A HREF="#copyright">COPYRIGHT</A></LI>
- </UL>
- <!-- INDEX END -->
-
- <HR>
- <P>
- <H1><A NAME="name">NAME</A></H1>
- <P>Tk::ProgressBar - A graphical progress bar</P>
- <P>
- <HR>
- <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
- <UL>
- <LI>Linux</LI>
- <LI>Solaris</LI>
- <LI>Windows</LI>
- </UL>
- <HR>
- <H1><A NAME="synopsis">SYNOPSIS</A></H1>
- <PRE>
- use Tk::ProgressBar;
- </PRE>
- <PRE>
-
- $progress = $parent->ProgressBar(
- -width => 200,
- -height => 20,
- -from => 0,
- -to => 100,
- -blocks => 10,
- -colors => [0, 'green', 50, 'yellow' , 80, 'red'],
- -variable => \$percent_done
- );</PRE>
- <P>
- <HR>
- <H1><A NAME="description">DESCRIPTION</A></H1>
- <P><STRONG>Tk::ProgressBar</STRONG> provides a widget which will show a graphical representation
- of a value, given maximum and minimum reference values.</P>
- <P>
- <HR>
- <H1><A NAME="standard options">STANDARD OPTIONS</A></H1>
- <P><STRONG>-padx -pady -troughcolor -highlightthickness -borderwidth -relief</STRONG></P>
- <P>
- <HR>
- <H1><A NAME="widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></H1>
- <DL>
- <DT><STRONG><A NAME="item_%2Dwidth">-width</A></STRONG><BR>
- <DD>
- Specifies the desired narrow dimension of the ProgressBar in screen units (i.e.
- any of the forms acceptable to Tk_GetPixels). For vertical ProgressBars this is
- the ProgressBars width; for horizontal bars this is the ProgressBars height.
- <P></P>
- <DT><STRONG><A NAME="item_%2Dlength">-length</A></STRONG><BR>
- <DD>
- Specifies the desired long dimension of the ProgressBar in screen units (i.e. any
- of the forms acceptable to Tk_GetPixels). For vertical ProgressBars this is the
- ProgressBars height; for horizontal scales it is the ProgressBars width.
- <P></P>
- <DT><STRONG><A NAME="item_%2Dcolors">-colors</A></STRONG><BR>
- <DD>
- <DT><STRONG><A NAME="item_%2Dblocks">-blocks</A></STRONG><BR>
- <DD>
- <DT><STRONG><A NAME="item_%2Dresolution">-resolution</A></STRONG><BR>
- <DD>
- A real value specifying the resolution for the scale. If this value is greater
- than zero then the scale's value will always be rounded to an even multiple of
- this value, as will tick marks and the endpoints of the scale. If the value is
- less than zero then no rounding occurs. Defaults to 1 (i.e., the value will be
- integral).
- <P></P>
- <DT><STRONG><A NAME="item_%2Danchor">-anchor</A></STRONG><BR>
- <DD>
- <DT><STRONG><A NAME="item_%2Dvariable">-variable</A></STRONG><BR>
- <DD>
- Specifies the reference to a scalar variable to link to the ProgressBar.
- Whenever the value of the variable changes, the ProgressBar will upate
- to reflect this value. (See also the <STRONG>value</STRONG> method below.)
- <P></P>
- <DT><STRONG><A NAME="item_%2Dfrom">-from</A></STRONG><BR>
- <DD>
- <DT><STRONG><A NAME="item_%2Dto">-to</A></STRONG><BR>
- <DD>
- <DT><STRONG><A NAME="item_%2Dgap">-gap</A></STRONG><BR>
- <DD>
- </DL>
- <P>
- <HR>
- <H1><A NAME="widget methods">WIDGET METHODS</A></H1>
- <DL>
- <DT><STRONG><A NAME="item_value"><EM>$ProgressBar</EM>-><STRONG>value</STRONG>(?<EM>value</EM>?)</A></STRONG><BR>
- <DD>
- If <EM>value</EM> is omitted, returns the current value of the ProgressBar. If
- <EM>value</EM> is given, the value of the ProgressBar is set. If <EM>$value</EM> is
- given but undefined the value of the option <STRONG>-from</STRONG> is used.
- <P></P></DL>
- <P>
- <HR>
- <H1><A NAME="author">AUTHOR</A></H1>
- <P>Graham Barr <<EM><A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A></EM>></P>
- <P>
- <HR>
- <H1><A NAME="copyright">COPYRIGHT</A></H1>
- <P>Copyright (c) 1997-1998 Graham Barr. All rights reserved.
- This program is free software; you can redistribute it and/or modify it
- under the same terms as Perl itself.</P>
- <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
- <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
- <STRONG><P CLASS=block> Tk::ProgressBar - A graphical progress bar</P></STRONG>
- </TD></TR>
- </TABLE>
-
- </BODY>
-
- </HTML>
-