1=head1 NAME
2
3Tk::Scrolled - Create a widget with attached scrollbar(s)
4
5=for category Derived Widgets
6
7=for index_group Perl/Tk Constructs
8
9=head1 SYNOPSIS
10
11S<    >I<$whatever> = I<$parent>-E<gt>B<Scrolled>(I<Whatever> ?,B<-scrollbars>=E<gt>I<where>? ?,...?);
12
13=head1 DESCRIPTION
14
15To stop a flood of B<ScrlWhatever> widgets Perl/Tk introcuded the special
16constructor B<Scrolled>.  B<Scrolled> creates a widget of the given Class
17I<Whatever> with attached L<scrollbar(s)|Tk::Scrollbar>.
18
19=head1 OPTIONS
20
21All options beside B<-scrollbars> explained below are passed to
22the I<Whatever> widget constructor.
23
24=over 4
25
26=item -scrollbars
27
28Expects as argument the position where the scrollbars should be
29created:  B<w>, B<e> or B<n>, B<s> or a combination of
30them.  If the one or both positions are prefixed with B<o> the
31scrollbar will only show up if there is a 'real' need to scroll.
32
33=back
34
35=head1 ADVERTISED SUBWIDGETS
36
37See L<Tk::mega/"Subwidget"> how to use advertised widgets.
38
39=over 4
40
41=item scrolled
42
43the scrolled widget
44
45=item I<widget>
46
47same as B<scrolled> above.  I<widget> is the kind of widget passed
48to scrolled as first argument in all lowercase.
49
50=item xscrollbar
51
52the B<Scrollbar> widget used for horizontal scrolling (if it exists)
53
54=item yscrollbar
55
56the B<Scrollbar> widget used for vertical scrolling (if it exists)
57
58=item corner
59
60a frame in the corner between the vertical and horizontal scrolbar
61
62=back
63
64=head1 BUGS
65
66If a widget does not support I<-{x,y}scrollcommand> options,
67B<Scrolled> does not complain if the specified widget class does
68not support them.  E.g.,
69
70S<    >I<$parent>->B<Scrolled>(B<'Button'>, ...)
71
72One does not get an error message or warning when one tries to
73configure scrollbars after the widget construction:
74
75S<    >I<$ascrolled>->B<configure>(B<-scrollbars> => B<'e'>);
76
77=head1 SEE ALSO
78
79L<Tk::Scrollbar|Tk::Scrollbar>
80
81=head1 KEYWORDS
82
83scrolled, scrollbar
84
85=cut
86
87