summaryrefslogtreecommitdiffstats
path: root/doc/messageBox.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2024-01-25 17:50:00 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2024-01-25 17:50:00 (GMT)
commit2f4b99c2d164ebbc4b182ae7eb1f0d635aea6b87 (patch)
tree8e669fafc852c6743d5f926fabcf25a5d4155496 /doc/messageBox.n
parentdbd87b5ee2ea675c3ad1c2c74c48c8523498693e (diff)
downloadtk-2f4b99c2d164ebbc4b182ae7eb1f0d635aea6b87.zip
tk-2f4b99c2d164ebbc4b182ae7eb1f0d635aea6b87.tar.gz
tk-2f4b99c2d164ebbc4b182ae7eb1f0d635aea6b87.tar.bz2
Another round of small fixes, especially spelling errors...
Diffstat (limited to 'doc/messageBox.n')
-rw-r--r--doc/messageBox.n45
1 files changed, 21 insertions, 24 deletions
diff --git a/doc/messageBox.n b/doc/messageBox.n
index b7be4e8..33825dc 100644
--- a/doc/messageBox.n
+++ b/doc/messageBox.n
@@ -23,12 +23,15 @@ popped up, \fBtk_messageBox\fR waits for the user to select one of the
buttons. Then it returns the symbolic name of the selected button.
.PP
The following option-value pairs are supported:
+.\" OPTION: -command
.TP
\fB\-command\fI string\fR
+.
Specifies the prefix of a Tcl command to invoke when the user closes the
dialog. The actual command consists of \fIstring\fR followed by a space
and the name of the button clicked by the user to close the dialog. This
is only available on Mac OS X.
+.\" OPTION: -default
.TP
\fB\-default\fI name\fR
.
@@ -39,6 +42,7 @@ this message window (
and so on). See \fB\-type\fR
for a list of the symbolic names. If this option is not specified,
the first button in the dialog will be made the default.
+.\" OPTION: -detail
.TP
\fB\-detail\fI string\fR
.
@@ -46,6 +50,7 @@ Specifies an auxiliary message to the main message given by 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.
+.\" OPTION: -icon
.TP
\fB\-icon\fI iconImage\fR
.
@@ -53,51 +58,43 @@ 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.
+.\" OPTION: -message
.TP
\fB\-message\fI string\fR
.
Specifies the message to display in this message box. The
default value is an empty string.
+.\" OPTION: -parent
.TP
\fB\-parent\fI window\fR
.
Makes \fIwindow\fR the logical parent of the message box. The message
box is displayed on top of its parent window.
+.\" OPTION: -title
.TP
\fB\-title\fI titleString\fR
.
Specifies a string to display as the title of the message box. The
default value is an empty string.
+.\" OPTION: -type
.TP
\fB\-type\fI predefinedType\fR
.
Arranges for a predefined set of buttons to be displayed. The
following values are possible for \fIpredefinedType\fR:
.RS
-.TP 18
-\fBabortretryignore\fR
-.
+.IP \fBabortretryignore\fR 18
Displays three buttons whose symbolic names are \fBabort\fR,
\fBretry\fR and \fBignore\fR.
-.TP 18
-\fBok\fR
-.
+.IP \fBok\fR 18
Displays one button whose symbolic name is \fBok\fR.
-.TP 18
-\fBokcancel\fR
-.
+.IP \fBokcancel\fR 18
Displays two buttons whose symbolic names are \fBok\fR and \fBcancel\fR.
-.TP 18
-\fBretrycancel\fR
-.
+.IP \fBretrycancel\fR 18
Displays two buttons whose symbolic names are \fBretry\fR and \fBcancel\fR.
-.TP 18
-\fByesno\fR
-.
+.IP \fByesno\fR 18
Displays two buttons whose symbolic names are \fByes\fR and \fBno\fR.
-.TP 18
-\fByesnocancel\fR
-.
+.IP \fByesnocancel\fR 18
Displays three buttons whose symbolic names are \fByes\fR, \fBno\fR
and \fBcancel\fR.
.RE
@@ -105,13 +102,13 @@ and \fBcancel\fR.
.SH EXAMPLE
.PP
.CS
-set answer [\fBtk_messageBox\fR \-message "Really quit?" \e
- \-icon question \-type yesno \e
- \-detail "Select \e"Yes\e" to make the application exit"]
-switch \-\- $answer {
+set answer [\fBtk_messageBox\fR -message "Really quit?" \e
+ -icon question -type yesno \e
+ -detail "Select \e"Yes\e" to make the application exit"]
+switch -- $answer {
yes exit
- no {\fBtk_messageBox\fR \-message "I know you like this application!" \e
- \-type ok}
+ no {\fBtk_messageBox\fR -message "I know you like this application!" \e
+ -type ok}
}
.CE
.SH KEYWORDS