diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-30 21:29:58 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-30 21:29:58 (GMT) |
commit | f9705d9d3162582585108a3e60dc8164e5e73d74 (patch) | |
tree | 7090d93b57cff685ebe7ccea984672560fa3b271 /doc/optionMenu.n | |
parent | e3d080ec8d965eb9ad0e606c90f01b9af73facb3 (diff) | |
download | tk-f9705d9d3162582585108a3e60dc8164e5e73d74.zip tk-f9705d9d3162582585108a3e60dc8164e5e73d74.tar.gz tk-f9705d9d3162582585108a3e60dc8164e5e73d74.tar.bz2 |
More documentation improvements
Diffstat (limited to 'doc/optionMenu.n')
-rw-r--r-- | doc/optionMenu.n | 88 |
1 files changed, 43 insertions, 45 deletions
diff --git a/doc/optionMenu.n b/doc/optionMenu.n index b6d3257..761c99b 100644 --- a/doc/optionMenu.n +++ b/doc/optionMenu.n @@ -1,45 +1,43 @@ -'\" -'\" 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: optionMenu.n,v 1.3 2004/06/21 14:48:04 dkf Exp $ -'\" -.so man.macros -.TH tk_optionMenu n 4.0 Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -tk_optionMenu \- Create an option menubutton and its menu -.SH SYNOPSIS -\fBtk_optionMenu \fIw varName value \fR?\fIvalue value ...\fR? -.BE - -.SH DESCRIPTION -.PP -This procedure creates an option menubutton whose name is \fIw\fR, -plus an associated menu. -Together they allow the user to select one of the values -given by the \fIvalue\fR arguments. -The current value will be stored in the global variable whose -name is given by \fIvarName\fR and it will also be displayed as the label -in the option menubutton. -The user can click on the menubutton to display a menu containing -all of the \fIvalue\fRs and thereby select a new value. -Once a new value is selected, it will be stored in the variable -and appear in the option menubutton. -The current value can also be changed by setting the variable. -.PP -The return value from \fBtk_optionMenu\fR is the name of the menu -associated with \fIw\fR, so that the caller can change its configuration -options or manipulate it in other ways. -.SH EXAMPLE -.CS -tk_optionMenu .foo myVar Foo Bar Boo Spong Wibble -pack .foo -.CE - -.SH KEYWORDS -option menu +'\"
+'\" 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: optionMenu.n,v 1.4 2007/10/30 21:29:59 dkf Exp $
+'\"
+.so man.macros
+.TH tk_optionMenu n 4.0 Tk "Tk Built-In Commands"
+.BS
+'\" Note: do not modify the .SH NAME line immediately below!
+.SH NAME
+tk_optionMenu \- Create an option menubutton and its menu
+.SH SYNOPSIS
+\fBtk_optionMenu \fIpathName varName value \fR?\fIvalue value ...\fR?
+.BE
+.SH DESCRIPTION
+.PP
+This procedure creates an option menubutton whose name is \fIpathName\fR,
+plus an associated menu.
+Together they allow the user to select one of the values
+given by the \fIvalue\fR arguments.
+The current value will be stored in the global variable whose
+name is given by \fIvarName\fR and it will also be displayed as the label
+in the option menubutton.
+The user can click on the menubutton to display a menu containing
+all of the \fIvalue\fRs and thereby select a new value.
+Once a new value is selected, it will be stored in the variable
+and appear in the option menubutton.
+The current value can also be changed by setting the variable.
+.PP
+The return value from \fBtk_optionMenu\fR is the name of the menu
+associated with \fIpathName\fR, so that the caller can change its
+configuration options or manipulate it in other ways.
+.SH EXAMPLE
+.CS
+tk_optionMenu .foo myVar Foo Bar Boo Spong Wibble
+pack .foo
+.CE
+.SH KEYWORDS
+option menu
|