summaryrefslogtreecommitdiff
path: root/Master/tlpkg/tlperl/lib/Tk/MsgBox.pod
blob: 6f5536cf89cf620d45474af1a17a60ea73a62828 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

=head1 NAME

Tk::MsgBox - create and manipulate a message dialog

=for pm Tk/MsgBox.pm

=for category Popups and Dialogs

=head1 SYNOPSIS

    use Tk::MsgBox
    ...
    $d = $top->MsgBox(-title => "Title", -type => "okcancel");
    ...
    $button = $d->Show;

=head1 DESCRIPTION

B<MsgBox> is a simple dialog with predefined buttons.

=head1 OPTIONS

The options recognized by B<MsgBox> are as follows:

=over 4

=item B<-icon>

Specify the icon of the MsgBox. Valid values are B<error>, B<info>,
B<question>, or B<warning>.

=item B<-type>

Specify the type of the MsgBox. Valid values are B<abortretryignore>,
B<ok>, B<okcancel>, B<retrycancel>, B<yesno>, or B<yesnocancel>. The
type determines the buttons to be shown.

=item B<-default>

Specify the default button. This must be one of B<abort>, B<retry>,
B<ignore>, B<ok>, B<cancel>, B<yes>, or B<no>, depending on the type
of the MsgBox previously specified.

=item B<-detail>

Specify text for the detail region of the MsgBox.

=item B<-message>

Specify the message text of the MsgBox.

=item B<-title>

Specify the title of the MsgBox.

=back

=head1 METHODS

B<MsgBox> supports only one method as of now:

=over 4

=item B<Show()>

Displays the MsgBox until the user invokes one of the buttons. Returns
the name of the button invoked.

=back

=head1 AUTHOR

Translated from Tcl/Tk by B<Slaven Rezic> srezic@cpan.org

This code is distributed under the same terms as Perl.

=head1 SEE ALSO

L<Tk::messageBox>, L<Tk::DialogBox>, L<Tk::Dialog>.

=cut