This file is indexed.

/usr/lib/perl5/Tk/TableMatrix.pod is in libtk-tablematrix-perl 1.23-6build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   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
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
#  See the file "license.terms" for information on usage and redistribution
#  of this file, and for a DISCLAIMER OF ALL WARRANTIES.
#
#



=head1 NAME 

TableMatrix - Create and manipulate tables  

=head1 Synopsis 

I<$table> = I<$parent>-E<gt>B<TableMatrix>(?I<options>?);

=head1 STANDARD OPTIONS 

B<-anchor  -background  -cursor 
   -exportselection  -font  -foreground    -highlightbackground  -highlightcolor 
 -highlightthickness    -insertbackground  -insertborderwidth  -insertofftime 
   -insertontime  -insertwidth  -invertselected  -relief  -takefocus 
 -xscrollcommand    -yscrollcommand>

=head1 Widget-specific Options 

=over 1

=item Switch: B<-autoclear> 

=item Name: B<autoClear> 

=item Class: B<AutoClear>

A boolean value which specifies whether the first keypress in a cell will 
delete whatever text was previously there.  Defaults to 0.

=item Switch:  B<-bordercursor> 

=item Name: B<borderCursor> 

=item Class: B<Cursor> 

Specifies the name of the cursor to show when over borders, a visual 
indication that interactive resizing is allowed (it is thus affect by 
the value of -resizeborders).  Defaults to I<crosshair >.  

=item Switch: B<-borderwidth or -bd> 

=item Name: B<borderWidth> 

=item Class: B<BorderWidth> 

Specifies a non-negative pixel value or list of values indicating the width
of the 3-D border to draw on interior table cells (if such a border is
being drawn; the <Brelief> option typically determines this).  If one
value is specified, a rectangle of this width will be drawn.  If two values
are specified, then only the left and right edges of the cell will have
borders.  If four values are specified, then the values correspond to the
{left right top bottom} edges.  This can be overridden by the a tag's
borderwidth option.  It can also be affected by the defined
B<-drawmode> for the table.  Each value in the list must have one of
the forms acceptable to B<Tk_GetPixels>.

=item Switch: B<-browsecommand or -browsecmd> 

=item Name: B<browseCommand> 

=item Class: B<BrowseCommand>

Specifies a command (callback) which will be evaluated 
anytime the active cell changes. The Previous Index and the Current index is passed to this
command as arguments.

=item Switch: B<-cache> 

=item Name: B<cache> 

=item Class: B<Cache>

A boolean value that specifies whether an 
internal cache of the table contents should be kept.  This greatly enhances 
speed performance when used with B<-command > but uses extra memory.  Can maintain 
state when both B<-command > and B<-variable > are empty.  The cache is automatically 
flushed whenever the value of B<-cache > or B<-variable > changes, otherwise you 
have to explicitly call B<clear> on it.  Defaults to off.

=item Switch: B<-colorigin> 

=item Name: B<colOrigin> 

=item Class: B<Origin>

Specifies what column 
index to interpret as the leftmost column in the table. This value is used 
for user indices in the table.  Defaults to 0.  

=item Switch: B<-cols>

=item Name: B<cols> 

=item Class: B<Cols>

Number of cols in the table.  Defaults 
to 10.  

=item Switch: B<-colseparator> 

=item Name: B<colSeparator>

=item Class: B<Separator>

Specifies a separator character that will be interpreted 
as the column separator when cutting or pasting data in a table.  By default, 
columns are separated as elements of a tcl list.  

=item Switch: B<-colstretchmode> 

=item Name: B<colStretchMode> 

=item Class: B<StretchMode>  

Specifies one 
of the following stretch modes for columns to fill extra allocated window 
space:  

=back

=over 2

=item B<none >  

Columns will not stretch to fill the assigned window space. 
If the columns are too narrow, there will be a blank space at the right 
of the table.  This is the default. 

=item B<unset >  

Only columns that do not have 
a specific width set will be stretched.

=item B<all >  

All columns will be stretched 
by the same number of pixels to fill the window space allocated to the 
table.  This mode can interfere with interactive border resizing which 
tries to force column width. 

=item B<last >  

The last column will be stretched  
to fill the window space allocated to the table. 

=item B<fill >

(only valid for 
B<-rowstretch > currently)  

The table will get more or less columns according 
to the window space allocated to the table.  This mode has numerous quirks 
and may disappear in the future.

=back

=over 1

=item Switch: B<-coltagcommand>

=item Name: B<colTagCommand> 

=item Class: B<TagCommand>

Provides the name of a 
procedure that will be evaluated by the widget to determine the tag to 
be used for a given column.  When displaying a cell, the table widget will 
first check to see if a tag has been defined using the B<tag col > widget 
method.  If no tag is found, it will evaluate the named procedure passing 
the column number in question as the sole argument.  The procedure is expected 
to return the name of a tag to use, or a null string. Errors occuring during 
the evaluation of the procedure, or the return of an invalid tag name 
are silently ignored.

The Current column number is passed as an argument to the col command.


=item Switch: B<-colwidth> 

=item Name: B<colWidth> 

=item Class: B<ColWidth>

Default column width, interpreted as characters 
in the default font when the number is positive, or pixels if it is negative. 
Defaults to 10.

=item Switch: B<-command> 

=item Name: B<command>

=item Class: B<Command>

Specified a command to use as a procedural interface to 
cell values. If B<-usecommand > is true, this command will be used instead 
of any reference to the B<-variable > array.  When retrieving cell values, 
the return value of the command is used as the value for the cell. 

Args passed to this callback: The Set Flag (=1 if setting, else retrieving), the current row, 
the current col, the cell value (if setting).

=item Switch: B<-drawmode> 

=item Name: B<drawMode> 

=item Class: B<DrawMode>

Sets 
the table drawing mode to one of the following options:

=back

=over 2

=item B<slow >  

The table 
is drawn to an offscreen pixmap using the Tk bordering functions (double-buffering). 
This means there will be no flashing, but this mode is slow for larger 
tables.

=item B<compatible >  

The table is drawn directly to the screen using the 
Tk border functions. It is faster, but the screen may flash on update.  
This is the default. 

=item B<fast >  

The table is drawn directly to the screen and 
the borders are done with fast X calls, so they are always one pixel wide 
only.  As a side effect, it restricts B<-borderwidth > to a range of 0 or 1. 
This mode provides best performance for large tables, but can flash on 
redraw and is not 100% Tk compatible on the border mode. 

=item B<single >  

The table 
is drawn to the screen as in fast mode, but only single pixel lines are 
drawn (not square borders).   

=back

=over 1

=item Switch: B<-flashmode> 

=item Name: B<flashMode> 

