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

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::Radiobutton - Create and manipulate Radiobutton 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::Radiobutton - Create and manipulate Radiobutton 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::Radiobutton - Create and manipulate Radiobutton 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>$radiobutton</EM> = <EM>$parent</EM>-><STRONG>Radiobutton</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>-cursor</STRONG><TD><STRONG>-highlightthickness</STRONG><TD><STRONG>-takefocus</STRONG>
  52. <TR><TD><STRONG>-activeforeground</STRONG><TD><STRONG>-disabledforeground</STRONG><TD><STRONG>-image</STRONG><TD><STRONG>-text</STRONG>
  53. <TR><TD><STRONG>-anchor</STRONG><TD><STRONG>-font</STRONG><TD><STRONG>-justify</STRONG><TD><STRONG>-textvariable</STRONG>
  54. <TR><TD><STRONG>-background</STRONG><TD><STRONG>-foreground</STRONG><TD><STRONG>-padx</STRONG><TD><STRONG>-underline</STRONG>
  55. <TR><TD><STRONG>-bitmap</STRONG><TD><STRONG>-highlightbackground</STRONG><TD><STRONG>-pady</STRONG><TD><STRONG>-wraplength</STRONG>
  56. <TR><TD><STRONG>-borderwidth</STRONG><TD><STRONG>-highlightcolor</STRONG><TD><STRONG>-relief</STRONG></TABLE></P>
  57. <P>See <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> for details of the standard options.</P>
  58. <P>
  59. <HR>
  60. <H1><A NAME="widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></H1>
  61. <DL>
  62. <DT><STRONG><A NAME="item_Name%3A_command">Name:    <STRONG>command</STRONG></A></STRONG><BR>
  63. <DD>
  64. <DT><STRONG><A NAME="item_Class%3A_Command">Class:    <STRONG>Command</STRONG></A></STRONG><BR>
  65. <DD>
  66. <DT><STRONG><A NAME="item_Switch%3A_%2Dcommand">Switch:    <STRONG>-command</STRONG></A></STRONG><BR>
  67. <DD>
  68. Specifies a <A HREF="../../../site/lib/Tk/callbacks.html">perl/Tk callback</A> to associate with the button.  This command
  69. is typically invoked when mouse button 1 is released over the button
  70. window.  The button's global variable (<STRONG>-variable</STRONG> option) will
  71. be updated before the command is invoked.
  72. <P></P>
  73. <DT><STRONG><A NAME="item_Name%3A_height">Name:    <STRONG>height</STRONG></A></STRONG><BR>
  74. <DD>
  75. <DT><STRONG><A NAME="item_Class%3A_Height">Class:    <STRONG>Height</STRONG></A></STRONG><BR>
  76. <DD>
  77. <DT><STRONG><A NAME="item_Switch%3A_%2Dheight">Switch:    <STRONG>-height</STRONG></A></STRONG><BR>
  78. <DD>
  79. Specifies a desired height for the button.
  80. If an image or bitmap is being displayed in the button then the value is in
  81. screen units (i.e. any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>);
  82. for text it is in lines of text.
  83. If this option isn't specified, the button's desired height is computed
  84. from the size of the image or bitmap or text being displayed in it.
  85. <P></P>
  86. <DT><STRONG><A NAME="item_Name%3A_indicatorOn">Name:    <STRONG>indicatorOn</STRONG></A></STRONG><BR>
  87. <DD>
  88. <DT><STRONG><A NAME="item_Class%3A_IndicatorOn">Class:    <STRONG>IndicatorOn</STRONG></A></STRONG><BR>
  89. <DD>
  90. <DT><STRONG><A NAME="item_Switch%3A_%2Dindicatoron">Switch:    <STRONG>-indicatoron</STRONG></A></STRONG><BR>
  91. <DD>
  92. Specifies whether or not the indicator should be drawn.  Must be a
  93. proper boolean value.  If false, the <STRONG>relief</STRONG> option is
  94. ignored and the widget's relief is always sunken if the widget is
  95. selected and raised otherwise.
  96. <P></P>
  97. <DT><STRONG><A NAME="item_Name%3A_selectColor">Name:    <STRONG>selectColor</STRONG></A></STRONG><BR>
  98. <DD>
  99. <DT><STRONG><A NAME="item_Class%3A_Background">Class:    <STRONG>Background</STRONG></A></STRONG><BR>
  100. <DD>
  101. <DT><STRONG><A NAME="item_Switch%3A_%2Dselectcolor">Switch:    <STRONG>-selectcolor</STRONG></A></STRONG><BR>
  102. <DD>
  103. Specifies a background color to use when the button is selected.
  104. If <STRONG>indicatorOn</STRONG> is true then the color applies to the indicator.
  105. Under Windows, this color is used as the background for the indicator
  106. regardless of the select state.
  107. If <STRONG>indicatorOn</STRONG> is false, this color is used as the background
  108. for the entire widget, in place of <STRONG>background</STRONG> or <STRONG>activeBackground</STRONG>,
  109. whenever the widget is selected.
  110. If specified as an empty string then no special color is used for
  111. displaying when the widget is selected.
  112. <P></P>
  113. <DT><STRONG><A NAME="item_Name%3A_selectImage">Name:    <STRONG>selectImage</STRONG></A></STRONG><BR>
  114. <DD>
  115. <DT><STRONG><A NAME="item_Class%3A_SelectImage">Class:    <STRONG>SelectImage</STRONG></A></STRONG><BR>
  116. <DD>
  117. <DT><STRONG><A NAME="item_Switch%3A_%2Dselectimage">Switch:    <STRONG>-selectimage</STRONG></A></STRONG><BR>
  118. <DD>
  119. Specifies an image to display (in place of the <STRONG>image</STRONG> option)
  120. when the radiobutton is selected.
  121. This option is ignored unless the <STRONG>image</STRONG> option has been
  122. specified.
  123. <P></P>
  124. <DT><STRONG><A NAME="item_Name%3A_state">Name:    <STRONG>state</STRONG></A></STRONG><BR>
  125. <DD>
  126. <DT><STRONG><A NAME="item_Class%3A_State">Class:    <STRONG>State</STRONG></A></STRONG><BR>
  127. <DD>
  128. <DT><STRONG><A NAME="item_Switch%3A_%2Dstate">Switch:    <STRONG>-state</STRONG></A></STRONG><BR>
  129. <DD>
  130. Specifies one of three states for the radiobutton:  <STRONG>normal</STRONG>, <STRONG>active</STRONG>,
  131. or <STRONG>disabled</STRONG>.  In normal state the radiobutton is displayed using the
  132. <STRONG>foreground</STRONG> and <STRONG>background</STRONG> options.  The active state is
  133. typically used when the pointer is over the radiobutton.  In active state
  134. the radiobutton is displayed using the <STRONG>activeForeground</STRONG> and
  135. <STRONG>activeBackground</STRONG> options.  Disabled state means that the radiobutton
  136. should be insensitive:  the default bindings will refuse to activate
  137. the widget and will ignore mouse button presses.
  138. In this state the <STRONG>disabledForeground</STRONG> and
  139. <STRONG>background</STRONG> options determine how the radiobutton is displayed.
  140. <P></P>
  141. <DT><STRONG><A NAME="item_Name%3A_value">Name:    <STRONG>value</STRONG></A></STRONG><BR>
  142. <DD>
  143. <DT><STRONG><A NAME="item_Class%3A_Value">Class:    <STRONG>Value</STRONG></A></STRONG><BR>
  144. <DD>
  145. <DT><STRONG><A NAME="item_Switch%3A_%2Dvalue">Switch:    <STRONG>-value</STRONG></A></STRONG><BR>
  146. <DD>
  147. Specifies value to store in the button's associated variable whenever
  148. this button is selected.
  149. <P></P>
  150. <DT><STRONG><A NAME="item_Name%3A_variable">Name:    <STRONG>variable</STRONG></A></STRONG><BR>
  151. <DD>
  152. <DT><STRONG><A NAME="item_Class%3A_Variable">Class:    <STRONG>Variable</STRONG></A></STRONG><BR>
  153. <DD>
  154. <DT><STRONG><A NAME="item_Switch%3A_%2Dvariable">Switch:    <STRONG>-variable</STRONG></A></STRONG><BR>
  155. <DD>
  156. Specifies reference to a variable to set whenever this button is
  157. selected.  Changes in this variable also cause the button to select
  158. or deselect itself. Defaults to the value <CODE>\$Tk::selectedButton</CODE>.
  159. <P></P>
  160. <DT><STRONG><A NAME="item_Name%3A_width">Name:    <STRONG>width</STRONG></A></STRONG><BR>
  161. <DD>
  162. <DT><STRONG><A NAME="item_Class%3A_Width">Class:    <STRONG>Width</STRONG></A></STRONG><BR>
  163. <DD>
  164. <DT><STRONG><A NAME="item_Switch%3A_%2Dwidth">Switch:    <STRONG>-width</STRONG></A></STRONG><BR>
  165. <DD>
  166. Specifies a desired width for the button.
  167. If an image or bitmap is being displayed in the button, the value is in
  168. screen units (i.e. any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>);
  169. for text it is in characters.
  170. If this option isn't specified, the button's desired width is computed
  171. from the size of the image or bitmap or text being displayed in it.
  172. <P></P></DL>
  173. <P>
  174. <HR>
  175. <H1><A NAME="description">DESCRIPTION</A></H1>
  176. <P>The <STRONG>Radiobutton</STRONG> method creates a new window (given by the
  177. $widget argument) and makes it into a radiobutton widget.
  178. Additional
  179. options, described above, may be specified on the command line
  180. or in the option database
  181. to configure aspects of the radiobutton such as its colors, font,
  182. text, and initial relief.  The <STRONG>radiobutton</STRONG> command returns its
  183. $widget argument.  At the time this command is invoked,
  184. there must not exist a window named $widget, but
  185. $widget's parent must exist.</P>
  186. <P>A radiobutton is a widget that displays a textual string, bitmap or image
  187. and a diamond or circle called an <EM>indicator</EM>.
  188. If text is displayed, it must all be in a single font, but it
  189. can occupy multiple lines on the screen (if it contains newlines
  190. or if wrapping occurs because of the <STRONG>wrapLength</STRONG> option) and
  191. one of the characters may optionally be underlined using the
  192. <STRONG>underline</STRONG> option.  A radiobutton has
  193. all of the behavior of a simple button: it can display itself in either
  194. of three different ways, according to the <STRONG>state</STRONG> option;
  195. it can be made to appear
  196. raised, sunken, or flat; it can be made to flash; and it invokes
  197. a <A HREF="../../../site/lib/Tk/callbacks.html">perl/Tk callback</A> whenever mouse button 1 is clicked over the
  198. check button.</P>
  199. <P>In addition, radiobuttons can be <EM>selected</EM>.
  200. If a radiobutton is selected, the indicator is normally
  201. drawn with a selected appearance, and
  202. a Tcl variable associated with the radiobutton is set to a particular
  203. value (normally 1).
  204. Under Unix, the indicator is drawn with a sunken relief and a special
  205. color.  Under Windows, the indicator is drawn with a round mark inside.
  206. If the radiobutton is not selected, then the indicator is drawn with a
  207. deselected appearance, and the associated variable is
  208. set to a different value (typically 0).
  209. Under Unix, the indicator is drawn with a raised relief and no special
  210. color.  Under Windows, the indicator is drawn without a round mark inside.
  211. Typically, several radiobuttons share a single variable and the
  212. value of the variable indicates which radiobutton is to be selected.
  213. When a radiobutton is selected it sets the value of the variable to
  214. indicate that fact;  each radiobutton also monitors the value of
  215. the variable and automatically selects and deselects itself when the
  216. variable's value changes.
  217. By default the variable <STRONG>selectedButton</STRONG>
  218. is used;  its contents give the name of the button that is
  219. selected, or the empty string if no button associated with that
  220. variable is selected.
  221. The name of the variable for a radiobutton,
  222. plus the variable to be stored into it, may be modified with options
  223. on the command line or in the option database.
  224. Configuration options may also be used to modify the way the
  225. indicator is displayed (or whether it is displayed at all).
  226. By default a radiobutton is configured to select itself on button clicks.</P>
  227. <P>
  228. <HR>
  229. <H1><A NAME="widget methods">WIDGET METHODS</A></H1>
  230. <P>The <STRONG>Radiobutton</STRONG> method creates a widget object.
  231. This object supports the <STRONG>configure</STRONG> and <STRONG>cget</STRONG> methods
  232. described in <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> which can be used to enquire and
  233. modify the options described above.
  234. The widget also inherits all the methods provided by the generic
  235. <A HREF="../../../site/lib/Tk/Widget.html">Tk::Widget</A> class.</P>
  236. <P>The following additional methods are available for radiobutton widgets:</P>
  237. <DL>
  238. <DT><STRONG><A NAME="item_deselect"><EM>$radiobutton</EM>-><STRONG>deselect</STRONG></A></STRONG><BR>
  239. <DD>
  240. Deselects the radiobutton and sets the associated variable to an
  241. empty string.
  242. If this radiobutton was not currently selected, the command has
  243. no effect.
  244. <P></P>
  245. <DT><STRONG><A NAME="item_flash"><EM>$radiobutton</EM>-><STRONG>flash</STRONG></A></STRONG><BR>
  246. <DD>
  247. Flashes the radiobutton.  This is accomplished by redisplaying the radiobutton
  248. several times, alternating between active and normal colors.  At
  249. the end of the flash the radiobutton is left in the same normal/active
  250. state as when the command was invoked.
  251. This command is ignored if the radiobutton's state is <STRONG>disabled</STRONG>.
  252. <P></P>
  253. <DT><STRONG><A NAME="item_invoke"><EM>$radiobutton</EM>-><STRONG>invoke</STRONG></A></STRONG><BR>
  254. <DD>
  255. Does just what would have happened if the user invoked the radiobutton
  256. with the mouse: selects the button and invokes
  257. its associated Tcl command, if there is one.
  258. The return value is the return value from the Tcl command, or an
  259. empty string if there is no command associated with the radiobutton.
  260. This command is ignored if the radiobutton's state is <STRONG>disabled</STRONG>.
  261. <P></P>
  262. <DT><STRONG><A NAME="item_select"><EM>$radiobutton</EM>-><STRONG>select</STRONG></A></STRONG><BR>
  263. <DD>
  264. Selects the radiobutton and sets the associated variable to the
  265. value corresponding to this widget.
  266. <P></P></DL>
  267. <P>
  268. <HR>
  269. <H1><A NAME="bindings">BINDINGS</A></H1>
  270. <P>Tk automatically creates class bindings for radiobuttons that give them
  271. the following default behavior:</P>
  272. <DL>
  273. <DT><STRONG><A NAME="item_%5B1%5D">[1]</A></STRONG><BR>
  274. <DD>
  275. On Unix systems, a radiobutton activates whenever the mouse passes
  276. over it and deactivates whenever the mouse leaves the radiobutton.  On
  277. Mac and Windows systems, when mouse button 1 is pressed over a
  278. radiobutton, the button activates whenever the mouse pointer is inside
  279. the button, and deactivates whenever the mouse pointer leaves the
  280. button.
  281. <P></P>
  282. <DT><STRONG><A NAME="item_%5B2%5D">[2]</A></STRONG><BR>
  283. <DD>
  284. When mouse button 1 is pressed over a radiobutton it is invoked (it
  285. becomes selected and the command associated with the button is
  286. invoked, if there is one).
  287. <P></P>
  288. <DT><STRONG><A NAME="item_%5B3%5D">[3]</A></STRONG><BR>
  289. <DD>
  290. When a radiobutton has the input focus, the space key causes the radiobutton
  291. to be invoked.
  292. <P>If the radiobutton's state is <STRONG>disabled</STRONG> then none of the above
  293. actions occur:  the radiobutton is completely non-responsive.</P>
  294. <P>The behavior of radiobuttons can be changed by defining new bindings for
  295. individual widgets or by redefining the class bindings.</P>
  296. <P></P></DL>
  297. <P>
  298. <HR>
  299. <H1><A NAME="keywords">KEYWORDS</A></H1>
  300. <P>radiobutton, widget</P>
  301. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  302. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  303. <STRONG><P CLASS=block> Tk::Radiobutton - Create and manipulate Radiobutton widgets</P></STRONG>
  304. </TD></TR>
  305. </TABLE>
  306.  
  307. </BODY>
  308.  
  309. </HTML>
  310.