home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _653b7581732948bd3f7642db5d2cf747 < prev    next >
Text File  |  2000-03-23  |  17KB  |  380 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::Scale - Create and manipulate Scale widgets</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Tk::Scale - Create and manipulate Scale widgets</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#standard options">STANDARD OPTIONS</A></LI>
  25.     <LI><A HREF="#widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></LI>
  26.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  27.     <LI><A HREF="#widget methods">WIDGET METHODS</A></LI>
  28.     <LI><A HREF="#bindings">BINDINGS</A></LI>
  29.     <LI><A HREF="#keywords">KEYWORDS</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>Tk::Scale - Create and manipulate Scale widgets</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <P><EM>$scale</EM> = <EM>$parent</EM>-><STRONG>Scale</STRONG>(?<EM>options</EM>?);</P>
  48. <P>
  49. <HR>
  50. <H1><A NAME="standard options">STANDARD OPTIONS</A></H1>
  51. <P><TABLE CELLSPACING=0 CELLPADDING=0><TR><TD><STRONG>-activebackground</STRONG><TD><STRONG>-font</STRONG><TD><STRONG>-highlightthickness</STRONG><TD><STRONG>-repeatinterval</STRONG>
  52. <TR><TD><STRONG>-background</STRONG><TD><STRONG>-foreground</STRONG><TD><STRONG>-orient</STRONG><TD><STRONG>-takefocus</STRONG>
  53. <TR><TD><STRONG>-borderwidth</STRONG><TD><STRONG>-highlightbackground</STRONG><TD><STRONG>-relief</STRONG><TD><STRONG>-troughcolor</STRONG>
  54. <TR><TD><STRONG>-cursor</STRONG><TD><STRONG>-highlightcolor</STRONG><TD><STRONG>-repeatdelay</STRONG></TABLE></P>
  55. <P>See <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> for details of the standard options.</P>
  56. <P>
  57. <HR>
  58. <H1><A NAME="widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></H1>
  59. <DL>
  60. <DT><STRONG><A NAME="item_Name%3A_bigIncrement">Name:    <STRONG>bigIncrement</STRONG></A></STRONG><BR>
  61. <DD>
  62. <DT><STRONG><A NAME="item_Class%3A_BigIncrement">Class:    <STRONG>BigIncrement</STRONG></A></STRONG><BR>
  63. <DD>
  64. <DT><STRONG><A NAME="item_Switch%3A_%2Dbigincrement">Switch:    <STRONG>-bigincrement</STRONG></A></STRONG><BR>
  65. <DD>
  66. Some interactions with the scale cause its value to change by
  67. ``large'' increments;  this option specifies the size of the
  68. large increments.  If specified as 0, the large increments default
  69. to 1/10 the range of the scale.
  70. <P></P>
  71. <DT><STRONG><A NAME="item_Name%3A_command">Name:    <STRONG>command</STRONG></A></STRONG><BR>
  72. <DD>
  73. <DT><STRONG><A NAME="item_Class%3A_Command">Class:    <STRONG>Command</STRONG></A></STRONG><BR>
  74. <DD>
  75. <DT><STRONG><A NAME="item_Switch%3A_%2Dcommand">Switch:    <STRONG>-command</STRONG></A></STRONG><BR>
  76. <DD>
  77. Specifies the prefix of a <A HREF="../../../site/lib/Tk/callbacks.html">perl/Tk callback</A> to invoke whenever the scale's
  78. value is changed via a method.
  79. The actual command consists
  80. of this option followed by a space and a real number indicating the
  81. new value of the scale.
  82. <P></P>
  83. <DT><STRONG><A NAME="item_Name%3A_digits">Name:    <STRONG>digits</STRONG></A></STRONG><BR>
  84. <DD>
  85. <DT><STRONG><A NAME="item_Class%3A_Digits">Class:    <STRONG>Digits</STRONG></A></STRONG><BR>
  86. <DD>
  87. <DT><STRONG><A NAME="item_Switch%3A_%2Ddigits">Switch:    <STRONG>-digits</STRONG></A></STRONG><BR>
  88. <DD>
  89. An integer specifying how many significant digits should be retained
  90. when converting the value of the scale to a string.
  91. If the number is less than or equal to zero, then the scale picks
  92. the smallest value that guarantees that every possible slider
  93. position prints as a different string.
  94. <P></P>
  95. <DT><STRONG><A NAME="item_Name%3A_from">Name:    <STRONG>from</STRONG></A></STRONG><BR>
  96. <DD>
  97. <DT><STRONG><A NAME="item_Class%3A_From">Class:    <STRONG>From</STRONG></A></STRONG><BR>
  98. <DD>
  99. <DT><STRONG><A NAME="item_Switch%3A_%2Dfrom">Switch:    <STRONG>-from</STRONG></A></STRONG><BR>
  100. <DD>
  101. A real value corresponding to the left or top end of the scale.
  102. <P></P>
  103. <DT><STRONG><A NAME="item_Name%3A_label">Name:    <STRONG>label</STRONG></A></STRONG><BR>
  104. <DD>
  105. <DT><STRONG><A NAME="item_Class%3A_Label">Class:    <STRONG>Label</STRONG></A></STRONG><BR>
  106. <DD>
  107. <DT><STRONG><A NAME="item_Switch%3A_%2Dlabel">Switch:    <STRONG>-label</STRONG></A></STRONG><BR>
  108. <DD>
  109. A string to display as a label for the scale.  For
  110. vertical scales the label is displayed just to the right of the
  111. top end of the scale.  For horizontal scales the label is displayed
  112. just above the left end of the scale.  If the option is specified
  113. as an empty string, no label is displayed.
  114. <P></P>
  115. <DT><STRONG><A NAME="item_Name%3A_length">Name:    <STRONG>length</STRONG></A></STRONG><BR>
  116. <DD>
  117. <DT><STRONG><A NAME="item_Class%3A_Length">Class:    <STRONG>Length</STRONG></A></STRONG><BR>
  118. <DD>
  119. <DT><STRONG><A NAME="item_Switch%3A_%2Dlength">Switch:    <STRONG>-length</STRONG></A></STRONG><BR>
  120. <DD>
  121. Specifies the desired long dimension of the scale in screen units
  122. (i.e. any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>).
  123. For vertical scales this is the scale's height;  for horizontal scales
  124. it is the scale's width.
  125. <P></P>
  126. <DT><STRONG><A NAME="item_Name%3A_resolution">Name:    <STRONG>resolution</STRONG></A></STRONG><BR>
  127. <DD>
  128. <DT><STRONG><A NAME="item_Class%3A_Resolution">Class:    <STRONG>Resolution</STRONG></A></STRONG><BR>
  129. <DD>
  130. <DT><STRONG><A NAME="item_Switch%3A_%2Dresolution">Switch:    <STRONG>-resolution</STRONG></A></STRONG><BR>
  131. <DD>
  132. A real value specifying the resolution for the scale.
  133. If this value is greater than zero then the scale's value will always be
  134. rounded to an even multiple of this value, as will tick marks and
  135. the endpoints of the scale.  If the value is less than zero then no
  136. rounding occurs.  Defaults to 1 (i.e., the value will be integral).
  137. <P></P>
  138. <DT><STRONG><A NAME="item_Name%3A_showValue">Name:    <STRONG>showValue</STRONG></A></STRONG><BR>
  139. <DD>
  140. <DT><STRONG><A NAME="item_Class%3A_ShowValue">Class:    <STRONG>ShowValue</STRONG></A></STRONG><BR>
  141. <DD>
  142. <DT><STRONG><A NAME="item_Switch%3A_%2Dshowvalue">Switch:    <STRONG>-showvalue</STRONG></A></STRONG><BR>
  143. <DD>
  144. Specifies a boolean value indicating whether or not the current
  145. value of the scale is to be displayed.
  146. <P></P>
  147. <DT><STRONG><A NAME="item_Name%3A_sliderLength">Name:    <STRONG>sliderLength</STRONG></A></STRONG><BR>
  148. <DD>
  149. <DT><STRONG><A NAME="item_Class%3A_SliderLength">Class:    <STRONG>SliderLength</STRONG></A></STRONG><BR>
  150. <DD>
  151. <DT><STRONG><A NAME="item_Switch%3A_%2Dsliderlength">Switch:    <STRONG>-sliderlength</STRONG></A></STRONG><BR>
  152. <DD>
  153. Specfies the size of the slider, measured in screen units along the slider's
  154. long dimension.  The value may be specified in any of the forms acceptable
  155. to <STRONG>Tk_GetPixels</STRONG>.
  156. <P></P>
  157. <DT><STRONG><A NAME="item_Name%3A_sliderRelief">Name:    <STRONG>sliderRelief</STRONG></A></STRONG><BR>
  158. <DD>
  159. <DT><STRONG><A NAME="item_Class%3A_SliderRelief">Class:    <STRONG>SliderRelief</STRONG></A></STRONG><BR>
  160. <DD>
  161. <DT><STRONG><A NAME="item_Switch%3A_%2Dsliderrelief">Switch:    <STRONG>-sliderrelief</STRONG></A></STRONG><BR>
  162. <DD>
  163. Specifies the relief to use when drawing the slider, such as <STRONG>raised</STRONG>
  164. or <STRONG>sunken</STRONG>.
  165. <P></P>
  166. <DT><STRONG><A NAME="item_Name%3A_state">Name:    <STRONG>state</STRONG></A></STRONG><BR>
  167. <DD>
  168. <DT><STRONG><A NAME="item_Class%3A_State">Class:    <STRONG>State</STRONG></A></STRONG><BR>
  169. <DD>
  170. <DT><STRONG><A NAME="item_Switch%3A_%2Dstate">Switch:    <STRONG>-state</STRONG></A></STRONG><BR>
  171. <DD>
  172. Specifies one of three states for the scale:  <STRONG>normal</STRONG>,
  173. <STRONG>active</STRONG>, or <STRONG>disabled</STRONG>.
  174. If the scale is disabled then the value may not be changed and the scale
  175. won't activate.
  176. If the scale is active, the slider is displayed using the color
  177. specified by the <STRONG>activeBackground</STRONG> option.
  178. <P></P>
  179. <DT><STRONG><A NAME="item_Name%3A_tickInterval">Name:    <STRONG>tickInterval</STRONG></A></STRONG><BR>
  180. <DD>
  181. <DT><STRONG><A NAME="item_Class%3A_TickInterval">Class:    <STRONG>TickInterval</STRONG></A></STRONG><BR>
  182. <DD>
  183. <DT><STRONG><A NAME="item_Switch%3A_%2Dtickinterval">Switch:    <STRONG>-tickinterval</STRONG></A></STRONG><BR>
  184. <DD>
  185. Must be a real value.
  186. Determines the spacing between numerical
  187. tick marks displayed below or to the left of the slider.
  188. If 0, no tick marks will be displayed.
  189. <P></P>
  190. <DT><STRONG><A NAME="item_Name%3A_to">Name:    <STRONG>to</STRONG></A></STRONG><BR>
  191. <DD>
  192. <DT><STRONG><A NAME="item_Class%3A_To">Class:    <STRONG>To</STRONG></A></STRONG><BR>
  193. <DD>
  194. <DT><STRONG><A NAME="item_Switch%3A_%2Dto">Switch:    <STRONG>-to</STRONG></A></STRONG><BR>
  195. <DD>
  196. Specifies a real value corresponding
  197. to the right or bottom end of the scale.
  198. This value may be either less than or greater than the <STRONG>from</STRONG> option.
  199. <P></P>
  200. <DT><STRONG><A NAME="item_Name%3A_variable">Name:    <STRONG>variable</STRONG></A></STRONG><BR>
  201. <DD>
  202. <DT><STRONG><A NAME="item_Class%3A_Variable">Class:    <STRONG>Variable</STRONG></A></STRONG><BR>
  203. <DD>
  204. <DT><STRONG><A NAME="item_Switch%3A_%2Dvariable">Switch:    <STRONG>-variable</STRONG></A></STRONG><BR>
  205. <DD>
  206. Specifies the name of a global variable to link to the scale.  Whenever the
  207. value of the variable changes, the scale will update to reflect this
  208. value.
  209. Whenever the scale is manipulated interactively, the variable
  210. will be modified to reflect the scale's new value.
  211. <P></P>
  212. <DT><STRONG><A NAME="item_Name%3A_width">Name:    <STRONG>width</STRONG></A></STRONG><BR>
  213. <DD>
  214. <DT><STRONG><A NAME="item_Class%3A_Width">Class:    <STRONG>Width</STRONG></A></STRONG><BR>
  215. <DD>
  216. <DT><STRONG><A NAME="item_Switch%3A_%2Dwidth">Switch:    <STRONG>-width</STRONG></A></STRONG><BR>
  217. <DD>
  218. Specifies the desired narrow dimension of the trough in screen units
  219. (i.e. any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>).
  220. For vertical scales this is the trough's width;  for horizontal scales
  221. this is the trough's height.
  222. <P></P></DL>
  223. <P>
  224. <HR>
  225. <H1><A NAME="description">DESCRIPTION</A></H1>
  226. <P>The <STRONG>Scale</STRONG> method creates a new window (given by the
  227. $widget argument) and makes it into a scale widget.
  228. Additional
  229. options, described above, may be specified on the command line
  230. or in the option database
  231. to configure aspects of the scale such as its colors, orientation,
  232. and relief.  The <STRONG>scale</STRONG> command returns its
  233. $widget argument.  At the time this command is invoked,
  234. there must not exist a window named $widget, but
  235. $widget's parent must exist.</P>
  236. <P>A scale is a widget that displays a rectangular <EM>trough</EM> and a
  237. small <EM>slider</EM>.  The trough corresponds to a range
  238. of real values (determined by the <STRONG>from</STRONG>, <STRONG>to</STRONG>, and
  239. <STRONG>resolution</STRONG> options),
  240. and the position of the slider selects a particular real value.
  241. The slider's position (and hence the scale's value) may be adjusted
  242. with the mouse or keyboard as described in
  243. the <A HREF="#bindings">BINDINGS</A> section below.  Whenever the scale's value is changed, a Tcl
  244. command is invoked (using the <STRONG>command</STRONG> option) to notify
  245. other interested widgets of the change.
  246. In addition, the value
  247. of the scale can be linked to a Tcl variable (using the <STRONG>variable</STRONG>
  248. option), so that changes in either are reflected in the other.</P>
  249. <P>Three annotations may be displayed in a scale widget:  a label
  250. appearing at the top right of the widget (top left for horizontal
  251. scales), a number displayed just to the left of the slider
  252. (just above the slider for horizontal scales), and a collection
  253. of numerical tick marks just to the left of the current value
  254. (just below the trough for horizontal scales).  Each of these three
  255. annotations may be enabled or disabled using the
  256. configuration options.</P>
  257. <P>
  258. <HR>
  259. <H1><A NAME="widget methods">WIDGET METHODS</A></H1>
  260. <P>The <STRONG>Scale</STRONG> method creates a widget object.
  261. This object supports the <STRONG>configure</STRONG> and <STRONG>cget</STRONG> methods
  262. described in <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> which can be used to enquire and
  263. modify the options described above.
  264. The widget also inherits all the methods provided by the generic
  265. <A HREF="../../../site/lib/Tk/Widget.html">Tk::Widget</A> class.</P>
  266. <P>The following additional methods are available for scale widgets:</P>
  267. <DL>
  268. <DT><STRONG><A NAME="item_coords"><EM>$scale</EM>-><STRONG>coords</STRONG>(?<EM>value</EM>?)</A></STRONG><BR>
  269. <DD>
  270. Returns a list whose elements are the x and y coordinates of
  271. the point along the centerline of the trough that corresponds
  272. to <EM>value</EM>.
  273. If <EM>value</EM> is omitted then the scale's current value is used.
  274. <P></P>
  275. <DT><STRONG><A NAME="item_get"><EM>$scale</EM>-><STRONG>get</STRONG>(?<EM>x, y</EM>?)</A></STRONG><BR>
  276. <DD>
  277. If <EM>x</EM> and <EM>y</EM> are omitted, returns the current value
  278. of the scale.  If <EM>x</EM> and <EM>y</EM> are specified, they give
  279. pixel coordinates within the widget;  the command returns
  280. the scale value corresponding to the given pixel.
  281. Only one of <EM>x</EM> or <EM>y</EM> is used:  for horizontal scales
  282. <EM>y</EM> is ignored, and for vertical scales <EM>x</EM> is ignored.
  283. <P></P>
  284. <DT><STRONG><A NAME="item_identify"><EM>$scale</EM>-><STRONG>identify</STRONG>(<EM>x, y</EM>)</A></STRONG><BR>
  285. <DD>
  286. Returns a string indicating what part of the scale lies under
  287. the coordinates given by <EM>x</EM> and <EM>y</EM>.
  288. A return value of <STRONG>slider</STRONG> means that the point is over
  289. the slider;  <STRONG>trough1</STRONG> means that the point is over the
  290. portion of the slider above  or to the left of the slider;
  291. and <STRONG>trough2</STRONG> means that the point is over the portion
  292. of the slider below or to the right of the slider.
  293. If the point isn't over one of these elements, an empty string
  294. is returned.
  295. <P></P>
  296. <DT><STRONG><A NAME="item_set"><EM>$scale</EM>-><STRONG>set</STRONG>(<EM>value</EM>)</A></STRONG><BR>
  297. <DD>
  298. This command is invoked to change the current value of the scale,
  299. and hence the position at which the slider is displayed.  <EM>Value</EM>
  300. gives the new value for the scale.
  301. The command has no effect if the scale is disabled.
  302. <P></P></DL>
  303. <P>
  304. <HR>
  305. <H1><A NAME="bindings">BINDINGS</A></H1>
  306. <P>Tk automatically creates class bindings for scales that give them
  307. the following default behavior.
  308. Where the behavior is different for vertical and horizontal scales,
  309. the horizontal behavior is described in parentheses.</P>
  310. <DL>
  311. <DT><STRONG><A NAME="item_%5B1%5D">[1]</A></STRONG><BR>
  312. <DD>
  313. If button 1 is pressed in the trough, the scale's value will
  314. be incremented or decremented by the value of the <STRONG>resolution</STRONG>
  315. option so that the slider moves in the direction of the cursor.
  316. If the button is held down, the action auto-repeats.
  317. <P></P>
  318. <DT><STRONG><A NAME="item_%5B2%5D">[2]</A></STRONG><BR>
  319. <DD>
  320. If button 1 is pressed over the slider, the slider can be dragged
  321. with the mouse.
  322. <P></P>
  323. <DT><STRONG><A NAME="item_%5B3%5D">[3]</A></STRONG><BR>
  324. <DD>
  325. If button 1 is pressed in the trough with the Control key down,
  326. the slider moves all the way to the end of its range, in the
  327. direction towards the mouse cursor.
  328. <P></P>
  329. <DT><STRONG><A NAME="item_%5B4%5D">[4]</A></STRONG><BR>
  330. <DD>
  331. If button 2 is pressed, the scale's value is set to the mouse
  332. position.  If the mouse is dragged with button 2 down, the scale's
  333. value changes with the drag.
  334. <P></P>
  335. <DT><STRONG><A NAME="item_%5B5%5D">[5]</A></STRONG><BR>
  336. <DD>
  337. The Up and Left keys move the slider up (left) by the value
  338. of the <STRONG>resolution</STRONG> option.
  339. <P></P>
  340. <DT><STRONG><A NAME="item_%5B6%5D">[6]</A></STRONG><BR>
  341. <DD>
  342. The Down and Right keys move the slider down (right) by the value
  343. of the <STRONG>resolution</STRONG> option.
  344. <P></P>
  345. <DT><STRONG><A NAME="item_%5B7%5D">[7]</A></STRONG><BR>
  346. <DD>
  347. Control-Up and Control-Left move the slider up (left) by the
  348. value of the <STRONG>bigIncrement</STRONG> option.
  349. <P></P>
  350. <DT><STRONG><A NAME="item_%5B8%5D">[8]</A></STRONG><BR>
  351. <DD>
  352. Control-Down and Control-Right move the slider down (right) by the
  353. value of the <STRONG>bigIncrement</STRONG> option.
  354. <P></P>
  355. <DT><STRONG><A NAME="item_%5B9%5D">[9]</A></STRONG><BR>
  356. <DD>
  357. Home moves the slider to the top (left) end of its range.
  358. <P></P>
  359. <DT><STRONG><A NAME="item_%5B10%5D">[10]</A></STRONG><BR>
  360. <DD>
  361. End moves the slider to the bottom (right) end of its range.
  362. <P>If the scale is disabled using the <STRONG>state</STRONG> option then
  363. none of the above bindings have any effect.</P>
  364. <P>The behavior of scales can be changed by defining new bindings for
  365. individual widgets or by redefining the class bindings.</P>
  366. <P></P></DL>
  367. <P>
  368. <HR>
  369. <H1><A NAME="keywords">KEYWORDS</A></H1>
  370. <P>scale, slider, trough, widget</P>
  371. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  372. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  373. <STRONG><P CLASS=block> Tk::Scale - Create and manipulate Scale widgets</P></STRONG>
  374. </TD></TR>
  375. </TABLE>
  376.  
  377. </BODY>
  378.  
  379. </HTML>
  380.