=item Class: B<FlashMode>

A boolean value which specifies whether 
cells should flash when their value changes.  The table tag B<flash > will 
be applied to these cells for the duration specified by B<-flashtime >.  Defaults 
to 0.

=item Switch: B<-flashtime> 

=item Name: B<flashTime> 

=item Class: B<FlashTime>

The amount of time, in 1/4 second increments, for which a cell 
should flash when its value has changed.  B<-flashmode > must be on.  Defaults 
to 2. 

=item Switch: B<-height> 

=item Name: B<height> 

=item Class: B<Height> 

Specifies the desired height for the window, in rows. If zero or less, 
then the desired height for the window is made just large enough to hold 
all the rows in the table.  The height can be further limited by B<-maxheight 
>.  

=item Switch: B<-invertselected> 

=item Name: B<invertSelected> 

=item Class: B<InvertSelected>

Specifies whether the foreground and background 
of an item should simply have their values swapped instead of merging 
the I<sel > tag options when the cell is selected.  Defaults to 0 (merge I<sel> tag). 

=item Switch: B<-ipadx> 

=item Name: B<ipadX> 

=item Class: B<Pad>

A pixel value specifying the internal offset X padding for text in a cell.
This value does not grow the size of the cell, it just causes the text to
be drawn further from the cell border.  It only affects one side (depending
on anchor).  Defaults to 0.  See B<-padx> for an alternate padding
style.

=item Switch: B<-ipady> 

=item Name: B<ipadY> 

=item Class: B<Pad>

A pixel value specifying the internal offset Y padding for text in a cell.
This value does not grow the size of the cell, it just causes the text to
be drawn further from the cell border.  It only affects one side (depending
on anchor).  Defaults to 0.  See B<-pady> for an alternate padding
style.

=item Switch: B<-justify> 

=item Name: B<justify> 

=item Class: B<Justify>

How to justify multi-line text in a cell. It must
be one of B<left>, B<right>, or B<center>. Defaults to
left.

=item Switch: B<-maxheight> 

=item Name: B<maxHeight> 

=item Class: B<MaxHeight>

The max height in pixels that the window will request.  Defaults 
to 600.  

=item Switch: B<-maxwidth> 

=item Name: B<maxWidth> 

=item Class: B<MaxWidth>

The max width in pixels that the window will request.  Defaults 
to 800.  

=item Switch: B<-multiline> 

=item Name: B<multiline> 

=item Class: B<Multiline>

Specifies the default setting for the multiline tag 
option.  Defaults to 1.  

=item Switch: B<-pady> 

=item Name: B<padX> 

=item Class: B<Pad>

A pixel value specifying the offset X padding for a cell.  This value
causes the default size of the cell to increase by two times the value (one
for each side), unless a specific pixel size is chosen for the cell with
the B<width> command.  This will force an empty area on the left and
right of each cell edge.  This padding affects all types of data in the
cell.  Defaults to 0.  See B<-ipadx> for an alternate padding style.

=item Switch: B<-pady> 

=item Name: B<padY> 

=item Class: B<Pad>

A pixel value specifying the offset Y padding for a cell.  This value
causes the default size of the cell to increase by two times the value (one
for each side), unless a specific pixel size is chosen for the cell with
the B<height> command.  This will force an empty area on the top and
bottom of each cell edge.  This padding affects all types of data in the
cell.  Defaults to 0.  See B<-ipadx> for an alternate padding style.

=item Switch: B<-resizeborders> 

=item Name: B<resizeBorders> 

=item Class: B<ResizeBorders>

Specifies what kind of interactive 
border resizing to allow, must be one of row, col, both (default) or none. 

=item Switch: B<-rowheight> 

=item Name: B<rowHeight> 

=item Class: 

B<RowHeight>  Default row height, interpreted as lines in the default font 
when the number is positive, or pixels if it is negative.  Defaults to 
1.  

=item Switch: B<-roworigin> 

=item Name: B<rowOrigin> 

=item Class: B<Origin>

Specifies what row index to interpret as the topmost row in the 
table. This value is used for user indices in the table.  Defaults to 0. 

=item Switch: B<-rows> 

=item Name: B<rows> 

=item Class: B<Rows>

Number 
of rows in the table.  Defaults to 10.  

=item Switch: B<-rowseparator>

=item Name: B<rowSeparator> 

=item Class: B<Separator>

Specifies a separator character 
that will be interpreted as the row separator when cutting or pasting 
data in a table.  By default, rows are separated as tcl lists.

=item Switch: B<-rowstretchmode> 

=item Name: B<rowStretchMode> 

=item Class: B<StretchMode> 

Specifies the stretch modes for rows to fill extra allocated window space. 
See B<-colstretchmode > for valid options.  

=item Switch: B<-rowtagcommand> 

=item Name: B<rowTagCommand> 

=item Class: B<TagCommand>

Provides the 
name of a procedure that can evaluated by the widget to determine the 
tag to be used for a given row.  The procedure must be defined by the user 
to accept a single argument (the row number), and return a tag name or 
null string.  This operates in a similar manner as B<-coltagcommand >, except 
that it applies to row tags. 

The Current row number is passed as an argument to the row command.

=item Switch: B<-selectioncommand or -selcmd> 

=item Name: B<selectionCommand> 

=item Class: B<SelectionCommand>

Specifies 
a command (callback) to evaluate when the selection is retrieved from a table via 
the selection mechanism (ie: evaluating "B<selection get >"). The return value 
from this command will become the string passed on by the selection mechanism. 
The following arguments are passed to this callback: The number of rows in the 
selection, number of columns in the selection, the selection string, the number
of cell in the selection.

=item Switch: B<-selectmode> 

=item Name: B<selectMode>

=item Class: B<SelectMode>

Specifies one of several styles for manipulating the 
selection.  The value of the option may be arbitrary, but the default bindings 
expect it to be either B<single >, B<browse >, B<multiple >, or B<extended >; the 
default value is B<browse >.  These styles are like those for the Tk listbox, 
except expanded for 2 dimensions.  

=item Switch: B<-selecttitle> 

=item Name: B<selectTitles> 

=item Class: B<SelectTitles>

Specifies whether title 
cells should be allowed in the selection. Defaults to 0 (disallowed).  

=item Switch: B<-selecttype> 

=item Name: B<selectType> 

=item Class: B<SelectType> 

Specifies one of several types of selection for the table.  The value 
of the option may be one of B<row >, B<col >, B<cell >, or B<both > (meaning B<row && 
col >); the default value is B<cell >.  These types define whether an entire 
row/col is affected when a cell's selection is changed (set or clear).  

=item Switch: B<-sparsearray> 

=item Name: B<sparseArray> 

