util/X86LINUX64/man/mann/scale.n

   1 '\"
   2 '\" Copyright (c) 1990-1994 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 .TH scale n 4.1 Tk "Tk Built-In Commands"
   9 .\" The -*- nroff -*- definitions below are for supplemental macros used
  10 .\" in Tcl/Tk manual entries.
  11 .\"
  12 .\" .AP type name in/out ?indent?
  13 .\"     Start paragraph describing an argument to a library procedure.
  14 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  15 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  16 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  17 .\"     needed;  use .AS below instead)
  18 .\"
  19 .\" .AS ?type? ?name?
  20 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  21 .\"     name are examples of largest possible arguments that will be passed
  22 .\"     to .AP later.  If args are omitted, default tab stops are used.
  23 .\"
  24 .\" .BS
  25 .\"     Start box enclosure.  From here until next .BE, everything will be
  26 .\"     enclosed in one large box.
  27 .\"
  28 .\" .BE
  29 .\"     End of box enclosure.
  30 .\"
  31 .\" .CS
  32 .\"     Begin code excerpt.
  33 .\"
  34 .\" .CE
  35 .\"     End code excerpt.
  36 .\"
  37 .\" .VS ?version? ?br?
  38 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  39 .\"     of man pages.  The first argument is ignored and used for recording
  40 .\"     the version when the .VS was added, so that the sidebars can be
  41 .\"     found and removed when they reach a certain age.  If another argument
  42 .\"     is present, then a line break is forced before starting the sidebar.
  43 .\"
  44 .\" .VE
  45 .\"     End of vertical sidebar.
  46 .\"
  47 .\" .DS
  48 .\"     Begin an indented unfilled display.
  49 .\"
  50 .\" .DE
  51 .\"     End of indented unfilled display.
  52 .\"
  53 .\" .SO ?manpage?
  54 .\"     Start of list of standard options for a Tk widget. The manpage
  55 .\"     argument defines where to look up the standard options; if
  56 .\"     omitted, defaults to "options". The options follow on successive
  57 .\"     lines, in three columns separated by tabs.
  58 .\"
  59 .\" .SE
  60 .\"     End of list of standard options for a Tk widget.
  61 .\"
  62 .\" .OP cmdName dbName dbClass
  63 .\"     Start of description of a specific option.  cmdName gives the
  64 .\"     option's name as specified in the class command, dbName gives
  65 .\"     the option's name in the option database, and dbClass gives
  66 .\"     the option's class in the option database.
  67 .\"
  68 .\" .UL arg1 arg2
  69 .\"     Print arg1 underlined, then print arg2 normally.
  70 .\"
  71 .\" .QW arg1 ?arg2?
  72 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  73 .\"
  74 .\" .PQ arg1 ?arg2?
  75 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  76 .\"     (for trailing punctuation) and then a closing parenthesis.
  77 .\"
  78 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  79 .if t .wh -1.3i ^B
  80 .nr ^l \n(.l
  81 .ad b
  82 .\"     # Start an argument description
  83 .de AP
  84 .ie !"\\$4"" .TP \\$4
  85 .el \{\
  86 .   ie !"\\$2"" .TP \\n()Cu
  87 .   el          .TP 15
  88 .\}
  89 .ta \\n()Au \\n()Bu
  90 .ie !"\\$3"" \{\
  91 \&\\$1 \\fI\\$2\\fP (\\$3)
  92 .\".b
  93 .\}
  94 .el \{\
  95 .br
  96 .ie !"\\$2"" \{\
  97 \&\\$1  \\fI\\$2\\fP
  98 .\}
  99 .el \{\
 100 \&\\fI\\$1\\fP
 101 .\}
 102 .\}
 103 ..
 104 .\"     # define tabbing values for .AP
 105 .de AS
 106 .nr )A 10n
 107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 108 .nr )B \\n()Au+15n
 109 .\"
 110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 112 ..
 113 .AS Tcl_Interp Tcl_CreateInterp in/out
 114 .\"     # BS - start boxed text
 115 .\"     # ^y = starting y location
 116 .\"     # ^b = 1
 117 .de BS
 118 .br
 119 .mk ^y
 120 .nr ^b 1u
 121 .if n .nf
 122 .if n .ti 0
 123 .if n \l'\\n(.lu\(ul'
 124 .if n .fi
 125 ..
 126 .\"     # BE - end boxed text (draw box now)
 127 .de BE
 128 .nf
 129 .ti 0
 130 .mk ^t
 131 .ie n \l'\\n(^lu\(ul'
 132 .el \{\
 133 .\"     Draw four-sided box normally, but don't draw top of
 134 .\"     box if the box started on an earlier page.
 135 .ie !\\n(^b-1 \{\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .el \}\
 139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 140 .\}
 141 .\}
 142 .fi
 143 .br
 144 .nr ^b 0
 145 ..
 146 .\"     # VS - start vertical sidebar
 147 .\"     # ^Y = starting y location
 148 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 149 .de VS
 150 .if !"\\$2"" .br
 151 .mk ^Y
 152 .ie n 'mc \s12\(br\s0
 153 .el .nr ^v 1u
 154 ..
 155 .\"     # VE - end of vertical sidebar
 156 .de VE
 157 .ie n 'mc
 158 .el \{\
 159 .ev 2
 160 .nf
 161 .ti 0
 162 .mk ^t
 163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 164 .sp -1
 165 .fi
 166 .ev
 167 .\}
 168 .nr ^v 0
 169 ..
 170 .\"     # Special macro to handle page bottom:  finish off current
 171 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 172 .\"     # page bottom macro.
 173 .de ^B
 174 .ev 2
 175 'ti 0
 176 'nf
 177 .mk ^t
 178 .if \\n(^b \{\
 179 .\"     Draw three-sided box if this is the box's first page,
 180 .\"     draw two sides but no top otherwise.
 181 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 183 .\}
 184 .if \\n(^v \{\
 185 .nr ^x \\n(^tu+1v-\\n(^Yu
 186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 187 .\}
 188 .bp
 189 'fi
 190 .ev
 191 .if \\n(^b \{\
 192 .mk ^y
 193 .nr ^b 2
 194 .\}
 195 .if \\n(^v \{\
 196 .mk ^Y
 197 .\}
 198 ..
 199 .\"     # DS - begin display
 200 .de DS
 201 .RS
 202 .nf
 203 .sp
 204 ..
 205 .\"     # DE - end display
 206 .de DE
 207 .fi
 208 .RE
 209 .sp
 210 ..
 211 .\"     # SO - start of list of standard options
 212 .de SO
 213 'ie '\\$1'' .ds So \\fBoptions\\fR
 214 'el .ds So \\fB\\$1\\fR
 215 .SH "STANDARD OPTIONS"
 216 .LP
 217 .nf
 218 .ta 5.5c 11c
 219 .ft B
 220 ..
 221 .\"     # SE - end of list of standard options
 222 .de SE
 223 .fi
 224 .ft R
 225 .LP
 226 See the \\*(So manual entry for details on the standard options.
 227 ..
 228 .\"     # OP - start of full description for a single option
 229 .de OP
 230 .LP
 231 .nf
 232 .ta 4c
 233 Command-Line Name:      \\fB\\$1\\fR
 234 Database Name:  \\fB\\$2\\fR
 235 Database Class: \\fB\\$3\\fR
 236 .fi
 237 .IP
 238 ..
 239 .\"     # CS - begin code excerpt
 240 .de CS
 241 .RS
 242 .nf
 243 .ta .25i .5i .75i 1i
 244 ..
 245 .\"     # CE - end code excerpt
 246 .de CE
 247 .fi
 248 .RE
 249 ..
 250 .\"     # UL - underline word
 251 .de UL
 252 \\$1\l'|0\(ul'\\$2
 253 ..
 254 .\"     # QW - apply quotation marks to word
 255 .de QW
 256 .ie '\\*(lq'"' ``\\$1''\\$2
 257 .\"" fix emacs highlighting
 258 .el \\*(lq\\$1\\*(rq\\$2
 259 ..
 260 .\"     # PQ - apply parens and quotation marks to word
 261 .de PQ
 262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 263 .\"" fix emacs highlighting
 264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 265 ..
 266 .\"     # QR - quoted range
 267 .de QR
 268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 269 .\"" fix emacs highlighting
 270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 271 ..
 272 .\"     # MT - "empty" string
 273 .de MT
 274 .QW ""
 275 ..
 276 .BS
 277 '\" Note:  do not modify the .SH NAME line immediately below!
 278 .SH NAME
 279 scale \- Create and manipulate 'scale' value-controlled slider widgets
 280 .SH SYNOPSIS
 281 \fBscale\fR \fIpathName \fR?\fIoptions\fR?
 282 .SO
 283 \-activebackground      \-foreground    \-relief
 284 \-background    \-highlightbackground   \-repeatdelay
 285 \-borderwidth   \-highlightcolor        \-repeatinterval
 286 \-cursor        \-highlightthickness    \-takefocus
 287 \-font  \-orient        \-troughcolor
 288 .SE
 289 .SH "WIDGET-SPECIFIC OPTIONS"
 290 .OP \-bigincrement bigIncrement BigIncrement
 291 Some interactions with the scale cause its value to change by
 292 .QW large
 293 increments;  this option specifies the size of the
 294 large increments.  If specified as 0, the large increments default
 295 to 1/10 the range of the scale.
 296 .OP \-command command Command
 297 Specifies the prefix of a Tcl command to invoke whenever the scale's
 298 value is changed via a widget command.
 299 The actual command consists
 300 of this option followed by a space and a real number indicating the
 301 new value of the scale.
 302 .OP \-digits digits Digits
 303 An integer specifying how many significant digits should be retained
 304 when converting the value of the scale to a string.
 305 If the number is less than or equal to zero, then the scale picks
 306 the smallest value that guarantees that every possible slider
 307 position prints as a different string.
 308 .OP \-from from From
 309 A real value corresponding to the left or top end of the scale.
 310 .OP \-label label Label
 311 A string to display as a label for the scale.  For
 312 vertical scales the label is displayed just to the right of the
 313 top end of the scale.  For horizontal scales the label is displayed
 314 just above the left end of the scale.  If the option is specified
 315 as an empty string, no label is displayed.
 316 .OP \-length length Length
 317 Specifies the desired long dimension of the scale in screen units
 318 (i.e. any of the forms acceptable to \fBTk_GetPixels\fR).
 319 For vertical scales this is the scale's height;  for horizontal scales
 320 it is the scale's width.
 321 .OP \-resolution resolution Resolution
 322 A real value specifying the resolution for the scale.
 323 If this value is greater than zero then the scale's value will always be
 324 rounded to an even multiple of this value, as will tick marks and
 325 the endpoints of the scale.  If the value is less than zero then no
 326 rounding occurs.  Defaults to 1 (i.e., the value will be integral).
 327 .OP \-showvalue showValue ShowValue
 328 Specifies a boolean value indicating whether or not the current
 329 value of the scale is to be displayed.
 330 .OP \-sliderlength sliderLength SliderLength
 331 Specifies the size of the slider, measured in screen units along the slider's
 332 long dimension.  The value may be specified in any of the forms acceptable
 333 to \fBTk_GetPixels\fR.
 334 .OP \-sliderrelief sliderRelief SliderRelief
 335 Specifies the relief to use when drawing the slider, such as \fBraised\fR
 336 or \fBsunken\fR.
 337 .OP \-state state State
 338 Specifies one of three states for the scale:  \fBnormal\fR,
 339 \fBactive\fR, or \fBdisabled\fR.
 340 If the scale is disabled then the value may not be changed and the scale
 341 will not activate.
 342 If the scale is active, the slider is displayed using the color
 343 specified by the \fB\-activebackground\fR option.
 344 .OP \-tickinterval tickInterval TickInterval
 345 Must be a real value.
 346 Determines the spacing between numerical
 347 tick marks displayed below or to the left of the slider.
 348 If 0, no tick marks will be displayed.
 349 .OP \-to to To
 350 Specifies a real value corresponding
 351 to the right or bottom end of the scale.
 352 This value may be either less than or greater than the \fB\-from\fR option.
 353 .OP \-variable variable Variable
 354 Specifies the name of a global variable to link to the scale.  Whenever the
 355 value of the variable changes, the scale will update to reflect this
 356 value.
 357 Whenever the scale is manipulated interactively, the variable
 358 will be modified to reflect the scale's new value.
 359 .OP \-width width Width
 360 Specifies the desired narrow dimension of the trough in screen units
 361 (i.e. any of the forms acceptable to \fBTk_GetPixels\fR).
 362 For vertical scales this is the trough's width;  for horizontal scales
 363 this is the trough's height.
 364 .BE
 365 .SH DESCRIPTION
 366 .PP
 367 The \fBscale\fR command creates a new window (given by the
 368 \fIpathName\fR argument) and makes it into a scale widget.
 369 Additional
 370 options, described above, may be specified on the command line
 371 or in the option database
 372 to configure aspects of the scale such as its colors, orientation,
 373 and relief.  The \fBscale\fR command returns its
 374 \fIpathName\fR argument.  At the time this command is invoked,
 375 there must not exist a window named \fIpathName\fR, but
 376 \fIpathName\fR's parent must exist.
 377 .PP
 378 A scale is a widget that displays a rectangular \fItrough\fR and a
 379 small \fIslider\fR.  The trough corresponds to a range
 380 of real values (determined by the \fB\-from\fR, \fB\-to\fR, and
 381 \fB\-resolution\fR options),
 382 and the position of the slider selects a particular real value.
 383 The slider's position (and hence the scale's value) may be adjusted
 384 with the mouse or keyboard as described in the \fBBINDINGS\fR
 385 section below.  Whenever the scale's value is changed, a Tcl
 386 command is invoked (using the \fB\-command\fR option) to notify
 387 other interested widgets of the change.
 388 In addition, the value
 389 of the scale can be linked to a Tcl variable (using the \fB\-variable\fR
 390 option), so that changes in either are reflected in the other.
 391 .PP
 392 Three annotations may be displayed in a scale widget:  a label
 393 appearing at the top right of the widget (top left for horizontal
 394 scales), a number displayed just to the left of the slider
 395 (just above the slider for horizontal scales), and a collection
 396 of numerical tick marks just to the left of the current value
 397 (just below the trough for horizontal scales).  Each of these three
 398 annotations may be enabled or disabled using the
 399 configuration options.
 400 .SH "WIDGET COMMAND"
 401 .PP
 402 The \fBscale\fR command creates a new Tcl command whose
 403 name is \fIpathName\fR.  This
 404 command may be used to invoke various
 405 operations on the widget.  It has the following general form:
 406 .CS
 407 \fIpathName option \fR?\fIarg arg ...\fR?
 408 .CE
 409 \fIOption\fR and the \fIarg\fRs
 410 determine the exact behavior of the command.  The following
 411 commands are possible for scale widgets:
 412 .TP
 413 \fIpathName \fBcget\fR \fIoption\fR
 414 .
 415 Returns the current value of the configuration option given
 416 by \fIoption\fR.
 417 \fIOption\fR may have any of the values accepted by the \fBscale\fR
 418 command.
 419 .TP
 420 \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
 421 .
 422 Query or modify the configuration options of the widget.
 423 If no \fIoption\fR is specified, returns a list describing all of
 424 the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
 425 information on the format of this list).  If \fIoption\fR is specified
 426 with no \fIvalue\fR, then the command returns a list describing the
 427 one named option (this list will be identical to the corresponding
 428 sublist of the value returned if no \fIoption\fR is specified).  If
 429 one or more \fIoption\-value\fR pairs are specified, then the command
 430 modifies the given widget option(s) to have the given value(s);  in
 431 this case the command returns an empty string.
 432 \fIOption\fR may have any of the values accepted by the \fBscale\fR
 433 command.
 434 .TP
 435 \fIpathName \fBcoords \fR?\fIvalue\fR?
 436 .
 437 Returns a list whose elements are the x and y coordinates of
 438 the point along the centerline of the trough that corresponds
 439 to \fIvalue\fR.
 440 If \fIvalue\fR is omitted then the scale's current value is used.
 441 .TP
 442 \fIpathName \fBget\fR ?\fIx y\fR?
 443 .
 444 If \fIx\fR and \fIy\fR are omitted, returns the current value
 445 of the scale.  If \fIx\fR and \fIy\fR are specified, they give
 446 pixel coordinates within the widget;  the command returns
 447 the scale value corresponding to the given pixel.
 448 Only one of \fIx\fR or \fIy\fR is used:  for horizontal scales
 449 \fIy\fR is ignored, and for vertical scales \fIx\fR is ignored.
 450 .TP
 451 \fIpathName \fBidentify \fIx y\fR
 452 .
 453 Returns a string indicating what part of the scale lies under
 454 the coordinates given by \fIx\fR and \fIy\fR.
 455 A return value of \fBslider\fR means that the point is over
 456 the slider;  \fBtrough1\fR means that the point is over the
 457 portion of the slider above  or to the left of the slider;
 458 and \fBtrough2\fR means that the point is over the portion
 459 of the slider below or to the right of the slider.
 460 If the point is not over one of these elements, an empty string
 461 is returned.
 462 .TP
 463 \fIpathName \fBset \fIvalue\fR
 464 .
 465 This command is invoked to change the current value of the scale,
 466 and hence the position at which the slider is displayed.  \fIValue\fR
 467 gives the new value for the scale.
 468 The command has no effect if the scale is disabled.
 469 .SH BINDINGS
 470 .PP
 471 Tk automatically creates class bindings for scales that give them
 472 the following default behavior.
 473 Where the behavior is different for vertical and horizontal scales,
 474 the horizontal behavior is described in parentheses.
 475 .IP [1]
 476 If button 1 is pressed in the trough, the scale's value will
 477 be incremented or decremented by the value of the \fB\-resolution\fR
 478 option so that the slider moves in the direction of the cursor.
 479 If the button is held down, the action auto-repeats.
 480 .IP [2]
 481 If button 1 is pressed over the slider, the slider can be dragged
 482 with the mouse.
 483 .IP [3]
 484 If button 1 is pressed in the trough with the Control key down,
 485 the slider moves all the way to the end of its range, in the
 486 direction towards the mouse cursor.
 487 .IP [4]
 488 If button 2 is pressed, the scale's value is set to the mouse
 489 position.  If the mouse is dragged with button 2 down, the scale's
 490 value changes with the drag.
 491 .IP [5]
 492 The Up and Left keys move the slider up (left) by the value
 493 of the \fB\-resolution\fR option.
 494 .IP [6]
 495 The Down and Right keys move the slider down (right) by the value
 496 of the \fB\-resolution\fR option.
 497 .IP [7]
 498 Control-Up and Control-Left move the slider up (left) by the
 499 value of the \fB\-bigincrement\fR option.
 500 .IP [8]
 501 Control-Down and Control-Right move the slider down (right) by the
 502 value of the \fB\-bigincrement\fR option.
 503 .IP [9]
 504 Home moves the slider to the top (left) end of its range.
 505 .IP [10]
 506 End moves the slider to the bottom (right) end of its range.
 507 .PP
 508 If the scale is disabled using the \fB\-state\fR option then
 509 none of the above bindings have any effect.
 510 .PP
 511 The behavior of scales can be changed by defining new bindings for
 512 individual widgets or by redefining the class bindings.
 513 .SH "SEE ALSO"
 514 ttk::scale(n)
 515 .SH KEYWORDS
 516 scale, slider, trough, widget
 517 '\" Local Variables:
 518 '\" mode: nroff
 519 '\" End: