2 '\" Copyright (c) 1990-1994 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 .TH radiobutton n 4.4 Tk "Tk Built-In Commands"
9 .\" The -*- nroff -*- definitions below are for supplemental macros used
10 .\" in Tcl/Tk manual entries.
12 .\" .AP type name in/out ?indent?
13 .\" Start paragraph describing an argument to a library procedure.
14 .\" type is type of argument (int, etc.), in/out is either "in", "out",
15 .\" or "in/out" to describe whether procedure reads or modifies arg,
16 .\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 .\" needed; use .AS below instead)
20 .\" Give maximum sizes of arguments for setting tab stops. Type and
21 .\" name are examples of largest possible arguments that will be passed
22 .\" to .AP later. If args are omitted, default tab stops are used.
25 .\" Start box enclosure. From here until next .BE, everything will be
26 .\" enclosed in one large box.
29 .\" End of box enclosure.
32 .\" Begin code excerpt.
37 .\" .VS ?version? ?br?
38 .\" Begin vertical sidebar, for use in marking newly-changed parts
39 .\" of man pages. The first argument is ignored and used for recording
40 .\" the version when the .VS was added, so that the sidebars can be
41 .\" found and removed when they reach a certain age. If another argument
42 .\" is present, then a line break is forced before starting the sidebar.
45 .\" End of vertical sidebar.
48 .\" Begin an indented unfilled display.
51 .\" End of indented unfilled display.
54 .\" Start of list of standard options for a Tk widget. The manpage
55 .\" argument defines where to look up the standard options; if
56 .\" omitted, defaults to "options". The options follow on successive
57 .\" lines, in three columns separated by tabs.
60 .\" End of list of standard options for a Tk widget.
62 .\" .OP cmdName dbName dbClass
63 .\" Start of description of a specific option. cmdName gives the
64 .\" option's name as specified in the class command, dbName gives
65 .\" the option's name in the option database, and dbClass gives
66 .\" the option's class in the option database.
69 .\" Print arg1 underlined, then print arg2 normally.
72 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
75 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
76 .\" (for trailing punctuation) and then a closing parenthesis.
78 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
82 .\" # Start an argument description
86 . ie !"\\$2"" .TP \\n()Cu
91 \&\\$1 \\fI\\$2\\fP (\\$3)
104 .\" # define tabbing values for .AP
107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
113 .AS Tcl_Interp Tcl_CreateInterp in/out
114 .\" # BS - start boxed text
115 .\" # ^y = starting y location
123 .if n \l'\\n(.lu\(ul'
126 .\" # BE - end boxed text (draw box now)
131 .ie n \l'\\n(^lu\(ul'
133 .\" Draw four-sided box normally, but don't draw top of
134 .\" box if the box started on an earlier page.
136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
146 .\" # VS - start vertical sidebar
147 .\" # ^Y = starting y location
148 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
152 .ie n 'mc \s12\(br\s0
155 .\" # VE - end of vertical sidebar
163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
170 .\" # Special macro to handle page bottom: finish off current
171 .\" # box/sidebar if in box/sidebar mode, then invoked standard
172 .\" # page bottom macro.
179 .\" Draw three-sided box if this is the box's first page,
180 .\" draw two sides but no top otherwise.
181 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
185 .nr ^x \\n(^tu+1v-\\n(^Yu
186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
199 .\" # DS - begin display
205 .\" # DE - end display
211 .\" # SO - start of list of standard options
213 'ie '\\$1'' .ds So \\fBoptions\\fR
214 'el .ds So \\fB\\$1\\fR
215 .SH "STANDARD OPTIONS"
221 .\" # SE - end of list of standard options
226 See the \\*(So manual entry for details on the standard options.
228 .\" # OP - start of full description for a single option
233 Command-Line Name: \\fB\\$1\\fR
234 Database Name: \\fB\\$2\\fR
235 Database Class: \\fB\\$3\\fR
239 .\" # CS - begin code excerpt
245 .\" # CE - end code excerpt
250 .\" # UL - underline word
254 .\" # QW - apply quotation marks to word
256 .ie '\\*(lq'"' ``\\$1''\\$2
257 .\"" fix emacs highlighting
258 .el \\*(lq\\$1\\*(rq\\$2
260 .\" # PQ - apply parens and quotation marks to word
262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
263 .\"" fix emacs highlighting
264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
266 .\" # QR - quoted range
268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
269 .\"" fix emacs highlighting
270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
272 .\" # MT - "empty" string
277 '\" Note: do not modify the .SH NAME line immediately below!
279 radiobutton \- Create and manipulate 'radiobutton' pick-one widgets
281 \fBradiobutton\fR \fIpathName \fR?\fIoptions\fR?
283 \-activebackground \-disabledforeground \-padx
284 \-activeforeground \-font \-pady
285 \-anchor \-foreground \-relief
286 \-background \-highlightbackground \-takefocus
287 \-bitmap \-highlightcolor \-text
288 \-borderwidth \-highlightthickness \-textvariable
289 \-compound \-image \-underline
290 \-cursor \-justify \-wraplength
292 .SH "WIDGET-SPECIFIC OPTIONS"
293 .OP \-command command Command
294 Specifies a Tcl command to associate with the button. This command
295 is typically invoked when mouse button 1 is released over the button
296 window. The button's global variable (\fB\-variable\fR option) will
297 be updated before the command is invoked.
298 .OP \-height height Height
299 Specifies a desired height for the button.
300 If an image or bitmap is being displayed in the button then the value is in
301 screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
302 for text it is in lines of text.
303 If this option is not specified, the button's desired height is computed
304 from the size of the image or bitmap or text being displayed in it.
305 .OP \-indicatoron indicatorOn IndicatorOn
306 Specifies whether or not the indicator should be drawn. Must be a
307 proper boolean value. If false, the \fB\-relief\fR option is
308 ignored and the widget's relief is always sunken if the widget is
309 selected and raised otherwise.
310 .OP \-selectcolor selectColor Background
311 Specifies a background color to use when the button is selected.
312 If \fB\-indicatoron\fR is true then the color applies to the indicator.
313 Under Windows, this color is used as the background for the indicator
314 regardless of the select state.
315 If \fB\-indicatoron\fR is false, this color is used as the background
316 for the entire widget, in place of \fB\-background\fR or \fB\-activeBackground\fR,
317 whenever the widget is selected.
318 If specified as an empty string then no special color is used for
319 displaying when the widget is selected.
320 .OP \-offrelief offRelief OffRelief
321 Specifies the relief for the checkbutton when the indicator is not drawn and
322 the checkbutton is off. The default value is
324 By setting this option to
326 and setting \fB\-indicatoron\fR to false and \fB\-overrelief\fR to
328 the effect is achieved
329 of having a flat button that raises on mouse-over and which is
330 depressed when activated. This is the behavior typically exhibited by
331 the Align-Left, Align-Right, and Center radiobuttons on the toolbar of a
332 word-processor, for example.
333 .OP \-overrelief overRelief OverRelief
334 Specifies an alternative relief for the radiobutton, to be used when the
335 mouse cursor is over the widget. This option can be used to make
336 toolbar buttons, by configuring \fB\-relief flat \-overrelief
337 raised\fR. If the value of this option is the empty string, then no
338 alternative relief is used when the mouse cursor is over the radiobutton.
339 The empty string is the default value.
340 .OP \-selectimage selectImage SelectImage
341 Specifies an image to display (in place of the \fB\-image\fR option)
342 when the radiobutton is selected.
343 This option is ignored unless the \fB\-image\fR option has been
345 .OP \-state state State
346 Specifies one of three states for the radiobutton: \fBnormal\fR, \fBactive\fR,
347 or \fBdisabled\fR. In normal state the radiobutton is displayed using the
348 \fB\-foreground\fR and \fB\-background\fR options. The active state is
349 typically used when the pointer is over the radiobutton. In active state
350 the radiobutton is displayed using the \fB\-activeforeground\fR and
351 \fB\-activebackground\fR options. Disabled state means that the radiobutton
352 should be insensitive: the default bindings will refuse to activate
353 the widget and will ignore mouse button presses.
354 In this state the \fB\-disabledforeground\fR and
355 \fB\-background\fR options determine how the radiobutton is displayed.
356 .OP \-tristateimage tristateImage TristateImage
357 Specifies an image to display (in place of the \fB\-image\fR option)
358 when the radiobutton is selected.
359 This option is ignored unless the \fB\-image\fR option has been
361 .OP \-tristatevalue tristateValue Value
362 Specifies the value that causes the radiobutton to display the multi-value
363 selection, also known as the tri-state mode. Defaults to
365 .OP \-value value Value
366 Specifies value to store in the button's associated variable whenever
367 this button is selected.
368 .OP \-variable variable Variable
369 Specifies the name of a global variable to set whenever this button is
370 selected. Changes in this variable also cause the button to select
372 Defaults to the value \fBselectedButton\fR.
373 .OP \-width width Width
374 Specifies a desired width for the button.
375 If an image or bitmap is being displayed in the button, the value is in
376 screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
377 for text it is in characters.
378 If this option is not specified, the button's desired width is computed
379 from the size of the image or bitmap or text being displayed in it.
383 The \fBradiobutton\fR command creates a new window (given by the
384 \fIpathName\fR argument) and makes it into a radiobutton widget.
386 options, described above, may be specified on the command line
387 or in the option database
388 to configure aspects of the radiobutton such as its colors, font,
389 text, and initial relief. The \fBradiobutton\fR command returns its
390 \fIpathName\fR argument. At the time this command is invoked,
391 there must not exist a window named \fIpathName\fR, but
392 \fIpathName\fR's parent must exist.
394 A radiobutton is a widget that displays a textual string, bitmap or image
395 and a diamond or circle called an \fIindicator\fR.
396 If text is displayed, it must all be in a single font, but it
397 can occupy multiple lines on the screen (if it contains newlines
398 or if wrapping occurs because of the \fB\-wraplength\fR option) and
399 one of the characters may optionally be underlined using the
400 \fB\-underline\fR option. A radiobutton has
401 all of the behavior of a simple button: it can display itself in either
402 of three different ways, according to the \fB\-state\fR option;
403 it can be made to appear
404 raised, sunken, or flat; it can be made to flash; and it invokes
405 a Tcl command whenever mouse button 1 is clicked over the
408 In addition, radiobuttons can be \fIselected\fR.
409 If a radiobutton is selected, the indicator is normally
410 drawn with a selected appearance, and
411 a Tcl variable associated with the radiobutton is set to a particular
413 Under Unix, the indicator is drawn with a sunken relief and a special
414 color. Under Windows, the indicator is drawn with a round mark inside.
415 If the radiobutton is not selected, then the indicator is drawn with a
416 deselected appearance, and the associated variable is
417 set to a different value (typically 0).
418 The indicator is drawn without a round mark inside.
419 Typically, several radiobuttons share a single variable and the
420 value of the variable indicates which radiobutton is to be selected.
421 When a radiobutton is selected it sets the value of the variable to
422 indicate that fact; each radiobutton also monitors the value of
423 the variable and automatically selects and deselects itself when the
424 variable's value changes.
425 If the variable's value matches the \fB\-tristatevalue\fR, then the radiobutton
426 is drawn using the tri-state mode. This mode is used to indicate mixed or
427 multiple values. (This is used when the radiobutton represents the state
429 By default the variable \fBselectedButton\fR
430 is used; its contents give the name of the button that is
431 selected, or the empty string if no button associated with that
432 variable is selected.
433 The name of the variable for a radiobutton,
434 plus the variable to be stored into it, may be modified with options
435 on the command line or in the option database.
436 Configuration options may also be used to modify the way the
437 indicator is displayed (or whether it is displayed at all).
438 By default a radiobutton is configured to select itself on button clicks.
441 The \fBradiobutton\fR command creates a new Tcl command whose
442 name is \fIpathName\fR. This
443 command may be used to invoke various
444 operations on the widget. It has the following general form:
446 \fIpathName option \fR?\fIarg arg ...\fR?
448 \fIOption\fR and the \fIarg\fRs
449 determine the exact behavior of the command. The following
450 commands are possible for radiobutton widgets:
452 \fIpathName \fBcget\fR \fIoption\fR
454 Returns the current value of the configuration option given
456 \fIOption\fR may have any of the values accepted by the \fBradiobutton\fR
459 \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
461 Query or modify the configuration options of the widget.
462 If no \fIoption\fR is specified, returns a list describing all of
463 the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
464 information on the format of this list). If \fIoption\fR is specified
465 with no \fIvalue\fR, the command returns a list describing the
466 one named option (this list will be identical to the corresponding
467 sublist of the value returned if no \fIoption\fR is specified). If
468 one or more \fIoption\-value\fR pairs are specified, the command
469 modifies the given widget option(s) to have the given value(s); in
470 this case the command returns an empty string.
471 \fIOption\fR may have any of the values accepted by the \fBradiobutton\fR
474 \fIpathName \fBdeselect\fR
476 Deselects the radiobutton and sets the associated variable to an
478 If this radiobutton was not currently selected, the command has
481 \fIpathName \fBflash\fR
483 Flashes the radiobutton. This is accomplished by redisplaying the radiobutton
484 several times, alternating between active and normal colors. At
485 the end of the flash the radiobutton is left in the same normal/active
486 state as when the command was invoked.
487 This command is ignored if the radiobutton's state is \fBdisabled\fR.
489 \fIpathName \fBinvoke\fR
491 Does just what would have happened if the user invoked the radiobutton
492 with the mouse: selects the button and invokes
493 its associated Tcl command, if there is one.
494 The return value is the return value from the Tcl command, or an
495 empty string if there is no command associated with the radiobutton.
496 This command is ignored if the radiobutton's state is \fBdisabled\fR.
498 \fIpathName \fBselect\fR
500 Selects the radiobutton and sets the associated variable to the
501 value corresponding to this widget.
504 Tk automatically creates class bindings for radiobuttons that give them
505 the following default behavior:
507 On Unix systems, a radiobutton activates whenever the mouse passes
508 over it and deactivates whenever the mouse leaves the radiobutton. On
509 Mac and Windows systems, when mouse button 1 is pressed over a
510 radiobutton, the button activates whenever the mouse pointer is inside
511 the button, and deactivates whenever the mouse pointer leaves the
514 When mouse button 1 is pressed over a radiobutton it is invoked (it
515 becomes selected and the command associated with the button is
516 invoked, if there is one).
518 When a radiobutton has the input focus, the space key causes the radiobutton
521 If the radiobutton's state is \fBdisabled\fR then none of the above
522 actions occur: the radiobutton is completely non-responsive.
524 The behavior of radiobuttons can be changed by defining new bindings for
525 individual widgets or by redefining the class bindings.
527 checkbutton(n), labelframe(n), listbox(n), options(n), scale(n), ttk::radiobutton(n)
OSDN Git Service