=item Class: B<SparseArray>

A boolean value that specifies whether an associated Tcl 
array should be kept as a sparse array (1, the default) or as a full array 
(0).  If true, then cell values that are empty will be deleted from the 
array (taking less memory).  If false, then all values in the array will 
be maintained.  

=item Switch: B<-state> 

=item Name: B<state> 

=item Class: B<State>  

Specifies one of two states for the entry:  B<normal > or B<disabled>.
If the table is disabled then the value may not be changed using widget 
commands and no insertion cursor will be displayed, even if the input 
focus is in the widget.  Also, all insert or delete methods will be ignored. 
Defaults to B<normal >.  

=item Switch: B<-titlecols> 

=item Name: B<titleCols> 

=item Class: B<TitleCols>

Number of columns to use as a title area.  Defaults 
to 0.  

=item Switch: B<-titlerows> 

=item Name: B<titleRows> 

=item Class: B<TitleRows>  

Number of rows to use as a title area.  Defaults to 0. 

=item Switch: B<-usecommand> 

=item Name: B<useCommand> 

=item Class: B<UseCommand> 

A boolean value which specifies whether to use the B<command > option. This 
value sets itself to zero if B<command > is used and returns an error. Defaults 
to 1 (will use B<command > if specified).  

=item Switch: B<-validate> 

=item Name: B<validate> 

=item Class: B<Validate>

A boolean specifying whether 
validation should occur for the active buffer. Defaults to 0.  

=item Switch: B<-validatecommand or -vcmd> 

=item Name: B<validateCommand>

=item Class: B<ValidateCommand>  

Specifies a command (callback) to execute when the active 
cell is edited.  This command is expected to return a 1 or 0.  If it 
returns 1, then it is assumed the new value is OK, otherwise the new 
value is rejected (the edition will not take place).  Errors in this command 
are handled in the background. The following arguments are supplied to the callback:
row, col, oldContents of cell, potential new contents of cell, Current Index in the cell.


=item Switch: B<-variable> 

=item Name: B<variable> 

=item Class: B<Variable>  

Global Tcl array variable to attach 
to the table's C array.  It will be created if it doesn't already exist or 
is a simple variable.  Keys used by the table in the array are of the form 
I<row >,I<col > for cells and the special key I<active > which contains the value 
of the active cell buffer.  The Tcl array is managed as a sparse array 
(the table doesn't require all valid indices have values).  No stored value 
for an index is equivalent to the empty string, and clearing a cell will 
remove that index from the Tcl array, unless the B<-sparsearray > options 
is set to 0.  

=item Switch: B<-width> 

=item Name: B<width> 

=item Class: B<Width>  

Specifies the desired width for the window, in columns. If zero 
or less, then the desired width for the window is made just large enough 
to hold all the columns in the table.  The width can be further limited 
by B<-maxwidth >.  

=item Switch: B<-wrap> 

=item Name: B<wrap> 

=item Class: B<Wrap>  

Specifies the default wrap value for tags.  Defaults to 0.  

=back

=head1 DESCRIPTION 


The B<TableMatrix > command creates a 2-dimensional grid of cells.  The table can 
use a Tcl array variable or Tcl command for data storage and retrieval. 
The widget has an active cell, the contents of which can be edited (when 
the state is normal).  The widget supports a default style for the cells 
and also multiple I<tags >, which can be used to change the style of a row, 
column or cell (see TAGS for details).  A cell I<flash > can be set up so 
that changed cells will change color for a specified amount of time ("blink"). 
 Cells can have embedded images or windows, as described in L<Tags> and L<Embedded Windows> respectively. 

One or more cells may be selected as described below. 
 If a table is exporting its selection (see B<-exportselection > option), 
then it will observe the standard X11 protocols for handling the selection. 
 See L<the Selection> for details. It is not necessary for all the cells to 
be displayed in the table window at once; commands described below may 
be used to change the view in the window. Tables allow scrolling in both 
directions using the standard B<-xscrollcommand > and B<-yscrollcommand > options. 
 They also support scanning, as described below. 

In order to obtain good 
performance, the table widget supports multiple drawing modes, two of 
which are fully Tk compatible.  

=head1 Indices 

Many of the widget commands for tables take one or 
more indices as arguments. An index specifies a particular cell of the 
table, in any of the following ways: 

=over 1

=item I<number,number >  

Specifies the cell 
as a numerical index of row,col which corresponds to the index of the 
associated Perl Hash, where B<-roworigin,-colorigin > corresponds to the first 
cell in the table (0,0 by default). The values for row
and column will be constrained to actual values
in the table, which means a valid cell is
always found.

=item B<active >  

Indicates the cell that has 
the location cursor. It is specified with the B<activate > widget command. 

=item B<anchor >  

Indicates the anchor point for the selection, which is set with 
the B<selection anchor > widget command. 

=item B<bottomright >  

Indicates the bottom-rightmost 
cell visible in the table. 

=item B<end >  

Indicates the bottom right cell of the 
table. 

=item B<origin >  

Indicates the top-leftmost editable cell of the table, not 
necessarily in the display.  This takes into account the user specified 
origin and title area. 

=item B<topleft >  

Indicates the top-leftmost editable cell 
visible in the table (this excludes title cells). 

=item B<@x,y>  

Indicates the 
cell that covers the point in the table window specified by I<x > and I<y > 
(in pixel coordinates).  If no cell covers that point, then the closest 
cell to that point is used. In the widget command descriptions below, arguments 
named I<index >, I<first >, and I<last > always contain text indices in one of 
the above forms.  

=back

=head1 Tags 

A tag is a textual string that is associated with zero or more rows,
columns or cells in a table.  Tags may contain arbitrary characters, but it
is probably best to avoid using names which look like indices to reduce
coding confusion.  There may be any number of tags in a table, but each
row, column or cell can only have one tag associated with it at a time.
There are several permanent tags in each table that can be configured by
the user and will determine the attributes for special cells:

=over 1

=item B<active >  

This tag is given to the I<active > cell 

=item B<flash >  

If flash 
mode is on, this tag is given to any recently edited cells. 

=item B<sel >  

This 
tag is given to any selected cells. 

=item B<title >  

This tag is given to any cells 
in the title rows and columns.  This tag has B<-state > I<disabled > by default. 

=back

Tags control the way cells are displayed on the screen.  Where appropriate, 
the default for displaying cells is determined by the options for the 
table widget.  However, display options may be associated with individual 
tags using the L<tagConfigure> method.  If a cell, row or column has been 
tagged, then the display options associated with the tag override the 
default display style.  The following options are currently supported for 
tags:  

=over 1

=item B<-anchor> I<anchor>  

Anchor for item in the cell space. 

=item B<-background > or B<-bg > I<color >  

Background color of the cell. 

=item B<-borderwidth > or B<-bd > I<pixel >  

Borderwidth of the cell, of the same format for the table, but may also
be empty to inherit the default table borderwidth value (the default).

=item B<-font> I<fontName >  

Font for text in the cell. 

=item B<-foreground> or B<-fg > I<color >  

Foreground color of the cell. 

=item B<-justify> I<justify > 

How to 
justify multi-line text in a cell. It must be one of B<left >, B<right >, or B<center>. 

=item B<-image> I<imageName >  

An image to display in the cell instead of text. 

=item B<-multiline> I<boolean >  

Whether to display text with newlines on multiple lines. 

=item B<-relief>  

The relief for the cell. May be the empty
string to cause this tag to not disturb the
value.

=item B<-showtext> I<boolean>  

Whether to show the text over an image.

=item B<-state> I<state>  

The state of the cell, to allow for certain cells 
to be disabled. This prevents the cell from being edited by the I<insert 
> or I<delete > methods, but a direct I<set > will not be prevented. 

=item B<-wrap> I<boolean>  

Whether characters should wrap in a cell that is not wide enough.

=back

A priority order is defined among tags based on creation order (first
created tag has highest default priority), and this order is used in
implementing some of the tag-related functions described below.  When a cell
is displayed, its properties are determined by the tags which are assigned
to it.  The priority of a tag can be modified by the I<tagLower> and the 
I<tagRaise> methods.

If a cell has several tags associated with it that define the same display
options (eg - a B<title> cell with specific B<row> and B<cell>
tags), then the options of the highest priority tag are used.  If a
particular display option hasn't been specified for a particular tag, or if
it is specified as an empty string, then that option will not be used; the
next-highest-priority tag's option will be used instead.  If no tag
specifies a particular display option, then the default style for the
widget will be used.

Images are used for display purposes 
only.  Editing in that cell will still be enabled and any querying of the 
cell will show the text value of the cell, regardless of the value of 
B<-showtext >.  

Note: There can be only one tag for a given tag type. ( Tag types = B<flash >, B<active >, B<sel >, B<title >, 
B<celltag> B<rowtag >, B<coltag >.) For example, you can't apply two cell tags to a single cell (or two row tags to a
single row, etc) and expect the tag's properties to be merged. The last tag-type applied will be the one that
is used. 


