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

通讯编程

开发平台:

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: radiobutton.n,v 1.6.2.1 2004/10/28 10:19:29 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH radiobutton n 4.4 Tk "Tk Built-In Commands"
  12. .BS
  13. '" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. radiobutton - Create and manipulate radiobutton widgets
  16. .SH SYNOPSIS
  17. fBradiobuttonfR fIpathName fR?fIoptionsfR?
  18. .SO
  19. -activebackground -disabledforeground -padx
  20. -activeforeground -font -pady
  21. -anchor -foreground -relief
  22. -background -highlightbackground -takefocus
  23. -bitmap -highlightcolor -text
  24. -borderwidth -highlightthickness -textvariable
  25. -compound -image -underline
  26. -cursor -justify -wraplength
  27. .SE
  28. .SH "WIDGET-SPECIFIC OPTIONS"
  29. .OP -command command Command
  30. Specifies a Tcl command to associate with the button.  This command
  31. is typically invoked when mouse button 1 is released over the button
  32. window.  The button's global variable (fB-variablefR option) will
  33. be updated before the command is invoked.
  34. .OP -height height Height
  35. Specifies a desired height for the button.
  36. If an image or bitmap is being displayed in the button then the value is in
  37. screen units (i.e. any of the forms acceptable to fBTk_GetPixelsfR);
  38. for text it is in lines of text.
  39. If this option isn't specified, the button's desired height is computed
  40. from the size of the image or bitmap or text being displayed in it.
  41. .OP -indicatoron indicatorOn IndicatorOn
  42. Specifies whether or not the indicator should be drawn.  Must be a
  43. proper boolean value.  If false, the fBrelieffR option is
  44. ignored and the widget's relief is always sunken if the widget is
  45. selected and raised otherwise.
  46. .OP -selectcolor selectColor Background
  47. Specifies a background color to use when the button is selected.
  48. If fBindicatorOnfR is true then the color applies to the indicator.
  49. Under Windows, this color is used as the background for the indicator
  50. regardless of the select state.
  51. If fBindicatorOnfR is false, this color is used as the background
  52. for the entire widget, in place of fBbackgroundfR or fBactiveBackgroundfR,
  53. whenever the widget is selected.
  54. If specified as an empty string then no special color is used for
  55. displaying when the widget is selected.
  56. .OP -offrelief offRelief OffRelief
  57. .VS 8.4
  58. Specifies the relief for the checkbutton when the indicator is not drawn and
  59. the checkbutton is off.  The default value is "raised".  By setting this option
  60. to "flat" and setting -indicatoron to false and -overrelief to raised,
  61. the effect is achieved 
  62. of having a flat button that raises on mouse-over and which is
  63. depressed when activated.  This is the behavior typically exhibited by
  64. the Align-Left, Align-Right, and Center radiobuttons on the toolbar of a 
  65. word-processor, for example.
  66. .VE 8.4
  67. .OP -overrelief overRelief OverRelief
  68. .VS 8.4
  69. Specifies an alternative relief for the radiobutton, to be used when the
  70. mouse cursor is over the widget.  This option can be used to make
  71. toolbar buttons, by configuring fB-relief flat -overrelief
  72. raisedfR.  If the value of this option is the empty string, then no
  73. alternative relief is used when the mouse cursor is over the radiobutton.
  74. The empty string is the default value.
  75. .VE 8.4
  76. .OP -selectimage selectImage SelectImage
  77. Specifies an image to display (in place of the fBimagefR option)
  78. when the radiobutton is selected.
  79. This option is ignored unless the fBimagefR option has been
  80. specified.
  81. .OP -state state State
  82. Specifies one of three states for the radiobutton:  fBnormalfR, fBactivefR,
  83. or fBdisabledfR.  In normal state the radiobutton is displayed using the
  84. fBforegroundfR and fBbackgroundfR options.  The active state is
  85. typically used when the pointer is over the radiobutton.  In active state
  86. the radiobutton is displayed using the fBactiveForegroundfR and
  87. fBactiveBackgroundfR options.  Disabled state means that the radiobutton
  88. should be insensitive:  the default bindings will refuse to activate
  89. the widget and will ignore mouse button presses.
  90. In this state the fBdisabledForegroundfR and
  91. fBbackgroundfR options determine how the radiobutton is displayed.
  92. .OP -value value Value
  93. Specifies value to store in the button's associated variable whenever
  94. this button is selected.
  95. .OP -variable variable Variable
  96. Specifies name of global variable to set whenever this button is
  97. selected.  Changes in this variable also cause the button to select
  98. or deselect itself.
  99. Defaults to the value fBselectedButtonfR.
  100. .OP -width width Width
  101. Specifies a desired width for the button.
  102. If an image or bitmap is being displayed in the button, the value is in
  103. screen units (i.e. any of the forms acceptable to fBTk_GetPixelsfR);
  104. for text it is in characters.
  105. If this option isn't specified, the button's desired width is computed
  106. from the size of the image or bitmap or text being displayed in it.
  107. .BE
  108. .SH DESCRIPTION
  109. .PP
  110. The fBradiobuttonfR command creates a new window (given by the
  111. fIpathNamefR argument) and makes it into a radiobutton widget.
  112. Additional
  113. options, described above, may be specified on the command line
  114. or in the option database
  115. to configure aspects of the radiobutton such as its colors, font,
  116. text, and initial relief.  The fBradiobuttonfR command returns its
  117. fIpathNamefR argument.  At the time this command is invoked,
  118. there must not exist a window named fIpathNamefR, but
  119. fIpathNamefR's parent must exist.
  120. .PP
  121. .VS
  122. A radiobutton is a widget that displays a textual string, bitmap or image
  123. and a diamond or circle called an fIindicatorfR.
  124. .VE
  125. If text is displayed, it must all be in a single font, but it
  126. can occupy multiple lines on the screen (if it contains newlines
  127. or if wrapping occurs because of the fBwrapLengthfR option) and
  128. one of the characters may optionally be underlined using the
  129. fBunderlinefR option.  A radiobutton has
  130. all of the behavior of a simple button: it can display itself in either
  131. of three different ways, according to the fBstatefR option;
  132. it can be made to appear
  133. raised, sunken, or flat; it can be made to flash; and it invokes
  134. a Tcl command whenever mouse button 1 is clicked over the
  135. check button.
  136. .PP
  137. In addition, radiobuttons can be fIselectedfR.
  138. If a radiobutton is selected, the indicator is normally
  139. .VS
  140. drawn with a selected appearance, and
  141. a Tcl variable associated with the radiobutton is set to a particular
  142. value (normally 1).
  143. Under Unix, the indicator is drawn with a sunken relief and a special
  144. color.  Under Windows, the indicator is drawn with a round mark inside.
  145. If the radiobutton is not selected, then the indicator is drawn with a
  146. deselected appearance, and the associated variable is
  147. set to a different value (typically 0).
  148. Under Unix, the indicator is drawn with a raised relief and no special
  149. color.  Under Windows, the indicator is drawn without a round mark inside.
  150. .VE
  151. Typically, several radiobuttons share a single variable and the
  152. value of the variable indicates which radiobutton is to be selected.
  153. When a radiobutton is selected it sets the value of the variable to
  154. indicate that fact;  each radiobutton also monitors the value of
  155. the variable and automatically selects and deselects itself when the
  156. variable's value changes.
  157. By default the variable fBselectedButtonfR
  158. is used;  its contents give the name of the button that is
  159. selected, or the empty string if no button associated with that
  160. variable is selected.
  161. The name of the variable for a radiobutton,
  162. plus the variable to be stored into it, may be modified with options
  163. on the command line or in the option database.
  164. Configuration options may also be used to modify the way the
  165. indicator is displayed (or whether it is displayed at all).
  166. By default a radiobutton is configured to select itself on button clicks.
  167. .SH "WIDGET COMMAND"
  168. .PP
  169. The fBradiobuttonfR command creates a new Tcl command whose
  170. name is fIpathNamefR.  This
  171. command may be used to invoke various
  172. operations on the widget.  It has the following general form:
  173. .CS
  174. fIpathName option fR?fIarg arg ...fR?
  175. .CE
  176. fIOptionfR and the fIargfRs
  177. determine the exact behavior of the command.  The following
  178. commands are possible for radiobutton widgets:
  179. .TP
  180. fIpathName fBcgetfR fIoptionfR
  181. Returns the current value of the configuration option given
  182. by fIoptionfR.
  183. fIOptionfR may have any of the values accepted by the fBradiobuttonfR
  184. command.
  185. .TP
  186. fIpathName fBconfigurefR ?fIoptionfR? ?fIvalue option value ...fR?
  187. Query or modify the configuration options of the widget.
  188. If no fIoptionfR is specified, returns a list describing all of
  189. the available options for fIpathNamefR (see fBTk_ConfigureInfofR for
  190. information on the format of this list).  If fIoptionfR is specified
  191. with no fIvaluefR, the command returns a list describing the
  192. one named option (this list will be identical to the corresponding
  193. sublist of the value returned if no fIoptionfR is specified).  If
  194. one or more fIoption-valuefR pairs are specified, the command
  195. modifies the given widget option(s) to have the given value(s);  in
  196. this case the command returns an empty string.
  197. fIOptionfR may have any of the values accepted by the fBradiobuttonfR
  198. command.
  199. .TP
  200. fIpathName fBdeselectfR
  201. Deselects the radiobutton and sets the associated variable to an
  202. empty string.
  203. If this radiobutton was not currently selected, the command has
  204. no effect.
  205. .TP
  206. fIpathName fBflashfR
  207. Flashes the radiobutton.  This is accomplished by redisplaying the radiobutton
  208. several times, alternating between active and normal colors.  At
  209. the end of the flash the radiobutton is left in the same normal/active
  210. state as when the command was invoked.
  211. This command is ignored if the radiobutton's state is fBdisabledfR.
  212. .TP
  213. fIpathName fBinvokefR
  214. Does just what would have happened if the user invoked the radiobutton
  215. with the mouse: selects the button and invokes
  216. its associated Tcl command, if there is one.
  217. The return value is the return value from the Tcl command, or an
  218. empty string if there is no command associated with the radiobutton.
  219. This command is ignored if the radiobutton's state is fBdisabledfR.
  220. .TP
  221. fIpathName fBselectfR
  222. Selects the radiobutton and sets the associated variable to the
  223. value corresponding to this widget.
  224. .SH BINDINGS
  225. .PP
  226. Tk automatically creates class bindings for radiobuttons that give them
  227. the following default behavior:
  228. .IP [1]
  229. .VS
  230. On Unix systems, a radiobutton activates whenever the mouse passes
  231. over it and deactivates whenever the mouse leaves the radiobutton.  On
  232. Mac and Windows systems, when mouse button 1 is pressed over a
  233. radiobutton, the button activates whenever the mouse pointer is inside
  234. the button, and deactivates whenever the mouse pointer leaves the
  235. button.
  236. .VE
  237. .IP [2]
  238. When mouse button 1 is pressed over a radiobutton it is invoked (it
  239. becomes selected and the command associated with the button is
  240. invoked, if there is one).
  241. .IP [3]
  242. When a radiobutton has the input focus, the space key causes the radiobutton
  243. to be invoked.
  244. .PP
  245. If the radiobutton's state is fBdisabledfR then none of the above
  246. actions occur:  the radiobutton is completely non-responsive.
  247. .PP
  248. The behavior of radiobuttons can be changed by defining new bindings for
  249. individual widgets or by redefining the class bindings.
  250. .SH "SEE ALSO"
  251. checkbutton(n), labelframe(n), listbox(n), options(n), scale(n)
  252. .SH KEYWORDS
  253. radiobutton, widget