summaryrefslogtreecommitdiff
path: root/Master/tlpkg/tlperl/site/lib/Tk/Table.pod
blob: fa9d8c3658e77eb3504338ddea7993737b06cc49 (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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

=head1 NAME

Tk::Table - Scrollable 2 dimensional table of Tk widgets

=for pm Tk/Table.pm

=for category Tk Geometry Management

=head1 SYNOPSIS

  use Tk::Table;

  $table = $parent->Table(-rows => number,
                          -columns => number,
                          -scrollbars => anchor,
                          -fixedrows => number,
                          -fixedcolumns => number,
                          -takefocus => boolean);

  $widget = $table->Button(...);

  $old = $table->put($row,$col,$widget);
  $old = $table->put($row,$col,"Text");  # simple Label
  $widget = $table->get($row,$col);

  $cols = $table->totalColumns;
  $rows = $table->totalRows;

  $table->see($widget);
  $table->see($row,$col);

  ($row,$col) = $table->Posn($widget);

=head1 DESCRIPTION

Tk::Table is an all-perl widget/geometry manager which allows a two dimensional
table of arbitary perl/Tk widgets to be displayed.

Entries in the Table are simply ordinary perl/Tk widgets. They should
be created with the Table as their parent. Widgets are positioned in the
table using:

 $table->put($row,$col,$widget)

If I<$widget> is not a reference it is treated as a string, and
a Lable widget is created with the string as its text.

All the widgets in each column are set to the same width - the requested
width of the widest widget in the column.
Likewise, all the widgets in each row are set to the same height - the requested
height of the tallest widget in the column.

A number of rows and/or columns can be marked as 'fixed' - and so can serve
as 'headings' for the remainder the rows which are scrollable.

The requested size of the table as a whole is such that the number of rows
specified by -rows (default 10), and number of columns specified by -columns
(default 10) can be displayed.

If the Table is told it can take the keyboard focus then cursor and scroll
keys scroll the displayed widgets.

C<-scrollbars>. By default, scrollbars will be added C<nw>.
To disable scrollbars, set C<-scrollbars> to an empty string:

  $table = $parent->Table(-scrollbars => '', ...);

The table can be emptied using

 $table->clear

the widgets which were in the table are destroyed.


The Tk::Table widget is derived from a L<Tk::Frame>, so inherits all its
configure options.

The default focus traversal is giving the focus only to the table
widget as a whole. To enable focus traversal into table cells (e.g. if
there are embedded entry widgets), then the option C<-takefocus> has
to be set to C<0>.

=head1 BUGS / Snags / Possible enhancements

=over 4

=item *

Very large Tables consume a lot of X windows.

=item *

No equivalent of pack's -anchor/-pad etc. options

=back

=head1 SEE ALSO

L<Tk::grid>, L<Tk::HList>, L<Tk::TableMatrix>, L<Tk::MListbox>,
L<Tk::Columns>

=cut