=head1 Embedded Windows 

There may be any number of embedded windows 
in a table widget (one per cell), and any widget may be used as an embedded 
window (subject to the usual rules for geometry management, which require 
the table window to be the parent of the embedded window or a descendant 
of its parent).  The embedded window's position on the screen will be updated 
as the table is modified or scrolled, and it will be mapped and unmapped 
as it moves into and out of the visible area of the table widget.  Each 
embedded window occupies one cell's worth of space in the table widget, 
and it is referred to by the index of the cell in the table.  Windows associated 
with the table widget are destroyed when the table widget is destroyed. 

Windows are used for display purposes only.  A value still exists for that 
cell, but will not be shown unless the window is deleted in some way.  
If the window is destroyed or lost by the table widget to another geometry 
manager, then any data associated with it is lost (the cell it occupied 
will no longer appear in B<window names >).

When an embedded window is added 
to a table widget with the window configure widget command, several configuration 
options may be associated with it.  These options may be modified with 
later calls to the window configure widget command.  The following options 
are currently supported:  

=over 1

=item B<-create> I<callback>

NOT CURRENTLY SUPPORTED.  Specifies 
a Tcl script that may be evaluated to create the window for the annotation. 
 If no -window option has been specified for this cell then this script 
will be evaluated when the cell is about to be displayed on the screen. 
 Script must create a window for the cell and return the name of that 
window as its result. If the cell's window should ever be deleted, the script 
will be evaluated again the next time the cell is displayed. 

=item B<-background> or B<-bg> I<color>  

Background color of the cell.  If not specified, it uses 
the table's default background. 

=item B<-borderwidth> or B<-bd> I<pixelList >

Borderwidth of the cell, of the same format for the table, but may also
be empty to inherit the default table borderwidth value (the default).

=item B<-padx> I<pixels >

As defined in the Tk options 
man page. 

=item B<-pady> I<pixels>

As defined in the Tk options man page. 

=item B<-relief> I<relief>  

The relief to use for the cell in which the window lies.  If not specified, 
it uses the table's default relief. 

=item B<-sticky> I<sticky > 

Stickiness of the window 
inside the cell, as defined by the B<grid > command. 

=item B<-window> I<$widget>  

Specifies 
the a window to display in the  annotation.  It must exist before 
being specified here.   

=back

=head1 the Selection 

Table selections are available as 
type STRING.  By default, the value of the selection will be the values 
of the selected cells in nested Tcl list form where each row is a list 
and each column is an element of a row list. You can change the way this 
value is interpreted by setting the B<-rowseparator > and B<-colseparator > options. 
 For example, default Excel format would be to set B<-rowseparator > to "\n" 
and B<-colseparator > to "\t".  Changing these values affects both how the table 
sends out the selection and reads in pasted data, ensuring that the table 
should always be able to cut and paste to itself.  It is possible to change 
how pastes are handled by editing the table library procedure B<tk_tablePasteHandler 
>.  This might be necessary if B<-selectioncommand > is set.  

=head1 Row/Col Spanning 

Individual cells can span multiple rows and/or columns.  This is done via 
the B<spans > command (see below for exact arguments).  Cells in the title 
area that span are not permitted to span beyond the title area, and will 
be constrained accordingly.  If the title area shrinks during a configure, 
sanity checking will occur to ensure the above.  You may set spans on regular 
cells that extend beyond the defined row/col area.  These spans will not 
be constrained, so that when the defined row/col area expands, the span 
will expand with it. 

When setting a span, checks are made as to whether 
the span would overlap an already spanning or hidden cell.  This is an 
error and it not allowed. Spans can affect the overall speed of table drawing, 
although not significantly.  If spans are not used, then there is no performance 
loss. 

Cells I<hidden > by spanning cells still have valid data.  This will 
be seen during cut and paste operations that involve hidden cells, or 
through direct access by a command like B<get > or B<set >. 

The drawing properties 
of spanning cells apply to only the visual area of the cell.  For example, 
if a cell is center justified over 5 columns, then when viewing any portion 
of those columns, it will appear centered in the visible area. The non-visible 
column area will not be considered in the centering calculations.  

=head1 Command Substitution 

The various option based commands that the table supports 
all support the familiar Tk %-substitution model (see L<Tk::bind > for more details). 
 The following %-sequences are recognized and substituted by the table 
widget: 

=over 1

