File: feedback.n.html

package info (click to toggle)
itcl3.0 3.0.1-6
links: PTS
area: main
in suites: sarge
size: 10,128 kB
ctags: 3,519
sloc: tcl: 32,416; ansic: 12,683; sh: 3,917; makefile: 692; awk: 273; perl: 265
file content (224 lines) | stat: -rw-r--r-- 6,366 bytes
parent folder | download | duplicates (8)
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>

<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>

feedback - Create and manipulate a feedback widget to
display feedback on the current status of an ongoing operation
to the user.
<P>

<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>

<B>feedback</B> <I>pathName</I> ?<I>options</I>?
<P>

<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>

itk::Widget &lt;- Labeledwidget &lt;- Feedback
<P>

<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>

<B>background</B>      <B>cursor</B>         <B>foreground</B>      <B>highlightColor</B>
<B>highlightThickness</B>
<P>
See the &quot;options&quot; manual entry for details on the standard
options.
<P>

<H2><A NAME="sect5" HREF="#toc5"><B>INHERITED</B> <B>OPTIONS</B></A></H2>

<B>labelBitmap</B>     <B>labelFont</B>      <B>labelImage</B>      <B>labelMargin</B>
<DL>
<DT><B>labelPos</B> <DD>       <B>labelText</B>      <B>labelVariable</B>
<P>
</DD>
</DL>
See the &quot;labeledwidget&quot; class manual entry for details on
the inherited options.
<P>

<H2><A NAME="sect6" HREF="#toc6"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>barcolor</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>BarColor</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-barcolor</B>
<P>
</DD>
</DL>
Specifies the color of the status bar, in any of the
forms acceptable to <B>Tk_GetColor</B>. The default is
DodgerBlue.
<P>
<DL>
<DT>Name: <DD>          <B>barheight</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>BarHeight</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-barheight</B>
<P>
</DD>
</DL>
Specifies the height of the status bar, in any of the
forms acceptable to <B>Tk_GetPixels</B>. The default is 20.
<P>
<DL>
<DT>Name: <DD>          <B>troughColor</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>TroughColor</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-troughcolor</B>
<P>
</DD>
</DL>
Specifies the color of the frame in which the status
bar sits, in any of the forms acceptable to
<B>Tk_GetColor</B>. The default is white.
<P>
<DL>
<DT>Name: <DD>          <B>steps</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Steps</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-steps</B>
<P>
</DD>
</DL>
Specifies the total number of steps for the status bar.
The default is 10.
<P>

<H2><A NAME="sect7" HREF="#toc7"><B>DESCRIPTION</B></A></H2>

The <B>feedback</B> command creates a widget to display feedback on
the current status of an ongoing operation to the user.
Display is given as a percentage and as a thermometer type
bar. Options exist for adding a label and controlling its
position.
<P>

<H2><A NAME="sect8" HREF="#toc8"><B>METHODS</B></A></H2>

The <B>feedback</B> command creates a new Tcl command whose name is
<I>pathName</I>. This command may be used to invoke various operations
on the widget. It has the following general form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for scrolledtext
widgets:
<P>

<H2><A NAME="sect9" HREF="#toc9"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>

<I>pathName</I> <B>cget</B> <I>option</I><BR>

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 <B>scrolledhtml</B> command.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
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>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (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</I> - <I>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 <B>feedback</B> command.
<P>
<I>pathName</I> <B>reset</B><BR>

Reset the current number of steps completed to 0, and
configures the percentage complete label text to 0%
<P>
<I>pathName</I> <B>step</B> ?<I>inc</I>?<BR>

Increase the current number of steps completed by the
amount specified by <I>inc</I>. <I>Inc</I> defaults to 1.
<P>

<H2><A NAME="sect10" HREF="#toc10"><B>EXAMPLE</B></A></H2>

feedback .fb -labeltext &quot;Status&quot; -steps 20
pack .fb -padx 10 -pady 10 -fill both -expand yes
<P>
for {set i 0} {$i &lt; 20} {incr i} {
.fb step<BR>

after 500<BR>

}
<P>

<H2><A NAME="sect11" HREF="#toc11"><B>ACKNOWLEDGEMENTS</B></A></H2>

Sam Shen
<P>
This code is based largely on his feedback.tcl code
from tk inspect. The original feedback code is copyright
1995 Lawrence Berkeley Laboratory.
<P>

<H2><A NAME="sect12" HREF="#toc12"><B>AUTHOR</B></A></H2>

Kris Raney
<P>

<H2><A NAME="sect13" HREF="#toc13"><B>KEYWORDS</B></A></H2>

feedback, widget
<P>

<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">DESCRIPTION</A></LI>
<LI><A NAME="toc8" HREF="#sect8">METHODS</A></LI>
<LI><A NAME="toc9" HREF="#sect9">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">EXAMPLE</A></LI>
<LI><A NAME="toc11" HREF="#sect11">ACKNOWLEDGEMENTS</A></LI>
<LI><A NAME="toc12" HREF="#sect12">AUTHOR</A></LI>
<LI><A NAME="toc13" HREF="#sect13">KEYWORDS</A></LI>
</UL>
</BODY></HTML>