radiobutton.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:11k
- '"
- '" Copyright (c) 1990-1994 The Regents of the University of California.
- '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
- '"
- '" See the file "license.terms" for information on usage and redistribution
- '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
- '"
- '" RCS: @(#) $Id: radiobutton.n,v 1.6.2.1 2004/10/28 10:19:29 dkf Exp $
- '"
- .so man.macros
- .TH radiobutton n 4.4 Tk "Tk Built-In Commands"
- .BS
- '" Note: do not modify the .SH NAME line immediately below!
- .SH NAME
- radiobutton - Create and manipulate radiobutton widgets
- .SH SYNOPSIS
- fBradiobuttonfR fIpathName fR?fIoptionsfR?
- .SO
- -activebackground -disabledforeground -padx
- -activeforeground -font -pady
- -anchor -foreground -relief
- -background -highlightbackground -takefocus
- -bitmap -highlightcolor -text
- -borderwidth -highlightthickness -textvariable
- -compound -image -underline
- -cursor -justify -wraplength
- .SE
- .SH "WIDGET-SPECIFIC OPTIONS"
- .OP -command command Command
- Specifies a Tcl command to associate with the button. This command
- is typically invoked when mouse button 1 is released over the button
- window. The button's global variable (fB-variablefR option) will
- be updated before the command is invoked.
- .OP -height height Height
- Specifies a desired height for the button.
- If an image or bitmap is being displayed in the button then the value is in
- screen units (i.e. any of the forms acceptable to fBTk_GetPixelsfR);
- for text it is in lines of text.
- If this option isn't specified, the button's desired height is computed
- from the size of the image or bitmap or text being displayed in it.
- .OP -indicatoron indicatorOn IndicatorOn
- Specifies whether or not the indicator should be drawn. Must be a
- proper boolean value. If false, the fBrelieffR option is
- ignored and the widget's relief is always sunken if the widget is
- selected and raised otherwise.
- .OP -selectcolor selectColor Background
- Specifies a background color to use when the button is selected.
- If fBindicatorOnfR is true then the color applies to the indicator.
- Under Windows, this color is used as the background for the indicator
- regardless of the select state.
- If fBindicatorOnfR is false, this color is used as the background
- for the entire widget, in place of fBbackgroundfR or fBactiveBackgroundfR,
- whenever the widget is selected.
- If specified as an empty string then no special color is used for
- displaying when the widget is selected.
- .OP -offrelief offRelief OffRelief
- .VS 8.4
- Specifies the relief for the checkbutton when the indicator is not drawn and
- the checkbutton is off. The default value is "raised". By setting this option
- to "flat" and setting -indicatoron to false and -overrelief to raised,
- the effect is achieved
- of having a flat button that raises on mouse-over and which is
- depressed when activated. This is the behavior typically exhibited by
- the Align-Left, Align-Right, and Center radiobuttons on the toolbar of a
- word-processor, for example.
- .VE 8.4
- .OP -overrelief overRelief OverRelief
- .VS 8.4
- Specifies an alternative relief for the radiobutton, to be used when the
- mouse cursor is over the widget. This option can be used to make
- toolbar buttons, by configuring fB-relief flat -overrelief
- raisedfR. If the value of this option is the empty string, then no
- alternative relief is used when the mouse cursor is over the radiobutton.
- The empty string is the default value.
- .VE 8.4
- .OP -selectimage selectImage SelectImage
- Specifies an image to display (in place of the fBimagefR option)
- when the radiobutton is selected.
- This option is ignored unless the fBimagefR option has been
- specified.
- .OP -state state State
- Specifies one of three states for the radiobutton: fBnormalfR, fBactivefR,
- or fBdisabledfR. In normal state the radiobutton is displayed using the
- fBforegroundfR and fBbackgroundfR options. The active state is
- typically used when the pointer is over the radiobutton. In active state
- the radiobutton is displayed using the fBactiveForegroundfR and
- fBactiveBackgroundfR options. Disabled state means that the radiobutton
- should be insensitive: the default bindings will refuse to activate
- the widget and will ignore mouse button presses.
- In this state the fBdisabledForegroundfR and
- fBbackgroundfR options determine how the radiobutton is displayed.
- .OP -value value Value
- Specifies value to store in the button's associated variable whenever
- this button is selected.
- .OP -variable variable Variable
- Specifies name of global variable to set whenever this button is
- selected. Changes in this variable also cause the button to select
- or deselect itself.
- Defaults to the value fBselectedButtonfR.
- .OP -width width Width
- Specifies a desired width for the button.
- If an image or bitmap is being displayed in the button, the value is in
- screen units (i.e. any of the forms acceptable to fBTk_GetPixelsfR);
- for text it is in characters.
- If this option isn't specified, the button's desired width is computed
- from the size of the image or bitmap or text being displayed in it.
- .BE
- .SH DESCRIPTION
- .PP
- The fBradiobuttonfR command creates a new window (given by the
- fIpathNamefR argument) and makes it into a radiobutton widget.
- Additional
- options, described above, may be specified on the command line
- or in the option database
- to configure aspects of the radiobutton such as its colors, font,
- text, and initial relief. The fBradiobuttonfR command returns its
- fIpathNamefR argument. At the time this command is invoked,
- there must not exist a window named fIpathNamefR, but
- fIpathNamefR's parent must exist.
- .PP
- .VS
- A radiobutton is a widget that displays a textual string, bitmap or image
- and a diamond or circle called an fIindicatorfR.
- .VE
- If text is displayed, it must all be in a single font, but it
- can occupy multiple lines on the screen (if it contains newlines
- or if wrapping occurs because of the fBwrapLengthfR option) and
- one of the characters may optionally be underlined using the
- fBunderlinefR option. A radiobutton has
- all of the behavior of a simple button: it can display itself in either
- of three different ways, according to the fBstatefR option;
- it can be made to appear
- raised, sunken, or flat; it can be made to flash; and it invokes
- a Tcl command whenever mouse button 1 is clicked over the
- check button.
- .PP
- In addition, radiobuttons can be fIselectedfR.
- If a radiobutton is selected, the indicator is normally
- .VS
- drawn with a selected appearance, and
- a Tcl variable associated with the radiobutton is set to a particular
- value (normally 1).
- Under Unix, the indicator is drawn with a sunken relief and a special
- color. Under Windows, the indicator is drawn with a round mark inside.
- If the radiobutton is not selected, then the indicator is drawn with a
- deselected appearance, and the associated variable is
- set to a different value (typically 0).
- Under Unix, the indicator is drawn with a raised relief and no special
- color. Under Windows, the indicator is drawn without a round mark inside.
- .VE
- Typically, several radiobuttons share a single variable and the
- value of the variable indicates which radiobutton is to be selected.
- When a radiobutton is selected it sets the value of the variable to
- indicate that fact; each radiobutton also monitors the value of
- the variable and automatically selects and deselects itself when the
- variable's value changes.
- By default the variable fBselectedButtonfR
- is used; its contents give the name of the button that is
- selected, or the empty string if no button associated with that
- variable is selected.
- The name of the variable for a radiobutton,
- plus the variable to be stored into it, may be modified with options
- on the command line or in the option database.
- Configuration options may also be used to modify the way the
- indicator is displayed (or whether it is displayed at all).
- By default a radiobutton is configured to select itself on button clicks.
- .SH "WIDGET COMMAND"
- .PP
- The fBradiobuttonfR command creates a new Tcl command whose
- name is fIpathNamefR. This
- command may be used to invoke various
- operations on the widget. It has the following general form:
- .CS
- fIpathName option fR?fIarg arg ...fR?
- .CE
- fIOptionfR and the fIargfRs
- determine the exact behavior of the command. The following
- commands are possible for radiobutton widgets:
- .TP
- fIpathName fBcgetfR fIoptionfR
- Returns the current value of the configuration option given
- by fIoptionfR.
- fIOptionfR may have any of the values accepted by the fBradiobuttonfR
- command.
- .TP
- fIpathName fBconfigurefR ?fIoptionfR? ?fIvalue option value ...fR?
- Query or modify the configuration options of the widget.
- If no fIoptionfR is specified, returns a list describing all of
- the available options for fIpathNamefR (see fBTk_ConfigureInfofR for
- information on the format of this list). If fIoptionfR is specified
- with no fIvaluefR, the command returns a list describing the
- one named option (this list will be identical to the corresponding
- sublist of the value returned if no fIoptionfR is specified). If
- one or more fIoption-valuefR pairs are specified, the command
- modifies the given widget option(s) to have the given value(s); in
- this case the command returns an empty string.
- fIOptionfR may have any of the values accepted by the fBradiobuttonfR
- command.
- .TP
- fIpathName fBdeselectfR
- Deselects the radiobutton and sets the associated variable to an
- empty string.
- If this radiobutton was not currently selected, the command has
- no effect.
- .TP
- fIpathName fBflashfR
- Flashes the radiobutton. This is accomplished by redisplaying the radiobutton
- several times, alternating between active and normal colors. At
- the end of the flash the radiobutton is left in the same normal/active
- state as when the command was invoked.
- This command is ignored if the radiobutton's state is fBdisabledfR.
- .TP
- fIpathName fBinvokefR
- Does just what would have happened if the user invoked the radiobutton
- with the mouse: selects the button and invokes
- its associated Tcl command, if there is one.
- The return value is the return value from the Tcl command, or an
- empty string if there is no command associated with the radiobutton.
- This command is ignored if the radiobutton's state is fBdisabledfR.
- .TP
- fIpathName fBselectfR
- Selects the radiobutton and sets the associated variable to the
- value corresponding to this widget.
- .SH BINDINGS
- .PP
- Tk automatically creates class bindings for radiobuttons that give them
- the following default behavior:
- .IP [1]
- .VS
- On Unix systems, a radiobutton activates whenever the mouse passes
- over it and deactivates whenever the mouse leaves the radiobutton. On
- Mac and Windows systems, when mouse button 1 is pressed over a
- radiobutton, the button activates whenever the mouse pointer is inside
- the button, and deactivates whenever the mouse pointer leaves the
- button.
- .VE
- .IP [2]
- When mouse button 1 is pressed over a radiobutton it is invoked (it
- becomes selected and the command associated with the button is
- invoked, if there is one).
- .IP [3]
- When a radiobutton has the input focus, the space key causes the radiobutton
- to be invoked.
- .PP
- If the radiobutton's state is fBdisabledfR then none of the above
- actions occur: the radiobutton is completely non-responsive.
- .PP
- The behavior of radiobuttons can be changed by defining new bindings for
- individual widgets or by redefining the class bindings.
- .SH "SEE ALSO"
- checkbutton(n), labelframe(n), listbox(n), options(n), scale(n)
- .SH KEYWORDS
- radiobutton, widget