util/src/TclTk/tk8.6.12/doc/ttk_radiobutton.n

   1 '\"
   2 '\" Copyright (c) 2004 Joe English
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .TH ttk::radiobutton n 8.5 Tk "Tk Themed Widget"
   8 .so man.macros
   9 .BS
  10 .SH NAME
  11 ttk::radiobutton \- Mutually exclusive option widget
  12 .SH SYNOPSIS
  13 \fBttk::radiobutton\fR \fIpathName \fR?\fIoptions\fR?
  14 .BE
  15 .SH DESCRIPTION
  16 .PP
  17 \fBttk::radiobutton\fR widgets are used in groups to show or change
  18 a set of mutually-exclusive options.
  19 Radiobuttons are linked to a Tcl variable,
  20 and have an associated value; when a radiobutton is clicked,
  21 it sets the variable to its associated value.
  22 .SO ttk_widget
  23 \-class \-compound      \-cursor
  24 \-image \-state \-style
  25 \-takefocus     \-text  \-textvariable
  26 \-underline     \-width
  27 .SE
  28 .SH "WIDGET-SPECIFIC OPTIONS"
  29 .OP \-command command Command
  30 A Tcl script to evaluate whenever the widget is invoked.
  31 .OP \-value Value Value
  32 The value to store in the associated \fB\-variable\fR
  33 when the widget is selected.
  34 .OP \-variable variable Variable
  35 The name of a global variable whose value is linked to the widget.
  36 Default value is \fB::selectedButton\fR.
  37 .SH "WIDGET COMMAND"
  38 .PP
  39 In addition to the standard
  40 \fBcget\fR, \fBconfigure\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR
  41 commands, radiobuttons support the following additional
  42 widget commands:
  43 .TP
  44 \fIpathname\fB invoke\fR
  45 Sets the \fB\-variable\fR to the \fB\-value\fR, selects the widget,
  46 and evaluates the associated \fB\-command\fR.
  47 Returns the result of the \fB\-command\fR, or the empty
  48 string if no \fB\-command\fR is specified.
  49 .\" Missing: select, deselect.  Useful?
  50 .\" Missing: flash.  This is definitely not useful.
  51 .SH "WIDGET STATES"
  52 .PP
  53 The widget does not respond to user input if the \fBdisabled\fR state is set.
  54 The widget sets the \fBselected\fR state whenever
  55 the linked \fB\-variable\fR is set to the widget's \fB\-value\fR,
  56 and clears it otherwise.
  57 The widget sets the \fBalternate\fR state whenever the
  58 linked \fB\-variable\fR is unset.
  59 (The \fBalternate\fR state may be used to indicate a
  60 .QW tri-state
  61 or
  62 .QW indeterminate
  63 selection.)
  64 .SH "STANDARD STYLES"
  65 .PP
  66 \fBTtk::radiobutton\fR widgets support the \fBToolbutton\fR style in all
  67 standard themes, which is useful for creating widgets for toolbars.
  68 .SH "STYLING OPTIONS"
  69 .PP
  70 The class name for a \fBttk::radiobutton\fP is \fBTRadiobutton\fP.
  71 .PP
  72 Dynamic states: \fBactive\fP, \fBalternate\fP, \fBdisabled\fP,
  73 \fBpressed\fP, \fBreadonly\fP, \fBselected\fP.
  74 .PP
  75 \fBTRadiobutton\fP styling options configurable with \fBttk::style\fP
  76 are:
  77 .PP
  78 \fB\-background\fP \fIcolor\fP
  79 .br
  80 \fB\-compound\fP \fIcompound\fP
  81 .br
  82 \fB\-foreground\fP \fIcolor\fP
  83 .br
  84 \fB\-indicatorbackground\fP \fIcolor\fP
  85 .br
  86 \fB\-indicatorcolor\fP \fIcolor\fP
  87 .br
  88 \fB\-indicatormargin\fP \fIpadding\fP
  89 .br
  90 \fB\-indicatorrelief\fP \fIrelief\fP
  91 .br
  92 \fB\-padding\fP \fIpadding\fP
  93 .PP
  94 Some options are only available for specific themes.
  95 .PP
  96 See the \fBttk::style\fP manual page for information on how to configure
  97 ttk styles.
  98 .SH "SEE ALSO"
  99 ttk::widget(n), ttk::checkbutton(n), radiobutton(n)
 100 .SH "KEYWORDS"
 101 widget, button, option
 102 '\" Local Variables:
 103 '\" mode: nroff
 104 '\" End: