← Back to branch summary

~ubuntu-branches/ubuntu/natty/perl-tk/natty

« back to all changes in this revision

Viewing changes to pod/Dialog.pod

  • Committer: Bazaar Package Importer
  • Author(s): Stephen Zander
  • Date: 2004-03-14 13:54:44 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040314135444-prc09u2or4dbr3to
Tags: 1:800.025-2
http://bugs.debian.org/237942
Add xlibs-dev to Build-Depends:,
Closes: #237942

Show diffs side-by-side

added added

removed removed

Lines of Context:
pod/Dialog.pod
19
19
 
20
20
=head1 DESCRIPTION
21
21
 
22
 
This procedure is part of the Tk script library - its arguments describe a
23
 
dialog box.
24
 
After creating a dialog box, B<Dialog> waits for the user to
25
 
select one of the buttons either by clicking on the button with the
26
 
mouse or by typing return to invoke the default button (if any).
27
 
Then it returns the text string of the selected button.
 
22
This procedure is part of the Tk script library - its arguments
 
23
describe a dialog box.  After creating a dialog box, B<Dialog> waits
 
24
for the user to select one of the Buttons either by clicking on the
 
25
Button with the mouse or by typing return to invoke the default Button
 
26
(if any).  Then it returns the text string of the selected Button.
28
27
 
29
28
While waiting for the user to respond, B<Dialog> sets a local
30
29
grab.  This prevents the user from interacting with the application
31
 
in any way except to invoke the dialog box.  See B<Show()> method.
 
30
in any way except to invoke the dialog box.  See the B<Show()> method.
 
31
 
 
32
=head1 OPTIONS
32
33
 
33
34
The following option/value pairs are supported:
34
35
 
40
41
 
41
42
=item B<-text>
42
43
 
43
 
Message to appear in the top portion of the dialog box.
 
44
Message to appear in the top portion of the Dialog.
44
45
 
45
46
=item B<-bitmap>
46
47
 
47
 
If non-empty, specifies a bitmap to display in the top portion of
48
 
the dialog, to the left of the text.
49
 
If this is an empty string then no bitmap is displayed in the dialog.
 
48
If non-empty, specifies a bitmap to display in the top portion of the
 
49
Dialog, to the left of the text.  If this is an empty string then no
 
50
bitmap is displayed in the Dialog.
50
51
 
51
52
=item B<-default_button>
52
53
 
53
 
Text label string of the button that displays the default ring.
 
54
Text label string of the Button that displays the default ring.
54
55
 
55
56
=item B<-buttons>
56
57
 
57
 
A reference to a list of button label strings.
58
 
Each I<string> specifies text to display in a button,
59
 
in order from left to right.
 
58
A reference to a list of Button label strings.  Each I<string>
 
59
specifies text to display in a Button, in order from left to right.
60
60
 
61
61
=back
62
62
 
64
64
 
65
65
=over 4
66
66
 
67
 
=item C<$answer = $dialog-E<gt>B<Show>(?-global?);>
 
67
=item I<$answer> = $dialog-E<gt>B<Show(>?-global?B<)>;
68
68
 
69
 
This method displays the dialog, waits for the user's response, and stores
70
 
the text string of the selected button in C<$answer>.  If I<-global> is
 
69
This method displays the Dialog, waits for the user's response, and stores
 
70
the text string of the selected Button in I<$answer>.  If I<-global> is
71
71
specified a global (rather than local) grab is performed.
72
72
 
 
73
The actual Dialog is shown using the B<Popup> method. Any other
 
74
options supplied to B<Show> are passed to B<Popup>, and can be used to
 
75
position the Dialog on the screen. Please read Tk::Popup for details.
 
76
 
 
77
=back
 
78
 
 
79
=head1 ADVERTISED WIDGETS
 
80
 
 
81
Because Tk::Dialog is a subclass of Tk::DialogBox it inherits all the
 
82
advertised subwidgets of its superclass: e.g. "B_button-text", where
 
83
'button-text' is a Button's -text value. Additionally, Tk::Dialog
 
84
advertises:
 
85
 
 
86
=over 4
 
87
 
 
88
=item B<message>
 
89
 
 
90
The dialog's Label widget containing the message text.
 
91
 
 
92
=item B<bitmap>
 
93
 
 
94
The dialog's Label widget containing the bitmap image.
 
95
 
73
96
=back
74
97
 
75
98
=head1 EXAMPLE