summaryrefslogtreecommitdiffstats
path: root/doc/menubutton.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2013-09-23 19:51:51 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2013-09-23 19:51:51 (GMT)
commitc23066514482f0e8e2b176b7e4d1703f31c66afb (patch)
tree41393445b6b2b0c31971f570d09b0d4220d4c83b /doc/menubutton.n
parentfda5a92486b6dbcc21fa7a92de8cde9615f315a8 (diff)
downloadtk-c23066514482f0e8e2b176b7e4d1703f31c66afb.zip
tk-c23066514482f0e8e2b176b7e4d1703f31c66afb.tar.gz
tk-c23066514482f0e8e2b176b7e4d1703f31c66afb.tar.bz2
Documentation tweaks to make index entries more informative.
Diffstat (limited to 'doc/menubutton.n')
-rw-r--r--doc/menubutton.n12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/menubutton.n b/doc/menubutton.n
index c8b0958..6b723ff 100644
--- a/doc/menubutton.n
+++ b/doc/menubutton.n
@@ -10,7 +10,7 @@
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
-menubutton \- Create and manipulate menubutton widgets
+menubutton \- Create and manipulate 'menubutton' pop-up menu indicator widgets
.SH SYNOPSIS
\fBmenubutton\fR \fIpathName \fR?\fIoptions\fR?
.SO
@@ -93,13 +93,19 @@ the menu before releasing the mouse button, the button release
causes the underlying menu entry to be invoked. When the button
is released, the menu is unposted.
.PP
-Menubuttons are typically organized into groups called menu bars
+Menubuttons are used to construct a \fBtk_optionMenu\fR, which is the
+preferred mechanism for allowing a user to select one item from a list
+on Mac OS X.
+.PP
+Menubuttons were also typically organized into groups called menu bars
that allow scanning:
if the mouse button is pressed over one menubutton (causing it
to post its menu) and the mouse is moved over another menubutton
in the same menu bar without releasing the mouse button, then the
menu of the first menubutton is unposted and the menu of the
new menubutton is posted instead.
+\fIThis use is deprecated\fR in favor of setting a \fBmenu\fR directly as a
+menubar; see the \fBtoplevel\fR's \fB\-menu\fR option for how to do that.
.PP
There are several interactions between menubuttons and menus; see
the \fBmenu\fR manual entry for information on various menu configurations,
@@ -118,12 +124,14 @@ determine the exact behavior of the command. The following
commands are possible for menubutton widgets:
.TP
\fIpathName \fBcget \fIoption\fR
+.
Returns the current value of the configuration option given
by \fIoption\fR.
\fIOption\fR may have any of the values accepted by the \fBmenubutton\fR
command.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
+.
Query or modify the configuration options of the widget.
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for