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 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
|
#==============================================================================
# Contains the implementation of the plainnotebook widget.
#
# Structure of the module:
# - Namespace initialization
# - Private procedure creating the default bindings
# - Public procedure creating a new plainnotebook widget
# - Private configuration procedures
# - Private procedures implementing the plainnotebook widget command
# - Private procedures used in bindings
# - Private utility procedures
#
# Copyright (c) 2021-2024 Csaba Nemethi (E-mail: csaba.nemethi@t-online.de)
#==============================================================================
#
# Namespace initialization
# ========================
#
namespace eval scrollutil::pnb {
#
# The array configSpecs is used to handle configuration options. The names
# of its elements are the configuration options for the Plainnotebook
# class. The value of an array element is a list containing the database
# name and class as well as an indicator specifying the widget to which the
# option applies: f stands for the outer frame, n for the notebook child,
# and w for the plainnotebook widget itself.
#
# Command-Line Name {Database Name Database Class W}
# ----------------------------------------------------------
#
variable configSpecs
array set configSpecs {
-caller {caller Caller w}
-closabletabs {closableTabs ClosableTabs w}
-cursor {cursor Cursor f}
-forgetcommand {forgetCommand ForgetCommand w}
-height {height Height n}
-leavecommand {leaveCommand LeaveCommand w}
-movabletabs {movableTabs MovableTabs w}
-side {side Side w}
-takefocus {takeFocus TakeFocus f}
-title {title Title w}
-width {width Width n}
}
#
# Extend the elements of the array configSpecs
#
lappend configSpecs(-caller) -1
lappend configSpecs(-closabletabs) 0
lappend configSpecs(-cursor) ""
lappend configSpecs(-forgetcommand) ""
lappend configSpecs(-height) 0
lappend configSpecs(-leavecommand) ""
lappend configSpecs(-movabletabs) 1
lappend configSpecs(-side) left
lappend configSpecs(-takefocus) "ttk::takefocus"
lappend configSpecs(-title) ""
lappend configSpecs(-width) 0
variable configOpts [lsort [array names configSpecs]]
#
# Use a list to facilitate the handling of command options
#
variable cmdOpts [list add addbutton addlabel addseparator adjustsize \
attrib cget closablestate configure forget hasattrib \
hastabattrib hide index insert insertbutton insertlabel \
insertseparator instate see select state style \
tab tabattrib tabpath tabs titlepath unsetattrib \
unsettabattrib]
#
# Array variable used in binding scripts for the tag PnbTab:
#
variable stateArr
array set stateArr {
closebtnPressed 0
sourceIdx ""
targetIdx ""
}
variable userDataSupported [expr {$::tk_version >= 8.5 &&
[package vcompare $::tk_patchLevel "8.5a2"] >= 0}]
#
# Create the descend element
#
proc createDescendElement {} {
::scrollutil::createDescendImages
set width [expr {[image width scrollutil_descendImg] +
[winfo pixels . 6p]}]
ttk::style element create descend image [list scrollutil_descendImg \
disabled scrollutil_descendDisabledImg \
] -width $width -sticky e
}
ttk::style theme settings default {
if {[lsearch -exact [ttk::style element names] "descend"] < 0} {
createDescendElement
}
}
#
# Create the Desc.Toolbutton layout
#
proc createDescToolbuttonLayout {} {
set toolbtnLayout [ttk::style layout Toolbutton]
set oldStr1 "Toolbutton.label -sticky nswe"
set oldStr2 "Toolbutton.label -expand 1 -sticky nswe"
set newStr "Toolbutton.label -side left -sticky {}\
Toolbutton.descend -side right -sticky {}"
foreach oldStr [list $oldStr1 $oldStr2] {
if {[set first [string first $oldStr $toolbtnLayout]] >= 0} {
set last [expr {$first + [string length $oldStr] - 1}]
ttk::style layout Desc.Toolbutton \
[string replace $toolbtnLayout $first $last $newStr]
return 1
}
}
return 0
}
createDescToolbuttonLayout
#
# Create the closebtn element
#
proc createClosebtnElement {} {
::scrollutil::createCloseImages
#
# The "user*" states are not supported by
# Tk versions earlier than 8.5.9 or 8.6b1.
#
variable user1 "user1" user2 "user2"
if {[package vsatisfies $::tk_patchLevel 8-8.5.9] ||
[package vsatisfies $::tk_patchLevel 8.6-8.6b1]} {
set user1 "readonly"
set user2 "invalid"
}
set width [expr {[image width scrollutil_closeImg] +
[winfo pixels . 3p]}]
set sticky [expr {[tk windowingsystem] eq "aqua" ? "w" : "e"}]
ttk::style element create closebtn image [list scrollutil_closeImg \
$user2 scrollutil_closePressedImg \
$user1 scrollutil_closeHoverImg \
disabled scrollutil_closeDisabledImg \
] -width $width -sticky $sticky
}
ttk::style theme settings default {
if {[lsearch -exact [ttk::style element names] "closebtn"] < 0} {
createClosebtnElement
}
}
#
# Create the ClosablePage.Toolbutton layout
#
proc createClosablePageToolbuttonLayout {} {
set toolbtnLayout [ttk::style layout Toolbutton]
set oldStr1 "Toolbutton.label -sticky nswe"
set oldStr2 "Toolbutton.label -expand 1 -sticky nswe"
if {[tk windowingsystem] eq "aqua"} {
set newStr "Toolbutton.closebtn -side left -sticky {}\
Toolbutton.label -side left -sticky {}"
} else {
set newStr "Toolbutton.label -side left -sticky {}\
Toolbutton.closebtn -side right -sticky {}"
}
foreach oldStr [list $oldStr1 $oldStr2] {
if {[set first [string first $oldStr $toolbtnLayout]] >= 0} {
set last [expr {$first + [string length $oldStr] - 1}]
ttk::style layout ClosablePage.Toolbutton \
[string replace $toolbtnLayout $first $last $newStr]
return 1
}
}
return 0
}
createClosablePageToolbuttonLayout
#
# Create a font for titles and labels
#
proc createTitleFont {} {
set size [font actual TkDefaultFont -size]
if {$size == 0} {
set size 9
}
set factor [expr {$size * 6}]
set size [expr {$factor / 5}]
if {$factor % 5 > 2} {
incr size
}
variable titleFont \
[eval font create [font actual TkDefaultFont] -size $size]
}
createTitleFont
#
# Configure some styles
#
proc configStyles {} {
#
# Configure the Plainnotebook.TNotebook style
#
ttk::style layout Plainnotebook.TNotebook.Tab null
ttk::style configure Plainnotebook.TNotebook -mintabwidth 0 \
-padding 0 -tabmargins 0
#
# Configure the Desc.Toolbutton, Page.Toolbutton,
# and ClosablePage.Toolbutton styles
#
foreach style {Desc.Toolbutton Page.Toolbutton
ClosablePage.Toolbutton} {
ttk::style configure $style -anchor w -padding 3p
}
switch [mwutil::currentTheme] {
alt -
classic -
default {
set lst [linsert [ttk::style map Toolbutton -background] 0 \
selected #c3c3c3]
ttk::style map Page.Toolbutton -background $lst
ttk::style map ClosablePage.Toolbutton -background $lst
}
clam {
set lst [linsert [ttk::style map Toolbutton -background] 2 \
selected #bab5ab]
ttk::style map Page.Toolbutton -background $lst
ttk::style map ClosablePage.Toolbutton -background $lst
set lst [linsert [ttk::style map Toolbutton -lightcolor] 0 \
selected #bab5ab]
ttk::style map Page.Toolbutton -lightcolor $lst
ttk::style map ClosablePage.Toolbutton -lightcolor $lst
set lst [linsert [ttk::style map Toolbutton -darkcolor] 0 \
selected #bab5ab]
ttk::style map Page.Toolbutton -darkcolor $lst
ttk::style map ClosablePage.Toolbutton -darkcolor $lst
}
}
#
# Configure the PnbTitle.TLabel and PnbLabel.TLabel styles
#
variable titleFont
ttk::style configure PnbTitle.TLabel -font $titleFont
ttk::style configure PnbLabel.TLabel -font $titleFont
}
configStyles
variable currentTheme [::mwutil::currentTheme]
}
#
# Private procedure creating the default bindings
# ===============================================
#
#------------------------------------------------------------------------------
# scrollutil::pnb::createBindings
#
# Creates the default bindings for the binding tags Plainnotebook,
# PlainnotebookMain, PnbTab, PnbRadiobtn, PnbMiddleFrame, and PnbContentFrame.
#------------------------------------------------------------------------------
proc scrollutil::pnb::createBindings {} {
bind Plainnotebook <KeyPress> continue
bind Plainnotebook <FocusIn> {
if {[focus -lastfor %W] eq "%W"} {
focus %W.frm.sa.sf
}
}
bind Plainnotebook <Map> { scrollutil::pnb::onPlainnotebookMap %W }
bind Plainnotebook <Destroy> {
namespace delete scrollutil::ns%W
catch {rename %W ""}
}
bind Plainnotebook <<TkWorldChanged>> {
if {"%d" eq "FontChanged"} {
scrollutil::pnb::onFontChanged %W
}
}
bind Plainnotebook <<ThemeChanged>> { scrollutil::pnb::onThemeChanged %W }
bindtags . [linsert [bindtags .] 1 PlainnotebookMain]
foreach event {<<ThemeChanged>> <<LightAqua>> <<DarkAqua>>} {
bind PlainnotebookMain $event {
scrollutil::pnb::onThemeChanged %W
}
}
#
# Add support for moving and closing the plainnotebook tabs with the mouse
#
bind PnbTab <Motion> { scrollutil::pnb::onMotion %W %x %y }
bind PnbTab <Button-1> { scrollutil::pnb::onButton1 %W %x %y }
bind PnbTab <B1-Motion> { scrollutil::pnb::onB1Motion %W %X %Y }
bind PnbTab <Leave> { scrollutil::pnb::onLeave %W }
bind PnbTab <B1-Leave> { scrollutil::pnb::onB1Leave %W }
bind PnbTab <ButtonRelease-1> { scrollutil::pnb::onButtonRel1 %W %x %y }
bind PnbTab <Escape> { scrollutil::pnb::onEscape %W }
#
# Define the virtual event <<Button3>> and create a binding for it
#
event add <<Button3>> <Button-3>
if {[tk windowingsystem] eq "aqua"} {
event add <<Button3>> <Control-Button-1>
}
variable userDataSupported
if {$userDataSupported} {
bind PnbTab <<Button3>> { scrollutil::pnb::onButton3 %W %X %Y }
}
bind PnbRadiobtn <Down> {
scrollutil::pnb::cycleTab [scrollutil::pnb::tabToPnb %W] "" 1; break
}
bind PnbRadiobtn <Up> {
scrollutil::pnb::cycleTab [scrollutil::pnb::tabToPnb %W] "" -1; break
}
bind PnbRadiobtn <Control-Tab> {
scrollutil::pnb::cycleTab [scrollutil::pnb::tabToPnb %W] "" 1; break
}
bind PnbRadiobtn <Control-Shift-Tab> {
scrollutil::pnb::cycleTab [scrollutil::pnb::tabToPnb %W] "" -1; break
}
catch {
bind PnbRadiobtn <Control-ISO_Left_Tab> {
scrollutil::pnb::cycleTab [scrollutil::pnb::tabToPnb %W] "" -1
break
}
}
#
# Implement the navigation between the selectable plainnotebook tabs via
# the mouse wheel (TIP 591). Use our own bindMouseWheel procedure rather
# than ttk::bindMouseWheel, which was not present in tile before Dec. 2008.
#
bind PnbMiddleFrame <Enter> {
set scrollutil::xWheelEvents 0; set scrollutil::yWheelEvents 0
}
::scrollutil::bindMouseWheel PnbTab \
{scrollutil::pnb::cycleTab [scrollutil::pnb::tabToPnb %W]}
::scrollutil::bindMouseWheel PnbMiddleFrame \
{scrollutil::pnb::cycleTab [scrollutil::pnb::mfToPnb %W]}
variable ::scrollutil::touchpadScrollSupport
if {$touchpadScrollSupport} {
bind PnbTab <TouchpadScroll> {
if {%# %% 15 == 0} {
lassign [tk::PreciseScrollDeltas %D] \
scrollutil::dX scrollutil::dY
if {$scrollutil::dY != 0} {
scrollutil::pnb::cycleTab [scrollutil::pnb::tabToPnb %W] \
"" [expr {$scrollutil::dY < 0 ? -1 : 1}]
}
}
}
bind PnbMiddleFrame <TouchpadScroll> {
if {%# %% 15 == 0} {
lassign [tk::PreciseScrollDeltas %D] \
scrollutil::dX scrollutil::dY
if {$scrollutil::dY != 0} {
scrollutil::pnb::cycleTab [scrollutil::pnb::mfToPnb %W] \
"" [expr {$scrollutil::dY < 0 ? -1 : 1}]
}
}
}
}
bind PnbContentFrame <Configure> { scrollutil::pnb::onCfConfigure %W %w }
#
# Override the library procedure ::ttk::notebook::TLCycleTab
#
proc ::ttk::notebook::TLCycleTab {w dir} {
set nb [EnclosingNotebook $w]
if {$nb ne ""} {
if {[winfo class $nb] eq "Plainnotebook"} {
::scrollutil::pnb::cycleTab $nb "" $dir
} else {
CycleTab $nb $dir
}
return -code break
}
}
}
#
# Public procedure creating a new plainnotebook widget
# ====================================================
#
#------------------------------------------------------------------------------
# scrollutil::plainnotebook
#
# Creates a new plainnotebook widget whose name is specified as the first
# command-line argument, and configures it according to the options and their
# values given on the command line. Returns the name of the newly created
# widget.
#------------------------------------------------------------------------------
proc scrollutil::plainnotebook args {
variable usingTile
if {!$usingTile} {
return -code error "package scrollutil_tile is not loaded"
}
variable pnb::configSpecs
variable pnb::configOpts
if {[llength $args] == 0} {
mwutil::wrongNumArgs "plainnotebook pathName ?options?"
}
#
# Create a frame of the class Plainnotebook
#
set win [lindex $args 0]
if {[catch {
ttk::frame $win -class Plainnotebook -borderwidth 0 -relief flat \
-height 0 -width 0 -padding 0
} result] != 0} {
return -code error $result
}
#
# Create a namespace within the current one to hold the data of the widget
#
namespace eval ns$win {
#
# The following array holds various data for this widget
#
variable data
#
# The following array is used to hold arbitrary attributes
# and their values for this widget and its pages
#
variable attribs
}
#
# Initialize some components of data
#
upvar ::scrollutil::ns${win}::data data
foreach opt $configOpts {
set data($opt) [lindex $configSpecs($opt) 3]
}
#
# Create a frame with the ascend toolbutton,
# the title label, and a separator as children
#
set frm [ttk::frame $win.frm -padding 0]
pnb::configFrame $win.frm
if {[lsearch -exact [image names] "scrollutil_ascendImg"] < 0} {
createAscendImage
}
set ascend [ttk::button $frm.ascend -style Toolbutton \
-image scrollutil_ascendImg]
set title [ttk::label $frm.title -style PnbTitle.TLabel]
set sep [ttk::separator $frm.sep]
#
# Create a scrollableframe within a scrollarea,
# which in turn is a child of the above frame
#
set sa [scrollarea $frm.sa -borderwidth 0 -relief flat]
set charWidth [font measure TkDefaultFont -displayof $win "0"]
set sf [scrollableframe $sa.sf -borderwidth 0 -contentheight 0 \
-contentwidth 0 -fitcontentheight 0 -fitcontentwidth 0 -height 0 \
-relief flat -xscrollincrement $charWidth -yscrollincrement 0 \
-width 0]
$sa setwidget $sf
if {$::tcl_platform(platform) ne "windows" || ($::tk_version >= 8.6 &&
[package vcompare $::tk_patchLevel "8.6b2"] >= 0)} {
disableScrollingByWheel $sf
}
grid $ascend -row 0 -column 0 -padx {1.5p 0} -pady 1.5p
grid $title -row 0 -column 1 -sticky w -padx 3p -pady 1.5p
grid $sep -columnspan 2 -sticky we
grid $sa -columnspan 2 -sticky nswe
grid rowconfigure $frm 2 -weight 1
grid columnconfigure $frm 1 -weight 1
grid remove $ascend $title $sep
#
# Create a plain ttk::notebook widget and deactivate
# the TNotebook keyboard bindings for it
#
set nb [ttk::notebook $win.nb -style Plainnotebook.TNotebook]
foreach event {<Right> <Left> <Control-Tab> <Control-Shift-Tab>} {
bind $nb $event break
}
catch {bind $nb <Control-ISO_Left_Tab> break}
pack $frm -side left -fill y
pack $nb -side left -expand 1 -fill both
array set data [list \
sf $sf \
cf [$sf contentframe] \
cfWidth 0 \
rbCount 0 \
auxCount 0 \
currentPage "" \
]
bindtags $sf.mf [linsert [bindtags $sf.mf] 1 PnbMiddleFrame]
bindtags $data(cf) [linsert [bindtags $data(cf)] 1 PnbContentFrame]
#
# Configure the widget according to the command-line
# arguments and to the available database options
#
if {[catch {
mwutil::configureWidget $win configSpecs scrollutil::pnb::doConfig \
scrollutil::pnb::doCget [lrange $args 1 end] 1
} result] != 0} {
destroy $win
return -code error $result
}
#
# Move the original widget command into the namespace pnb within the current
# one and create an alias of the original name for a new widget procedure
#
rename ::$win pnb::$win
interp alias {} ::$win {} scrollutil::pnb::plainnotebookWidgetCmd $win
menu $win._m_e_n_u_ -tearoff 0
#
# Deactivate the navigation between the tabs of the
# plain ttk::notebook widget via the mouse wheel
#
bindMouseWheel $nb break
variable touchpadScrollSupport
if {$touchpadScrollSupport} {
bind $nb <TouchpadScroll> break
}
if {$touchpadScrollSupport} {
#
# Override the (T)Scrollbar class bindings for $sa.vsb
# in order to make sure that <TouchpadScroll> events will
# scroll the scrollableframe by units rather than pixels
#
bind $sa.vsb <TouchpadScroll> {
if {%# %% 5 != 0} {
break
}
lassign [tk::PreciseScrollDeltas %D] scrollutil::dX scrollutil::dY
if {$scrollutil::dY != 0} {
{*}[%W cget -command] scroll [expr {-$scrollutil::dY}] units
}
break
}
}
return $win
}
#
# Private configuration procedures
# ================================
#
#------------------------------------------------------------------------------
# scrollutil::pnb::doConfig
#
# Applies the value val of the configuration option opt to the plainnotebook
# widget win.
#------------------------------------------------------------------------------
proc scrollutil::pnb::doConfig {win opt val} {
variable configSpecs
upvar ::scrollutil::ns${win}::data data
#
# Apply the value to the widget corresponding to the given option
#
switch [lindex $configSpecs($opt) 2] {
f {
#
# Apply the value to the outer frame and save the
# properly formatted value of val in data($opt)
#
$win configure $opt $val
set data($opt) [$win cget $opt]
switch -- $opt {
-cursor {
$win.frm configure $opt $val
$win.nb configure $opt $val
}
}
}
n {
#
# Apply the value to the notebook and save the
# properly formatted value of val in data($opt)
#
$win.nb configure $opt $val
set data($opt) [$win.nb cget $opt]
}
w {
switch -- $opt {
-caller {
##nagelfar ignore
if {![string is integer -strict $val]} {
return -code error "bad page index $val"
}
if {$val >= 0} {
set pm [winfo parent $win]
if {[winfo class $pm] ne "Pagesman"} {
return -code error \
"parent \"$pm\" is not a pagesman widget"
}
if {$val >= [$pm size]} {
return -code error "page index $val out of bounds"
}
$win.frm.ascend configure -command \
[list $pm select $val]
}
set data($opt) $val
if {$val < 0} {
grid remove $win.frm.ascend
} else {
grid $win.frm.ascend
}
if {$val < 0 && $data(-title) eq ""} {
grid remove $win.frm.sep
} else {
grid $win.frm.sep
}
}
-closabletabs {
set data($opt) [expr {$val ? 1 : 0}]
set data(rbStyle) [expr {
$val ? "ClosablePage.Toolbutton" : "Page.Toolbutton"}]
foreach w [winfo children $data(cf)] {
if {[winfo class $w] eq "TRadiobutton"} {
$w configure -style $data(rbStyle)
}
}
}
-forgetcommand -
-leavecommand {
set data($opt) $val
}
-movabletabs {
set data($opt) [expr {$val ? 1 : 0}]
}
-side {
set side [mwutil::fullOpt "side" $val {left right}]
set data($opt) $side
pack forget $win.frm $win.nb
pack $win.frm -side $side -fill y
pack $win.nb -side $side -expand 1 -fill both
}
-title {
set data($opt) $val
$win.frm.title configure -text $val
if {$val eq ""} {
grid remove $win.frm.title
} else {
grid $win.frm.title
}
if {$data(-caller) < 0 && $val eq ""} {
grid remove $win.frm.sep
} else {
grid $win.frm.sep
}
}
}
}
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::doCget
#
# Returns the value of the configuration option opt for the plainnotebook
# widget win.
#------------------------------------------------------------------------------
proc scrollutil::pnb::doCget {win opt} {
upvar ::scrollutil::ns${win}::data data
return $data($opt)
}
#
# Private procedures implementing the plainnotebook widget command
# ================================================================
#
#------------------------------------------------------------------------------
# scrollutil::pnb::plainnotebookWidgetCmd
#
# Processes the Tcl command corresponding to a plainnotebook widget.
#------------------------------------------------------------------------------
proc scrollutil::pnb::plainnotebookWidgetCmd {win args} {
set argCount [llength $args]
if {$argCount == 0} {
mwutil::wrongNumArgs "$win option ?arg arg ...?"
}
upvar ::scrollutil::ns${win}::data data
set nb $win.nb
variable cmdOpts
set cmd [mwutil::fullOpt "command" [lindex $args 0] $cmdOpts]
set argList [lrange $args 1 end]
switch $cmd {
add {
set widget [lindex $args 1]
set tabIdx [lsearch -exact [$nb tabs] $widget]
if {[set isNew [expr {$tabIdx < 0}]]} {
set tabIdx [$nb index end]
}
if {[catch {eval [list $nb $cmd] $argList} result] != 0} {
return -code error $result
}
if {$isNew} {
set rb [ttk::radiobutton $data(cf).rb$data(rbCount) \
-style $data(rbStyle) \
-command [list $nb select $widget] -value $widget \
-variable ::scrollutil::ns${win}::data(selectedPage)]
incr data(rbCount)
set tabPath $rb
bindtags $rb [linsert [bindtags $rb] 1 PnbTab PnbRadiobtn]
} else {
set tabPath [widgetToTab $win $widget]
}
configTab $win $tabIdx $tabPath
return $tabPath
}
addbutton {
if {$argCount < 3 || $argCount > 4} {
mwutil::wrongNumArgs "$win $cmd pageIndex text ?image?"
}
set pm [winfo parent $win]
if {[winfo class $pm] ne "Pagesman"} {
return -code error "\"$pm\" is not a pagesman widget"
}
foreach {pageIdx text img} $argList {}
##nagelfar ignore
if {![string is integer -strict $pageIdx] || $pageIdx < 0} {
return -code error "bad page index $pageIdx"
}
if {$img ne "" && [lsearch -exact [image names] $img] < 0} {
return -code error "image \"$img\" doesn't exist"
}
set name aux$data(auxCount)
$nb add [ttk::frame $nb.$name] -compound left -text $text \
-image $img -state disabled
set aux [ttk::button $data(cf).$name -style Desc.Toolbutton \
-takefocus 0 -compound left -text $text -image $img \
-command [list $pm select $pageIdx]]
grid $aux -sticky we
incr data(auxCount)
bindtags $aux [linsert [bindtags $aux] 1 PnbTab]
return $aux
}
addlabel {
if {$argCount < 2 || $argCount > 3} {
mwutil::wrongNumArgs "$win $cmd text ?image?"
}
foreach {text img} $argList {}
if {$img ne "" && [lsearch -exact [image names] $img] < 0} {
return -code error "image \"$img\" doesn't exist"
}
set name aux$data(auxCount)
$nb add [ttk::frame $nb.$name] -compound left -text $text \
-image $img -state disabled
set aux [ttk::label $data(cf).$name -style PnbLabel.TLabel \
-takefocus 0 -compound left -text $text -image $img \
-padding 3p]
grid $aux -sticky we
incr data(auxCount)
bindtags $aux [linsert [bindtags $aux] 1 PnbTab]
return $aux
}
addseparator {
if {$argCount != 1} {
mwutil::wrongNumArgs "$win $cmd"
}
set name aux$data(auxCount)
$nb add [ttk::frame $nb.$name] -state disabled
set aux [ttk::separator $data(cf).$name -takefocus 0]
grid $aux -sticky we
incr data(auxCount)
bindtags $aux [linsert [bindtags $aux] 1 PnbTab]
return $aux
}
attrib {
return [::scrollutil::attribSubCmd $win "widget" $argList]
}
cget {
if {$argCount != 2} {
mwutil::wrongNumArgs "$win $cmd option"
}
#
# Return the value of the specified configuration option
#
variable configSpecs
set opt [mwutil::fullConfigOpt [lindex $args 1] configSpecs]
return $data($opt)
}
closablestate {
if {$argCount < 2 || $argCount > 3} {
mwutil::wrongNumArgs "$win $cmd tabId ?boolean?"
}
set tabId [lindex $args 1]
if {[catch {::$win index $tabId} tabIdx] != 0} {
return -code error $tabIdx
} elseif {$tabIdx < 0 || $tabIdx >= [$nb index end]} {
return -code error "tab index $tabId out of bounds"
}
set widget [lindex [$nb tabs] $tabIdx]
set tabPath [widgetToTab $win $widget]
if {$argCount == 2} {
return [expr {
[$tabPath cget -style] eq "ClosablePage.Toolbutton"}]
} else {
set val [expr {[lindex $args 2] ? 1 : 0}]
set tabClass [winfo class $tabPath]
if {$tabClass eq "TRadiobutton"} {
$tabPath configure -style [expr {
$val ? "ClosablePage.Toolbutton" : "Page.Toolbutton"}]
return ""
} else {
return -code error \
"unsupported tab widget class \"$tabClass\""
}
}
}
configure {
variable configSpecs
return [mwutil::configureSubCmd $win configSpecs \
scrollutil::pnb::doConfig scrollutil::pnb::doCget $argList]
}
forget {
if {$argCount != 2} {
mwutil::wrongNumArgs "$win $cmd tab"
}
if {[catch {::$win index [lindex $args 1]} tabIdx] == 0 &&
$tabIdx >= 0 && $tabIdx < [$nb index end]} {
set widget [lindex [$nb tabs] $tabIdx]
set tabPath [widgetToTab $win $widget]
if {[set forgetCmd $data(-forgetcommand)] ne "" &&
![uplevel #0 $forgetCmd [list $win $widget]]} {
return 0
}
}
if {[catch {eval [list $nb $cmd] $argList} result] != 0} {
return -code error $result
}
upvar ::scrollutil::ns${win}::attribs attribs
array unset attribs $widget-*
destroy $tabPath
return 1
}
hasattrib -
unsetattrib {
if {$argCount != 2} {
mwutil::wrongNumArgs "$win $cmd name"
}
return [::scrollutil::${cmd}SubCmd $win "widget" [lindex $args 1]]
}
hastabattrib -
unsettabattrib {
if {$argCount != 3} {
mwutil::wrongNumArgs "$win $cmd tab name"
}
set tabId [lindex $args 1]
if {[catch {::$win index $tabId} tabIdx] != 0} {
return -code error $tabIdx
} elseif {$tabIdx < 0 || $tabIdx >= [$nb index end]} {
return -code error "tab index $tabId out of bounds"
}
set first [string first "tab" $cmd]
set last [expr {$first + 2}]
set cmd [string replace $cmd $first $last] ;# (has|unset)attrib
set widget [lindex [$nb tabs] $tabIdx]
return [::scrollutil::${cmd}SubCmd $win $widget [lindex $args 2]]
}
hide {
if {[catch {::$win index [lindex $args 1]} tabIdx] == 0 &&
$tabIdx >= 0 && $tabIdx < [$nb index end]} {
set widget [lindex [$nb tabs] $tabIdx]
set tabPath [widgetToTab $win $widget]
}
if {[catch {eval [list $nb $cmd] $argList} result] != 0} {
return -code error $result
}
grid remove $tabPath
return ""
}
index {
if {$argCount != 2} {
mwutil::wrongNumArgs "$win $cmd tab"
}
set tabId [lindex $args 1]
##nagelfar ignore
if {[scan $tabId "@%d,%d%n" x y count] == 3 &&
$count == [string length $tabId]} {
set cf $data(cf)
incr x [expr {[winfo rootx $win] - [winfo rootx $cf]}]
incr y [expr {[winfo rooty $win] - [winfo rooty $cf]}]
if {$x < 0 || $x >= [winfo width $cf] ||
$y < 0 || $y >= [winfo height $cf]} {
return ""
}
set tabIdx 0
foreach widget [$win.nb tabs] {
set tabPath [widgetToTab $win $widget]
set tabY [winfo y $tabPath]
if {$y >= $tabY && $y < $tabY + [winfo height $tabPath]} {
return $tabIdx
}
incr tabIdx
}
return ""
} else {
set code [catch {$nb $cmd $tabId} result]
return -code $code $result
}
}
insert {
set widget [lindex $args 2]
set isNew [expr {[lsearch -exact [$nb tabs] $widget] < 0}]
if {[catch {eval [list $nb $cmd] $argList} result] != 0} {
return -code error $result
}
if {$isNew} {
set rb [ttk::radiobutton $data(cf).rb$data(rbCount) \
-style $data(rbStyle) \
-command [list $nb select $widget] -value $widget \
-variable ::scrollutil::ns${win}::data(selectedPage)]
incr data(rbCount)
set tabPath $rb
bindtags $rb [linsert [bindtags $rb] 1 PnbTab PnbRadiobtn]
} else {
set tabPath [widgetToTab $win $widget]
}
reorderTabs $win
configTab $win [$nb index $widget] $tabPath
return $tabPath
}
insertbutton {
if {$argCount < 4 || $argCount > 5} {
mwutil::wrongNumArgs "$win $cmd index pageIndex text ?image?"
}
set pos [lindex $args 1]
if {$pos eq "end"} {
set tabIdx end
} elseif {[catch {::$win index $pos} tabIdx] != 0} {
return -code error $tabIdx
} elseif {$tabIdx < 0} {
return -code error "tab index $pos out of bounds"
}
set pm [winfo parent $win]
if {[winfo class $pm] ne "Pagesman"} {
return -code error "\"$pm\" is not a pagesman widget"
}
foreach {pageIdx text img} [lrange $args 2 end] {}
##nagelfar ignore
if {![string is integer -strict $pageIdx] || $pageIdx < 0} {
return -code error "bad page index $pageIdx"
}
if {$img ne "" && [lsearch -exact [image names] $img] < 0} {
return -code error "image \"$img\" doesn't exist"
}
set name aux$data(auxCount)
$nb insert $tabIdx [ttk::frame $nb.$name] -compound left \
-text $text -image $img -state disabled
set aux [ttk::button $data(cf).$name -style Desc.Toolbutton \
-takefocus 0 -compound left -text $text -image $img \
-command [list $pm select $pageIdx]]
incr data(auxCount)
bindtags $aux [linsert [bindtags $aux] 1 PnbTab]
reorderTabs $win
return $aux
}
insertlabel {
if {$argCount < 3 || $argCount > 4} {
mwutil::wrongNumArgs "$win $cmd index text ?image?"
}
set pos [lindex $args 1]
if {$pos eq "end"} {
set tabIdx end
} elseif {[catch {::$win index $pos} tabIdx] != 0} {
return -code error $tabIdx
} elseif {$tabIdx < 0} {
return -code error "tab index $pos out of bounds"
}
foreach {text img} [lrange $args 2 end] {}
if {$img ne "" && [lsearch -exact [image names] $img] < 0} {
return -code error "image \"$img\" doesn't exist"
}
set name aux$data(auxCount)
$nb insert $tabIdx [ttk::frame $nb.$name] -compound left \
-text $text -image $img -state disabled
set aux [ttk::label $data(cf).$name -style PnbLabel.TLabel \
-takefocus 0 -compound left -text $text -image $img \
-padding 3p]
incr data(auxCount)
bindtags $aux [linsert [bindtags $aux] 1 PnbTab]
reorderTabs $win
return $aux
}
insertseparator {
if {$argCount != 2} {
mwutil::wrongNumArgs "$win $cmd index"
}
set pos [lindex $args 1]
if {$pos eq "end"} {
set tabIdx end
} elseif {[catch {::$win index $pos} tabIdx] != 0} {
return -code error $tabIdx
} elseif {$tabIdx < 0} {
return -code error "tab index $pos out of bounds"
}
set name aux$data(auxCount)
$nb insert $tabIdx [ttk::frame $nb.$name] -state disabled
set aux [ttk::separator $data(cf).$name -takefocus 0]
incr data(auxCount)
bindtags $aux [linsert [bindtags $aux] 1 PnbTab]
reorderTabs $win
return $aux
}
instate {
if {$argCount < 2 || $argCount > 3} {
mwutil::wrongNumArgs "$win $cmd stateSpec ?script?"
}
set stateSpec [lindex $args 1]
if {$argCount == 2} {
return [$nb instate $stateSpec]
} elseif {[$nb instate $stateSpec]} {
return -code [catch {uplevel 1 [lindex $args 2]}] ""
} else {
return ""
}
}
adjustsize {
if {$argCount != 1} {
mwutil::wrongNumArgs "$win $cmd"
}
return [adjustsizeSubCmd $win]
}
see {
if {$argCount != 2} {
mwutil::wrongNumArgs "$win $cmd tabId"
}
set tabId [lindex $args 1]
if {[catch {::$win index $tabId} tabIdx] != 0} {
return -code error $tabIdx
} elseif {$tabIdx < 0 || $tabIdx >= [$nb index end]} {
return -code error "tab index $tabId out of bounds"
}
set widget [lindex [$nb tabs] $tabIdx]
set tabPath [widgetToTab $win $widget]
$data(sf) see $tabPath
return ""
}
select -
tabs {
set code [catch {eval [list $nb $cmd] $argList} result]
return -code $code $result
}
state {
if {[catch {eval [list $nb $cmd] $argList} result] != 0} {
return -code error $result
}
if {$argCount > 1} {
set stateSpec [expr {
[$nb instate disabled] ? "disabled" : "!disabled"}]
foreach w [list $win.frm.ascend $win.frm.title $win.frm.sep] {
$w state $stateSpec
}
foreach w [winfo children $data(cf)] {
$w state $stateSpec
}
}
return $result
}
style {
if {$argCount != 1} {
mwutil::wrongNumArgs "$win $cmd"
}
return "Plainnotebook.TNotebook"
}
tab {
if {[catch {::$win index [lindex $args 1]} tabIdx] == 0} {
set widget [lindex [$nb tabs] $tabIdx]
if {$widget ne ""} {
set tabPath [widgetToTab $win $widget]
set tabClass [winfo class $tabPath]
}
}
if {[catch {eval [list $nb $cmd] $argList} result] != 0} {
return -code error $result
}
if {$argCount == 2} {
set idx [expr {[lsearch -exact $result "-state"] + 1}]
set state [lindex $result $idx]
if {$state eq "disabled" && $tabClass ne "TRadiobutton"} {
set state [expr {[$tabPath instate disabled] ?
"disabled" : "normal"}]
set result [lreplace $result $idx $idx $state]
}
} elseif {$argCount == 3 &&
[string match "-sta*" [lindex $args 2]]} {
set state [$nb tab $tabIdx -state]
if {$state eq "disabled" && $tabClass ne "TRadiobutton"} {
set result [expr {[$tabPath instate disabled] ?
"disabled" : "normal"}]
}
} elseif {$argCount > 3} {
if {$tabClass ne "TRadiobutton"} {
foreach {opt val} [lrange $args 2 end] {
if {[string match "-sta*" $opt]} {
set state [mwutil::fullOpt "state" $val \
{normal disabled hidden}]
if {$state ne "hidden"} {
set state [expr {$state eq "disabled" ?
"disabled" : "!disabled"}]
$tabPath state $state
}
}
}
}
configTab $win $tabIdx $tabPath
}
return $result
}
tabattrib {
if {$argCount < 2} {
mwutil::wrongNumArgs \
"$win $cmd tab ?name ?value name value ...??"
}
set tabId [lindex $args 1]
if {[catch {::$win index $tabId} tabIdx] != 0} {
return -code error $tabIdx
} elseif {$tabIdx < 0 || $tabIdx >= [$nb index end]} {
return -code error "tab index $tabId out of bounds"
}
set widget [lindex [$nb tabs] $tabIdx]
return [::scrollutil::attribSubCmd $win $widget \
[lrange $args 2 end]]
}
tabpath {
if {$argCount != 2} {
mwutil::wrongNumArgs "$win $cmd tabId"
}
set tabId [lindex $args 1]
if {[catch {::$win index $tabId} tabIdx] != 0} {
return -code error $tabIdx
} elseif {$tabIdx < 0 || $tabIdx >= [$nb index end]} {
return -code error "tab index $tabId out of bounds"
}
set widget [lindex [$nb tabs] $tabIdx]
return [widgetToTab $win $widget]
}
titlepath {
if {$argCount != 1} {
mwutil::wrongNumArgs "$win $cmd"
}
return $win.frm.title
}
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::adjustsizeSubCmd
#
# Processes the scrollednotebook adjustsize subcommmand.
#------------------------------------------------------------------------------
proc scrollutil::pnb::adjustsizeSubCmd win {
upvar ::scrollutil::ns${win}::data data
set nb $win.nb
set maxWidth 0
foreach widget [$nb tabs] {
set padding [::$win tab $widget -padding]
foreach {l t r b} [mwutil::parsePadding $win $padding] {}
set reqWidth [expr {[winfo reqwidth $widget] + $l + $r}]
if {$reqWidth > $maxWidth} {
set maxWidth $reqWidth
}
}
::$win configure -width $maxWidth
update idletasks
if {![array exists ::scrollutil::ns${win}::data] ||
[winfo class $win] ne "Plainnotebook"} {
return ""
}
set maxHeight 0
foreach widget [$nb tabs] {
set padding [::$win tab $widget -padding]
foreach {l t r b} [mwutil::parsePadding $win $padding] {}
set reqHeight [expr {[winfo reqheight $widget] + $t + $b}]
if {$reqHeight > $maxHeight} {
set maxHeight $reqHeight
}
}
::$win configure -height $maxHeight
return ""
}
#------------------------------------------------------------------------------
# scrollutil::pnb::configTab
#
# Configures the ttk::radiobutton, ttk::button, ttk::label, or ttk::separator
# associated with a given page of the plainnotebook widget win.
#------------------------------------------------------------------------------
proc scrollutil::pnb::configTab {win tabIdx tabPath} {
set tabClass [winfo class $tabPath]
foreach {opt val} [$win.nb tab $tabIdx] {
switch -- $opt {
-compound -
-image -
-text {
if {$tabClass ne "TSeparator"} {
$tabPath configure $opt $val
}
}
-underline {
if {$tabClass eq "TRadiobutton"} {
$tabPath configure $opt $val
}
}
-state {
switch $val {
hidden { grid remove $tabPath }
normal {
if {$tabClass eq "TRadiobutton"} {
$tabPath configure $opt $val
} else {
$win.nb tab $tabIdx -state disabled
}
grid $tabPath -sticky we
}
disabled {
if {$tabClass eq "TRadiobutton"} {
$tabPath configure $opt $val
}
grid $tabPath -sticky we
}
}
}
}
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::reorderTabs
#
# Lays out the tabs of the plainnotebook widget win using grid, in the order of
# the notebook's pages.
#------------------------------------------------------------------------------
proc scrollutil::pnb::reorderTabs win {
upvar ::scrollutil::ns${win}::data data
eval grid forget [grid slaves $data(cf)]
foreach widget [$win.nb tabs] {
set tabPath [widgetToTab $win $widget]
grid $tabPath -sticky we
if {[$win.nb tab $widget -state] eq "hidden"} {
grid remove $tabPath
}
}
}
#
# Private procedures used in bindings
# ===================================
#
#------------------------------------------------------------------------------
# scrollutil::pnb::onPlainnotebookMap
#------------------------------------------------------------------------------
proc scrollutil::pnb::onPlainnotebookMap win {
onNbTabChanged $win.nb 0
bind $win.nb <<NotebookTabChanged>> { scrollutil::pnb::onNbTabChanged %W 1 }
after 100 [list scrollutil::pnb::setYScrollIncr $win]
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onNbTabChanged
#------------------------------------------------------------------------------
proc scrollutil::pnb::onNbTabChanged {nb seeTab} {
set win [winfo parent $nb]
upvar ::scrollutil::ns${win}::data data
#
# Invoke the command specified as the value
# of the -leavecommand option if appropriate
#
set widget [$nb select]
if {$widget ne "" && $widget ne $data(currentPage) &&
[lsearch -exact [$nb tabs] $data(currentPage)] >= 0 &&
[$nb tab $data(currentPage) -state] eq "normal" &&
[set cmd $data(-leavecommand)] ne "" &&
![uplevel #0 $cmd [list $win $data(currentPage)]]} {
#
# Restore the selection to $data(currentPage)
#
bind $nb <<NotebookTabChanged>> {}
$nb select $data(currentPage)
set data(selectedPage) $data(currentPage)
$data(sf) see [widgetToTab $win $data(currentPage)]
after 1 [list scrollutil::pnb::restoreTabChangedBinding $nb]
return ""
}
set data(selectedPage) $widget
if {$widget ne ""} {
#
# Re-manage the radiobutton corresponding to $widget
# because it might have been unmanaged via grid remove
#
set rb [widgetToTab $win $widget]
grid $rb -sticky we
if {$seeTab} {
$data(sf) see $rb
}
}
set data(currentPage) $widget
event generate $win <<NotebookTabChanged>>
}
#------------------------------------------------------------------------------
# scrollutil::pnb::restoreTabChangedBinding
#------------------------------------------------------------------------------
proc scrollutil::pnb::restoreTabChangedBinding nb {
if {![winfo exists $nb] || [winfo class $nb] ne "TNotebook"} {
return ""
}
bind $nb <<NotebookTabChanged>> { scrollutil::pnb::onNbTabChanged %W 1 }
}
#------------------------------------------------------------------------------
# scrollutil::pnb::setYScrollIncr
#------------------------------------------------------------------------------
proc scrollutil::pnb::setYScrollIncr win {
if {[destroyed $win]} {
return ""
}
#
# Set the scrollableframe's yscrollincrement
#
upvar ::scrollutil::ns${win}::data data
set sf $data(sf)
foreach w [grid slaves $data(cf)] {
if {[winfo class $w] eq "TRadiobutton"} {
set rbHeight [winfo reqheight $w]
$sf configure -yscrollincrement $rbHeight
break
}
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onFontChanged
#------------------------------------------------------------------------------
proc scrollutil::pnb::onFontChanged win {
variable titleFont
set configList {}
foreach opt {-family -size -weight -slant -underline -overstrike} {
set val1 [font actual TkDefaultFont $opt]
set val2 [font actual $titleFont $opt]
switch -- $opt {
-family -
-weight -
-slant { set hasChanged [expr {$val1 ne $val2}] }
-underline -
-overstrike { set hasChanged [expr {$val1 != $val2}] }
-size {
if {$val1 == 0} {
set val1 9
}
set factor [expr {$val1 * 6}]
set val1 [expr {$factor / 5}]
if {$factor % 5 > 2} {
incr val1
}
set hasChanged [expr {$val1 != $val2}]
}
}
if {$hasChanged} {
lappend configList $opt $val1
}
}
if {[llength $configList] != 0} {
eval font configure [list $titleFont] $configList
}
upvar ::scrollutil::ns${win}::data data
set charWidth [font measure TkDefaultFont -displayof $win "0"]
$data(sf) configure -xscrollincrement $charWidth
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onThemeChanged
#------------------------------------------------------------------------------
proc scrollutil::pnb::onThemeChanged w {
if {$w eq "."} {
::scrollutil::getForegroundColors normalFg disabledFg
::scrollutil::setImgForeground scrollutil_closeImg $normalFg
::scrollutil::setImgForeground scrollutil_closeDisabledImg $disabledFg
::scrollutil::setImgForeground scrollutil_descendImg $normalFg
::scrollutil::setImgForeground scrollutil_descendDisabledImg $disabledFg
if {[lsearch -exact [image names] "scrollutil_ascendImg"] >= 0} {
::scrollutil::setImgForeground scrollutil_ascendImg $normalFg
}
variable currentTheme
set newTheme [::mwutil::currentTheme]
if {$newTheme ne $currentTheme} {
set currentTheme $newTheme
createDescToolbuttonLayout
createClosablePageToolbuttonLayout
configStyles
}
} else {
configFrame $w.frm
after 100 [list scrollutil::pnb::setYScrollIncr $w]
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onMotion
#------------------------------------------------------------------------------
proc scrollutil::pnb::onMotion {tabPath x y} {
variable user1
if {[$tabPath identify $x $y] eq "closebtn"} {
$tabPath instate !disabled {
$tabPath state $user1
}
} else {
$tabPath state !$user1
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onButton1
#------------------------------------------------------------------------------
proc scrollutil::pnb::onButton1 {tabPath x y} {
set win [tabToPnb $tabPath]
::$win instate disabled {
return ""
}
variable stateArr
if {[$tabPath identify $x $y] eq "closebtn"} {
$tabPath instate !disabled {
variable user2
$tabPath state $user2
set stateArr(closebtnPressed) 1
}
return -code break ""
}
if {[::$win cget -movabletabs]} {
set stateArr(sourceIdx) [::$win index [tabToWidget $win $tabPath]]
set stateArr(cursor) [::$win cget -cursor]
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onB1Motion
#------------------------------------------------------------------------------
proc scrollutil::pnb::onB1Motion {tabPath rootX rootY} {
set cf [winfo parent $tabPath]
set sf [winfo parent [winfo parent $cf]]
set frm [winfo parent [winfo parent $sf]]
set win [winfo parent $frm]
set x [expr {$rootX - [winfo rootx $tabPath]}]
set y [expr {$rootY - [winfo rooty $tabPath]}]
variable stateArr
variable user1
variable user2
if {[$tabPath identify $x $y] eq "closebtn" && $stateArr(closebtnPressed)} {
$tabPath state $user2
return -code break ""
} else {
$tabPath state [list !$user2 !$user1]
}
if {[set sourceIdx $stateArr(sourceIdx)] < 0} {
return ""
}
set x [expr {$rootX - [winfo rootx $cf]}]
set y [expr {$rootY - [winfo rooty $cf]}]
$sf seerect $x $y $x $y
set x [expr {$rootX - [winfo rootx $win]}]
set y [expr {$rootY - [winfo rooty $win]}]
set tabIdx [::$win index @$x,$y]
if {$tabIdx < 0 || $tabIdx == $sourceIdx} {
::$win configure -cursor $stateArr(cursor)
set stateArr(targetIdx) ""
} else {
if {$tabIdx < $sourceIdx} {
::$win configure -cursor sb_up_arrow
} else {
::$win configure -cursor sb_down_arrow
}
set stateArr(targetIdx) $tabIdx
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onLeave
#------------------------------------------------------------------------------
proc scrollutil::pnb::onLeave tabPath {
variable user1
$tabPath state !$user1
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onB1Leave
#------------------------------------------------------------------------------
proc scrollutil::pnb::onB1Leave tabPath {
variable user1
variable user2
$tabPath state [list !$user2 !$user1]
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onButtonRel1
#------------------------------------------------------------------------------
proc scrollutil::pnb::onButtonRel1 {tabPath x y} {
variable user1
variable user2
$tabPath state [list !$user2 !$user1]
set win [tabToPnb $tabPath]
variable stateArr
variable userDataSupported
if {[$tabPath identify $x $y] eq "closebtn" && $stateArr(closebtnPressed)} {
set tabIdx [::$win index [tabToWidget $win $tabPath]]
set widget [lindex [::$win tabs] $tabIdx]
if {[::$win forget $tabIdx] && $userDataSupported} {
event generate $win <<NotebookTabClosed>> -data $widget
}
set stateArr(closebtnPressed) 0
return -code break ""
}
set stateArr(closebtnPressed) 0
if {$stateArr(targetIdx) >= 0} {
#
# Move the tab $sourceIdx of $win to the position $targetIdx
#
set sourceIdx $stateArr(sourceIdx)
set targetIdx $stateArr(targetIdx)
set widget [lindex [$win.nb tabs] $sourceIdx]
::$win insert $targetIdx $widget
::$win configure -cursor $stateArr(cursor)
if {$userDataSupported} {
event generate $win <<NotebookTabMoved>> \
-data [list $widget $targetIdx]
}
set stateArr(targetIdx) ""
}
set stateArr(sourceIdx) ""
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onEscape
#------------------------------------------------------------------------------
proc scrollutil::pnb::onEscape tabPath {
set win [tabToPnb $tabPath]
variable stateArr
if {$stateArr(targetIdx) >= 0} {
::$win configure -cursor $stateArr(cursor)
set stateArr(targetIdx) ""
}
set stateArr(sourceIdx) ""
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onButton3
#------------------------------------------------------------------------------
proc scrollutil::pnb::onButton3 {tabPath rootX rootY} {
set win [tabToPnb $tabPath]
::$win instate disabled {
return ""
}
set tabIdx [::$win index [tabToWidget $win $tabPath]]
set menu $win._m_e_n_u_
$menu delete 0 end
event generate $win <<MenuItemsRequested>> -data [list $menu $tabIdx]
after 100 [list scrollutil::pnb::postMenu $menu $rootX $rootY]
}
#------------------------------------------------------------------------------
# scrollutil::pnb::postMenu
#------------------------------------------------------------------------------
proc scrollutil::pnb::postMenu {menu rootX rootY} {
#
# This is an "after 100" callback; check
# whether the menu exists and has items
#
if {![winfo exists $menu] || [winfo class $menu] ne "Menu" ||
[$menu index end] eq "none"} {
return ""
}
#
# For awthemes:
#
catch {ttk::theme::[mwutil::currentTheme]::setMenuColors $menu}
tk_popup $menu $rootX $rootY
}
#------------------------------------------------------------------------------
# scrollutil::pnb::cycleTab
#------------------------------------------------------------------------------
proc scrollutil::pnb::cycleTab {win axis dir {divisor 1.0}} {
if {$axis eq "x" || $axis eq "y"} {
#
# Count both the <MouseWheel> and <Shift-MouseWheel>
# events, and ignore the non-dominant ones
#
variable ::scrollutil::xWheelEvents
variable ::scrollutil::yWheelEvents
incr ${axis}WheelEvents
if {($xWheelEvents + $yWheelEvents > 10) &&
($axis eq "x" && $xWheelEvents < $yWheelEvents ||
$axis eq "y" && $yWheelEvents < $xWheelEvents)} {
return ""
}
}
set currentIdx [::$win index current]
if {$currentIdx >= 0} {
set tabCount [::$win index end]
set d [expr {$dir/$divisor}]
set d [expr {int($d > 0 ? ceil($d) : floor($d))}]
set selectIdx [expr {($currentIdx + $d) % $tabCount}]
set step [expr {$d > 0 ? 1 : -1}]
while {([winfo class [::$win tabpath $selectIdx]] ne "TRadiobutton" ||
[::$win tab $selectIdx -state] ne "normal") &&
($selectIdx != $currentIdx)} {
set selectIdx [expr {($selectIdx + $step) % $tabCount}]
}
if {$selectIdx != $currentIdx} {
::$win select $selectIdx
}
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::onCfConfigure
#------------------------------------------------------------------------------
proc scrollutil::pnb::onCfConfigure {cf width} {
set sf [winfo parent [winfo parent $cf]]
set frm [winfo parent [winfo parent $sf]]
set win [winfo parent $frm]
upvar ::scrollutil::ns${win}::data data
if {$width != $data(cfWidth)} {
$sf configure -width $width
set data(cfWidth) $width
}
}
#
# Private utility procedures
# ==========================
#
#------------------------------------------------------------------------------
# scrollutil::pnb::configFrame
#
# Sets the -borderwidth and -relief options of a given ttk::frame to theme-
# specific values.
#------------------------------------------------------------------------------
proc scrollutil::pnb::configFrame frm {
switch [mwutil::currentTheme] {
aqua { set bd 1; set rel sunken }
vista -
xpnative { set bd 1; set rel solid }
awblack -
awclearlooks -
awdark -
awlight -
awwinxpblue -
clam -
winnative { set bd 2; set rel raised }
default { set bd 1; set rel raised }
}
$frm configure -borderwidth $bd -relief $rel
}
#------------------------------------------------------------------------------
# scrollutil::pnb::widgetToTab
#
# Returns the path name of the ttk::radiobutton, ttk::button, ttk::label, or
# ttk::separator correspondig to a given page widget of the plainnotebook
# widget win.
#------------------------------------------------------------------------------
proc scrollutil::pnb::widgetToTab {win widget} {
upvar ::scrollutil::ns${win}::data data
set widgetName [winfo name $widget]
foreach w [winfo children $data(cf)] {
if {([winfo class $w] eq "TRadiobutton" &&
[$w cget -value] eq $widget) || [winfo name $w] eq $widgetName} {
return $w
}
}
return ""
}
#------------------------------------------------------------------------------
# scrollutil::pnb::tabToWidget
#
# Returns the path name of the page widget correspondig to a given tab (a
# ttk::radiobutton, ttk::button, ttk::label, or ttk::separator) of the
# plainnotebook widget win.
#------------------------------------------------------------------------------
proc scrollutil::pnb::tabToWidget {win tabPath} {
upvar ::scrollutil::ns${win}::data data
if {[winfo class $tabPath] eq "TRadiobutton"} {
return [$tabPath cget -value]
} else {
return $win.nb.[winfo name $tabPath]
}
}
#------------------------------------------------------------------------------
# scrollutil::pnb::tabToPnb
#
# Returns the path name of the plainnotebook widget correspondig to a given tab
# (a ttk::radiobutton, ttk::button, ttk::label, or ttk::separator).
#------------------------------------------------------------------------------
proc scrollutil::pnb::tabToPnb tabPath {
set cf [winfo parent $tabPath]
set sf [winfo parent [winfo parent $cf]]
set frm [winfo parent [winfo parent $sf]]
return [winfo parent $frm]
}
#------------------------------------------------------------------------------
# scrollutil::pnb::mfToPnb
#
# Returns the path name of the plainnotebook widget correspondig to the middle
# frame of its scrollableframe.
#------------------------------------------------------------------------------
proc scrollutil::pnb::mfToPnb mf {
set sf [winfo parent $mf]
set frm [winfo parent [winfo parent $sf]]
return [winfo parent $frm]
}
#------------------------------------------------------------------------------
# scrollutil::pnb::destroyed
#
# Checks whether the plainnotebook widget win got destroyed by some custom
# script.
#------------------------------------------------------------------------------
proc scrollutil::pnb::destroyed win {
#
# A bit safer than using "winfo exists", because the widget might have
# been destroyed and its name reused for a new non-plainnotebook widget:
#
return [expr {![array exists ::scrollutil::ns${win}::data] ||
[winfo class $win] ne "Plainnotebook"}]
}
|