home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _b9e9f599ca6ac99604ac33a0ce55c252 < prev    next >
Text File  |  2000-03-23  |  41KB  |  778 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::options - Standard options supported by widgets and their manipulation</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::options - Standard options supported by widgets and their manipulation</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="#description">DESCRIPTION</A></LI>
  25.     <UL>
  26.  
  27.         <LI><A HREF="#creation options: widget name and class">Creation options: Widget Name and Class</A></LI>
  28.         <LI><A HREF="#reconfigurable options">Reconfigurable options</A></LI>
  29.     </UL>
  30.  
  31.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  32.     <LI><A HREF="#keywords">KEYWORDS</A></LI>
  33. </UL>
  34. <!-- INDEX END -->
  35.  
  36. <HR>
  37. <P>
  38. <H1><A NAME="name">NAME</A></H1>
  39. <P>Tk::options - Standard options supported by widgets and their manipulation</P>
  40. <P>
  41. <HR>
  42. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  43. <UL>
  44. <LI>Linux</LI>
  45. <LI>Solaris</LI>
  46. <LI>Windows</LI>
  47. </UL>
  48. <HR>
  49. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  50. <P>    <EM>$value</EM> = <EM>$widget</EM>-><STRONG>cget</STRONG>('<EM>-option</EM>');</P>
  51. <P>    <EM>$widget</EM>-><STRONG>configure</STRONG>(<EM>-option</EM>=><EM>value</EM> ?,<EM>-option</EM>=><EM>value</EM> ...?);</P>
  52. <P>    <EM>@list</EM> = <EM>$widget</EM>-><STRONG>configure</STRONG>('<EM>-option</EM>');</P>
  53. <P>    <EM>@lol</EM> = <EM>$widget</EM>-><STRONG>configure</STRONG>;</P>
  54. <P>
  55. <HR>
  56. <H1><A NAME="description">DESCRIPTION</A></H1>
  57. <P>All widgets, and images have a standard mechanism for setting and querying
  58. attibutes or options. The mechanism is based on two methods <STRONG>configure</STRONG>
  59. and <STRONG>cget</STRONG>. The behaviour of these methods is as follows:</P>
  60. <DL>
  61. <DT><STRONG><A NAME="item_configure"><EM>$widget</EM>-><STRONG>configure</STRONG>(<EM>-option</EM>=><EM>value</EM> ?,<EM>-option</EM>=><EM>value</EM> ...?);</A></STRONG><BR>
  62. <DD>
  63. Sets the values of <EM>-option</EM> to <EM>value</EM> for each <EM>-option</EM>=><EM>value</EM>
  64. pair. The internal <STRONG>new</STRONG> method does an implicit <STRONG>configure</STRONG> in this
  65. form with options passed in at widget create time.
  66. <P></P>
  67. <DT><STRONG><EM>$widget</EM>-><STRONG>configure</STRONG>('<EM>-option</EM>')</STRONG><BR>
  68. <DD>
  69. In array context returns a list of five or two elements.  If <EM>-option</EM>
  70. is an alias for another options it return a list consisting of the
  71. alias option and the name for the option is is an alias for, e.g.,
  72. <CODE>('-bg', 'background')</CODE>.  If <EM>-option</EM> is not an alias the returned
  73. list has the following five elements:
  74. <DL>
  75. <DT><STRONG><A NAME="item_Option_Name"><EM>Option Name</EM></A></STRONG><BR>
  76. <DD>
  77. The value of <EM>-option</EM>, e.g., <STRONG>-background</STRONG>.
  78. <P></P>
  79. <DT><STRONG><A NAME="item_Name"><EM>Name</EM></A></STRONG><BR>
  80. <DD>
  81. The option's name in the option database, e.g., <CODE>background</CODE>.
  82. <P></P>
  83. <DT><STRONG><A NAME="item_Class"><EM>Class</EM></A></STRONG><BR>
  84. <DD>
  85. The option's class value in the option database, e.g., <CODE>Background</CODE>.
  86. <P></P>
  87. <DT><STRONG><A NAME="item_Default"><EM>Default</EM></A></STRONG><BR>
  88. <DD>
  89. The default value for the option if not specified or in the option database,
  90. e.g., <CODE>grey</CODE>.
  91. <P></P>
  92. <DT><STRONG><A NAME="item_Value"><EM>Value</EM></A></STRONG><BR>
  93. <DD>
  94. The current value (as returned by <STRONG>cget</STRONG>), e.g., <CODE>white</CODE>.
  95. <P></P></DL>
  96. <DT><STRONG><EM>$widget</EM>-><STRONG>configure</STRONG></STRONG><BR>
  97. <DD>
  98. Returns a list of lists for all the options supported by <EM>$widget</EM>.
  99. Each sub-list is in the form returned by <STRONG>configure</STRONG>('<EM>-option</EM>').
  100. (This mechanism is used by the <STRONG>Tk::Derived</STRONG> class to determine
  101. the options available from base class.)
  102. <P></P>
  103. <DT><STRONG><A NAME="item_cget"><EM>$widget</EM>-><STRONG>cget</STRONG>('<EM>-option</EM>')</A></STRONG><BR>
  104. <DD>
  105. Returns the current value of <EM>-option</EM> for <EM>$widget</EM>.
  106. <P><STRONG>cget</STRONG>('<EM>-option</EM>') is clumsy with the need for <STRONG>''</STRONG> due to perl's
  107. parsing rules. Something more subtle using <A HREF="../../../lib/Pod/perlfunc.html#tie">tie</A> might look better.</P>
  108. <P></P></DL>
  109. <P>The following paragraphs describe the common configuration options supported by
  110. widgets in the Tk toolkit.  Every widget does not necessarily support every option
  111. (see the the documentation entries for individual widgets for a list of the
  112. standard options supported by that widget), but if a widget does support an option
  113. with one of the names listed below, then the option has exactly the effect
  114. described below.</P>
  115. <P>In the descriptions below, ``Name'' refers to the option's name in the option
  116. database.  ``Class'' refers to the option's class value
  117. in the option database.  ``Switch'' refers to the switch used in widget-creation
  118. and <STRONG>configure</STRONG> widget methods to set this value. For example, if an option's
  119. configure option is <STRONG>-foreground</STRONG> and there exists a widget <EM>$widget</EM>, then the
  120. call:</P>
  121. <P>    <EM>$widget</EM>-><STRONG>configure</STRONG>(<STRONG>-foreground</STRONG>=><STRONG>'black'</STRONG>)</P>
  122. <P>may be used to specify the value <STRONG>black</STRONG> for the option in the widget <EM>$widget</EM>.
  123. Configure options may be abbreviated, as long as the abbreviation is unambiguous
  124. (abbreviation is deprecated in perl/Tk).</P>
  125. <P>
  126. <H2><A NAME="creation options: widget name and class">Creation options: Widget Name and Class</A></H2>
  127. <P>The <STRONG>Name</STRONG> and <STRONG>-class</STRONG> options can only be specified when a widget is 
  128. created, and cannot be changed with <STRONG>configure</STRONG>.  These options determine
  129. the widget's identity and how Tk applies resource values from the
  130. option database (see <A HREF="../../../site/lib/Tk/option.html">the Tk::option manpage</A>) and so they 
  131. cannot be assigned by the options database.</P>
  132. <DL>
  133. <DT><STRONG><A NAME="item_Name%3A_name">Name:    <EM>name</EM></A></STRONG><BR>
  134. <DD>
  135. <DT><STRONG><A NAME="item_Switch%3A_Name">Switch:    <STRONG>Name</STRONG></A></STRONG><BR>
  136. <DD>
  137. Specifies the path element for the widget.  Names generally begin with a
  138. lowercase letter.
  139. <P>Each widget has a unique <EM>pathname</EM> that follows the hierarchy from the
  140. <STRONG>MainWindow</STRONG> to the widget itself.  Since the widget's <STRONG>PathName</STRONG> is
  141. used to assign options from the options database, it is important to
  142. specify a distinctive <STRONG>Name</STRONG> for any widget that will have non-default
  143. options.  See <A HREF="../../../site/lib/Tk/option.html">the Tk::option manpage</A> for details.</P>
  144. <P></P>
  145. <DT><STRONG><A NAME="item_Name%3A_class">Name:    <EM>class</EM></A></STRONG><BR>
  146. <DD>
  147. <DT><STRONG><A NAME="item_Switch%3A_%2Dclass">Switch:    <STRONG>-class</STRONG></A></STRONG><BR>
  148. <DD>
  149. Specifies a class for the window.  Classes generally begin with an
  150. uppercase letter.
  151. <P>This class will be used when querying the option database for
  152. the window's other options (see Tk::options), and it will also be used 
  153. later for other purposes such as bindings.  One typically assigns a class
  154. to a <STRONG>TopLevel</STRONG> or <STRONG>Frame</STRONG> so that the class will apply to all of
  155. that widget's children.</P>
  156. <P></P></DL>
  157. <P>
  158. <H2><A NAME="reconfigurable options">Reconfigurable options</A></H2>
  159. <P>These options can be set at widget creation or changed later via <STRONG>configure</STRONG>.</P>
  160. <DL>
  161. <DT><STRONG><A NAME="item_Name%3A_activeBackground">Name:    <STRONG>activeBackground</STRONG></A></STRONG><BR>
  162. <DD>
  163. <DT><STRONG><A NAME="item_Class%3A_Foreground">Class:    <STRONG>Foreground</STRONG></A></STRONG><BR>
  164. <DD>
  165. <DT><STRONG><A NAME="item_Switch%3A_%2Dactivebackground">Switch:    <STRONG>-activebackground</STRONG></A></STRONG><BR>
  166. <DD>
  167. Specifies background color to use when drawing active elements.
  168. An element (a widget or portion of a widget) is active if the
  169. mouse cursor is positioned over the element and pressing a mouse button
  170. will cause some action to occur.
  171. If strict Motif compliance has been requested by setting the
  172. <STRONG>$Tk::strictMotif</STRONG> variable, this option will normally be
  173. ignored;  the normal background color will be used instead.
  174. For some elements on Windows and Macintosh systems, the active color
  175. will only be used while mouse button 1 is pressed over the element.
  176. <P></P>
  177. <DT><STRONG><A NAME="item_Name%3A_activeBorderWidth">Name:    <STRONG>activeBorderWidth</STRONG></A></STRONG><BR>
  178. <DD>
  179. <DT><STRONG><A NAME="item_Class%3A_BorderWidth">Class:    <STRONG>BorderWidth</STRONG></A></STRONG><BR>
  180. <DD>
  181. <DT><STRONG><A NAME="item_Switch%3A_%2Dactiveborderwidth">Switch:    <STRONG>-activeborderwidth</STRONG></A></STRONG><BR>
  182. <DD>
  183. Specifies a non-negative value indicating
  184. the width of the 3-D border drawn around active elements.
  185. See above for definition of active elements.
  186. The value may have any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
  187. This option is typically only available in widgets displaying more
  188. than one element at a time (e.g. menus but not buttons).
  189. <P></P>
  190. <DT><STRONG><A NAME="item_Name%3A_activeForeground">Name:    <STRONG>activeForeground</STRONG></A></STRONG><BR>
  191. <DD>
  192. <DT><STRONG><A NAME="item_Class%3A_Background">Class:    <STRONG>Background</STRONG></A></STRONG><BR>
  193. <DD>
  194. <DT><STRONG><A NAME="item_Switch%3A_%2Dactiveforeground">Switch:    <STRONG>-activeforeground</STRONG></A></STRONG><BR>
  195. <DD>
  196. Specifies foreground color to use when drawing active elements.
  197. See above for definition of active elements.
  198. <P></P>
  199. <DT><STRONG><A NAME="item_Name%3A_activetile">Name:    <STRONG>activetile</STRONG></A></STRONG><BR>
  200. <DD>
  201. <DT><STRONG><A NAME="item_Class%3A_Tile">Class:    <STRONG>Tile</STRONG></A></STRONG><BR>
  202. <DD>
  203. <DT><STRONG><A NAME="item_Switch%3A_%2Dactivetile">Switch:    <STRONG>-activetile</STRONG></A></STRONG><BR>
  204. <DD>
  205. Specifies image used to display inside active elements of the widget.
  206. See above for definition of active elements.
  207. <P></P>
  208. <DT><STRONG><A NAME="item_Name%3A_anchor">Name:    <STRONG>anchor</STRONG></A></STRONG><BR>
  209. <DD>
  210. <DT><STRONG><A NAME="item_Class%3A_Anchor">Class:    <STRONG>Anchor</STRONG></A></STRONG><BR>
  211. <DD>
  212. <DT><STRONG><A NAME="item_Switch%3A_%2Danchor">Switch:    <STRONG>-anchor</STRONG></A></STRONG><BR>
  213. <DD>
  214. Specifies how the information in a widget (e.g. text or a bitmap)
  215. is to be displayed in the widget.
  216. Must be one of the values <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>,
  217. <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, <STRONG>nw</STRONG>, or <STRONG>center</STRONG>.
  218. For example, <STRONG>nw</STRONG> means display the information such that its
  219. top-left corner is at the top-left corner of the widget.
  220. <P></P>
  221. <DT><STRONG><A NAME="item_Name%3A_background">Name:    <STRONG>background</STRONG></A></STRONG><BR>
  222. <DD>
  223. <DT><STRONG>Class:    <STRONG>Background</STRONG></STRONG><BR>
  224. <DD>
  225. <DT><STRONG><A NAME="item_Switch%3A_%2Dbackground">Switch:    <STRONG>-background</STRONG></A></STRONG><BR>
  226. <DD>
  227. <DT><STRONG><A NAME="item_Alias%3A_%2Dbg">Alias:    <STRONG>-bg</STRONG></A></STRONG><BR>
  228. <DD>
  229. Specifies the normal background color to use when displaying the
  230. widget.
  231. <P></P>
  232. <DT><STRONG><A NAME="item_Name%3A_bitmap">Name:    <STRONG>bitmap</STRONG></A></STRONG><BR>
  233. <DD>
  234. <DT><STRONG><A NAME="item_Class%3A_Bitmap">Class:    <STRONG>Bitmap</STRONG></A></STRONG><BR>
  235. <DD>
  236. <DT><STRONG><A NAME="item_Switch%3A_%2Dbitmap">Switch:    <STRONG>-bitmap</STRONG></A></STRONG><BR>
  237. <DD>
  238. Specifies a bitmap to display in the widget, in any of the forms
  239. acceptable to <STRONG>Tk_GetBitmap</STRONG>.
  240. The exact way in which the bitmap is displayed may be affected by
  241. other options such as <STRONG>-anchor</STRONG> or <STRONG>-justify</STRONG>.
  242. Typically, if this option is specified then it overrides other
  243. options that specify a textual value to display in the widget;
  244. the <STRONG>-bitmap</STRONG> option may be reset to an empty string to re-enable
  245. a text display.
  246. In widgets that support both <STRONG>-bitmap</STRONG> and <STRONG>-image</STRONG> options,
  247. <STRONG>-image</STRONG> will usually override <STRONG>-bitmap</STRONG>.
  248. <P></P>
  249. <DT><STRONG><A NAME="item_Name%3A_borderWidth">Name:    <STRONG>borderWidth</STRONG></A></STRONG><BR>
  250. <DD>
  251. <DT><STRONG>Class:    <STRONG>BorderWidth</STRONG></STRONG><BR>
  252. <DD>
  253. <DT><STRONG><A NAME="item_Switch%3A_%2Dborderwidth">Switch:    <STRONG>-borderwidth</STRONG></A></STRONG><BR>
  254. <DD>
  255. <DT><STRONG><A NAME="item_Alias%3A_%2Dbd">Alias:    <STRONG>-bd</STRONG></A></STRONG><BR>
  256. <DD>
  257. Specifies a non-negative value indicating the width
  258. of the 3-D border to draw around the outside of the widget (if such a
  259. border is being drawn;  the <STRONG>relief</STRONG> option typically determines
  260. this).  The value may also be used when drawing 3-D effects in the
  261. interior of the widget.
  262. The value may have any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
  263. <P></P>
  264. <DT><STRONG><A NAME="item_Name%3A_cursor">Name:    <STRONG>cursor</STRONG></A></STRONG><BR>
  265. <DD>
  266. <DT><STRONG><A NAME="item_Class%3A_Cursor">Class:    <STRONG>Cursor</STRONG></A></STRONG><BR>
  267. <DD>
  268. <DT><STRONG><A NAME="item_Switch%3A_%2Dcursor">Switch:    <STRONG>-cursor</STRONG></A></STRONG><BR>
  269. <DD>
  270. Specifies the mouse cursor to be used for the widget.
  271. The value may have any of the forms acceptable to <STRONG>Tk_GetCursor</STRONG>.
  272. <P></P>
  273. <DT><STRONG><A NAME="item_Name%3A_dash">Name:    <STRONG>dash</STRONG></A></STRONG><BR>
  274. <DD>
  275. <DT><STRONG><A NAME="item_Class%3A_Dash">Class:    <STRONG>Dash</STRONG></A></STRONG><BR>
  276. <DD>
  277. <DT><STRONG><A NAME="item_Switch%3A_%2Ddash">Switch:    <STRONG>-dash</STRONG></A></STRONG><BR>
  278. <DD>
  279. The value may have any of the forms accepted by <STRONG>Tk_GetDash</STRONG>,
  280. such as <STRONG>4</STRONG>, <STRONG>[6,4]</STRONG>, <STRONG>.</STRONG>, <STRONG>-</STRONG>, <STRONG>-.</STRONG>, or <STRONG>-..</STRONG>.
  281. <P></P>
  282. <DT><STRONG><A NAME="item_Name%3A_dashoffset">Name:    <STRONG>dashoffset</STRONG></A></STRONG><BR>
  283. <DD>
  284. <DT><STRONG><A NAME="item_Class%3A_Dashoffset">Class:    <STRONG>Dashoffset</STRONG></A></STRONG><BR>
  285. <DD>
  286. <DT><STRONG><A NAME="item_Switch%3A_%2Ddashoffset">Switch:    <STRONG>-dashoffset</STRONG></A></STRONG><BR>
  287. <DD>
  288. Specifies the offset in the dash list where the drawing starts.
  289. <P></P>
  290. <DT><STRONG><A NAME="item_Name%3A_disabledForeground">Name:    <STRONG>disabledForeground</STRONG></A></STRONG><BR>
  291. <DD>
  292. <DT><STRONG><A NAME="item_Class%3A_DisabledForeground">Class:    <STRONG>DisabledForeground</STRONG></A></STRONG><BR>
  293. <DD>
  294. <DT><STRONG><A NAME="item_Switch%3A_%2Ddisabledforeground">Switch:    <STRONG>-disabledforeground</STRONG></A></STRONG><BR>
  295. <DD>
  296. Specifies foreground color to use when drawing a disabled element.
  297. If the option is specified as an empty string (which is typically the
  298. case on monochrome displays), disabled elements are drawn with the
  299. normal foreground color but they are dimmed by drawing them
  300. with a stippled fill pattern.
  301. <P></P>
  302. <DT><STRONG><A NAME="item_Name%3A_disabledtile">Name:    <STRONG>disabledtile</STRONG></A></STRONG><BR>
  303. <DD>
  304. <DT><STRONG>Class:    <STRONG>Tile</STRONG></STRONG><BR>
  305. <DD>
  306. <DT><STRONG><A NAME="item_Switch%3A_%2Ddisabledtile">Switch:    <STRONG>-disabledtile</STRONG></A></STRONG><BR>
  307. <DD>
  308. Specifies image to use when drawing a disabled element.
  309. <P></P>
  310. <DT><STRONG><A NAME="item_Name%3A_exportSelection">Name:    <STRONG>exportSelection</STRONG></A></STRONG><BR>
  311. <DD>
  312. <DT><STRONG><A NAME="item_Class%3A_ExportSelection">Class:    <STRONG>ExportSelection</STRONG></A></STRONG><BR>
  313. <DD>
  314. <DT><STRONG><A NAME="item_Switch%3A_%2Dexportselection">Switch:    <STRONG>-exportselection</STRONG></A></STRONG><BR>
  315. <DD>
  316. Specifies whether or not a selection in the widget should also be
  317. the X selection.
  318. The value may have any of the forms accepted by <STRONG>Tcl_GetBoolean</STRONG>,
  319. such as <STRONG>true</STRONG>, <STRONG>false</STRONG>, <STRONG>0</STRONG>, <STRONG>1</STRONG>, <STRONG>yes</STRONG>, or <STRONG>no</STRONG>.
  320. If the selection is exported, then selecting in the widget deselects
  321. the current X selection, selecting outside the widget deselects any
  322. widget selection, and the widget will respond to selection retrieval
  323. requests when it has a selection.  The default is usually for widgets
  324. to export selections.
  325. <P></P>
  326. <DT><STRONG><A NAME="item_Name%3A_font">Name:    <STRONG>font</STRONG></A></STRONG><BR>
  327. <DD>
  328. <DT><STRONG><A NAME="item_Class%3A_Font">Class:    <STRONG>Font</STRONG></A></STRONG><BR>
  329. <DD>
  330. <DT><STRONG><A NAME="item_Switch%3A_%2Dfont">Switch:    <STRONG>-font</STRONG></A></STRONG><BR>
  331. <DD>
  332. Specifies the font to use when drawing text inside the widget.
  333. <P></P>
  334. <DT><STRONG><A NAME="item_Name%3A_foreground">Name:    <STRONG>foreground</STRONG></A></STRONG><BR>
  335. <DD>
  336. <DT><STRONG>Class:    <STRONG>Foreground</STRONG></STRONG><BR>
  337. <DD>
  338. <DT><STRONG><A NAME="item_Switch%3A_%2Dforeground">Switch:    <STRONG>-foreground</STRONG></A></STRONG><BR>
  339. <DD>
  340. <DT><STRONG><A NAME="item_Alias%3A_%2Dfg">Alias:    <STRONG>-fg</STRONG></A></STRONG><BR>
  341. <DD>
  342. Specifies the normal foreground color to use when displaying the widget.
  343. <P></P>
  344. <DT><STRONG><A NAME="item_Name%3A_highlightBackground">Name:    <STRONG>highlightBackground</STRONG></A></STRONG><BR>
  345. <DD>
  346. <DT><STRONG><A NAME="item_Class%3A_HighlightBackground">Class:    <STRONG>HighlightBackground</STRONG></A></STRONG><BR>
  347. <DD>
  348. <DT><STRONG><A NAME="item_Switch%3A_%2Dhighlightbackground">Switch:    <STRONG>-highlightbackground</STRONG></A></STRONG><BR>
  349. <DD>
  350. Specifies the color to display in the traversal highlight region when
  351. the widget does not have the input focus.
  352. <P></P>
  353. <DT><STRONG><A NAME="item_Name%3A_highlightColor">Name:    <STRONG>highlightColor</STRONG></A></STRONG><BR>
  354. <DD>
  355. <DT><STRONG><A NAME="item_Class%3A_HighlightColor">Class:    <STRONG>HighlightColor</STRONG></A></STRONG><BR>
  356. <DD>
  357. <DT><STRONG><A NAME="item_Switch%3A_%2Dhighlightcolor">Switch:    <STRONG>-highlightcolor</STRONG></A></STRONG><BR>
  358. <DD>
  359. Specifies the color to use for the traversal highlight rectangle that is
  360. drawn around the widget when it has the input focus.
  361. <P></P>
  362. <DT><STRONG><A NAME="item_Name%3A_highlightThickness">Name:    <STRONG>highlightThickness</STRONG></A></STRONG><BR>
  363. <DD>
  364. <DT><STRONG><A NAME="item_Class%3A_HighlightThickness">Class:    <STRONG>HighlightThickness</STRONG></A></STRONG><BR>
  365. <DD>
  366. <DT><STRONG><A NAME="item_Switch%3A_%2Dhighlightthickness">Switch:    <STRONG>-highlightthickness</STRONG></A></STRONG><BR>
  367. <DD>
  368. Specifies a non-negative value indicating the width of the highlight
  369. rectangle to draw around the outside of the widget when it has the
  370. input focus.
  371. The value may have any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
  372. If the value is zero, no focus highlight is drawn around the widget.
  373. <P></P>
  374. <DT><STRONG><A NAME="item_Name%3A_image">Name:    <STRONG>image</STRONG></A></STRONG><BR>
  375. <DD>
  376. <DT><STRONG><A NAME="item_Class%3A_Image">Class:    <STRONG>Image</STRONG></A></STRONG><BR>
  377. <DD>
  378. <DT><STRONG><A NAME="item_Switch%3A_%2Dimage">Switch:    <STRONG>-image</STRONG></A></STRONG><BR>
  379. <DD>
  380. Specifies an image to display in the widget, which must have been
  381. created with an image create. (See <A HREF="../../../site/lib/Tk/Image.html">the Tk::Image manpage</A> for details of image creation.)
  382. Typically, if the <STRONG>-image</STRONG> option is specified then it overrides other
  383. options that specify a bitmap or textual value to display in the widget;
  384. the <STRONG>-image</STRONG> option may be reset to an empty string to re-enable
  385. a bitmap or text display.
  386. <P></P>
  387. <DT><STRONG><A NAME="item_Name%3A_insertBackground">Name:    <STRONG>insertBackground</STRONG></A></STRONG><BR>
  388. <DD>
  389. <DT><STRONG>Class:    <STRONG>Foreground</STRONG></STRONG><BR>
  390. <DD>
  391. <DT><STRONG><A NAME="item_Switch%3A_%2Dinsertbackground">Switch:    <STRONG>-insertbackground</STRONG></A></STRONG><BR>
  392. <DD>
  393. Specifies the color to use as background in the area covered by the
  394. insertion cursor.  This color will normally override either the normal
  395. background for the widget (or the selection background if the insertion
  396. cursor happens to fall in the selection).
  397. <P></P>
  398. <DT><STRONG><A NAME="item_Name%3A_insertBorderWidth">Name:    <STRONG>insertBorderWidth</STRONG></A></STRONG><BR>
  399. <DD>
  400. <DT><STRONG>Class:    <STRONG>BorderWidth</STRONG></STRONG><BR>
  401. <DD>
  402. <DT><STRONG><A NAME="item_Switch%3A_%2Dinsertborderwidth">Switch:    <STRONG>-insertborderwidth</STRONG></A></STRONG><BR>
  403. <DD>
  404. Specifies a non-negative value indicating the width
  405. of the 3-D border to draw around the insertion cursor.
  406. The value may have any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
  407. <P></P>
  408. <DT><STRONG><A NAME="item_Name%3A_insertOffTime">Name:    <STRONG>insertOffTime</STRONG></A></STRONG><BR>
  409. <DD>
  410. <DT><STRONG><A NAME="item_Class%3A_OffTime">Class:    <STRONG>OffTime</STRONG></A></STRONG><BR>
  411. <DD>
  412. <DT><STRONG><A NAME="item_Switch%3A_%2Dinsertofftime">Switch:    <STRONG>-insertofftime</STRONG></A></STRONG><BR>
  413. <DD>
  414. Specifies a non-negative integer value indicating the number of
  415. milliseconds the insertion cursor should remain ``off'' in each blink cycle.
  416. If this option is zero then the cursor doesn't blink:  it is on
  417. all the time.
  418. <P></P>
  419. <DT><STRONG><A NAME="item_Name%3A_insertOnTime">Name:    <STRONG>insertOnTime</STRONG></A></STRONG><BR>
  420. <DD>
  421. <DT><STRONG><A NAME="item_Class%3A_OnTime">Class:    <STRONG>OnTime</STRONG></A></STRONG><BR>
  422. <DD>
  423. <DT><STRONG><A NAME="item_Switch%3A_%2Dinsertontime">Switch:    <STRONG>-insertontime</STRONG></A></STRONG><BR>
  424. <DD>
  425. Specifies a non-negative integer value indicating the number of
  426. milliseconds the insertion cursor should remain ``on'' in each blink cycle.
  427. <P></P>
  428. <DT><STRONG><A NAME="item_Name%3A_insertWidth">Name:    <STRONG>insertWidth</STRONG></A></STRONG><BR>
  429. <DD>
  430. <DT><STRONG><A NAME="item_Class%3A_InsertWidth">Class:    <STRONG>InsertWidth</STRONG></A></STRONG><BR>
  431. <DD>
  432. <DT><STRONG><A NAME="item_Switch%3A_%2Dinsertwidth">Switch:    <STRONG>-insertwidth</STRONG></A></STRONG><BR>
  433. <DD>
  434. Specifies a  value indicating the total width of the insertion cursor.
  435. The value may have any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
  436. If a border has been specified for the insertion
  437. cursor (using the <STRONG>insertBorderWidth</STRONG> option), the border
  438. will be drawn inside the width specified by the <STRONG>insertWidth</STRONG>
  439. option.
  440. <P></P>
  441. <DT><STRONG><A NAME="item_Name%3A_jump">Name:    <STRONG>jump</STRONG></A></STRONG><BR>
  442. <DD>
  443. <DT><STRONG><A NAME="item_Class%3A_Jump">Class:    <STRONG>Jump</STRONG></A></STRONG><BR>
  444. <DD>
  445. <DT><STRONG><A NAME="item_Switch%3A_%2Djump">Switch:    <STRONG>-jump</STRONG></A></STRONG><BR>
  446. <DD>
  447. For widgets with a slider that can be dragged to adjust a value,
  448. such as scrollbars, this option determines when
  449. notifications are made about changes in the value.
  450. The option's value must be a boolean of the form accepted by
  451. <STRONG>Tcl_GetBoolean</STRONG>.
  452. If the value is false, updates are made continuously as the
  453. slider is dragged.
  454. If the value is true, updates are delayed until the mouse button
  455. is released to end the drag;  at that point a single notification
  456. is made (the value ``jumps'' rather than changing smoothly).
  457. <P></P>
  458. <DT><STRONG><A NAME="item_Name%3A_justify">Name:    <STRONG>justify</STRONG></A></STRONG><BR>
  459. <DD>
  460. <DT><STRONG><A NAME="item_Class%3A_Justify">Class:    <STRONG>Justify</STRONG></A></STRONG><BR>
  461. <DD>
  462. <DT><STRONG><A NAME="item_Switch%3A_%2Djustify">Switch:    <STRONG>-justify</STRONG></A></STRONG><BR>
  463. <DD>
  464. When there are multiple lines of text displayed in a widget, this
  465. option determines how the lines line up with each other.
  466. Must be one of <STRONG>left</STRONG>, <STRONG>center</STRONG>, or <STRONG>right</STRONG>.
  467. <STRONG>Left</STRONG> means that the lines' left edges all line up, <STRONG>center</STRONG>
  468. means that the lines' centers are aligned, and <STRONG>right</STRONG> means
  469. that the lines' right edges line up.
  470. <P></P>
  471. <DT><STRONG><A NAME="item_Name%3A_offset">Name:    <STRONG>offset</STRONG></A></STRONG><BR>
  472. <DD>
  473. <DT><STRONG><A NAME="item_Class%3A_Offset">Class:    <STRONG>Offset</STRONG></A></STRONG><BR>
  474. <DD>
  475. <DT><STRONG><A NAME="item_Switch%3A_%2Doffset">Switch:    <STRONG>-offset</STRONG></A></STRONG><BR>
  476. <DD>
  477. Specifies the offset of tiles (see also <STRONG>-tile</STRONG> option). It can
  478. have two different formats <STRONG>-offset x,y</STRONG> or <STRONG>-offset side</STRONG>,
  479. where side can be <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>,
  480. <STRONG>sw</STRONG>, <STRONG>w</STRONG>, <STRONG>nw</STRONG>, or <STRONG>center</STRONG>. In the first case
  481. the origin is the origin of the toplevel of the current window.
  482. For the canvas itself and canvas objects the origin is the canvas
  483. origin, but putting <STRONG>#</STRONG> in front of the coordinate pair
  484. indicates using the toplevel origin in stead. For canvas objects,
  485. the <STRONG>-offset</STRONG> option is used for stippling as well.
  486. For the line and polygon canvas items you can also specify
  487. an index as argument, which connects the stipple or tile
  488. origin to one of the coordinate points of the line/polygon.
  489. <P></P>
  490. <DT><STRONG><A NAME="item_Name%3A_orient">Name:    <STRONG>orient</STRONG></A></STRONG><BR>
  491. <DD>
  492. <DT><STRONG><A NAME="item_Class%3A_Orient">Class:    <STRONG>Orient</STRONG></A></STRONG><BR>
  493. <DD>
  494. <DT><STRONG><A NAME="item_Switch%3A_%2Dorient">Switch:    <STRONG>-orient</STRONG></A></STRONG><BR>
  495. <DD>
  496. For widgets that can lay themselves out with either a horizontal
  497. or vertical orientation, such as scrollbars, this option specifies
  498. which orientation should be used.  Must be either <STRONG>horizontal</STRONG>
  499. or <STRONG>vertical</STRONG> or an abbreviation of one of these.
  500. <P></P>
  501. <DT><STRONG><A NAME="item_Name%3A_padX">Name:    <STRONG>padX</STRONG></A></STRONG><BR>
  502. <DD>
  503. <DT><STRONG><A NAME="item_Class%3A_Pad">Class:    <STRONG>Pad</STRONG></A></STRONG><BR>
  504. <DD>
  505. <DT><STRONG><A NAME="item_Switch%3A_%2Dpadx">Switch:    <STRONG>-padx</STRONG></A></STRONG><BR>
  506. <DD>
  507. Specifies a non-negative value indicating how much extra space
  508. to request for the widget in the X-direction.
  509. The value may have any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
  510. When computing how large a window it needs, the widget will
  511. add this amount to the width it would normally need (as determined
  512. by the width of the things displayed in the widget);  if the geometry
  513. manager can satisfy this request, the widget will end up with extra
  514. internal space to the left and/or right of what it displays inside.
  515. Most widgets only use this option for padding text:  if they are
  516. displaying a bitmap or image, then they usually ignore padding
  517. options.
  518. <P></P>
  519. <DT><STRONG><A NAME="item_Name%3A_padY">Name:    <STRONG>padY</STRONG></A></STRONG><BR>
  520. <DD>
  521. <DT><STRONG>Class:    <STRONG>Pad</STRONG></STRONG><BR>
  522. <DD>
  523. <DT><STRONG><A NAME="item_Switch%3A_%2Dpady">Switch:    <STRONG>-pady</STRONG></A></STRONG><BR>
  524. <DD>
  525. Specifies a non-negative value indicating how much extra space
  526. to request for the widget in the Y-direction.
  527. The value may have any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
  528. When computing how large a window it needs, the widget will add
  529. this amount to the height it would normally need (as determined by
  530. the height of the things displayed in the widget);  if the geometry
  531. manager can satisfy this request, the widget will end up with extra
  532. internal space above and/or below what it displays inside.
  533. Most widgets only use this option for padding text:  if they are
  534. displaying a bitmap or image, then they usually ignore padding
  535. options.
  536. <P></P>
  537. <DT><STRONG><A NAME="item_Name%3A_relief">Name:    <STRONG>relief</STRONG></A></STRONG><BR>
  538. <DD>
  539. <DT><STRONG><A NAME="item_Class%3A_Relief">Class:    <STRONG>Relief</STRONG></A></STRONG><BR>
  540. <DD>
  541. <DT><STRONG><A NAME="item_Switch%3A_%2Drelief">Switch:    <STRONG>-relief</STRONG></A></STRONG><BR>
  542. <DD>
  543. Specifies the 3-D effect desired for the widget.  Acceptable
  544. values are <STRONG>raised</STRONG>, <STRONG>sunken</STRONG>, <STRONG>flat</STRONG>, <STRONG>ridge</STRONG>,
  545. <STRONG>solid</STRONG>, and <STRONG>groove</STRONG>.
  546. The value
  547. indicates how the interior of the widget should appear relative
  548. to its exterior;  for example, <STRONG>raised</STRONG> means the interior of
  549. the widget should appear to protrude from the screen, relative to
  550. the exterior of the widget.
  551. <P></P>
  552. <DT><STRONG><A NAME="item_Name%3A_repeatDelay">Name:    <STRONG>repeatDelay</STRONG></A></STRONG><BR>
  553. <DD>
  554. <DT><STRONG><A NAME="item_Class%3A_RepeatDelay">Class:    <STRONG>RepeatDelay</STRONG></A></STRONG><BR>
  555. <DD>
  556. <DT><STRONG><A NAME="item_Switch%3A_%2Drepeatdelay">Switch:    <STRONG>-repeatdelay</STRONG></A></STRONG><BR>
  557. <DD>
  558. Specifies the number of milliseconds a button or key must be held
  559. down before it begins to auto-repeat.  Used, for example, on the
  560. up- and down-arrows in scrollbars.
  561. <P></P>
  562. <DT><STRONG><A NAME="item_Name%3A_repeatInterval">Name:    <STRONG>repeatInterval</STRONG></A></STRONG><BR>
  563. <DD>
  564. <DT><STRONG><A NAME="item_Class%3A_RepeatInterval">Class:    <STRONG>RepeatInterval</STRONG></A></STRONG><BR>
  565. <DD>
  566. <DT><STRONG><A NAME="item_Switch%3A_%2Drepeatinterval">Switch:    <STRONG>-repeatinterval</STRONG></A></STRONG><BR>
  567. <DD>
  568. Used in conjunction with <STRONG>repeatDelay</STRONG>:  once auto-repeat
  569. begins, this option determines the number of milliseconds between
  570. auto-repeats.
  571. <P></P>
  572. <DT><STRONG><A NAME="item_Name%3A_selectBackground">Name:    <STRONG>selectBackground</STRONG></A></STRONG><BR>
  573. <DD>
  574. <DT><STRONG>Class:    <STRONG>Foreground</STRONG></STRONG><BR>
  575. <DD>
  576. <DT><STRONG><A NAME="item_Switch%3A_%2Dselectbackground">Switch:    <STRONG>-selectbackground</STRONG></A></STRONG><BR>
  577. <DD>
  578. Specifies the background color to use when displaying selected
  579. items.
  580. <P></P>
  581. <DT><STRONG><A NAME="item_Name%3A_selectBorderWidth">Name:    <STRONG>selectBorderWidth</STRONG></A></STRONG><BR>
  582. <DD>
  583. <DT><STRONG>Class:    <STRONG>BorderWidth</STRONG></STRONG><BR>
  584. <DD>
  585. <DT><STRONG><A NAME="item_Switch%3A_%2Dselectborderwidth">Switch:    <STRONG>-selectborderwidth</STRONG></A></STRONG><BR>
  586. <DD>
  587. Specifies a non-negative value indicating the width
  588. of the 3-D border to draw around selected items.
  589. The value may have any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>.
  590. <P></P>
  591. <DT><STRONG><A NAME="item_Name%3A_selectForeground">Name:    <STRONG>selectForeground</STRONG></A></STRONG><BR>
  592. <DD>
  593. <DT><STRONG>Class:    <STRONG>Background</STRONG></STRONG><BR>
  594. <DD>
  595. <DT><STRONG><A NAME="item_Switch%3A_%2Dselectforeground">Switch:    <STRONG>-selectforeground</STRONG></A></STRONG><BR>
  596. <DD>
  597. Specifies the foreground color to use when displaying selected
  598. items.
  599. <P></P>
  600. <DT><STRONG><A NAME="item_Name%3A_setGrid">Name:    <STRONG>setGrid</STRONG></A></STRONG><BR>
  601. <DD>
  602. <DT><STRONG><A NAME="item_Class%3A_SetGrid">Class:    <STRONG>SetGrid</STRONG></A></STRONG><BR>
  603. <DD>
  604. <DT><STRONG><A NAME="item_Switch%3A_%2Dsetgrid">Switch:    <STRONG>-setgrid</STRONG></A></STRONG><BR>
  605. <DD>
  606. Specifies a boolean value that determines whether this widget controls the
  607. resizing grid for its top-level window.
  608. This option is typically used in text widgets, where the information
  609. in the widget has a natural size (the size of a character) and it makes
  610. sense for the window's dimensions to be integral numbers of these units.
  611. These natural window sizes form a grid.
  612. If the <STRONG>setGrid</STRONG> option is set to true then the widget will
  613. communicate with the window manager so that when the user interactively
  614. resizes the top-level window that contains the widget, the dimensions of
  615. the window will be displayed to the user in grid units and the window
  616. size will be constrained to integral numbers of grid units.
  617. See <A HREF="../../../site/lib/Tk/Wm.html#gridded geometry management">GRIDDED GEOMETRY MANAGEMENT in the Tk::Wm manpage</A>
  618. for more details.
  619. <P></P>
  620. <DT><STRONG><A NAME="item_Name%3A_takeFocus">Name:    <STRONG>takeFocus</STRONG></A></STRONG><BR>
  621. <DD>
  622. <DT><STRONG><A NAME="item_Class%3A_TakeFocus">Class:    <STRONG>TakeFocus</STRONG></A></STRONG><BR>
  623. <DD>
  624. <DT><STRONG><A NAME="item_Switch%3A_%2Dtakefocus">Switch:    <STRONG>-takefocus</STRONG></A></STRONG><BR>
  625. <DD>
  626. Determines whether the window accepts the focus during keyboard
  627. traversal (e.g., Tab and Shift-Tab).
  628. Before setting the focus to a window, the traversal scripts
  629. consult the value of the <STRONG>takeFocus</STRONG> option.
  630. A value of <STRONG>0</STRONG> means that the window should be skipped entirely
  631. during keyboard traversal.
  632. <STRONG>1</STRONG> means that the window should receive the input
  633. focus as long as it is viewable (it and all of its ancestors are mapped).
  634. An empty value for the option means that the traversal scripts make
  635. the decision about whether or not to focus on the window:  the current
  636. algorithm is to skip the window if it is
  637. disabled, if it has no key bindings, or if it is not viewable.
  638. If the value has any other form, then the traversal scripts take
  639. the value, append the name of the window to it (with a separator space),
  640. and evaluate the resulting string as a Callback.
  641. The script must return <STRONG>0</STRONG>, <STRONG>1</STRONG>, or an empty string:  a
  642. <STRONG>0</STRONG> or <STRONG>1</STRONG> value specifies whether the window will receive
  643. the input focus, and an empty string results in the default decision
  644. described above.
  645. Note: this interpretation of the option is defined entirely by
  646. the Callbacks that implement traversal:  the widget implementations
  647. ignore the option entirely, so you can change its meaning if you
  648. redefine the keyboard traversal scripts.
  649. <P></P>
  650. <DT><STRONG><A NAME="item_Name%3A_text">Name:    <STRONG>text</STRONG></A></STRONG><BR>
  651. <DD>
  652. <DT><STRONG><A NAME="item_Class%3A_Text">Class:    <STRONG>Text</STRONG></A></STRONG><BR>
  653. <DD>
  654. <DT><STRONG><A NAME="item_Switch%3A_%2Dtext">Switch:    <STRONG>-text</STRONG></A></STRONG><BR>
  655. <DD>
  656. Specifies a string to be displayed inside the widget.  The way in which
  657. the string is displayed depends on the particular widget and may be
  658. determined by other options, such as <STRONG>anchor</STRONG> or <STRONG>justify</STRONG>.
  659. <P></P>
  660. <DT><STRONG><A NAME="item_Name%3A_textVariable">Name:    <STRONG>textVariable</STRONG></A></STRONG><BR>
  661. <DD>
  662. <DT><STRONG><A NAME="item_Class%3A_Variable">Class:    <STRONG>Variable</STRONG></A></STRONG><BR>
  663. <DD>
  664. <DT><STRONG><A NAME="item_Switch%3A_%2Dtextvariable">Switch:    <STRONG>-textvariable</STRONG></A></STRONG><BR>
  665. <DD>
  666. Specifies the name of a variable.  The value of the variable is a text
  667. string to be displayed inside the widget;  if the variable value changes
  668. then the widget will automatically update itself to reflect the new value.
  669. The way in which the string is displayed in the widget depends on the
  670. particular widget and may be determined by other options, such as
  671. <STRONG>anchor</STRONG> or <STRONG>justify</STRONG>.
  672. <P></P>
  673. <DT><STRONG><A NAME="item_Name%3A_troughColor">Name:    <STRONG>troughColor</STRONG></A></STRONG><BR>
  674. <DD>
  675. <DT><STRONG>Class:    <STRONG>Background</STRONG></STRONG><BR>
  676. <DD>
  677. <DT><STRONG><A NAME="item_Switch%3A_%2Dtroughcolor">Switch:    <STRONG>-troughcolor</STRONG></A></STRONG><BR>
  678. <DD>
  679. Specifies the color to use for the rectangular trough areas
  680. in widgets such as scrollbars and scales.
  681. <P></P>
  682. <DT><STRONG><A NAME="item_Name%3A_troughTile">Name:    <STRONG>troughTile</STRONG></A></STRONG><BR>
  683. <DD>
  684. <DT><STRONG>Class:    <STRONG>Tile</STRONG></STRONG><BR>
  685. <DD>
  686. <DT><STRONG><A NAME="item_Switch%3A_%2Dtroughtile">Switch:    <STRONG>-troughtile</STRONG></A></STRONG><BR>
  687. <DD>
  688. Specifies image used to display in the rectangular trough areas
  689. in widgets such as scrollbars and scales.
  690. <P></P>
  691. <DT><STRONG><A NAME="item_Name%3A_underline">Name:    <STRONG>underline</STRONG></A></STRONG><BR>
  692. <DD>
  693. <DT><STRONG><A NAME="item_Class%3A_Underline">Class:    <STRONG>Underline</STRONG></A></STRONG><BR>
  694. <DD>
  695. <DT><STRONG><A NAME="item_Switch%3A_%2Dunderline">Switch:    <STRONG>-underline</STRONG></A></STRONG><BR>
  696. <DD>
  697. Specifies the integer index of a character to underline in the widget.
  698. This option is used by the default bindings to implement keyboard
  699. traversal for menu buttons and menu entries.
  700. 0 corresponds to the first character of the text displayed in the
  701. widget, 1 to the next character, and so on.
  702. <P></P>
  703. <DT><STRONG><A NAME="item_Name%3A_wrapLength">Name:    <STRONG>wrapLength</STRONG></A></STRONG><BR>
  704. <DD>
  705. <DT><STRONG><A NAME="item_Class%3A_WrapLength">Class:    <STRONG>WrapLength</STRONG></A></STRONG><BR>
  706. <DD>
  707. <DT><STRONG><A NAME="item_Switch%3A_%2Dwraplength">Switch:    <STRONG>-wraplength</STRONG></A></STRONG><BR>
  708. <DD>
  709. For widgets that can perform word-wrapping, this option specifies
  710. the maximum line length.
  711. Lines that would exceed this length are wrapped onto the next line,
  712. so that no line is longer than the specified length.
  713. The value may be specified in any of the standard forms for
  714. screen distances.
  715. If this value is less than or equal to 0 then no wrapping is done:  lines
  716. will break only at newline characters in the text.
  717. <P></P>
  718. <DT><STRONG><A NAME="item_Name%3A_xScrollCommand">Name:    <STRONG>xScrollCommand</STRONG></A></STRONG><BR>
  719. <DD>
  720. <DT><STRONG><A NAME="item_Class%3A_ScrollCommand">Class:    <STRONG>ScrollCommand</STRONG></A></STRONG><BR>
  721. <DD>
  722. <DT><STRONG><A NAME="item_Switch%3A_%2Dxscrollcommand">Switch:    <STRONG>-xscrollcommand</STRONG></A></STRONG><BR>
  723. <DD>
  724. Specifies a callback used to communicate with horizontal
  725. scrollbars.
  726. When the view in the widget's window changes (or
  727. whenever anything else occurs that could change the display in a
  728. scrollbar, such as a change in the total size of the widget's
  729. contents), the widget will
  730. make a callback passing two numeric arguments in addition to
  731. any specified in the callback.
  732. Each of the numbers is a fraction between 0 and 1, which indicates
  733. a position in the document.  0 indicates the beginning of the document,
  734. 1 indicates the end, .333 indicates a position one third the way through
  735. the document, and so on.
  736. The first fraction indicates the first information in the document
  737. that is visible in the window, and the second fraction indicates
  738. the information just after the last portion that is visible.
  739. Typically the
  740. <STRONG>xScrollCommand</STRONG> option consists of the scrollbar widget object
  741. and the method ``set'' i.e. [<STRONG>set</STRONG> => <EM>$sb</EM>]:
  742. this will cause the scrollbar to be updated whenever the view in the window changes.
  743. If this option is not specified, then no command will be executed.
  744. <P></P>
  745. <DT><STRONG><A NAME="item_Name%3A_yScrollCommand">Name:    <STRONG>yScrollCommand</STRONG></A></STRONG><BR>
  746. <DD>
  747. <DT><STRONG>Class:    <STRONG>ScrollCommand</STRONG></STRONG><BR>
  748. <DD>
  749. <DT><STRONG><A NAME="item_Switch%3A_%2Dyscrollcommand">Switch:    <STRONG>-yscrollcommand</STRONG></A></STRONG><BR>
  750. <DD>
  751. Specifies a calback used to communicate with vertical
  752. scrollbars.  This option is treated in the same way as the
  753. <STRONG>xScrollCommand</STRONG> option, except that it is used for vertical
  754. scrollbars and is provided by widgets that support vertical scrolling.
  755. See the description of <STRONG>xScrollCommand</STRONG> for details
  756. on how this option is used.
  757. <P></P></DL>
  758. <P>
  759. <HR>
  760. <H1><A NAME="see also">SEE ALSO</A></H1>
  761. <P><A HREF="../../../site/lib/Tk/option.html">Tk::option</A>
  762. <A HREF="../../../site/lib/Tk/callbacks.html">Tk::callbacks</A>
  763. <A HREF="../../../site/lib/Tk/configspec.html">Tk::configspec</A>
  764. <A HREF="../../../Tk/pTk/GetPixels.html">Tk_GetPixels</A></P>
  765. <P>
  766. <HR>
  767. <H1><A NAME="keywords">KEYWORDS</A></H1>
  768. <P>class, name, standard option, switch</P>
  769. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  770. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  771. <STRONG><P CLASS=block> Tk::options - Standard options supported by widgets and their manipulation</P></STRONG>
  772. </TD></TR>
  773. </TABLE>
  774.  
  775. </BODY>
  776.  
  777. </HTML>
  778.