=item B<%c >  

For B<SelectionCommand >, it is the maximum number of columns 
in any row in the selection.  Otherwise it is the column of the triggered 
cell. 

=item B<%C >  

A convenience substitution for I<%r >,I<%c >. 

=item B<%i >  

For B<SelectionCommand>, it is the total number of cells in the selection. For B<Command >, it is 
0 for a read (get) and 1 for a write (set). Otherwise it is the current 
cursor position in the cell. 

=item B<%r>

For B<SelectionCommand >, it is the number 
of rows in the selection. Otherwise it is the row of the triggered cell. 

=item B<%s >  

For B<ValidateCommand >, it is the current value of the cell being validated. 
For B<SelectionCommand >, it is the default value of the selection. For B<BrowseCommand 
>, it is the index of the last active cell. For B<Command >, it is empty for 
reads (get) and the current value of the cell for writes (set). 

=item B<%S >  

For 
B<ValidateCommand >, it is the potential new value of the cell being validated. 
For B<BrowseCommand >, it is the index of the new active cell. 

=item B<%W >  

The pathname 
to the window for which the command was generated.  

=back

=head1 Widget Methods 

The 
B<$window->E<gt>B<TableMatrix > method creates a widget object. This object supports the B<configure> and B<cget> methods
described in L<Tk::options> which can be used to enquire and
modify the options described above.
The widget also inherits all the methods provided by the generic
L<Tk::Widget|Tk::Widget> class.


The following additional methods are available for scale widgets:

=over 1

=item I<$table>-E<gt>B<activate>(I<index>)

Sets the active 
cell to the one indicated by I<index>.

=item I<$table>-E<gt>B<bbox>(I<first>, ?I<last>?)

It 
returns the bounding box for the specified cell (range) as a 4-tuple of 
x, y, width and height in pixels.  It clips the box to the visible portion, 
if any, otherwise an empty string is returned. 

=item I<$table>-E<gt>B<border>(I<option, args>)

This command is a voodoo hack to implement border sizing for tables. 
This is normally called through bindings, with the following as valid 
options:  

=back

=over 2

=item I<$table>-E<gt>B<borderMark>(I<x, y>, ?I<row|col>?)

Records I<x > and I<y > and 
the row and/or column border under that point in the table window, if 
any; used in conjunction with later B<border dragto > commands.  Typically 
this command is associated with a mouse button press in the widget.  If 
I<row > or I<col > is not specified, it returns a tuple of both border indices 
(an empty item means no border). Otherwise, just the specified item is 
returned. 

=item I<$table>-E<gt>B<borderDragto>(I<x, y>)

This command computes the difference 
between its I<x > and I<y > arguments and the I<x > and I<y > arguments to the last 
B<border mark > command for the widget.  It then adjusts the previously marked 
border by the difference.  This command is typically associated with mouse 
motion events in the widget, to produce the effect of interactive border 
resizing.  

=back

=over 1

=item I<$table>-E<gt>B<cget>(I<option>)

Returns the current value of the configuration 
option given by I<option >.  I<Option > may have any of the values accepted by 
the B<table > command. 

=item I<$table>-E<gt>B<clear>(I<option>, ?I<first>?, ?I<last>?)

This command 
is a convenience routine to clear certain state information managed by 
the table.  I<first > and I<last > represent valid table indices.  If neither 
are specified, then the command operates on the whole table.  The following 
options are recognized:  

=back

=over 2

=item I<$table>-E<gt>B<clearCache>(?I<first>?, ?I<last>?)

Clears 
the specified section of the cache, if the table has been keeping one. 

=item I<$table>-E<gt>B<clearSizes>(?I<first>?, ?I<last>?)

Clears the specified row and column 
areas of specific height/width dimensions.  When just one index is specified, 
for example B<2,0 >, that is interpreted as row 2 B<and > column 0. 

=item I<$table>-E<gt>B<clearTags>(?I<first>?, ?I<last>?)

Clears the specified area of tags (all row, 
column and cell tags). 

=item I<$table>-E<gt>B<clearAll>(?I<first>?, ?I<last>?)

Performs all 
of the above clear functions on the specified area.  

=back

=over 1

=item I<$table>-E<gt>B<colWidth>(?I<col>?, ?I<value, col, value, ...>?)

If no I<col > is 
specified, returns a list describing all cols for which a width has been 
set.  If B<col > is specified with no value, it prints out the width of that 
col in characters (positive number) or pixels (negative number).  If one 
or more I<col-value > pairs are specified, then it sets each col to be that 
width in characters (positive number) or pixels (negative number).  If 
I<value > is I<default >, then the col uses the default width, specified by 
B<-colwidth >. 


=over 1

=item I<$table>-E<gt>B<configure>(?I<option>?, ?I<value, option, value, ...>?)

Query or modify the configuration options 
of the widget. If no I<option > is specified, returns a list describing all 
of the available options for I<pathName > (see B<Tk_ConfigureInfo > for information 
on the format of this list).  If I<option > is specified with no I<value >, then 
the command returns a list describing the one named option (this list 
will be identical to the corresponding sublist of the value returned if 
no I<option > is specified).  If one or more I<option-value > pairs are specified, 
then the command modifies the given widget option(s) to have the given 
value(s);  in this case the command returns an empty string. I<Option > may 
have any of the values accepted by the B<table > command. 

=item I<$table>-E<gt>B<curselection>(?I<value>?)

With no arguments, it returns the sorted indices of the currently 
selected cells.  Otherwise it sets all the selected cells to the given 
value.  The set has no effect if there is no associated Tcl array or the 
state is disabled. 

=item I<$table>-E<gt>B<curvalue>(?I<value>?)

If no value is given, the 
value of the cell being edited (indexed by B<active >) is returned, else 
it is set to the given value. 

=item I<$table>-E<gt>B<delete>(I<option, arg>, ?I<arg>?)

This 
command is used to delete various things in a table.  It has several forms, 
depending on the I<option >:

=back

=over 2

=item I<$table>-E<gt>B<deleteActive>(I<index>, ?I<index>?)

Deletes text from the active cell.  If only one index is given, it deletes the 
character after that index, otherwise it deletes from the first index 
to the second.  I<index > can be a number, B<insert > or B<end >. 

=item I<$table>-E<gt>B<deleteCols>(?I<switches>?, I<index>, ?I<count>?)

Deletes I<count > cols starting at (and 
including) col I<index >.  The I<index > will be constrained to the limits of 
the tables.  If I<count > is negative, it deletes cols to the left.  Otherwise 
it deletes cols to the right.  I<count > defaults to 1 (meaning just the column 
specified).  The selection will be cleared.  At the moment, spans are not 
adjusted with this action.  Optional switches are:

