1<TITLE>feedback - Create and manipulate a feedback widget to display feedback on</TITLE> 2<H1>feedback - Create and manipulate a feedback widget to display feedback on</H1> 3 4the current status of an ongoing operation to the user. 5</pre><H2>SYNOPSIS</H2> 6<B>feedback<I> <I>pathName </I>?<I>options</I>? 7</pre><H2>INHERITANCE</H2> 8itk::Widget <- Labeledwidget <- Feedback 9</pre><H2>STANDARD OPTIONS</H2> 10<P> 11<table cellpadding=5> 12<td valign=top> 13<B>background</B><br> 14<B>highlightThickness</B><br> 15</td> 16<td valign=top> 17<B>cursor</B><br> 18</td> 19<td valign=top> 20<B>foreground</B><br> 21</td> 22<td valign=top> 23<B>highlightColor</B><br> 24</td> 25</table> 26<P> 27See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/options.n.html"> "options" </A> manual entry for details on the standard options. 28</pre><H2>INHERITED OPTIONS</H2> 29<P> 30<table cellpadding=5> 31<td valign=top> 32<B>labelBitmap</B><br> 33<B>labelPos</B><br> 34</td> 35<td valign=top> 36<B>labelFont</B><br> 37<B>labelText</B><br> 38</td> 39<td valign=top> 40<B>labelImage</B><br> 41<B>labelVariable</B><br> 42</td> 43<td valign=top> 44<B>labelMargin</B><br> 45</td> 46</table> 47<P> 48See the <A HREF="labeledwidget.n.html"> "labeledwidget" </A> class manual entry for details on the inherited options. 49</pre><H2>WIDGET-SPECIFIC OPTIONS</H2> 50<P> 51<pre> 52Name: <B>barcolor</B> 53Class: <B>BarColor</B> 54Command-Line Switch: <B>-barcolor</B> 55</pre> 56<UL> 57Specifies the color of the status bar, in any of the forms 58acceptable to <B>Tk_GetColor</B>. The default is DodgerBlue. 59</UL> 60<P> 61<pre> 62Name: <B>barheight</B> 63Class: <B>BarHeight</B> 64Command-Line Switch: <B>-barheight</B> 65</pre> 66<UL> 67Specifies the height of the status bar, in any of the forms 68acceptable to <B>Tk_GetPixels</B>. The default is 20. 69</UL> 70<P> 71<pre> 72Name: <B>troughColor</B> 73Class: <B>TroughColor</B> 74Command-Line Switch: <B>-troughcolor</B> 75</pre> 76<UL> 77Specifies the color of the frame in which the status bar sits, 78in any of the forms acceptable to <B>Tk_GetColor</B>. The default is white. 79</UL> 80<P> 81<pre> 82Name: <B>steps</B> 83Class: <B>Steps</B> 84Command-Line Switch: <B>-steps</B> 85</pre> 86<UL> 87Specifies the total number of steps for the status bar. The default is 10. 88</UL> 89<P> 90 91</pre><H2>DESCRIPTION</H2> 92<P> 93The <B>feedback</B> command creates a widget to display feedback on 94the current status of an ongoing operation to the user. Display is given as 95a percentage and as a thermometer type bar. Options exist for adding a label 96and controlling its position. 97 98</pre><H2>METHODS</H2> 99<P> 100The <B>feedback</B> command creates a new Tcl command whose 101name is <I>pathName</I>. This command may be used to invoke various 102operations on the widget. It has the following general form: 103<pre> 104<I>pathName option </I>?<I>arg arg ...</I>? 105</pre> 106<I>Option</I> and the <I>arg</I>s 107determine the exact behavior of the command. The following 108commands are possible for scrolledtext widgets: 109 110</pre><H2>WIDGET-SPECIFIC METHODS</H2> 111<DL> 112<DT> <I>pathName <B>cget</B> <I>option</I> 113</I></B> 114<DD> Returns the current value of the configuration option given 115by <I>option</I>. 116<I>Option</I> may have any of the values accepted by the <B>scrolledhtml</B> 117command. 118</DL> 119<DL> 120<DT> <I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>? 121</I></B> 122<DD> Query or modify the configuration options of the widget. 123If no <I>option</I> is specified, returns a list describing all of 124the available options for <I>pathName</I> (see <B>Tk_ConfigureInfo</B> for 125information on the format of this list). If <I>option</I> is specified 126with no <I>value</I>, then the command returns a list describing the 127one named option (this list will be identical to the corresponding 128sublist of the value returned if no <I>option</I> is specified). If 129one or more <I>option-value</I> pairs are specified, then the command 130modifies the given widget option(s) to have the given value(s); in 131this case the command returns an empty string. 132<I>Option</I> may have any of the values accepted by the <B>feedback</B> 133command. 134</DL> 135<DL> 136<DT> <I>pathName</I> <B>reset</B> 137</I></B> 138<DD> Reset the current number of steps completed to 0, and configures the 139percentage complete label text to 0% 140</DL> 141<DL> 142<DT> <I>pathName</I> <B>step</B> ?<I>inc</I>? 143</I></B> 144<DD> Increase the current number of steps completed by the amount specified 145by <I>inc</I>. <I>Inc</I> defaults to 1. 146 147</DL> 148</pre><H2>EXAMPLE</H2> 149<pre> 150 feedback .fb -labeltext "Status" -steps 20 151 pack .fb -padx 10 -pady 10 -fill both -expand yes 152 153 for {set i 0} {$i < 20} {incr i} { 154 .fb step 155 after 500 156 } 157</pre> 158</pre><H2>ACKNOWLEDGEMENTS</H2> 159Sam Shen 160<UL> 161This code is based largely on his feedback.tcl code from tk inspect. The 162original feedback code is copyright 1995 Lawrence Berkeley Laboratory. 163</UL> 164<P> 165</pre><H2>AUTHOR</H2> 166Kris Raney 167</pre><H2>KEYWORDS</H2> 168feedback, widget 169