~ubuntu-branches/ubuntu/dapper/tk8.0/dapper-updates

« back to all changes in this revision

Viewing changes to doc/optionMenu.n

  • Committer: Bazaar Package Importer
  • Author(s): Mike Markley
  • Date: 2001-07-24 21:57:40 UTC
  • Revision ID: james.westby@ubuntu.com-20010724215740-r70t25rtmbqjil2h
Tags: upstream-8.0.5
ImportĀ upstreamĀ versionĀ 8.0.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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: optionMenu.n,v 1.2 1998/09/14 18:22:58 stanton Exp $
 
9
'\" 
 
10
.so man.macros
 
11
.TH tk_optionMenu n 4.0 Tk "Tk Built-In Commands"
 
12
.BS
 
13
'\" Note:  do not modify the .SH NAME line immediately below!
 
14
.SH NAME
 
15
tk_optionMenu \- Create an option menubutton and its menu
 
16
.SH SYNOPSIS
 
17
\fBtk_optionMenu \fIw varName value \fR?\fIvalue value ...\fR?
 
18
.BE
 
19
 
 
20
.SH DESCRIPTION
 
21
.PP
 
22
This procedure creates an option menubutton whose name is \fIw\fR,
 
23
plus an associated menu.
 
24
Together they allow the user to select one of the values
 
25
given by the \fIvalue\fR arguments.
 
26
The current value will be stored in the global variable whose
 
27
name is given by \fIvarName\fR and it will also be displayed as the label
 
28
in the option menubutton.
 
29
The user can click on the menubutton to display a menu containing
 
30
all of the \fIvalue\fRs and thereby select a new value.
 
31
Once a new value is selected, it will be stored in the variable
 
32
and appear in the option menubutton.
 
33
The current value can also be changed by setting the variable.
 
34
.PP
 
35
The return value from \fBtk_optionMenu\fR is the name of the menu
 
36
associated with \fIw\fR, so that the caller can change its configuration
 
37
options or manipulate it in other ways.
 
38
 
 
39
.SH KEYWORDS
 
40
option menu