=back

=over 3

=item B<-holddimensions >  

Causes 
the table cols to be unaffected by the deletion (empty cols may appear). 
 By default the dimensions are adjusted by B<count >. 

=item B<-holdtags >  

Causes the 
tags specified by the I<tag > method to not move along with the data.  Also 
prevents specific widths set by the I<width > method from being adjusted. 
 By default, these tags are properly adjusted. 

=item B<-holdwindows >  

Causes the 
embedded windows created with the I<window > method to not move along with 
the data.  By default, these windows are properly adjusted. 

=item B<-keeptitles > 

Prevents title area cells from being changed.  Otherwise they are treated 
just like regular cells and will move as specified. 

=back

=over 2

=item I<$table>-E<gt>B<deleteRows>(?I<switches>?, I<index>, ?I<count>?)

Deletes B<count > rows starting at (and including) row B<index >.  If B<count > is negative, 
it deletes rows going up.  Otherwise it deletes rows going down.  The selection 
will be cleared.  The switches are the same as those for column deletion. 

=back

=over 1

=item I<$table>-E<gt>B<get>(I<first>, ?I<last>?)

Returns the value of the cells specified 
by the table indices I<first > and (optionally) I<last > in a list. 


=item I<$table>-E<gt>B<hidden>(?I<index>?, ?I<index, ...>?)

When called without args, it returns all the I<hidden > cells 
(those cells covered by a spanning cell).  If one index is specified, it 
returns the spanning cell covering that index, if any.  If multiple indices 
are specified, it returns 1 if all indices are hidden cells, 0 otherwise. 

=item I<$table>-E<gt>B<icursor>(?I<arg>?)

With no arguments, prints out the location of 
the insertion cursor in the active cell.  With one argument, sets the cursor 
to that point in the string.  0 is before the first character, you can 
also use B<insert > or B<end > for the current insertion point or the end of 
the text.  If there is no active cell, or the cell or table is disabled, 
this will return -1. 

=item I<$table>-E<gt>B<index>(I<index>, ?I<row|col>?)

Returns the integer 
cell coordinate that corresponds to I<index > in the form row,col.  If B<row 
> or B<col > is specified, then only the row or column index is returned. 

=item I<$table>-E<gt>B<insert>(I<option, arg, arg>)

This command is used to into various things into 
a table.  It has several forms, depending on the I<option >:  

=back

=over 2

=item I<$table>-E<gt>B<insertActive>(I<index, value>)

The I<value > is a text string which is inserted at 
the I<index > postion of the active cell.  The cursor is then positioned after 
the new text. I<index > can be a number, B<insert > or B<end >. 

=item I<$table>-E<gt>B<insertCols>(?I<switches>?, I<index>, ?I<count>?)

Inserts B<count > cols starting at col B<index >.  If B<count > is negative, it inserts before the specified col.  Otherwise 
it inserts after the specified col.  The selection will be cleared.  The 
switches are the same as those for column deletion. 

=item I<$table>-E<gt>B<insertRows>(?I<switches>?, I<index>, ?I<count>?)

Inserts B<count > rows starting at row B<index >.  If B<count > is negative, it inserts before the specified row.  Otherwise 
it inserts after the specified row.  The selection will be cleared.  The 
switches are the same as those for column deletion.  

=back

=over 1

=item I<$table>-E<gt>B<reread>()

Rereads the old contents of the cell back into the editing buffer.  Useful 
for a key binding when <Escape> is pressed to abort the edit (a default 
binding). 

=item I<$table>-E<gt>B<rowHeight>(?I<row>?, ?I<value, row, value, ...>?)

If no I<row > is specified, returns a 
list describing all rows for which a height has been set.  If B<row > is specified 
with no value, it prints out the height of that row in characters (positive 
number) or pixels (negative number).  If one or more I<row-value > pairs are 
specified, then it sets each row to be that height in lines (positive 
number) or pixels (negative number).  If I<value > is I<default >, then the row 
uses the default height, specified by B<-rowheight >. 

=item I<$table>-E<gt>B<scan>(I<option, args>)

This command is used to implement 
scanning on tables.  It has two forms, depending on I<option >:  

=back

=over 2

=item I<$table>-E<gt>B<scanMark>(I<x, y>)

Records I<x > and I<y > and the current view in the table window; 
 used in conjunction with later B<scan dragto > commands. Typically this command 
is associated with a mouse button press in the widget.  It returns an empty 
string. 

=item I<$table>-E<gt>B<scanDragto>(I<x, y>.)

This command computes the difference 
between its I<x > and I<y > arguments and the I<x > and I<y > arguments to the last 
B<scan mark > command for the widget.  It then adjusts the view by 5 times 
the difference in coordinates.  This command is typically associated with 
mouse motion events in the widget, to produce the effect of dragging the 
list at high speed through the window.  The return value is an empty string. 

=back

=over 1

=item I<$table>-E<gt>B<see>(I<index>)

Adjust the view in the table so that the cell given 
by I<index > is positioned as the cell one off from top left (excluding title 
rows and columns) if the cell is not currently visible on the screen.  
The actual cell may be different to keep the screen full. 

=item I<$table>-E<gt>B<selection>(I<option, arg>)

This command is used to adjust the selection within a table. 
 It has several forms, depending on I<option >:  

=back

=over 2

=item I<$table>-E<gt>B<selectionAnchor>(I<index>)

Sets the selection anchor to the cell given by I<index >.  The selection 
anchor is the end of the selection that is fixed while dragging out a 
selection with the mouse.  The index B<anchor > may be used to refer to the 
anchor cell. 

=item I<$table>-E<gt>B<selectionClear>(I<first>?I<last>?)

If any of the cells 
between I<first > and I<last > (inclusive) are selected, they are deselected. 
 The selection state is not changed for cells outside this range.  I<first > may be specified as B<all > to remove the selection from all cells. 

=item I<$table>-E<gt>B<selectionIncludes>(I<index>)

Returns 1 if the cell indicated by I<index > 
is currently selected, 0 if it isn't. 

=item I<$table>-E<gt>B<selectionSet>(I<first>, ?I<last>?)

Selects all of the cells in the range between I<first > and I<last >, inclusive, 
without affecting the selection state of cells outside that range.  

=back

perltk note this needs to be perlized

=over 1

=item I<$table>-E<gt>B<set>(?I<row|col>?, I<index>, ?I<value>?, ?I<index, value, ...>?)



Sets the specified index 
to the associated value.  Table validation will not be triggered via this 
method.  If B<row > or B<col > precedes the list of index/value pairs, then the 
value is assumed to be a Tcl list whose values will be split and set into 
the subsequent columns (if B<row > is specified) or rows (for B<col >).  For 
example, B< set row 2,3 {2,3 2,4 2,5} > will set 3 cells, from 2,3 to 2,5. 
The setting of cells is silently bounded by the known table dimensions. 

