scale.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:10k
源码类别:

通讯编程

开发平台:

Visual C++

  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. '" RCS: @(#) $Id: scale.n,v 1.3.8.1 2004/10/28 12:25:22 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH scale n 4.1 Tk "Tk Built-In Commands"
  12. .BS
  13. '" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. scale - Create and manipulate scale widgets
  16. .SH SYNOPSIS
  17. fBscalefR fIpathName fR?fIoptionsfR?
  18. .SO
  19. -activebackground -foreground -relief
  20. -background -highlightbackground -repeatdelay
  21. -borderwidth -highlightcolor -repeatinterval
  22. -cursor -highlightthickness -takefocus
  23. -font -orient -troughcolor
  24. .SE
  25. .SH "WIDGET-SPECIFIC OPTIONS"
  26. .OP -bigincrement bigIncrement BigIncrement
  27. Some interactions with the scale cause its value to change by
  28. ``large'' increments;  this option specifies the size of the
  29. large increments.  If specified as 0, the large increments default
  30. to 1/10 the range of the scale.
  31. .OP -command command Command
  32. Specifies the prefix of a Tcl command to invoke whenever the scale's
  33. value is changed via a widget command.
  34. The actual command consists
  35. of this option followed by a space and a real number indicating the
  36. new value of the scale.
  37. .OP -digits digits Digits
  38. An integer specifying how many significant digits should be retained
  39. when converting the value of the scale to a string.
  40. If the number is less than or equal to zero, then the scale picks
  41. the smallest value that guarantees that every possible slider
  42. position prints as a different string.
  43. .OP -from from From
  44. A real value corresponding to the left or top end of the scale.
  45. .OP -label label Label
  46. A string to display as a label for the scale.  For
  47. vertical scales the label is displayed just to the right of the
  48. top end of the scale.  For horizontal scales the label is displayed
  49. just above the left end of the scale.  If the option is specified
  50. as an empty string, no label is displayed.
  51. .OP -length length Length
  52. Specifies the desired long dimension of the scale in screen units
  53. (i.e. any of the forms acceptable to fBTk_GetPixelsfR).
  54. For vertical scales this is the scale's height;  for horizontal scales
  55. it is the scale's width.
  56. .OP -resolution resolution Resolution
  57. A real value specifying the resolution for the scale.
  58. If this value is greater than zero then the scale's value will always be
  59. rounded to an even multiple of this value, as will tick marks and
  60. the endpoints of the scale.  If the value is less than zero then no
  61. rounding occurs.  Defaults to 1 (i.e., the value will be integral).
  62. .OP -showvalue showValue ShowValue
  63. Specifies a boolean value indicating whether or not the current
  64. value of the scale is to be displayed.
  65. .OP -sliderlength sliderLength SliderLength
  66. Specifies the size of the slider, measured in screen units along the slider's
  67. long dimension.  The value may be specified in any of the forms acceptable
  68. to fBTk_GetPixelsfR.
  69. .OP -sliderrelief sliderRelief SliderRelief
  70. Specifies the relief to use when drawing the slider, such as fBraisedfR
  71. or fBsunkenfR.
  72. .OP -state state State
  73. Specifies one of three states for the scale:  fBnormalfR,
  74. fBactivefR, or fBdisabledfR.
  75. If the scale is disabled then the value may not be changed and the scale
  76. won't activate.
  77. If the scale is active, the slider is displayed using the color
  78. specified by the fBactiveBackgroundfR option.
  79. .OP -tickinterval tickInterval TickInterval
  80. Must be a real value.
  81. Determines the spacing between numerical
  82. tick marks displayed below or to the left of the slider.
  83. If 0, no tick marks will be displayed.
  84. .OP -to to To
  85. Specifies a real value corresponding
  86. to the right or bottom end of the scale.
  87. This value may be either less than or greater than the fBfromfR option.
  88. .OP -variable variable Variable
  89. Specifies the name of a global variable to link to the scale.  Whenever the
  90. value of the variable changes, the scale will update to reflect this
  91. value.
  92. Whenever the scale is manipulated interactively, the variable
  93. will be modified to reflect the scale's new value.
  94. .OP -width width Width
  95. Specifies the desired narrow dimension of the trough in screen units
  96. (i.e. any of the forms acceptable to fBTk_GetPixelsfR).
  97. For vertical scales this is the trough's width;  for horizontal scales
  98. this is the trough's height.
  99. .BE
  100. .SH DESCRIPTION
  101. .PP
  102. The fBscalefR command creates a new window (given by the
  103. fIpathNamefR argument) and makes it into a scale widget.
  104. Additional
  105. options, described above, may be specified on the command line
  106. or in the option database
  107. to configure aspects of the scale such as its colors, orientation,
  108. and relief.  The fBscalefR command returns its
  109. fIpathNamefR argument.  At the time this command is invoked,
  110. there must not exist a window named fIpathNamefR, but
  111. fIpathNamefR's parent must exist.
  112. .PP
  113. A scale is a widget that displays a rectangular fItroughfR and a
  114. small fIsliderfR.  The trough corresponds to a range
  115. of real values (determined by the fBfromfR, fBtofR, and
  116. fBresolutionfR options),
  117. and the position of the slider selects a particular real value.
  118. The slider's position (and hence the scale's value) may be adjusted
  119. with the mouse or keyboard as described in the fBBINDINGSfR
  120. section below.  Whenever the scale's value is changed, a Tcl
  121. command is invoked (using the fBcommandfR option) to notify
  122. other interested widgets of the change.
  123. In addition, the value
  124. of the scale can be linked to a Tcl variable (using the fBvariablefR
  125. option), so that changes in either are reflected in the other.
  126. .PP
  127. Three annotations may be displayed in a scale widget:  a label
  128. appearing at the top right of the widget (top left for horizontal
  129. scales), a number displayed just to the left of the slider
  130. (just above the slider for horizontal scales), and a collection
  131. of numerical tick marks just to the left of the current value
  132. (just below the trough for horizontal scales).  Each of these three
  133. annotations may be enabled or disabled using the
  134. configuration options.
  135. .SH "WIDGET COMMAND"
  136. .PP
  137. The fBscalefR command creates a new Tcl command whose
  138. name is fIpathNamefR.  This
  139. command may be used to invoke various
  140. operations on the widget.  It has the following general form:
  141. .CS
  142. fIpathName option fR?fIarg arg ...fR?
  143. .CE
  144. fIOptionfR and the fIargfRs
  145. determine the exact behavior of the command.  The following
  146. commands are possible for scale widgets:
  147. .TP
  148. fIpathName fBcgetfR fIoptionfR
  149. Returns the current value of the configuration option given
  150. by fIoptionfR.
  151. fIOptionfR may have any of the values accepted by the fBscalefR
  152. command.
  153. .TP
  154. fIpathName fBconfigurefR ?fIoptionfR? ?fIvalue option value ...fR?
  155. Query or modify the configuration options of the widget.
  156. If no fIoptionfR is specified, returns a list describing all of
  157. the available options for fIpathNamefR (see fBTk_ConfigureInfofR for
  158. information on the format of this list).  If fIoptionfR is specified
  159. with no fIvaluefR, then the command returns a list describing the
  160. one named option (this list will be identical to the corresponding
  161. sublist of the value returned if no fIoptionfR is specified).  If
  162. one or more fIoption-valuefR pairs are specified, then the command
  163. modifies the given widget option(s) to have the given value(s);  in
  164. this case the command returns an empty string.
  165. fIOptionfR may have any of the values accepted by the fBscalefR
  166. command.
  167. .TP
  168. fIpathName fBcoords fR?fIvaluefR?
  169. Returns a list whose elements are the x and y coordinates of
  170. the point along the centerline of the trough that corresponds
  171. to fIvaluefR.
  172. If fIvaluefR is omitted then the scale's current value is used.
  173. .TP
  174. fIpathName fBgetfR ?fIx yfR?
  175. If fIxfR and fIyfR are omitted, returns the current value
  176. of the scale.  If fIxfR and fIyfR are specified, they give
  177. pixel coordinates within the widget;  the command returns
  178. the scale value corresponding to the given pixel.
  179. Only one of fIxfR or fIyfR is used:  for horizontal scales
  180. fIyfR is ignored, and for vertical scales fIxfR is ignored.
  181. .TP
  182. fIpathName fBidentifyfR fIx yfR
  183. Returns a string indicating what part of the scale lies under
  184. the coordinates given by fIxfR and fIyfR.
  185. A return value of fBsliderfR means that the point is over
  186. the slider;  fBtrough1fR means that the point is over the
  187. portion of the slider above  or to the left of the slider;
  188. and fBtrough2fR means that the point is over the portion
  189. of the slider below or to the right of the slider.
  190. If the point isn't over one of these elements, an empty string
  191. is returned.
  192. .TP
  193. fIpathName fBsetfR fIvaluefR
  194. This command is invoked to change the current value of the scale,
  195. and hence the position at which the slider is displayed.  fIValuefR
  196. gives the new value for the scale.
  197. The command has no effect if the scale is disabled.
  198. .SH BINDINGS
  199. .PP
  200. Tk automatically creates class bindings for scales that give them
  201. the following default behavior.
  202. Where the behavior is different for vertical and horizontal scales,
  203. the horizontal behavior is described in parentheses.
  204. .IP [1]
  205. If button 1 is pressed in the trough, the scale's value will
  206. be incremented or decremented by the value of the fBresolutionfR
  207. option so that the slider moves in the direction of the cursor. 
  208. If the button is held down, the action auto-repeats.
  209. .IP [2]
  210. If button 1 is pressed over the slider, the slider can be dragged
  211. with the mouse.
  212. .IP [3]
  213. If button 1 is pressed in the trough with the Control key down,
  214. the slider moves all the way to the end of its range, in the
  215. direction towards the mouse cursor.
  216. .IP [4]
  217. If button 2 is pressed, the scale's value is set to the mouse
  218. position.  If the mouse is dragged with button 2 down, the scale's
  219. value changes with the drag.
  220. .IP [5]
  221. The Up and Left keys move the slider up (left) by the value
  222. of the fBresolutionfR option.
  223. .IP [6]
  224. The Down and Right keys move the slider down (right) by the value
  225. of the fBresolutionfR option.
  226. .IP [7]
  227. Control-Up and Control-Left move the slider up (left) by the
  228. value of the fBbigIncrementfR option.
  229. .IP [8]
  230. Control-Down and Control-Right move the slider down (right) by the
  231. value of the fBbigIncrementfR option.
  232. .IP [9]
  233. Home moves the slider to the top (left) end of its range.
  234. .IP [10]
  235. End moves the slider to the bottom (right) end of its range.
  236. .PP
  237. If the scale is disabled using the fBstatefR option then
  238. none of the above bindings have any effect.
  239. .PP
  240. The behavior of scales can be changed by defining new bindings for
  241. individual widgets or by redefining the class bindings.
  242. .SH KEYWORDS
  243. scale, slider, trough, widget