#  Copyright (c) 1992 The Regents of the University of California.
#  Copyright (c) 1994-1996 Sun Microsystems, Inc.
#  See the file "license.terms" for information on usage and redistribution
#  of this file, and for a DISCLAIMER OF ALL WARRANTIES.
#
#

=head1 NAME

Tk::Dialog - Create modal dialog and wait for response

=for pm Tk/Dialog.pm

=for category Popups and Dialogs

=head1 SYNOPSIS

S<    >I<$widget>-E<gt>B<Dialog>(title text bitmap default string string ...)

=head1 DESCRIPTION

This procedure is part of the Tk script library.
Its arguments describe a dialog box:

=over 4

=item I<$widget>

Name of top-level window to use for dialog.  Any existing window
by this name is destroyed.

=item I<title>

Text to appear in the window manager's title bar for the dialog.

=item I<text>

Message to appear in the top portion of the dialog box.

=item I<bitmap>

If non-empty, specifies a bitmap to display in the top portion of
the dialog, to the left of the text.
If this is an empty string then no bitmap is displayed in the dialog.

=item I<default>

If this is an integer greater than or equal to zero, then it gives
the index of the button that is to be the default button for the dialog
(0 for the leftmost button, and so on).
If less than zero or an empty string then there won't be any default
button.

=item I<string>

There will be one button for each of these arguments.
Each I<string> specifies text to display in a button,
in order from left to right.

After creating a dialog box, B<tk_dialog> waits for the user to
select one of the buttons either by clicking on the button with the
mouse or by typing return to invoke the default button (if any).
Then it returns the index of the selected button:  0 for the leftmost
button, 1 for the button next to it, and so on.
If the dialog's window is destroyed before the user selects one
of the buttons, then -1 is returned.

While waiting for the user to respond, B<tk_dialog> sets a local
grab.  This prevents the user from interacting with the application
in any way except to invoke the dialog box.

=back

=head1 KEYWORDS

bitmap, dialog, modal
