summaryrefslogtreecommitdiffstats
path: root/doc/messageBox.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2009-04-04 16:18:37 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2009-04-04 16:18:37 (GMT)
commit5d063ab7b3a58f14bc462097c7a345f2de83f9b2 (patch)
treed1fd8ab48b7d68ad0103dee7dbc8f322032e79dc /doc/messageBox.n
parent1d426ad81fcbd177e2b6451ba776eed17e1f9d92 (diff)
downloadtk-5d063ab7b3a58f14bc462097c7a345f2de83f9b2.zip
tk-5d063ab7b3a58f14bc462097c7a345f2de83f9b2.tar.gz
tk-5d063ab7b3a58f14bc462097c7a345f2de83f9b2.tar.bz2
Fix [Bug 1881896]
Diffstat (limited to 'doc/messageBox.n')
-rw-r--r--doc/messageBox.n23
1 files changed, 19 insertions, 4 deletions
diff --git a/doc/messageBox.n b/doc/messageBox.n
index c771d96..d956f7e 100644
--- a/doc/messageBox.n
+++ b/doc/messageBox.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: messageBox.n,v 1.12 2008/09/23 13:36:45 dkf Exp $
+'\" RCS: @(#) $Id: messageBox.n,v 1.13 2009/04/04 16:18:37 dkf Exp $
'\"
.so man.macros
.TH tk_messageBox n 4.2 Tk "Tk Built-In Commands"
@@ -27,6 +27,7 @@ buttons. Then it returns the symbolic name of the selected button.
The following option-value pairs are supported:
.TP
\fB\-default\fR \fIname\fR
+.
\fIName\fR gives the symbolic name of the default button for
this message window (
.QW ok ,
@@ -36,50 +37,64 @@ for a list of the symbolic names. If this option is not specified,
the first button in the dialog will be made the default.
.TP
\fB\-detail\fR \fIstring\fR
+.
Specifies an auxiliary message to the main message given by the
-\fB\-message\fR option. Where supported by the underlying OS, the
-message detail will be presented in a less emphasized font than the
+\fB\-message\fR option. The message detail will be presented beneath the main
+message and, where supported by the OS, in a less emphasized font than the
main message.
.TP
\fB\-icon\fR \fIiconImage\fR
+.
Specifies an icon to display. \fIIconImage\fR must be one of the
following: \fBerror\fR, \fBinfo\fR, \fBquestion\fR or
\fBwarning\fR. If this option is not specified, then the info icon will be
displayed.
.TP
\fB\-message\fR \fIstring\fR
-Specifies the message to display in this message box.
+.
+Specifies the message to display in this message box. This option is ignored
+on Mac OS X, where platform guidelines forbid the use of a title on this kind
+of dialog.
.TP
\fB\-parent\fR \fIwindow\fR
+.
Makes \fIwindow\fR the logical parent of the message box. The message
box is displayed on top of its parent window.
.TP
\fB\-title\fR \fItitleString\fR
+.
Specifies a string to display as the title of the message box. The
default value is an empty string.
.TP
\fB\-type\fR \fIpredefinedType\fR
+.
Arranges for a predefined set of buttons to be displayed. The
following values are possible for \fIpredefinedType\fR:
.RS
.TP 18
\fBabortretryignore\fR
+.
Displays three buttons whose symbolic names are \fBabort\fR,
\fBretry\fR and \fBignore\fR.
.TP 18
\fBok\fR
+.
Displays one button whose symbolic name is \fBok\fR.
.TP 18
\fBokcancel\fR
+.
Displays two buttons whose symbolic names are \fBok\fR and \fBcancel\fR.
.TP 18
\fBretrycancel\fR
+.
Displays two buttons whose symbolic names are \fBretry\fR and \fBcancel\fR.
.TP 18
\fByesno\fR
+.
Displays two buttons whose symbolic names are \fByes\fR and \fBno\fR.
.TP 18
\fByesnocancel\fR
+.
Displays three buttons whose symbolic names are \fByes\fR, \fBno\fR
and \fBcancel\fR.
.RE