| 1 |
578 |
markom |
<HTML>
|
| 2 |
|
|
<HEAD>
|
| 3 |
|
|
<TITLE>iwidgets2.2.0 User Commands - feedback</TITLE>
|
| 4 |
|
|
</HEAD>
|
| 5 |
|
|
<BODY BGCOLOR="#FFFFFF">
|
| 6 |
|
|
<H1>iwidgets2.2.0 User Commands - feedback</H1>
|
| 7 |
|
|
<HR>
|
| 8 |
|
|
<PRE>
|
| 9 |
|
|
|
| 10 |
|
|
</PRE>
|
| 11 |
|
|
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
|
| 12 |
|
|
|
| 13 |
|
|
|
| 14 |
|
|
</PRE>
|
| 15 |
|
|
<H2>NAME</H2><PRE>
|
| 16 |
|
|
feedback - Create and manipulate a feedback widget to
|
| 17 |
|
|
display feedback on the current status of an ongoing opera-
|
| 18 |
|
|
tion to the user.
|
| 19 |
|
|
|
| 20 |
|
|
|
| 21 |
|
|
</PRE>
|
| 22 |
|
|
<H2>SYNOPSIS</H2><PRE>
|
| 23 |
|
|
<STRONG>feedback</STRONG> <EM>pathName</EM> ?<EM>options</EM>?
|
| 24 |
|
|
|
| 25 |
|
|
|
| 26 |
|
|
</PRE>
|
| 27 |
|
|
<H2>INHERITANCE</H2><PRE>
|
| 28 |
|
|
itk::Widget <- Labeledwidget <- Feedback
|
| 29 |
|
|
|
| 30 |
|
|
|
| 31 |
|
|
</PRE>
|
| 32 |
|
|
<H2>STANDARD OPTIONS</H2><PRE>
|
| 33 |
|
|
<STRONG>background</STRONG> <STRONG>borderWidth</STRONG> <STRONG>cursor</STRONG> <STRONG>foreground</STRONG>
|
| 34 |
|
|
<STRONG>highlightColor</STRONG> <STRONG>highlightThickness</STRONG> <STRONG>relief</STRONG>
|
| 35 |
|
|
|
| 36 |
|
|
See the "options" manual entry for details on the standard
|
| 37 |
|
|
options.
|
| 38 |
|
|
|
| 39 |
|
|
|
| 40 |
|
|
</PRE>
|
| 41 |
|
|
<H2>INHERITED OPTIONS</H2><PRE>
|
| 42 |
|
|
<STRONG>labelBitmap</STRONG> <STRONG>labelFont</STRONG> <STRONG>labelImage</STRONG> <STRONG>labelMargin</STRONG>
|
| 43 |
|
|
<STRONG>labelPos</STRONG> <STRONG>labelText</STRONG> <STRONG>labelVariable</STRONG>
|
| 44 |
|
|
|
| 45 |
|
|
See the "labeledwidget" class manual entry for details on
|
| 46 |
|
|
the inherited options.
|
| 47 |
|
|
|
| 48 |
|
|
|
| 49 |
|
|
</PRE>
|
| 50 |
|
|
<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>
|
| 51 |
|
|
Name: <STRONG>barColor</STRONG>
|
| 52 |
|
|
Class: <STRONG>BarColor</STRONG>
|
| 53 |
|
|
Command-Line Switch: <STRONG>-barcolor</STRONG>
|
| 54 |
|
|
|
| 55 |
|
|
Specifies the color of the status bar, in any of the
|
| 56 |
|
|
forms acceptable to <STRONG>Tk_GetColor</STRONG>.
|
| 57 |
|
|
|
| 58 |
|
|
Name: <STRONG>barHeight</STRONG>
|
| 59 |
|
|
Class: <STRONG>BarHeight</STRONG>
|
| 60 |
|
|
Command-Line Switch: <STRONG>-barheight</STRONG>
|
| 61 |
|
|
|
| 62 |
|
|
Specifies the height of the status bar, in any of the
|
| 63 |
|
|
forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
|
| 64 |
|
|
|
| 65 |
|
|
Name: <STRONG>barWidth</STRONG>
|
| 66 |
|
|
Class: <STRONG>BarWidth</STRONG>
|
| 67 |
|
|
Command-Line Switch: <STRONG>-barwidth</STRONG>
|
| 68 |
|
|
|
| 69 |
|
|
Specifies the total width of the status bar (when
|
| 70 |
|
|
full,) in any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
|
| 71 |
|
|
|
| 72 |
|
|
Name: <STRONG>elementBorderWidth</STRONG>
|
| 73 |
|
|
Class: <STRONG>BorderWidth</STRONG>
|
| 74 |
|
|
Command-Line Switch: <STRONG>-elementborderwidth</STRONG>
|
| 75 |
|
|
Sets the width of the border around the status bar, in
|
| 76 |
|
|
any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. If it is
|
| 77 |
|
|
set to zero, the status bar has no border.
|
| 78 |
|
|
|
| 79 |
|
|
Name: <STRONG>steps</STRONG>
|
| 80 |
|
|
Class: <STRONG>Steps</STRONG>
|
| 81 |
|
|
Command-Line Switch: <STRONG>-steps</STRONG>
|
| 82 |
|
|
|
| 83 |
|
|
Specifies the total number of steps for the status bar.
|
| 84 |
|
|
The default is 10.
|
| 85 |
|
|
|
| 86 |
|
|
|
| 87 |
|
|
</PRE>
|
| 88 |
|
|
<H2>DESCRIPTION</H2><PRE>
|
| 89 |
|
|
The <STRONG>feedback</STRONG> command creates a feedback widget to display
|
| 90 |
|
|
feedback on the current status of an ongoing operation to
|
| 91 |
|
|
the user. Display is given as a percentage and as a thermom-
|
| 92 |
|
|
eter type bar. Options exist for adding a label and control-
|
| 93 |
|
|
ling its position.
|
| 94 |
|
|
|
| 95 |
|
|
|
| 96 |
|
|
|
| 97 |
|
|
</PRE>
|
| 98 |
|
|
<H2>METHODS</H2><PRE>
|
| 99 |
|
|
The <STRONG>feedback</STRONG> command creates a new Tcl command whose name is
|
| 100 |
|
|
<EM>pathName</EM>. This command may be used to invoke various opera-
|
| 101 |
|
|
tions on the widget. It has the following general form:
|
| 102 |
|
|
|
| 103 |
|
|
<EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?
|
| 104 |
|
|
|
| 105 |
|
|
<EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-
|
| 106 |
|
|
mand. The following commands are possible for scrolledtext
|
| 107 |
|
|
widgets:
|
| 108 |
|
|
|
| 109 |
|
|
|
| 110 |
|
|
|
| 111 |
|
|
</PRE>
|
| 112 |
|
|
<H2>WIDGET-SPECIFIC METHODS</H2><PRE>
|
| 113 |
|
|
<EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>
|
| 114 |
|
|
Returns the current value of the configuration option
|
| 115 |
|
|
given by <EM>option</EM>. <EM>Option</EM> may have any of the values
|
| 116 |
|
|
accepted by the <STRONG>scrolledhtml</STRONG> command.
|
| 117 |
|
|
|
| 118 |
|
|
<EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?
|
| 119 |
|
|
Query or modify the configuration options of the
|
| 120 |
|
|
widget. If no <EM>option</EM> is specified, returns a list
|
| 121 |
|
|
describing all of the available options for <EM>pathName</EM>
|
| 122 |
|
|
(see <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of
|
| 123 |
|
|
this list). If <EM>option</EM> is specified with no <EM>value</EM>, then
|
| 124 |
|
|
the command returns a list describing the one named
|
| 125 |
|
|
option (this list will be identical to the correspond-
|
| 126 |
|
|
ing sublist of the value returned if no <EM>option</EM> is
|
| 127 |
|
|
specified). If one or more <EM>option</EM> - <EM>value</EM> pairs are
|
| 128 |
|
|
specified, then the command modifies the given widget
|
| 129 |
|
|
option(s) to have the given value(s); in this case the
|
| 130 |
|
|
command returns an empty string. <EM>Option</EM> may have any
|
| 131 |
|
|
of the values accepted by the <STRONG>feedback</STRONG> command.
|
| 132 |
|
|
|
| 133 |
|
|
<EM>pathName</EM> <STRONG>reset</STRONG>
|
| 134 |
|
|
Reset status to 0%
|
| 135 |
|
|
|
| 136 |
|
|
<EM>pathName</EM> <STRONG>step</STRONG> ?<EM>inc</EM>?
|
| 137 |
|
|
Increase the current number of steps completed by <EM>inc</EM>.
|
| 138 |
|
|
<EM>Inc</EM> defaults to 1.
|
| 139 |
|
|
|
| 140 |
|
|
|
| 141 |
|
|
|
| 142 |
|
|
</PRE>
|
| 143 |
|
|
<H2>EXAMPLE</H2><PRE>
|
| 144 |
|
|
feedback .fb -labeltext "Status" -steps 20
|
| 145 |
|
|
pack .fb -padx 10 -pady 10 -fill both -expand yes
|
| 146 |
|
|
|
| 147 |
|
|
for {set i 0} {$i < 20} {incr i} {
|
| 148 |
|
|
.fb step
|
| 149 |
|
|
after 500
|
| 150 |
|
|
}
|
| 151 |
|
|
|
| 152 |
|
|
|
| 153 |
|
|
|
| 154 |
|
|
</PRE>
|
| 155 |
|
|
<H2>ACKNOWLEDGEMENTS</H2><PRE>
|
| 156 |
|
|
Sam Shen
|
| 157 |
|
|
|
| 158 |
|
|
This code is based largely on his feedback.tcl code
|
| 159 |
|
|
from tk inspect. The original feedback code is copy-
|
| 160 |
|
|
right 1995 Lawrence Berkeley Laboratory.
|
| 161 |
|
|
|
| 162 |
|
|
|
| 163 |
|
|
</PRE>
|
| 164 |
|
|
<H2>AUTHOR</H2><PRE>
|
| 165 |
|
|
Kris Raney
|
| 166 |
|
|
|
| 167 |
|
|
|
| 168 |
|
|
</PRE>
|
| 169 |
|
|
<H2>KEYWORDS</H2><PRE>
|
| 170 |
|
|
feedback, widget
|
| 171 |
|
|
|
| 172 |
|
|
|
| 173 |
|
|
|
| 174 |
|
|
|
| 175 |
|
|
|
| 176 |
|
|
|
| 177 |
|
|
|
| 178 |
|
|
|
| 179 |
|
|
|
| 180 |
|
|
|
| 181 |
|
|
|
| 182 |
|
|
|
| 183 |
|
|
|
| 184 |
|
|
|
| 185 |
|
|
|
| 186 |
|
|
|
| 187 |
|
|
|
| 188 |
|
|
|
| 189 |
|
|
|
| 190 |
|
|
|
| 191 |
|
|
|
| 192 |
|
|
|
| 193 |
|
|
</PRE>
|
| 194 |
|
|
</BODY>
|
| 195 |
|
|
</HTML>
|