=item I<$table>-E<gt>B<spans>(?I<index>?, ?I<rows,cols, index, rows,cols, ...>?)

This command is 
used to manipulate row/col spans.  When called with no arguments, all known 
spans are returned as a list of tuples of the form {index span}.  When 
called with only the I<index >, the span for that I<index > only is returned, 
if any.  Otherwise an even number of I<index rows,cols > pairs are used to 
set spans.  A span starts at the I<index > and continues for the specified 
number of rows and cols. Negative spans are not supported.  A span of 0,0 
unsets any span on that cell.  See EXAMPLES for more info. 

=item I<$table>-E<gt>B<tag>(option, ?I<arg, arg, ...>?)

This command is used to manipulate tags.  The exact 
behavior of the command depends on the I<option > argument that follows the 
B<tag > argument. I<cget >, I<cell >, and I<row|col > complain about unknown tag names. 
The following forms of the command are currently supported:  

=back

=over 2

=item I<$table>-E<gt>B<tagCell>(I<tagName, ?index, ...?>)

With no arguments, prints out the list of cells that use the I<tag>.
Otherwise it sets the specified cells to use the named tag, replacing any
tag that may have been set using this method before.  If I<tagName> is
'', the cells are reset to the default I<tag>.  Tags added during
-*tagcommand evaluation do not register here.  If I<tagName> does
not exist, it will be created with the default options.

=item I<$table>-E<gt>B<tagCget>(I<tagName, option>)

This command returns the current value of the option 
named I<option > associated with the tag given by I<tagName >.  I<Option > may have 
any of the values accepted by the B<tag configure > widget command. 

=item I<$table>-E<gt>B<tagCol>(I<tagName, ?col, ...?>)

With no arguments, prints out the list of cols that use the I<tag>.
Otherwise it sets the specified columns to use the named tag, replacing any
tag that may have been set using this method before.  If <tagName> is
'', the cols are reset to the default I<tag>.  Tags added during
-coltagcommand evaluation do not register here.  If I<tagName> does
not exist, it will be created with the default options.

=item I<$table>-E<gt>B<tagConfigure>(I<tagName>, ?I<option>?, ?I<value>?, ?I<option, value, ...>?)

This command is similar 
to the B<configure > widget command except that it modifies options associated 
with the tag given by I<tagName > instead of modifying options for the overall 
table widget.  If no I<option > is specified, the command returns a list describing 
all of the available options for I<tagName > (see B<Tk_ConfigureInfo > for information 
on the format of this list).  If I<option > is specified with no I<value >, then 
the command returns a list describing the one named option (this list 
will be identical to the corresponding sublist of the value returned if 
no I<option > is specified).  If one or more I<option-value > pairs are specified, 
then the command modifies the given option(s) to have the given value(s) 
in I<tagName >; in this case the command returns an empty string. See TAGS 
above for details on the options available for tags. 

=item I<$table>-E<gt>B<tagDelete>(I<tagName>)

Deletes a tag.  No error if the tag does not exist. 

=item I<$table>-E<gt>B<tagExists>(I<tagName>)

Returns 1 if the named tag exists, 0 otherwise. 

=item I<$table>-E<gt>B<tagIncludes>(I<tagName, index>)

Returns 1 if the specified index has the 
named tag, 0 otherwise. 

=item I<$table>-E<gt>B<tagLower>(I<tagName, ?belowThis?>)

Lower the priority of the named tag.  If I<belowThis> is not specified,
then the tag's priority is lowered to the bottom, otherwise it is lowered
to one below I<belowThis>.

=item I<$table>-E<gt>B<tagNames>(?I<pattern>?)

If no pattern is 
specified, shows the names of all defined tags. Otherwise the I<pattern > 
is used as a glob pattern to show only tags matching that pattern. 
Tag names are returned in priority order
(highest priority tag first).

=item I<$table>-E<gt>B<tagRaise>(I<tagName, ?aboveThis?>)

Raise the priority of the named tag.  If I<aboveThis> is not specified,
then the tag's priority is raised to the top, otherwise it is raised to
one above I<aboveThis>.


=item I<$table>-E<gt>B<tagRow>(I<tagName, ?row, ...?>)

With no arguments, prints out the list of rows that use the I<tag>.
Otherwise it sets the specified columns to use the named tag, replacing any
tag that may have been set using this method before.  If I<tagName> is
'', the rows are reset to use the default tag.  Tags added during
-rowtagcommand evaluation do not register here.  If I<tagName> does
not exist, it will be created with the default options.

=back

=over 1

=item I<$table>-E<gt>B<validate>(I<index>)

Explicitly validates the specified index based on the 
current B<-validatecommand > and returns 0 or 1 based on whether the cell 
was validated. 


=item I<$table>-E<gt>B<window>(option, ?I<arg, arg, ...>?)

This command is used to 
manipulate embedded windows.  The exact behavior of the command depends 
on the I<option > argument that follows the B<window > argument.  The following 
forms of the command are currently supported:  

=back

=over 2

=item I<$table>-E<gt>B<windowCget>(I<index, option>)

This command returns the current value of the option named I<option > associated with the window given by I<index >.  I<Option > may have any of the 
values accepted by the B<window configure > widget command. 

=item I<$table>-E<gt>B<windowConfigure>(I<index>, ?I<option>?, ?I<value>?, ?I<option, value, ...>?)

This command is 
similar to the B<configure > widget command except that it modifies options 
associated with the embedded window given by I<index > instead of modifying 
options for the overall table widget.  If no I<option > is specified, the 
command returns a list describing all of the available options for I<index 
> (see B<Tk_ConfigureInfo > for information on the format of this list).  If 
I<option > is specified with no I<value >, then the command returns a list describing 
the one named option (this list will be identical to the corresponding 
sublist of the value returned if no I<option > is specified).  If one or more 
I<option-value > pairs are specified, then the command modifies the given 
option(s) to have the given value(s) in I<index >; in this case the command 
returns an empty string. See EMBEDDED WINDOWS above for details on the 
options available for windows. 

=item I<$table>-E<gt>B<windowDelete>(I<index>, ?I<index, ...>?)

Deletes an embedded window from the table.  The associated window will 
also be deleted. 

=item I<$table>-E<gt>B<windowMove>(I<indexFrom, indexTo>)

Moves an embedded 
window from one cell to another.  If a window already exists in the target 
cell, it will be deleted. 

=item I<$table>-E<gt>B<windowNames>(?I<pattern>?)

