1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
|
<!-- 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>
spinner - Create and manipulate a spinner widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>spinner</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Widget <- Labeledwidget <- Spinner
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<B>background</B> <B>borderWidth</B> <B>cursor</B> <B>exportSelection</B>
<DL>
<DT><B>foreground</B> <DD> <B>highlightColor</B> <B>highlightThicknessinsertBackground</B>
</DD>
</DL>
<DL>
<DT><B>insertBorderWidth</B> <DD> <B>insertOffTime</B> <B>insertOnTimeinsertWidth</B>
<B>justify</B> <B>relief</B> <B>selectBackgroundselectBorderWidth</B>
</DD>
</DL>
<DL>
<DT><B>selectForeground</B> <DD> <B>textVariable</B>
<P>
</DD>
</DL>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>ASSOCIATED</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>show</B> <DD> <B>state</B>
<P>
</DD>
</DL>
See the "entry" manual entry for details on the associated
options.
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>INHERITED</B> <B>OPTIONS</B></A></H2>
<B>childSitePos</B> <B>command</B> <B>fixed</B> <B>focusCommand</B>
<DL>
<DT><B>invalid</B> <DD> <B>textBackground</B> <B>textFont</B> <B>validate</B>
<B>width</B>
<P>
</DD>
</DL>
See the "entryfield" widget manual entry for details on the
above inherited options.
<P>
<DL>
<DT><B>disabledForeground</B> <DD> <B>labelBitmap</B> <B>labelFontlabelImage</B>
<B>labelMargin</B> <B>labelPos</B> <B>labelText</B> <B>labelVariable</B>
<B>state</B>
<P>
</DD>
</DL>
See the "labeledwidget" widget manual entry for details on
the above inherited options.
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>arrowOrient</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Orient</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-arroworient</B>
<P>
</DD>
</DL>
Specifies placement of arrow buttons: <B>horizontal</B> or
<B>vertical</B>. The default is vertical.
<P>
<DL>
<DT>Name: <DD> <B>decrement</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
<P>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-decrement</B>
<P>
</DD>
</DL>
Tcl command to be executed when down arrow is pressed.
<P>
<DL>
<DT>Name: <DD> <B>increment</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-increment</B>
<P>
</DD>
</DL>
Tcl command to be executed when up arrow is pressed.
<P>
<DL>
<DT>Name: <DD> <B>repeatDelay</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>RepeatDelay</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-repeatdelay</B>
<P>
</DD>
</DL>
Specifies the initial delay in milliseconds before the
spinner repeat action on the arrow buttons engages.
The default is 300 milliseconds.
<P>
<DL>
<DT>Name: <DD> <B>repeatInterval</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>RepeatInterval</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-repeatinterval</B>
<P>
</DD>
</DL>
Specifies the repeat delay in milliseconds between
selections of the arrow buttons. A repeatinterval of 0
disables button repeat. The default is 100 milliseconds.
<P>
_________________________________________________________________
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>DESCRIPTION</B></A></H2>
The <B>spinner</B> command creates a spinner widget. The spinner
is comprised of an entryfield plus up and down arrow buttons.
Arrows may be drawn horizontally or vertically.
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>METHODS</B></A></H2>
The <B>spinner</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 spinner widgets:
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>ASSOCIATED</B> <B>METHODS</B></A></H2>
<B>delete</B> <B>get</B> <B>icursor</B> <B>index</B>
<B>insert</B> <B>scan</B> <B>selection</B> <B>xview</B>
<P>
See the "entry" manual entry for details on the associated
methods.
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>INHERITED</B> <B>METHODS</B></A></H2>
<B>childsite</B> <B>clear</B> <B>peek</B>
<P>
See the "entryfield" manual entry for details on the associated
methods.
<P>
<H2><A NAME="sect12" HREF="#toc12"><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>spinner</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>spinner</B> command.
<P>
<I>pathName</I> <B>down</B><BR>
Derived classes may overload this method to specialize
functionality.
<P>
<I>pathName</I> <B>up</B><BR>
Derived classes may overload this method to specialize
functionality.
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>COMPONENTS</B></A></H2>
<DL>
<DT>Name: <DD> <B>downarrow</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Canvas</B>
<P>
</DD>
</DL>
The downarrow component is the downward pointing button
of the spinner. See the "canvas" widget manual entry
for details on the downarrow component item.
<P>
<DL>
<DT>Name: <DD> <B>uparrow</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Canvas</B>
<P>
</DD>
</DL>
The uparrow component is the upward pointing button of
the spinner. See the "canvas" widget manual entry for
details on the uparrow component item.
<P>
<H2><A NAME="sect14" HREF="#toc14"><B>EXAMPLE</B></A></H2>
set months {January February March April May June July \
August September October November December}
<P>
proc blockInput {char} {<BR>
return 0<BR>
}
<P>
proc spinMonth {step} {<BR>
global months
<P>
set index [expr [lsearch $months [.sm get]] + $step]
<P>
if {$index < 0} {set index 11}
if {$index > 11} {set index 0}
<P>
<DL>
<DT>.sm delete 0 end<DD>
.sm insert 0 [lindex $months $index]
}
<P>
</DD>
</DL>
spinner .sm -labeltext "Month : " -width 10 -fixed 10 -validate blockInput \
-decrement {spinMonth -1} -increment {spinMonth 1}
.sm insert 0 January
<P>
pack .sm -padx 10 -pady 10
<P>
<H2><A NAME="sect15" HREF="#toc15"><B>ACKNOWLEDGEMENTS:</B></A></H2>
Ken Copeland <ken@hilco.com>
<P>
10/18/95 - Added auto-repeat action to spinner arrow
buttons.
<P>
<H2><A NAME="sect16" HREF="#toc16"><B>AUTHOR</B></A></H2>
Sue Yockey
<P>
<H2><A NAME="sect17" HREF="#toc17"><B>KEYWORDS</B></A></H2>
spinner, 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">ASSOCIATED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">DESCRIPTION</A></LI>
<LI><A NAME="toc9" HREF="#sect9">METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">ASSOCIATED METHODS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">INHERITED METHODS</A></LI>
<LI><A NAME="toc12" HREF="#sect12">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc13" HREF="#sect13">COMPONENTS</A></LI>
<LI><A NAME="toc14" HREF="#sect14">EXAMPLE</A></LI>
<LI><A NAME="toc15" HREF="#sect15">ACKNOWLEDGEMENTS:</A></LI>
<LI><A NAME="toc16" HREF="#sect16">AUTHOR</A></LI>
<LI><A NAME="toc17" HREF="#sect17">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|