| 1 |
578 |
markom |
'\"
|
| 2 |
|
|
'\" Copyright (c) 1992 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: dialog.n,v 1.1.1.1 2002-01-16 10:25:48 markom Exp $
|
| 9 |
|
|
'\"
|
| 10 |
|
|
.so man.macros
|
| 11 |
|
|
.TH tk_dialog n 4.1 Tk "Tk Built-In Commands"
|
| 12 |
|
|
.BS
|
| 13 |
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
| 14 |
|
|
.SH NAME
|
| 15 |
|
|
tk_dialog \- Create modal dialog and wait for response
|
| 16 |
|
|
.SH SYNOPSIS
|
| 17 |
|
|
\fBtk_dialog \fIwindow title text bitmap default string string ...\fR
|
| 18 |
|
|
.BE
|
| 19 |
|
|
|
| 20 |
|
|
.SH DESCRIPTION
|
| 21 |
|
|
.PP
|
| 22 |
|
|
This procedure is part of the Tk script library.
|
| 23 |
|
|
Its arguments describe a dialog box:
|
| 24 |
|
|
.TP
|
| 25 |
|
|
\fIwindow\fR
|
| 26 |
|
|
Name of top-level window to use for dialog. Any existing window
|
| 27 |
|
|
by this name is destroyed.
|
| 28 |
|
|
.TP
|
| 29 |
|
|
\fItitle\fR
|
| 30 |
|
|
Text to appear in the window manager's title bar for the dialog.
|
| 31 |
|
|
.TP
|
| 32 |
|
|
\fItext\fR
|
| 33 |
|
|
Message to appear in the top portion of the dialog box.
|
| 34 |
|
|
.TP
|
| 35 |
|
|
\fIbitmap\fR
|
| 36 |
|
|
If non-empty, specifies a bitmap to display in the top portion of
|
| 37 |
|
|
the dialog, to the left of the text.
|
| 38 |
|
|
If this is an empty string then no bitmap is displayed in the dialog.
|
| 39 |
|
|
.TP
|
| 40 |
|
|
\fIdefault\fR
|
| 41 |
|
|
If this is an integer greater than or equal to zero, then it gives
|
| 42 |
|
|
the index of the button that is to be the default button for the dialog
|
| 43 |
|
|
(0 for the leftmost button, and so on).
|
| 44 |
|
|
If less than zero or an empty string then there won't be any default
|
| 45 |
|
|
button.
|
| 46 |
|
|
.TP
|
| 47 |
|
|
\fIstring\fR
|
| 48 |
|
|
There will be one button for each of these arguments.
|
| 49 |
|
|
Each \fIstring\fR specifies text to display in a button,
|
| 50 |
|
|
in order from left to right.
|
| 51 |
|
|
.PP
|
| 52 |
|
|
After creating a dialog box, \fBtk_dialog\fR waits for the user to
|
| 53 |
|
|
select one of the buttons either by clicking on the button with the
|
| 54 |
|
|
mouse or by typing return to invoke the default button (if any).
|
| 55 |
|
|
Then it returns the index of the selected button: 0 for the leftmost
|
| 56 |
|
|
button, 1 for the button next to it, and so on.
|
| 57 |
|
|
If the dialog's window is destroyed before the user selects one
|
| 58 |
|
|
of the buttons, then -1 is returned.
|
| 59 |
|
|
.PP
|
| 60 |
|
|
While waiting for the user to respond, \fBtk_dialog\fR sets a local
|
| 61 |
|
|
grab. This prevents the user from interacting with the application
|
| 62 |
|
|
in any way except to invoke the dialog box.
|
| 63 |
|
|
|
| 64 |
|
|
.SH KEYWORDS
|
| 65 |
|
|
bitmap, dialog, modal
|
