137 lines
4.8 KiB
HTML
137 lines
4.8 KiB
HTML
<HTML>
|
|
<HEAD><TITLE>ProgressBar</TITLE></HEAD>
|
|
<BODY BGCOLOR=white>
|
|
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
|
<DD><B>ProgressBar</B>
|
|
- Progress indicator widget
|
|
</DD></DL>
|
|
<DL>
|
|
<DT><I>CREATION</I></DT>
|
|
<DD><A HREF="#descr"><B>ProgressBar</B></A> <I>pathName</I> ?<I>option value...</I>?</DD>
|
|
</DL>
|
|
<DL>
|
|
<DT><I>STANDARD OPTIONS</I></DT>
|
|
<DD><TABLE CELLSPACING=0 CELLSPACING=0 BORDER=0>
|
|
<TR>
|
|
<TD> <A HREF="options.htm#M-background">-background or -bg</A></TD>
|
|
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
|
<TD> <A HREF="options.htm#M-orient">-orient</A></TR>
|
|
</TR>
|
|
<TR>
|
|
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
|
<TD> <A HREF="options.htm#M-troughcolor">-troughcolor</A></TR>
|
|
</TR>
|
|
</TABLE></DD>
|
|
</DL>
|
|
<DL>
|
|
<DT><I><A HREF="#wso">WIDGET-SPECIFIC OPTIONS</A></I></DT>
|
|
<DD><TABLE CELLSPACING=0 CELLSPACING=0 BORDER=0>
|
|
<TR>
|
|
<TD> <A HREF="#-height">-height</A></TR>
|
|
<TD> <A HREF="#-maximum">-maximum</A></TR>
|
|
</TR>
|
|
<TR>
|
|
<TD> <A HREF="#-type">-type</A></TR>
|
|
<TD> <A HREF="#-variable">-variable</A></TR>
|
|
</TR>
|
|
<TR>
|
|
<TD> <A HREF="#-width">-width</A></TR>
|
|
</TABLE></DD>
|
|
</DL>
|
|
<DL>
|
|
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
|
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
|
<I>option</I>
|
|
</DD>
|
|
<DD><I>pathName</I> <A HREF="#configure"><B>configure</B></A>
|
|
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
|
|
</DD>
|
|
</DL>
|
|
<BR><HR WIDTH="100%"><BR>
|
|
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
|
<P>
|
|
|
|
ProgressBar widget indicates the user the progress of a lengthly operation.
|
|
It is used by <A HREF="MainFrame.html">MainFrame</A>
|
|
and <A HREF="ProgressDlg.html">ProgressDlg</A>.
|
|
</P>
|
|
<BR><HR WIDTH="50%"><BR>
|
|
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
|
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
|
<DD>
|
|
|
|
Specifies the desired height for the progress indicator.
|
|
</DD>
|
|
</DL>
|
|
<DL><DT><A NAME="-maximum"><B>-maximum</B></A></DT>
|
|
<DD>
|
|
|
|
Specifies the maximum value of the variable.
|
|
|
|
</DD>
|
|
</DL>
|
|
<DL><DT><A NAME="-type"><B>-type</B></A></DT>
|
|
<DD>
|
|
|
|
Specifies the type of the ProgressBar. Must be one of <B>normal</B>, <B>incremental</B> or
|
|
<B>infinite</B>.
|
|
<BR>If <B>type</B> is <I>normal</I>, the progress indicator is drawn proportional
|
|
to the variable value and <B>maximum</B> option each time the variable is set.
|
|
<BR>If <B>type</B> is <I>incremental</I>, the value of the progress indicator is maintained internally,
|
|
and incremented each time the variable is set by its value. The progress indicator is drawn proportional
|
|
to the internal value and <B>maximum</B> option.
|
|
<BR>If <B>type</B> is <I>infinite</I>, the value of the progress indicator is maintained internally,
|
|
and incremented each time the variable is set by its value. The progress indicator grow from left to
|
|
right if internal value (modulo <B>maximum</B>) is less than <B>maximum</B>/2, and from right to left if
|
|
internal value is greater than <B>maximum</B>/2.
|
|
<BR>See <B>-variable</B> option for special case of its value,
|
|
|
|
</DD>
|
|
</DL>
|
|
<DL><DT><A NAME="-variable"><B>-variable</B></A></DT>
|
|
<DD>
|
|
|
|
Specifies the variable attached to the progress indicator.
|
|
Progress indicator is updated when the value of the variable changes.
|
|
If the value of the variable is negative, the progress indicator is not
|
|
displayed (it is drawn flat with <B>background</B> color
|
|
- usefull for ProgressDlg to make it invisible). If its value 0, progress indicator
|
|
is reinitialized.
|
|
|
|
</DD>
|
|
</DL>
|
|
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
|
<DD>
|
|
|
|
Specifies the desired width for the progress indicator.
|
|
</DD>
|
|
</DL>
|
|
<HR WIDTH="50%"><BR>
|
|
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
|
<DL><DT><A NAME="cget"><I>pathName</I> <B>cget</B></A>
|
|
<I>option</I>
|
|
</DT><DD>
|
|
|
|
Returns the current value of the configuration option given by <I>option</I>.
|
|
<I>Option</I> may have any of the values accepted by the creation command.
|
|
</DD></DL>
|
|
<DL><DT><A NAME="configure"><I>pathName</I> <B>configure</B></A>
|
|
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
|
|
</DT><DD>
|
|
|
|
Query or modify the configuration options of the widget. If no <I>option</I> is specified,
|
|
returns a list describing all of the available options for <I>pathName</I>.
|
|
If <I>option</I> is specified with no <I>value</I>, then the command returns a list
|
|
describing the one named <I>option</I> (this list will be identical to the corresponding
|
|
sublist of the value returned if no <I>option</I> is specified). If one or
|
|
more <I>option-value</I> pairs are specified, then the command modifies the given widget
|
|
option(s) to have the given value(s); in this case the command returns an empty string.
|
|
<I>Option</I> may have any of the values accepted by the creation command.
|
|
Read-only options are not be modified.
|
|
|
|
</DD></DL>
|
|
</BODY></HTML>
|