If no pattern 
is specified, shows the cells of all embedded windows. Otherwise the I<pattern> is used as a glob pattern to show only cells matching that pattern.  

=back

=over 1

=item I<$table>-E<gt>B<xview>(I<args>)

This command is used to query and change the horizontal position 
of the information in the widget's window.  It can take any of the following 
forms:  

=item I<$table>-E<gt>B<xview>()

Returns a list containing two elements. Each element 
is a real fraction between 0 and 1;  together they describe the horizontal 
span that is visible in the window. For example, if the first element is 
.2 and the second element is .6, 20% of the table's text is off-screen to 
the left, the middle 40% is visible in the window, and 40% of the text 
is off-screen to the right. These are the same values passed to scrollbars 
via the B<-xscrollcommand > option. 

=item I<$table>-E<gt>B<xview>(I<index>)

Adjusts the view 
in the window so that the column given by I<index > is displayed at the left 
edge of the window. 

=item I<$table>-E<gt>B<xviewMoveto>(I<fraction>)

Adjusts the view in 
the window so that I<fraction > of the total width of the table text is off-screen 
to the left. I<fraction > must be a fraction between 0 and 1. 

=item I<$table>-E<gt>B<xviewScroll>(I<number, what>)

This command shifts the view in the window left or 
right according to I<number > and I<what >. I<Number > must be an integer. I<What > 
must be either B<units > or B<pages > or an abbreviation of one of these. If 
I<what > is B<units >, the view adjusts left or right by I<number > cells  
on the display;  if it is B<pages > then 
the view adjusts by I<number > screenfuls. If I<number > is negative then cells 
farther to the left become visible;  if it is positive then cells 
farther to the right become visible.  

=item I<$table>-E<gt>B<yview>(I<?args>?)

This command 
is used to query and change the vertical position of the text in the widget's 
window.  It can take any of the following forms:  

=back

=over 2

=item I<$table>-E<gt>B<yview>()

Returns 
a list containing two elements, both of which are real fractions between 
0 and 1.  The first element gives the position of the table element at 
the top of the window, relative to the table as a whole (0.5 means it is 
halfway through the table, for example).  The second element gives the 
position of the table element just after the last one in the window, relative 
to the table as a whole.  These are the same values passed to scrollbars 
via the B<-yscrollcommand > option. 

=item I<$table>-E<gt>B<yview>(I<index>)

Adjusts the view 
in the window so that the row given by I<index > is displayed at the top 
of the window. 

=item I<$table>-E<gt>B<yviewMoveto>(I<fraction>)

Adjusts the view in the 
window so that the element given by I<fraction > appears at the top of the 
window. I<Fraction > is a fraction between 0 and 1;  0 indicates the first 
element in the table, 0.33 indicates the element one-third the way through 
the table, and so on. 

=item I<$table>-E<gt>B<yviewscroll>(I<number, what>)

This command 
adjusts the view in the window up or down according to I<number > and I<what >.  I<Number > must be an integer.  I<What > must be either B<units > or B<pages >.  If 
I<what > is B<units >, the view adjusts up or down by I<number > cells; if it is 
B<pages > then the view adjusts by I<number > screenfuls.  If I<number > is negative 
then earlier elements become visible; if it is positive then later elements 
become visible.   

=back

=back

=head1 Default Bindings 

The initialization creates class bindings 
that give the following default behaviour: 

=over 1

=item [1] 

Clicking Button-1 in a cell 
activates that cell.  Clicking into an already active cell moves the insertion 
cursor to the character nearest the mouse. 

=item [2] 

Moving the mouse while Button-1 
is pressed will stroke out a selection area. Exiting while Button-1 is pressed 
causing scanning to occur on the table along with selection. 

=item [3] 

Moving 
the mouse while Button-2 is pressed causes scanning to occur without any 
selection. 

=item [4] 

Home moves the table to have the origin in view. 

=item [5] 

End 
moves the table to have the B<end > cell in view. 

=item [6] 

Control-Home moves the 
table to the origin and activates that cell. 

=item [7] 

Control-End moves the table 
to the end and activates that cell. 

=item [8] 

Shift-Control-Home extends the selection 
to the origin. 

=item [9] 

Shift-Control-End extends the selection to the end. 

=item [10] 


The left, right, up and down arrows move the active cell. 

=item [11] 

Shift-<arrow> 
extends the selection in that direction. 

=item [12] 

Control-leftarrow and Control-rightarrow 
move the insertion cursor within the cell. 

=item [13] 

Control-slash selects all 
the cells. 

=item [14] 

Control-backslash clears selection from all the cells. 

=item [15] 


Backspace deletes the character before the insertion cursor in the active 
cell. 

=item [16] 

Delete deletes the character after the insertion cursor in the 
active cell. 

=item [17] 

Escape rereads the value of the active cell from the 
specified data source, discarding any edits that have may been performed 
on the cell. 

=item [18] 

Control-a moves the insertion cursor to the beginning 
of the active cell. 

=item [19] 

Control-e moves the insertion cursor to the end 
of the active cell. 

=item [20] 

Control-minus and Control-equals decrease and increase 
the width of the column with the active cell in it. 

=item [21] 

Moving the mouse 
while Button-3 (the right button on Windows) is pressed while you are over 
a border will cause interactive resizing of that row and/or column to 
occur, based on the value of B<-resizeborders >. Some bindings may have slightly 
different behavior dependent on the B<-selectionmode > of the widget. If the 
widget is disabled using the B<-state > option, then its view can still be 
adjusted and cells can still be selected, but no insertion cursor will 
be displayed and no cell modifications will take place. The behavior of 
tables can be changed by defining new bindings for individual widgets 
or by redefining the class bindings.  The default bindings are either compiled 
in the TableMatrix.pm file 

=back 

=head1 Performance Issues 

The number of rows 
and columns or a table widget should not significantly affect the speed 
of redraw.  Recalculation and redraw of table parameters and cells is restricted 
as much as possible. The display cell with the insert cursor is redrawn 
each time the cursor blinks, which causes a steady stream of graphics 
traffic.  Set the B<-insertofftime > option to 0 avoid this.  The use of a B<-command>
with the table without a cache can cause significant slow-down, as the 
command is called once for each request of a cell value.  



=head1 Examples 

Set 
the topleft title area to be one spanning cell.  This overestimates both 
row and column span by one, but the command does all the constraining 
for us.  B<$table span [$table cget -roworigin],[$table cget -colorigin] [$table 
cget -titlerows],[$table cget -titlecols]  >Force a table window refresh 
(useful for the slight chance that a bug in the table is not causing proper 
refresh):  B<$table configure -padx [$table cget -padx]  > 


=head1 Keywords 

table, 
widget, extension