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 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673
|
# --------------------------------------------------------------------------- #
# FLATNOTEBOOK Widget wxPython IMPLEMENTATION
#
# Original C++ Code From Eran. You Can Find It At:
#
# http://wxforum.shadonet.com/viewtopic.php?t=5761&start=0
#
# License: wxWidgets license
#
#
# Python Code By:
#
# Andrea Gavana, @ 02 Oct 2006
# Latest Revision: 15 Feb 2014, 23.00 GMT
#
#
# For All Kind Of Problems, Requests Of Enhancements And Bug Reports, Please
# Write To Me At:
#
# andrea.gavana@gmail.com
# andrea.gavana@maerskoil.com
#
# Or, Obviously, To The wxPython Mailing List!!!
#
#
# End Of Comments
# --------------------------------------------------------------------------- #
"""
:class:`FlatNotebook` is a full, generic and owner-drawn implementation of :class:`Notebook`.
Description
===========
:class:`FlatNotebook` is a full implementation of the :class:`Notebook`, and designed to be
a drop-in replacement for :class:`Notebook`. The API functions are similar so one can
expect the function to behave in the same way.
Some features:
- The buttons are highlighted a la Firefox style;
- The scrolling is done for bulks of tabs (so, the scrolling is faster and better);
- The buttons area is never overdrawn by tabs (unlike many other implementations I saw);
- It is a generic control;
- Currently there are 6 different styles - VC8, VC 71, Standard, Fancy, Firefox 2 and Ribbon;
- Mouse middle click can be used to close tabs;
- A function to add right click menu for tabs (simple as meth:~FlatNotebook.SetRightClickMenu`);
- All styles has bottom style as well (they can be drawn in the bottom of screen);
- An option to hide 'X' button or navigation buttons (separately);
- Gradient colouring of the selected tabs and border;
- Support for drag 'n' drop of tabs, both in the same notebook or to another notebook;
- Possibility to have closing button on the active tab directly;
- Support for disabled tabs;
- Colours for active/inactive tabs, and captions;
- Background of tab area can be painted in gradient (VC8 style only);
- Colourful tabs - a random gentle colour is generated for each new tab (very cool, VC8 style only);
- Support for showing pages in "column/row mode", which means that all the pages will be
shown in "tile" mode while the tabs are hidden;
- Possibility to add a custom panel to show a logo or HTML documentation or
whatever you like when there are no pages left in :class:`FlatNotebook`;
- Try setting the tab area colour for the Ribbon Style.
And much more.
Usage
=====
Usage example::
import wx
import wx.lib.agw.flatnotebook as fnb
class MyFrame(wx.Frame):
def __init__(self, parent):
wx.Frame.__init(self, parent, -1, "FlatNotebook Demo")
panel = wx.Panel(self)
notebook = fnb.FlatNotebook(panel, -1)
for i in xrange(3):
caption = "Page %d"%(i+1)
notebook.AddPage(self.CreatePage(notebook, caption), caption)
sizer = wx.BoxSizer(wx.VERTICAL)
sizer.Add(notebook, 1, wx.ALL|wx.EXPAND, 5)
panel.SetSizer(sizer)
def CreatePage(self, notebook, caption):
'''
Creates a simple :class:`Panel` containing a :class:`TextCtrl`.
:param `notebook`: an instance of `FlatNotebook`;
:param `caption`: a simple label.
'''
p = wx.Panel(notebook)
wx.StaticText(p, -1, caption, (20,20))
wx.TextCtrl(p, -1, "", (20,40), (150,-1))
return p
# our normal wxApp-derived class, as usual
app = wx.App(0)
frame = MyFrame(None)
app.SetTopWindow(frame)
frame.Show()
app.MainLoop()
Window Styles
=============
This class supports the following window styles:
================================ =========== ==================================================
Window Styles Hex Value Description
================================ =========== ==================================================
``FNB_VC71`` 0x1 Use Visual Studio 2003 (VC7.1) style for tabs.
``FNB_FANCY_TABS`` 0x2 Use fancy style - square tabs filled with gradient colouring.
``FNB_TABS_BORDER_SIMPLE`` 0x4 Draw thin border around the page.
``FNB_NO_X_BUTTON`` 0x8 Do not display the 'X' button.
``FNB_NO_NAV_BUTTONS`` 0x10 Do not display the right/left arrows.
``FNB_MOUSE_MIDDLE_CLOSES_TABS`` 0x20 Use the mouse middle button for cloing tabs.
``FNB_BOTTOM`` 0x40 Place tabs at bottom - the default is to place them at top.
``FNB_NODRAG`` 0x80 Disable dragging of tabs.
``FNB_VC8`` 0x100 Use Visual Studio 2005 (VC8) style for tabs.
``FNB_X_ON_TAB`` 0x200 Place 'X' close button on the active tab.
``FNB_BACKGROUND_GRADIENT`` 0x400 Use gradients to paint the tabs background.
``FNB_COLOURFUL_TABS`` 0x800 Use colourful tabs (VC8 style only).
``FNB_DCLICK_CLOSES_TABS`` 0x1000 Style to close tab using double click.
``FNB_SMART_TABS`` 0x2000 Use `Smart Tabbing`, like ``Alt`` + ``Tab`` on Windows.
``FNB_DROPDOWN_TABS_LIST`` 0x4000 Use a dropdown menu on the left in place of the arrows.
``FNB_ALLOW_FOREIGN_DND`` 0x8000 Allows drag 'n' drop operations between different :class:`FlatNotebook`.
``FNB_HIDE_ON_SINGLE_TAB`` 0x10000 Hides the Page Container when there is one or fewer tabs.
``FNB_DEFAULT_STYLE`` 0x10020 :class:`FlatNotebook` default style.
``FNB_FF2`` 0x20000 Use Firefox 2 style for tabs.
``FNB_NO_TAB_FOCUS`` 0x40000 Does not allow tabs to have focus.
``FNB_RIBBON_TABS`` 0x80000 Use the Ribbon Tabs style
``FNB_HIDE_TABS`` 0x100000 Hides the Page Container allowing only keyboard navigation
``FNB_NAV_BUTTONS_WHEN_NEEDED`` 0x200000 Hides the navigation left/right arrows if all tabs fit
================================ =========== ==================================================
Events Processing
=================
This class processes the following events:
========================================= ==================================================
Event Name Description
========================================= ==================================================
``EVT_FLATNOTEBOOK_PAGE_CHANGED`` Notify client objects when the active page in :class:`FlatNotebook` has changed.
``EVT_FLATNOTEBOOK_PAGE_CHANGING`` Notify client objects when the active page in :class:`FlatNotebook` is about to change.
``EVT_FLATNOTEBOOK_PAGE_CLOSED`` Notify client objects when a page in :class:`FlatNotebook` has been closed.
``EVT_FLATNOTEBOOK_PAGE_CLOSING`` Notify client objects when a page in :class:`FlatNotebook` is closing.
``EVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU`` Notify client objects when a pop-up menu should appear next to a tab.
``EVT_FLATNOTEBOOK_PAGE_DROPPED`` Notify client objects when a tab has been dropped and re-arranged (on the *same* notebook)
``EVT_FLATNOTEBOOK_PAGE_DROPPED_FOREIGN`` Notify client objects when a tab has been dropped and re-arranged (from a foreign notebook)
========================================= ==================================================
License And Version
===================
:class:`FlatNotebook` is distributed under the wxPython license.
Latest Revision: Andrea Gavana @ 15 Feb 2014, 23.00 GMT
Version 3.2
"""
__docformat__ = "epytext"
#----------------------------------------------------------------------
# Beginning Of FLATNOTEBOOK wxPython Code
#----------------------------------------------------------------------
import wx
import random
import math
import weakref
import cPickle
# Used on OSX to get access to carbon api constants
if wx.Platform == '__WXMAC__':
import Carbon.Appearance
# Check for the new method in 2.7 (not present in 2.6.3.3)
if wx.VERSION_STRING < "2.7":
wx.Rect.Contains = lambda self, point: wx.Rect.Inside(self, point)
FNB_HEIGHT_SPACER = 10
""" Padding for the tab widths/heights, in pixels. """
# Use Visual Studio 2003 (VC7.1) style for tabs
FNB_VC71 = 1
"""Use Visual Studio 2003 (VC7.1) style for tabs"""
# Use fancy style - square tabs filled with gradient colouring
FNB_FANCY_TABS = 2
"""Use fancy style - square tabs filled with gradient colouring"""
# Draw thin border around the page
FNB_TABS_BORDER_SIMPLE = 4
"""Draw thin border around the page"""
# Do not display the 'X' button
FNB_NO_X_BUTTON = 8
"""Do not display the 'X' button"""
# Do not display the Right / Left arrows
FNB_NO_NAV_BUTTONS = 16
"""Do not display the right/left arrows"""
# Use the mouse middle button for cloing tabs
FNB_MOUSE_MIDDLE_CLOSES_TABS = 32
"""Use the mouse middle button for cloing tabs"""
# Place tabs at bottom - the default is to place them
# at top
FNB_BOTTOM = 64
"""Place tabs at bottom - the default is to place them at top"""
# Disable dragging of tabs
FNB_NODRAG = 128
"""Disable dragging of tabs"""
# Use Visual Studio 2005 (VC8) style for tabs
FNB_VC8 = 256
"""Use Visual Studio 2005 (VC8) style for tabs"""
# Firefox 2 tabs style
FNB_FF2 = 131072
"""Use Firefox 2 style for tabs"""
# Place 'X' on a tab
FNB_X_ON_TAB = 512
"""Place 'X' close button on the active tab"""
FNB_BACKGROUND_GRADIENT = 1024
"""Use gradients to paint the tabs background"""
FNB_COLOURFUL_TABS = 2048
"""Use colourful tabs (VC8 style only)"""
# Style to close tab using double click - styles 1024, 2048 are reserved
FNB_DCLICK_CLOSES_TABS = 4096
"""Style to close tab using double click"""
FNB_SMART_TABS = 8192
"""Use `Smart Tabbing`, like ``Alt`` + ``Tab`` on Windows"""
FNB_DROPDOWN_TABS_LIST = 16384
"""Use a dropdown menu on the left in place of the arrows"""
FNB_ALLOW_FOREIGN_DND = 32768
"""Allows drag and drop operations between different :class:`FlatNotebook`"""
FNB_HIDE_ON_SINGLE_TAB = 65536
"""Hides the :class:`PageContainer` when there is one or fewer tabs"""
FNB_NO_TAB_FOCUS = 262144
""" Does not allow tabs to have focus"""
FNB_RIBBON_TABS = 0x80000
"""Use Ribbon style for tabs"""
FNB_HIDE_TABS = 0x100000
"""Hides the tabs allowing only keyboard navigation between pages"""
FNB_NAV_BUTTONS_WHEN_NEEDED = 0x200000
""" Hides the navigation left/right arrows if all tabs fit. """
VERTICAL_BORDER_PADDING = 4
""" Padding between the text and the tab border. """
# Button size is a 16x16 xpm bitmap
BUTTON_SPACE = 16
"""Button size is a 16x16 xpm bitmap"""
MASK_COLOUR = wx.Colour(0, 128, 128)
"""Mask colour for the arrow bitmaps"""
# Button status
FNB_BTN_PRESSED = 2
"""Navigation button is pressed"""
FNB_BTN_HOVER = 1
"""Navigation button is hovered"""
FNB_BTN_NONE = 0
"""No navigation"""
# Hit Test results
FNB_TAB = 1 # On a tab
"""Indicates mouse coordinates inside a tab"""
FNB_X = 2 # On the X button
"""Indicates mouse coordinates inside the X region"""
FNB_TAB_X = 3 # On the 'X' button (tab's X button)
"""Indicates mouse coordinates inside the X region in a tab"""
FNB_LEFT_ARROW = 4 # On the rotate left arrow button
"""Indicates mouse coordinates inside the left arrow region"""
FNB_RIGHT_ARROW = 5 # On the rotate right arrow button
"""Indicates mouse coordinates inside the right arrow region"""
FNB_DROP_DOWN_ARROW = 6 # On the drop down arrow button
"""Indicates mouse coordinates inside the drop down arrow region"""
FNB_NOWHERE = 0 # Anywhere else
"""Indicates mouse coordinates not on any tab of the notebook"""
FNB_DEFAULT_STYLE = FNB_MOUSE_MIDDLE_CLOSES_TABS | FNB_HIDE_ON_SINGLE_TAB
""":class:`FlatNotebook` default style"""
# FlatNotebook Events:
# wxEVT_FLATNOTEBOOK_PAGE_CHANGED: Event Fired When You Switch Page;
# wxEVT_FLATNOTEBOOK_PAGE_CHANGING: Event Fired When You Are About To Switch
# Pages, But You Can Still "Veto" The Page Changing By Avoiding To Call
# event.Skip() In Your Event Handler;
# wxEVT_FLATNOTEBOOK_PAGE_CLOSING: Event Fired When A Page Is Closing, But
# You Can Still "Veto" The Page Changing By Avoiding To Call event.Skip()
# In Your Event Handler;
# wxEVT_FLATNOTEBOOK_PAGE_CLOSED: Event Fired When A Page Is Closed.
# wxEVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU: Event Fired When A Menu Pops-up In A Tab.
# wxEVT_FLATNOTEBOOK_PAGE_DROPPED: Event Fired When A Tab Is Dropped On The Same Notebook
wxEVT_FLATNOTEBOOK_PAGE_CHANGED = wx.wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
wxEVT_FLATNOTEBOOK_PAGE_CHANGING = wx.wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
wxEVT_FLATNOTEBOOK_PAGE_CLOSING = wx.NewEventType()
wxEVT_FLATNOTEBOOK_PAGE_CLOSED = wx.NewEventType()
wxEVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU = wx.NewEventType()
wxEVT_FLATNOTEBOOK_PAGE_DROPPED = wx.NewEventType()
wxEVT_FLATNOTEBOOK_PAGE_DROPPED_FOREIGN = wx.NewEventType()
#-----------------------------------#
# FlatNotebookEvent
#-----------------------------------#
EVT_FLATNOTEBOOK_PAGE_CHANGED = wx.EVT_NOTEBOOK_PAGE_CHANGED
""" Notify client objects when the active page in :class:`FlatNotebook` has changed."""
EVT_FLATNOTEBOOK_PAGE_CHANGING = wx.EVT_NOTEBOOK_PAGE_CHANGING
""" Notify client objects when the active page in :class:`FlatNotebook` is about to change."""
EVT_FLATNOTEBOOK_PAGE_CLOSING = wx.PyEventBinder(wxEVT_FLATNOTEBOOK_PAGE_CLOSING, 1)
""" Notify client objects when a page in :class:`FlatNotebook` is closing."""
EVT_FLATNOTEBOOK_PAGE_CLOSED = wx.PyEventBinder(wxEVT_FLATNOTEBOOK_PAGE_CLOSED, 1)
""" Notify client objects when a page in :class:`FlatNotebook` has been closed."""
EVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU = wx.PyEventBinder(wxEVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU, 1)
""" Notify client objects when a pop-up menu should appear next to a tab."""
EVT_FLATNOTEBOOK_PAGE_DROPPED = wx.PyEventBinder(wxEVT_FLATNOTEBOOK_PAGE_DROPPED, 1)
""" Notify client objects when a tab has been dropped and re-arranged (on the *same* notebook)."""
EVT_FLATNOTEBOOK_PAGE_DROPPED_FOREIGN = wx.PyEventBinder(wxEVT_FLATNOTEBOOK_PAGE_DROPPED_FOREIGN, 1)
""" Notify client objects when a tab has been dropped and re-arranged (from a foreign notebook)."""
# Some icons in XPM format
left_arrow_disabled_xpm = [
" 16 16 8 1",
"` c #008080",
". c #555555",
"# c #000000",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"````````````````",
"````````````````",
"````````.```````",
"```````..```````",
"``````.`.```````",
"`````.``.```````",
"````.```.```````",
"`````.``.```````",
"``````.`.```````",
"```````..```````",
"````````.```````",
"````````````````",
"````````````````",
"````````````````",
"````````````````"
]
x_button_pressed_xpm = [
" 16 16 8 1",
"` c #008080",
". c #4766e0",
"# c #9e9ede",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"`..............`",
"`.############.`",
"`.############.`",
"`.############.`",
"`.###aa####aa#.`",
"`.####aa##aa##.`",
"`.#####aaaa###.`",
"`.######aa####.`",
"`.#####aaaa###.`",
"`.####aa##aa##.`",
"`.###aa####aa#.`",
"`.############.`",
"`..............`",
"````````````````",
"````````````````"
]
left_arrow_xpm = [
" 16 16 8 1",
"` c #008080",
". c #555555",
"# c #000000",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"````````````````",
"````````````````",
"````````.```````",
"```````..```````",
"``````...```````",
"`````....```````",
"````.....```````",
"`````....```````",
"``````...```````",
"```````..```````",
"````````.```````",
"````````````````",
"````````````````",
"````````````````",
"````````````````"
]
x_button_hilite_xpm = [
" 16 16 8 1",
"` c #008080",
". c #4766e0",
"# c #c9dafb",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"`..............`",
"`.############.`",
"`.############.`",
"`.##aa####aa##.`",
"`.###aa##aa###.`",
"`.####aaaa####.`",
"`.#####aa#####.`",
"`.####aaaa####.`",
"`.###aa##aa###.`",
"`.##aa####aa##.`",
"`.############.`",
"`.############.`",
"`..............`",
"````````````````",
"````````````````"
]
x_button_xpm = [
" 16 16 8 1",
"` c #008080",
". c #555555",
"# c #000000",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"````````````````",
"````````````````",
"````````````````",
"````..````..````",
"`````..``..`````",
"``````....``````",
"```````..```````",
"``````....``````",
"`````..``..`````",
"````..````..````",
"````````````````",
"````````````````",
"````````````````",
"````````````````",
"````````````````"
]
left_arrow_pressed_xpm = [
" 16 16 8 1",
"` c #008080",
". c #4766e0",
"# c #9e9ede",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"`..............`",
"`.############.`",
"`.############.`",
"`.#######a####.`",
"`.######aa####.`",
"`.#####aaa####.`",
"`.####aaaa####.`",
"`.###aaaaa####.`",
"`.####aaaa####.`",
"`.#####aaa####.`",
"`.######aa####.`",
"`.#######a####.`",
"`..............`",
"````````````````",
"````````````````"
]
left_arrow_hilite_xpm = [
" 16 16 8 1",
"` c #008080",
". c #4766e0",
"# c #c9dafb",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"`..............`",
"`.############.`",
"`.######a#####.`",
"`.#####aa#####.`",
"`.####aaa#####.`",
"`.###aaaa#####.`",
"`.##aaaaa#####.`",
"`.###aaaa#####.`",
"`.####aaa#####.`",
"`.#####aa#####.`",
"`.######a#####.`",
"`.############.`",
"`..............`",
"````````````````",
"````````````````"
]
right_arrow_disabled_xpm = [
" 16 16 8 1",
"` c #008080",
". c #555555",
"# c #000000",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"````````````````",
"````````````````",
"```````.````````",
"```````..```````",
"```````.`.``````",
"```````.``.`````",
"```````.```.````",
"```````.``.`````",
"```````.`.``````",
"```````..```````",
"```````.````````",
"````````````````",
"````````````````",
"````````````````",
"````````````````"
]
right_arrow_hilite_xpm = [
" 16 16 8 1",
"` c #008080",
". c #4766e0",
"# c #c9dafb",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"`..............`",
"`.############.`",
"`.####a#######.`",
"`.####aa######.`",
"`.####aaa#####.`",
"`.####aaaa####.`",
"`.####aaaaa###.`",
"`.####aaaa####.`",
"`.####aaa#####.`",
"`.####aa######.`",
"`.####a#######.`",
"`.############.`",
"`..............`",
"````````````````",
"````````````````"
]
right_arrow_pressed_xpm = [
" 16 16 8 1",
"` c #008080",
". c #4766e0",
"# c #9e9ede",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"`..............`",
"`.############.`",
"`.############.`",
"`.#####a######.`",
"`.#####aa#####.`",
"`.#####aaa####.`",
"`.#####aaaa###.`",
"`.#####aaaaa##.`",
"`.#####aaaa###.`",
"`.#####aaa####.`",
"`.#####aa#####.`",
"`.#####a######.`",
"`..............`",
"````````````````",
"````````````````"
]
right_arrow_xpm = [
" 16 16 8 1",
"` c #008080",
". c #555555",
"# c #000000",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"````````````````",
"````````````````",
"```````.````````",
"```````..```````",
"```````...``````",
"```````....`````",
"```````.....````",
"```````....`````",
"```````...``````",
"```````..```````",
"```````.````````",
"````````````````",
"````````````````",
"````````````````",
"````````````````"
]
down_arrow_hilite_xpm = [
" 16 16 8 1",
"` c #008080",
". c #4766e0",
"# c #c9dafb",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"``.............`",
"``.###########.`",
"``.###########.`",
"``.###########.`",
"``.#aaaaaaaaa#.`",
"``.##aaaaaaa##.`",
"``.###aaaaa###.`",
"``.####aaa####.`",
"``.#####a#####.`",
"``.###########.`",
"``.###########.`",
"``.###########.`",
"``.............`",
"````````````````",
"````````````````"
]
down_arrow_pressed_xpm = [
" 16 16 8 1",
"` c #008080",
". c #4766e0",
"# c #9e9ede",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"``.............`",
"``.###########.`",
"``.###########.`",
"``.###########.`",
"``.###########.`",
"``.###########.`",
"``.#aaaaaaaaa#.`",
"``.##aaaaaaa##.`",
"``.###aaaaa###.`",
"``.####aaa####.`",
"``.#####a#####.`",
"``.###########.`",
"``.............`",
"````````````````",
"````````````````"
]
down_arrow_xpm = [
" 16 16 8 1",
"` c #008080",
". c #000000",
"# c #000000",
"a c #000000",
"b c #000000",
"c c #000000",
"d c #000000",
"e c #000000",
"````````````````",
"````````````````",
"````````````````",
"````````````````",
"````````````````",
"````````````````",
"````.........```",
"`````.......````",
"``````.....`````",
"```````...``````",
"````````.```````",
"````````````````",
"````````````````",
"````````````````",
"````````````````",
"````````````````"
]
#----------------------------------------------------------------------
from wx.lib.embeddedimage import PyEmbeddedImage
Mondrian = PyEmbeddedImage(
"iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABHNCSVQICAgIfAhkiAAAAHFJ"
"REFUWIXt1jsKgDAQRdF7xY25cpcWC60kioI6Fm/ahHBCMh+BRmGMnAgEWnvPpzK8dvrFCCCA"
"coD8og4c5Lr6WB3Q3l1TBwLYPuF3YS1gn1HphgEEEABcKERrGy0E3B0HFJg7C1N/f/kTBBBA"
"+Vi+AMkgFEvBPD17AAAAAElFTkSuQmCC")
#----------------------------------------------------------------------
def LightColour(colour, percent):
"""
Brighten the input colour by a percentage.
:param `colour`: a valid :class:`Colour` instance;
:param `percent`: the percentage by which the input colour should be brightened.
"""
end_colour = wx.WHITE
rd = end_colour.Red() - colour.Red()
gd = end_colour.Green() - colour.Green()
bd = end_colour.Blue() - colour.Blue()
high = 100
# We take the percent way of the colour from colour -. white
i = percent
r = colour.Red() + ((i*rd*100)/high)/100
g = colour.Green() + ((i*gd*100)/high)/100
b = colour.Blue() + ((i*bd*100)/high)/100
return wx.Colour(r, g, b)
def FormatColour(colour):
"""
Convert the input `colour` into a valid :class:`Colour` instance, using whatever typemap
accepted by wxWidgets/wxPython.
:param `colour`: can be an instance of :class:`Colour`, a 3 or 4 integer tuple, a hex
string, a string representing the colour name or ``None``.
:returns: a valid instance of :class:`Colour` or ``None`` if the input `colour` was ``None``
in the first place.
"""
if isinstance(colour, (list, tuple)):
colour = wx.Colour(*colour)
elif isinstance(colour, basestring):
colour = wx.NamedColour(colour)
return colour
def RandomColour():
""" Creates a random colour. """
r = random.randint(0, 255) # Random value betweem 0-255
g = random.randint(0, 255) # Random value betweem 0-255
b = random.randint(0, 255) # Random value betweem 0-255
return wx.Colour(r, g, b)
def PaintStraightGradientBox(dc, rect, startColour, endColour, vertical=True):
"""
Draws a gradient coloured box from `startColour` to `endColour`.
:param `dc`: an instance of :class:`DC`;
:param `rect`: the rectangle to fill with the gradient shading;
:param `startColour`: the first colour in the gradient shading;
:param `endColour`: the last colour in the gradient shading;
:param `vertical`: ``True`` if the gradient shading is north to south, ``False``
if it is east to west.
"""
rd = endColour.Red() - startColour.Red()
gd = endColour.Green() - startColour.Green()
bd = endColour.Blue() - startColour.Blue()
# Save the current pen and brush
savedPen = dc.GetPen()
savedBrush = dc.GetBrush()
if vertical:
high = rect.GetHeight()-1
else:
high = rect.GetWidth()-1
if high < 1:
return
for i in xrange(high+1):
r = startColour.Red() + ((i*rd*100)/high)/100
g = startColour.Green() + ((i*gd*100)/high)/100
b = startColour.Blue() + ((i*bd*100)/high)/100
p = wx.Pen(wx.Colour(r, g, b))
dc.SetPen(p)
if vertical:
dc.DrawLine(rect.x, rect.y+i, rect.x+rect.width, rect.y+i)
else:
dc.DrawLine(rect.x+i, rect.y, rect.x+i, rect.y+rect.height)
# Restore the pen and brush
dc.SetPen(savedPen)
dc.SetBrush(savedBrush)
def AdjustColour(colour, percent, alpha=wx.ALPHA_OPAQUE):
"""
Brighten/darken input colour by `percent` and adjust `alpha` channel if needed.
:param `colour`: colour object to adjust, an instance of :class:`Colour`;
:param `percent`: percent to adjust ``+`` (brighten) or ``-`` (darken);
:param `alpha`: amount to adjust the alpha channel.
:return: The modified colour.
"""
radj, gadj, badj = [int(val * (abs(percent) / 100.)) for val in colour.Get()]
if percent < 0:
radj, gadj, badj = [val * -1 for val in [radj, gadj, badj]]
else:
radj, gadj, badj = [val or 255 for val in [radj, gadj, badj]]
red = min(colour.Red() + radj, 255)
green = min(colour.Green() + gadj, 255)
blue = min(colour.Blue() + badj, 255)
return wx.Colour(red, green, blue, alpha)
if wx.VERSION_STRING < "2.8.9.2":
adjust_colour = AdjustColour
else:
from wx.lib.colourutils import AdjustColour as adjust_colour
# -----------------------------------------------------------------------------
# Util functions
# -----------------------------------------------------------------------------
def DrawButton(dc, rect, focus, upperTabs):
"""
Draws a :class:`FlatNotebook` tab.
:param `dc`: an instance of :class:`DC`;
:param `rect`: the tab's client rectangle;
:param `focus`: ``True`` if the tab has focus, ``False`` otherwise;
:param `upperTabs`: ``True`` if the tabs are at the top, ``False`` if they are
at the bottom.
"""
# Define the rounded rectangle base on the given rect
# we need an array of 9 points for it
regPts = [wx.Point() for indx in xrange(9)]
if focus:
if upperTabs:
leftPt = wx.Point(rect.x, rect.y + (rect.height / 10)*8)
rightPt = wx.Point(rect.x + rect.width - 2, rect.y + (rect.height / 10)*8)
else:
leftPt = wx.Point(rect.x, rect.y + (rect.height / 10)*5)
rightPt = wx.Point(rect.x + rect.width - 2, rect.y + (rect.height / 10)*5)
else:
leftPt = wx.Point(rect.x, rect.y + (rect.height / 2))
rightPt = wx.Point(rect.x + rect.width - 2, rect.y + (rect.height / 2))
# Define the top region
top = wx.RectPP(rect.GetTopLeft(), rightPt)
bottom = wx.RectPP(leftPt, rect.GetBottomRight())
topStartColour = wx.WHITE
if not focus:
topStartColour = LightColour(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE), 50)
topEndColour = wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE)
bottomStartColour = topEndColour
bottomEndColour = topEndColour
# Incase we use bottom tabs, switch the colours
if upperTabs:
if focus:
PaintStraightGradientBox(dc, top, topStartColour, topEndColour)
PaintStraightGradientBox(dc, bottom, bottomStartColour, bottomEndColour)
else:
PaintStraightGradientBox(dc, top, topEndColour , topStartColour)
PaintStraightGradientBox(dc, bottom, bottomStartColour, bottomEndColour)
else:
if focus:
PaintStraightGradientBox(dc, bottom, topEndColour, bottomEndColour)
PaintStraightGradientBox(dc, top,topStartColour, topStartColour)
else:
PaintStraightGradientBox(dc, bottom, bottomStartColour, bottomEndColour)
PaintStraightGradientBox(dc, top, topEndColour, topStartColour)
dc.SetBrush(wx.TRANSPARENT_BRUSH)
# ---------------------------------------------------------------------------- #
# Class FNBDropSource
# Gives Some Custom UI Feedback during the DnD Operations
# ---------------------------------------------------------------------------- #
class FNBDropSource(wx.DropSource):
"""
Give some custom UI feedback during the drag and drop operation in this
function. It is called on each mouse move, so your implementation must
not be too slow.
"""
def __init__(self, win):
"""
Default class constructor.
Used internally.
:param `win`: the source window for which we wish to provide UI feedback
during drag and drop operations.
"""
wx.DropSource.__init__(self, win)
self._win = win
def GiveFeedback(self, effect):
"""
You may give some custom UI feedback during the drag and drop operation
in this function. It is called on each mouse move, so your implementation
must not be too slow.
:param `effect`: the effect to implement. One of ``wx.DragCopy``, ``wx.DragMove``,
``wx.DragLink`` and ``wx.DragNone``.
:return: Return ``False`` if you want default feedback, or ``True`` if you
implement your own feedback. The return values is ignored under GTK.
:note: To show your own custom drag and drop UI feedback, you must override
this method.
"""
self._win.DrawDragHint()
return False
# ---------------------------------------------------------------------------- #
# Class FNBDragInfo
# Stores All The Information To Allow Drag And Drop Between Different
# FlatNotebooks.
# ---------------------------------------------------------------------------- #
class FNBDragInfo(object):
"""
Stores all the information to allow drag and drop between different
:class:`FlatNotebook` instances.
"""
_map = weakref.WeakValueDictionary()
def __init__(self, container, pageindex):
"""
Default class constructor.
:param `container`: the drag and drop container, a page in :class:`FlatNotebook`;
:param `pageindex`: the index of the tab that is actually being dragged.
"""
self._id = id(container)
FNBDragInfo._map[self._id] = container
self._pageindex = pageindex
def GetContainer(self):
""" Returns the :class:`FlatNotebook` page (usually a panel). """
return FNBDragInfo._map.get(self._id, None)
def GetPageIndex(self):
""" Returns the page index associated with a page. """
return self._pageindex
# ---------------------------------------------------------------------------- #
# Class FNBDropTarget
# Simply Used To Handle The OnDrop() Method When Dragging And Dropping Between
# Different FlatNotebooks.
# ---------------------------------------------------------------------------- #
class FNBDropTarget(wx.DropTarget):
"""
Class used to handle the :meth:`FlatNotebook.OnDropTarget() <FlatNotebook.OnDropTarget>` method when dragging and
dropping between different :class:`FlatNotebook` instances.
"""
def __init__(self, parent):
"""
Default class constructor.
:param `parent`: the window handling the drag and drop, an instance of
:class:`FlatNotebook`.
"""
wx.DropTarget.__init__(self)
self._parent = parent
self._dataobject = wx.CustomDataObject(wx.CustomDataFormat("FlatNotebook"))
self.SetDataObject(self._dataobject)
def OnData(self, x, y, dragres):
"""
Called after `OnDrop` returns ``True``.
By default this will usually call `GetData` and will return the suggested default value `dragres`.
:param `x`: the current x position of the mouse while dragging and dropping;
:param `y`: the current y position of the mouse while dragging and dropping;
:param `dragres`: an optional default return value.
"""
if not self.GetData():
return wx.DragNone
draginfo = self._dataobject.GetData()
drginfo = cPickle.loads(draginfo)
return self._parent.OnDropTarget(x, y, drginfo.GetPageIndex(), drginfo.GetContainer())
# ---------------------------------------------------------------------------- #
# Class PageInfo
# Contains parameters for every FlatNotebook page
# ---------------------------------------------------------------------------- #
class PageInfo(object):
"""
This class holds all the information (caption, image, etc...) belonging to a
single tab in :class:`FlatNotebook`.
"""
def __init__(self, caption="", imageindex=-1, tabangle=0, enabled=True):
"""
Default Class Constructor.
:param `caption`: the tab caption;
:param `imageindex`: the tab image index based on the assigned (set)
:class:`ImageList` (if any);
:param `tabangle`: the tab angle (only on standard tabs, from 0 to 15
degrees);
:param `enabled`: sets the tab as enabled or disabled.
"""
self._strCaption = caption
self._TabAngle = tabangle
self._ImageIndex = imageindex
self._bEnabled = enabled
self._pos = wx.Point(-1, -1)
self._size = wx.Size(-1, -1)
self._region = wx.Region()
self._xRect = wx.Rect()
self._colour = None
self._hasFocus = False
self._pageTextColour = None
def SetCaption(self, value):
"""
Sets the tab caption.
:param `value`: the new tab caption string.
"""
self._strCaption = value
def GetCaption(self):
""" Returns the tab caption. """
return self._strCaption
def SetPosition(self, value):
"""
Sets the tab position.
:param `value`: an instance of :class:`Point`.
"""
self._pos = value
def GetPosition(self):
""" Returns the tab position. """
return self._pos
def SetSize(self, value):
"""
Sets the tab size.
:param `value`: an instance of :class:`Size`.
"""
self._size = value
def GetSize(self):
""" Returns the tab size. """
return self._size
def SetTabAngle(self, value):
"""
Sets the tab header angle.
:param `value`: the tab header angle (0 <= value <= 15 degrees).
"""
self._TabAngle = min(45, value)
def GetTabAngle(self):
""" Returns the tab angle. """
return self._TabAngle
def SetImageIndex(self, value):
"""
Sets the tab image index.
:param `value`: an index within the :class:`FlatNotebook` image list specifying
the image to use for this tab.
"""
self._ImageIndex = value
def GetImageIndex(self):
""" Returns the tab image index. """
return self._ImageIndex
def GetPageTextColour(self):
"""
Returns the tab text colour if it has been set previously, or ``None``
otherwise.
"""
return self._pageTextColour
def SetPageTextColour(self, colour):
"""
Sets the tab text colour for this tab.
:param `colour`: an instance of :class:`Colour`. You can pass ``None`` or
:class:`NullColour` to return to the default page text colour.
"""
colour = FormatColour(colour)
if colour is None or not colour.IsOk():
self._pageTextColour = None
else:
self._pageTextColour = colour
def GetEnabled(self):
""" Returns whether the tab is enabled or not. """
return self._bEnabled
def EnableTab(self, enabled):
"""
Sets the tab enabled or disabled.
:param `enabled`: ``True`` to enable a tab, ``False`` to disable it.
"""
self._bEnabled = enabled
def SetRegion(self, points=[]):
"""
Sets the tab region.
:param `points`: a Python list of :class:`Point`
"""
self._region = wx.RegionFromPoints(points)
def GetRegion(self):
""" Returns the tab region. """
return self._region
def SetXRect(self, xrect):
"""
Sets the button 'X' area rect.
:param `xrect`: an instance of :class:`Rect`, specifying the client rectangle
of the 'X' button.
"""
self._xRect = xrect
def GetXRect(self):
""" Returns the button 'X' area rect. """
return self._xRect
def GetColour(self):
""" Returns the tab colour. """
return self._colour
def SetColour(self, colour):
"""
Sets the tab colour.
:param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython
to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple).
"""
self._colour = FormatColour(colour)
# ---------------------------------------------------------------------------- #
# Class FlatNotebookEvent
# ---------------------------------------------------------------------------- #
class FlatNotebookEvent(wx.PyCommandEvent):
"""
This events will be sent when a ``EVT_FLATNOTEBOOK_PAGE_CHANGED``,
``EVT_FLATNOTEBOOK_PAGE_CHANGING``, ``EVT_FLATNOTEBOOK_PAGE_CLOSING``,
``EVT_FLATNOTEBOOK_PAGE_CLOSED`` and ``EVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU`` is
mapped in the parent.
"""
def __init__(self, eventType, eventId=1, nSel=-1, nOldSel=-1):
"""
Default class constructor.
:param `eventType`: the event type;
:param `eventId`: the event identifier;
:param `nSel`: the current selection;
:param `nOldSel`: the old selection.
"""
wx.PyCommandEvent.__init__(self, eventType, eventId)
self._eventType = eventType
self.notify = wx.NotifyEvent(eventType, eventId)
def GetNotifyEvent(self):
""" Returns the actual :class:`NotifyEvent`. """
return self.notify
def IsAllowed(self):
"""
Returns ``True`` if the change is allowed (:meth:`~FlatNotebookEvent.Veto` hasn't been called) or
``False`` otherwise (if it was).
"""
return self.notify.IsAllowed()
def Veto(self):
"""
Prevents the change announced by this event from happening.
:note: It is in general a good idea to notify the user about the reasons
for vetoing the change because otherwise the applications behaviour (which
just refuses to do what the user wants) might be quite surprising.
"""
self.notify.Veto()
def Allow(self):
"""
This is the opposite of :meth:`~FlatNotebookEvent.Veto`: it explicitly allows the event to be processed.
For most events it is not necessary to call this method as the events are
allowed anyhow but some are forbidden by default (this will be mentioned
in the corresponding event description).
"""
self.notify.Allow()
def SetSelection(self, nSel):
"""
Sets the event selection.
:param `nSel`: an integer specifying the new selection.
"""
self._selection = nSel
def SetOldSelection(self, nOldSel):
"""
Sets the id of the page selected before the change.
:param `nOldSel`: an integer specifying the old selection.
"""
self._oldselection = nOldSel
def GetSelection(self):
""" Returns the currently selected page, or -1 if none was selected. """
return self._selection
def GetOldSelection(self):
""" Returns the page that was selected before the change, -1 if none was selected. """
return self._oldselection
# ---------------------------------------------------------------------------- #
# Class TabNavigatorWindow
# ---------------------------------------------------------------------------- #
class FlatNotebookDragEvent(FlatNotebookEvent):
"""
This event will be sent when a ``EVT_FLATNOTEBOOK_PAGE_DRAGGED_FOREIGN`` is
mapped in the parent.
"""
def __init__(self, eventType, eventId=1, nSel=-1, nOldSel=-1):
"""
Default class constructor.
:param `eventType`: the event type;
:param `eventId`: the event identifier;
:param `nSel`: the current selection;
:param `nOldSel`: the old selection.
"""
wx.PyCommandEvent.__init__(self, eventType, eventId)
self._eventType = eventType
self.notify = wx.NotifyEvent(eventType, eventId)
self._oldnotebook = -1
self._newnotebook = -1
def GetNotebook(self):
""" Returns the new notebook. """
return self._newnotebook
def GetOldNotebook(self):
""" Returns the old notebook. """
return self._oldnotebook
def SetNotebook(self, notebook):
"""
Sets the new notebook.
:param `notebook`: an instance of :class:`FlatNotebook`.
"""
self._newnotebook = notebook
def SetOldNotebook(self, old):
"""
Sets the old notebook.
:param `notebook`: an instance of :class:`FlatNotebook`.
"""
self._oldnotebook = old
# ---------------------------------------------------------------------------- #
# Class TabNavigatorWindow
# ---------------------------------------------------------------------------- #
class TabNavigatorWindow(wx.Dialog):
"""
This class is used to create a modal dialog that enables `Smart Tabbing`,
similar to what you would get by hitting ``Alt`` + ``Tab`` on Windows.
"""
def __init__(self, parent=None, icon=None):
"""
Default class constructor.
Used internally.
:param `parent`: the :class:`TabNavigatorWindow` parent window;
:param `icon`: a valid :class:`Bitmap` object representing the icon to be displayed
in the :class:`TabNavigatorWindow`.
"""
wx.Dialog.__init__(self, parent, wx.ID_ANY, "", style=0)
self._selectedItem = -1
self._indexMap = []
if icon is None:
self._bmp = Mondrian.GetBitmap()
else:
self._bmp = icon
sz = wx.BoxSizer(wx.VERTICAL)
self._listBox = wx.ListBox(self, wx.ID_ANY, wx.DefaultPosition, wx.Size(200, 150), [], wx.LB_SINGLE | wx.NO_BORDER)
mem_dc = wx.MemoryDC()
mem_dc.SelectObject(wx.EmptyBitmap(1,1))
font = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
font.SetWeight(wx.BOLD)
mem_dc.SetFont(font)
panelHeight = mem_dc.GetCharHeight()
panelHeight += 4 # Place a spacer of 2 pixels
# Out signpost bitmap is 24 pixels
if panelHeight < 24:
panelHeight = 24
self._panel = wx.Panel(self, wx.ID_ANY, wx.DefaultPosition, wx.Size(200, panelHeight))
sz.Add(self._panel)
sz.Add(self._listBox, 1, wx.EXPAND)
self.SetSizer(sz)
# Connect events to the list box
self._listBox.Bind(wx.EVT_KEY_UP, self.OnKeyUp)
self._listBox.Bind(wx.EVT_NAVIGATION_KEY, self.OnNavigationKey)
self._listBox.Bind(wx.EVT_LISTBOX_DCLICK, self.OnItemSelected)
# Connect paint event to the panel
self._panel.Bind(wx.EVT_PAINT, self.OnPanelPaint)
self._panel.Bind(wx.EVT_ERASE_BACKGROUND, self.OnPanelEraseBg)
self.SetBackgroundColour(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE))
self._listBox.SetBackgroundColour(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE))
self.PopulateListControl(parent)
self.GetSizer().Fit(self)
self.GetSizer().SetSizeHints(self)
self.GetSizer().Layout()
self.Centre()
# Set focus on the list box to avoid having to click on it to change
# the tab selection under GTK.
self._listBox.SetFocus()
def OnKeyUp(self, event):
"""
Handles the ``wx.EVT_KEY_UP`` for the :class:`TabNavigatorWindow`.
:param `event`: a :class:`KeyEvent` event to be processed.
"""
if event.GetKeyCode() == wx.WXK_CONTROL:
self.CloseDialog()
def OnNavigationKey(self, event):
"""
Handles the ``wx.EVT_NAVIGATION_KEY`` for the :class:`TabNavigatorWindow`.
:param `event`: a :class:`NavigationKeyEvent` event to be processed.
"""
selected = self._listBox.GetSelection()
bk = self.GetParent()
maxItems = bk.GetPageCount()
if event.GetDirection():
# Select next page
if selected == maxItems - 1:
itemToSelect = 0
else:
itemToSelect = selected + 1
else:
# Previous page
if selected == 0:
itemToSelect = maxItems - 1
else:
itemToSelect = selected - 1
self._listBox.SetSelection(itemToSelect)
def PopulateListControl(self, book):
"""
Populates the :class:`TabNavigatorWindow` listbox with a list of tabs.
:param `book`: an instance of :class:`FlatNotebook` containing the tabs to be
displayed in the listbox.
"""
selection = book.GetSelection()
count = book.GetPageCount()
self._listBox.Append(book.GetPageText(selection))
self._indexMap.append(selection)
prevSel = book.GetPreviousSelection()
if prevSel != wx.NOT_FOUND:
# Insert the previous selection as second entry
self._listBox.Append(book.GetPageText(prevSel))
self._indexMap.append(prevSel)
for c in xrange(count):
# Skip selected page
if c == selection:
continue
# Skip previous selected page as well
if c == prevSel:
continue
self._listBox.Append(book.GetPageText(c))
self._indexMap.append(c)
# Select the next entry after the current selection
self._listBox.SetSelection(0)
dummy = wx.NavigationKeyEvent()
dummy.SetDirection(True)
self.OnNavigationKey(dummy)
def OnItemSelected(self, event):
"""
Handles the ``wx.EVT_LISTBOX_DCLICK`` for the :class:`TabNavigatorWindow`.
:param `event`: a :class:`ListEvent` event to be processed.
"""
self.CloseDialog()
def CloseDialog(self):
"""
Closes the :class:`TabNavigatorWindow` dialog, setting the new selection in
:class:`FlatNotebook`.
"""
bk = self.GetParent()
self._selectedItem = self._listBox.GetSelection()
iter = self._indexMap[self._selectedItem]
bk._pages.FireEvent(iter)
self.EndModal(wx.ID_OK)
def OnPanelPaint(self, event):
"""
Handles the ``wx.EVT_PAINT`` for the :class:`TabNavigatorWindow` top panel.
:param `event`: a :class:`PaintEvent` event to be processed.
"""
dc = wx.PaintDC(self._panel)
rect = self._panel.GetClientRect()
bmp = wx.EmptyBitmap(rect.width, rect.height)
mem_dc = wx.MemoryDC()
mem_dc.SelectObject(bmp)
endColour = wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW)
startColour = LightColour(endColour, 50)
PaintStraightGradientBox(mem_dc, rect, startColour, endColour)
# Draw the caption title and place the bitmap
# get the bitmap optimal position, and draw it
bmpPt, txtPt = wx.Point(), wx.Point()
bmpPt.y = (rect.height - self._bmp.GetHeight())/2
bmpPt.x = 3
mem_dc.DrawBitmap(self._bmp, bmpPt.x, bmpPt.y, True)
# get the text position, and draw it
font = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
font.SetWeight(wx.BOLD)
mem_dc.SetFont(font)
fontHeight = mem_dc.GetCharHeight()
txtPt.x = bmpPt.x + self._bmp.GetWidth() + 4
txtPt.y = (rect.height - fontHeight)/2
mem_dc.SetTextForeground(wx.WHITE)
mem_dc.DrawText("Opened tabs:", txtPt.x, txtPt.y)
mem_dc.SelectObject(wx.NullBitmap)
dc.DrawBitmap(bmp, 0, 0)
def OnPanelEraseBg(self, event):
"""
Handles the ``wx.EVT_ERASE_BACKGROUND`` for the :class:`TabNavigatorWindow` top panel.
:param `event`: a :class:`EraseEvent` event to be processed.
:note: This method is intentionally empty to reduce flicker.
"""
pass
# ---------------------------------------------------------------------------- #
# Class FNBRenderer
# ---------------------------------------------------------------------------- #
class FNBRenderer(object):
"""
Parent class for the 6 renderers defined: `Standard`, `VC71`, `Fancy`, `Firefox 2`,
`VC8` and `Ribbon`. This class implements the common methods of all 6 renderers.
"""
def __init__(self):
""" Default class constructor. """
self._tabHeight = None
if wx.Platform == "__WXMAC__":
# Get proper highlight colour for focus rectangle from the
# current Mac theme. kThemeBrushFocusHighlight is
# available on Mac OS 8.5 and higher
if hasattr(wx, 'MacThemeColour'):
c = wx.MacThemeColour(Carbon.Appearance.kThemeBrushFocusHighlight)
else:
brush = wx.Brush(wx.BLACK)
brush.MacSetTheme(Carbon.Appearance.kThemeBrushFocusHighlight)
c = brush.GetColour()
self._focusPen = wx.Pen(c, 2, wx.SOLID)
else:
self._focusPen = wx.Pen(wx.BLACK, 1, wx.USER_DASH)
self._focusPen.SetDashes([1, 1])
self._focusPen.SetCap(wx.CAP_BUTT)
def GetLeftButtonPos(self, pageContainer):
"""
Returns the left button position in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
"""
pc = pageContainer
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
rect = pc.GetClientRect()
clientWidth = rect.width
if agwStyle & FNB_NO_X_BUTTON:
return clientWidth - 38
else:
return clientWidth - 54
def GetRightButtonPos(self, pageContainer):
"""
Returns the right button position in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
"""
pc = pageContainer
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
rect = pc.GetClientRect()
clientWidth = rect.width
if agwStyle & FNB_NO_X_BUTTON:
return clientWidth - 22
else:
return clientWidth - 38
def GetDropArrowButtonPos(self, pageContainer):
"""
Returns the drop down button position in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
"""
return self.GetRightButtonPos(pageContainer)
def GetXPos(self, pageContainer):
"""
Returns the 'X' button position in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
"""
pc = pageContainer
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
rect = pc.GetClientRect()
clientWidth = rect.width
if agwStyle & FNB_NO_X_BUTTON:
return clientWidth
else:
return clientWidth - 22
def GetButtonsAreaLength(self, pageContainer):
"""
Returns the navigation area width.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
"""
pc = pageContainer
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
# ''
if agwStyle & FNB_NO_NAV_BUTTONS and agwStyle & FNB_NO_X_BUTTON and not agwStyle & FNB_DROPDOWN_TABS_LIST:
return 0
# 'x'
elif agwStyle & FNB_NO_NAV_BUTTONS and not agwStyle & FNB_NO_X_BUTTON and not agwStyle & FNB_DROPDOWN_TABS_LIST:
return 22
# '<>'
if not agwStyle & FNB_NO_NAV_BUTTONS and agwStyle & FNB_NO_X_BUTTON and not agwStyle & FNB_DROPDOWN_TABS_LIST:
return 53 - 16
# 'vx'
if agwStyle & FNB_DROPDOWN_TABS_LIST and not agwStyle & FNB_NO_X_BUTTON:
return 22 + 16
# 'v'
if agwStyle & FNB_DROPDOWN_TABS_LIST and agwStyle & FNB_NO_X_BUTTON:
return 22
# '<>x'
return 53
def DrawArrowAccordingToState(self, dc, pc, rect):
"""
Draws the left and right scrolling arrows.
:param `dc`: an instance of :class:`DC`;
:param `pc`: an instance of :class:`FlatNotebook`;
:param `rect`: the client rectangle containing the scrolling arrows.
"""
lightFactor = (pc.HasAGWFlag(FNB_BACKGROUND_GRADIENT) and [70] or [0])[0]
PaintStraightGradientBox(dc, rect, pc._tabAreaColour, LightColour(pc._tabAreaColour, lightFactor))
def DrawLeftArrow(self, pageContainer, dc):
"""
Draws the left navigation arrow.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`.
"""
pc = pageContainer
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
if agwStyle & FNB_NO_NAV_BUTTONS:
return
# Make sure that there are pages in the container
if not pc._pagesInfoVec:
return
if agwStyle & FNB_NAV_BUTTONS_WHEN_NEEDED:
if pc._pagesInfoVec[-1].GetPosition() != wx.Point(-1, -1) and pc._nFrom == 0:
return
# Set the bitmap according to the button status
if pc._nLeftButtonStatus == FNB_BTN_HOVER:
arrowBmp = wx.BitmapFromXPMData(left_arrow_hilite_xpm)
elif pc._nLeftButtonStatus == FNB_BTN_PRESSED:
arrowBmp = wx.BitmapFromXPMData(left_arrow_pressed_xpm)
else:
arrowBmp = wx.BitmapFromXPMData(left_arrow_xpm)
if pc._nFrom == 0:
# Handle disabled arrow
arrowBmp = wx.BitmapFromXPMData(left_arrow_disabled_xpm)
arrowBmp.SetMask(wx.Mask(arrowBmp, MASK_COLOUR))
# Erase old bitmap
posx = self.GetLeftButtonPos(pc)
self.DrawArrowAccordingToState(dc, pc, wx.Rect(posx, 6, 16, 14))
# Draw the new bitmap
dc.DrawBitmap(arrowBmp, posx, 6, True)
def DrawRightArrow(self, pageContainer, dc):
"""
Draws the right navigation arrow.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`.
"""
pc = pageContainer
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
if agwStyle & FNB_NO_NAV_BUTTONS:
return
# Make sure that there are pages in the container
if not pc._pagesInfoVec:
return
if agwStyle & FNB_NAV_BUTTONS_WHEN_NEEDED:
if pc._pagesInfoVec[-1].GetPosition() != wx.Point(-1, -1) and pc._nFrom == 0:
return
# Set the bitmap according to the button status
if pc._nRightButtonStatus == FNB_BTN_HOVER:
arrowBmp = wx.BitmapFromXPMData(right_arrow_hilite_xpm)
elif pc._nRightButtonStatus == FNB_BTN_PRESSED:
arrowBmp = wx.BitmapFromXPMData(right_arrow_pressed_xpm)
else:
arrowBmp = wx.BitmapFromXPMData(right_arrow_xpm)
# Check if the right most tab is visible, if it is
# don't rotate right anymore
if pc._pagesInfoVec[-1].GetPosition() != wx.Point(-1, -1):
arrowBmp = wx.BitmapFromXPMData(right_arrow_disabled_xpm)
arrowBmp.SetMask(wx.Mask(arrowBmp, MASK_COLOUR))
# erase old bitmap
posx = self.GetRightButtonPos(pc)
self.DrawArrowAccordingToState(dc, pc, wx.Rect(posx, 6, 16, 14))
# Draw the new bitmap
dc.DrawBitmap(arrowBmp, posx, 6, True)
def DrawDropDownArrow(self, pageContainer, dc):
"""
Draws the drop-down arrow in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`.
"""
pc = pageContainer
# Check if this style is enabled
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
if not agwStyle & FNB_DROPDOWN_TABS_LIST:
return
# Make sure that there are pages in the container
if not pc._pagesInfoVec:
return
if pc._nArrowDownButtonStatus == FNB_BTN_HOVER:
downBmp = wx.BitmapFromXPMData(down_arrow_hilite_xpm)
elif pc._nArrowDownButtonStatus == FNB_BTN_PRESSED:
downBmp = wx.BitmapFromXPMData(down_arrow_pressed_xpm)
else:
downBmp = wx.BitmapFromXPMData(down_arrow_xpm)
downBmp.SetMask(wx.Mask(downBmp, MASK_COLOUR))
# erase old bitmap
posx = self.GetDropArrowButtonPos(pc)
self.DrawArrowAccordingToState(dc, pc, wx.Rect(posx, 6, 16, 14))
# Draw the new bitmap
dc.DrawBitmap(downBmp, posx, 6, True)
def DrawX(self, pageContainer, dc):
"""
Draw the 'X' navigation button in the navigation area.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`.
"""
pc = pageContainer
# Check if this style is enabled
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
if agwStyle & FNB_NO_X_BUTTON:
return
# Make sure that there are pages in the container
if not pc._pagesInfoVec:
return
# Set the bitmap according to the button status
if pc._nXButtonStatus == FNB_BTN_HOVER:
xbmp = wx.BitmapFromXPMData(x_button_hilite_xpm)
elif pc._nXButtonStatus == FNB_BTN_PRESSED:
xbmp = wx.BitmapFromXPMData(x_button_pressed_xpm)
else:
xbmp = wx.BitmapFromXPMData(x_button_xpm)
xbmp.SetMask(wx.Mask(xbmp, MASK_COLOUR))
# erase old bitmap
posx = self.GetXPos(pc)
self.DrawArrowAccordingToState(dc, pc, wx.Rect(posx, 6, 16, 14))
# Draw the new bitmap
dc.DrawBitmap(xbmp, posx, 6, True)
def DrawTabX(self, pageContainer, dc, rect, tabIdx, btnStatus):
"""
Draws the 'X' in the selected tab.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `rect`: the current tab client rectangle;
:param `tabIdx`: the index of the current tab;
:param `btnStatus`: the status of the 'X' button in the current tab.
"""
pc = pageContainer
if not pc.HasAGWFlag(FNB_X_ON_TAB):
return
# We draw the 'x' on the active tab only
if tabIdx != pc.GetSelection() or tabIdx < 0:
return
# Set the bitmap according to the button status
if btnStatus == FNB_BTN_HOVER:
xBmp = wx.BitmapFromXPMData(x_button_hilite_xpm)
elif btnStatus == FNB_BTN_PRESSED:
xBmp = wx.BitmapFromXPMData(x_button_pressed_xpm)
else:
xBmp = wx.BitmapFromXPMData(x_button_xpm)
# Set the masking
xBmp.SetMask(wx.Mask(xBmp, MASK_COLOUR))
# Draw the new bitmap
dc.DrawBitmap(xBmp, rect.x, rect.y, True)
# Update the vector
rr = wx.Rect(rect.x, rect.y, 14, 13)
pc._pagesInfoVec[tabIdx].SetXRect(rr)
def DrawTabsLine(self, pageContainer, dc, selTabX1=-1, selTabX2=-1):
"""
Draws a line over the tabs.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `selTabX1`: first x coordinate of the tab line;
:param `selTabX2`: second x coordinate of the tab line.
"""
pc = pageContainer
clntRect = pc.GetClientRect()
clientRect3 = wx.Rect(0, 0, clntRect.width, clntRect.height)
if pc.HasAGWFlag(FNB_FF2):
if not pc.HasAGWFlag(FNB_BOTTOM):
fillColour = wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE)
else:
fillColour = wx.WHITE
dc.SetPen(wx.Pen(fillColour))
if pc.HasAGWFlag(FNB_BOTTOM):
dc.DrawLine(1, 0, clntRect.width-1, 0)
dc.DrawLine(1, 1, clntRect.width-1, 1)
dc.SetPen(wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW)))
dc.DrawLine(1, 2, clntRect.width-1, 2)
dc.SetPen(wx.Pen(fillColour))
dc.DrawLine(selTabX1 + 2, 2, selTabX2 - 1, 2)
else:
dc.DrawLine(1, clntRect.height, clntRect.width-1, clntRect.height)
dc.DrawLine(1, clntRect.height-1, clntRect.width-1, clntRect.height-1)
dc.SetPen(wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW)))
dc.DrawLine(1, clntRect.height-2, clntRect.width-1, clntRect.height-2)
dc.SetPen(wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE)))
dc.DrawLine(selTabX1 + 2, clntRect.height-2, selTabX2-1, clntRect.height-2)
else:
if pc.HasAGWFlag(FNB_BOTTOM):
clientRect = wx.Rect(0, 2, clntRect.width, clntRect.height - 2)
clientRect2 = wx.Rect(0, 1, clntRect.width, clntRect.height - 1)
else:
clientRect = wx.Rect(0, 0, clntRect.width, clntRect.height - 2)
clientRect2 = wx.Rect(0, 0, clntRect.width, clntRect.height - 1)
dc.SetBrush(wx.TRANSPARENT_BRUSH)
dc.SetPen(wx.Pen(pc.GetSingleLineBorderColour()))
dc.DrawRectangleRect(clientRect2)
dc.DrawRectangleRect(clientRect3)
dc.SetPen(wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW)))
dc.DrawRectangleRect(clientRect)
if not pc.HasAGWFlag(FNB_TABS_BORDER_SIMPLE):
dc.SetPen(wx.Pen((pc.HasAGWFlag(FNB_VC71) and [wx.Colour(247, 243, 233)] or [pc._tabAreaColour])[0]))
dc.DrawLine(0, 0, 0, clientRect.height+1)
if pc.HasAGWFlag(FNB_BOTTOM):
dc.DrawLine(0, clientRect.height+1, clientRect.width, clientRect.height+1)
else:
dc.DrawLine(0, 0, clientRect.width, 0)
dc.DrawLine(clientRect.width - 1, 0, clientRect.width - 1, clientRect.height+1)
def CalcTabWidth(self, pageContainer, tabIdx, tabHeight):
"""
Calculates the width of the input tab.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `tabIdx`: the index of the input tab;
:param `tabHeight`: the height of the tab.
"""
pc = pageContainer
dc = wx.MemoryDC()
dc.SelectObject(wx.EmptyBitmap(1,1))
boldFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
boldFont.SetWeight(wx.FONTWEIGHT_BOLD)
if pc.IsDefaultTabs():
shapePoints = int(tabHeight*math.tan(float(pc._pagesInfoVec[tabIdx].GetTabAngle())/180.0*math.pi))
# Calculate the text length using the bold font, so when selecting a tab
# its width will not change
dc.SetFont(boldFont)
width, pom = dc.GetTextExtent(pc.GetPageText(tabIdx))
# Set a minimum size to a tab
if width < 20:
width = 20
tabWidth = 2*pc._pParent.GetPadding() + width
# Style to add a small 'x' button on the top right
# of the tab
if pc.HasAGWFlag(FNB_X_ON_TAB) and tabIdx == pc.GetSelection():
# The xpm image that contains the 'x' button is 9 pixels
spacer = 9
if pc.HasAGWFlag(FNB_VC8):
spacer = 4
tabWidth += pc._pParent.GetPadding() + spacer
if pc.IsDefaultTabs():
# Default style
tabWidth += 2*shapePoints
hasImage = pc._ImageList != None and pc._pagesInfoVec[tabIdx].GetImageIndex() != -1
# For VC71 style, we only add the icon size (16 pixels)
if hasImage:
if not pc.IsDefaultTabs():
tabWidth += 16 + pc._pParent.GetPadding()
else:
# Default style
tabWidth += 16 + pc._pParent.GetPadding() + shapePoints/2
return tabWidth
def CalcTabHeight(self, pageContainer):
"""
Calculates the height of the input tab.
:param `pageContainer`: an instance of :class:`FlatNotebook`.
"""
if self._tabHeight:
return self._tabHeight
pc = pageContainer
dc = wx.MemoryDC()
dc.SelectObject(wx.EmptyBitmap(1,1))
# For GTK it seems that we must do this steps in order
# for the tabs will get the proper height on initialization
# on MSW, preforming these steps yields wierd results
normalFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
boldFont = normalFont
if "__WXGTK__" in wx.PlatformInfo:
boldFont.SetWeight(wx.FONTWEIGHT_BOLD)
dc.SetFont(boldFont)
height = dc.GetCharHeight()
tabHeight = height + FNB_HEIGHT_SPACER # We use 8 pixels as padding
if "__WXGTK__" in wx.PlatformInfo:
# On GTK the tabs are should be larger
tabHeight += 6
self._tabHeight = tabHeight
return tabHeight
def DrawTabs(self, pageContainer, dc):
"""
Actually draws the tabs in :class:`FlatNotebook`.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`.
"""
pc = pageContainer
if "__WXMAC__" in wx.PlatformInfo:
# Works well on MSW & GTK, however this lines should be skipped on MAC
if not pc._pagesInfoVec or pc._nFrom >= len(pc._pagesInfoVec):
pc.Hide()
return
# Get the text hight
tabHeight = self.CalcTabHeight(pageContainer)
agwStyle = pc.GetParent().GetAGWWindowStyleFlag()
# Calculate the number of rows required for drawing the tabs
rect = pc.GetClientRect()
clientWidth = rect.width
# Set the maximum client size
pc.SetSizeHints(self.GetButtonsAreaLength(pc), tabHeight)
borderPen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW))
if agwStyle & FNB_VC71:
backBrush = wx.Brush(wx.Colour(247, 243, 233))
else:
backBrush = wx.Brush(pc._tabAreaColour)
noselBrush = wx.Brush(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNFACE))
selBrush = wx.Brush(pc._activeTabColour)
size = pc.GetSize()
# Background
dc.SetTextBackground((agwStyle & FNB_VC71 and [wx.Colour(247, 243, 233)] or [pc.GetBackgroundColour()])[0])
dc.SetTextForeground(pc._activeTextColour)
dc.SetBrush(backBrush)
# If border style is set, set the pen to be border pen
if pc.HasAGWFlag(FNB_TABS_BORDER_SIMPLE):
dc.SetPen(borderPen)
else:
colr = (pc.HasAGWFlag(FNB_VC71) and [wx.Colour(247, 243, 233)] or [pc.GetBackgroundColour()])[0]
dc.SetPen(wx.Pen(colr))
if pc.HasAGWFlag(FNB_FF2):
lightFactor = (pc.HasAGWFlag(FNB_BACKGROUND_GRADIENT) and [70] or [0])[0]
PaintStraightGradientBox(dc, pc.GetClientRect(), pc._tabAreaColour, LightColour(pc._tabAreaColour, lightFactor))
dc.SetBrush(wx.TRANSPARENT_BRUSH)
dc.DrawRectangle(0, 0, size.x, size.y)
# We always draw the bottom/upper line of the tabs
# regradless the style
dc.SetPen(borderPen)
if not pc.HasAGWFlag(FNB_FF2):
self.DrawTabsLine(pc, dc)
# Restore the pen
dc.SetPen(borderPen)
if pc.HasAGWFlag(FNB_VC71):
greyLineYVal = (pc.HasAGWFlag(FNB_BOTTOM) and [0] or [size.y - 2])[0]
whiteLineYVal = (pc.HasAGWFlag(FNB_BOTTOM) and [3] or [size.y - 3])[0]
pen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE))
dc.SetPen(pen)
# Draw thik grey line between the windows area and
# the tab area
for num in xrange(3):
dc.DrawLine(0, greyLineYVal + num, size.x, greyLineYVal + num)
wbPen = (pc.HasAGWFlag(FNB_BOTTOM) and [wx.BLACK_PEN] or [wx.WHITE_PEN])[0]
dc.SetPen(wbPen)
dc.DrawLine(1, whiteLineYVal, size.x - 1, whiteLineYVal)
# Restore the pen
dc.SetPen(borderPen)
# Draw labels
normalFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
boldFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
boldFont.SetWeight(wx.FONTWEIGHT_BOLD)
dc.SetFont(boldFont)
posx = pc._pParent.GetPadding()
# Update all the tabs from 0 to 'pc._nFrom' to be non visible
for i in xrange(pc._nFrom):
pc._pagesInfoVec[i].SetPosition(wx.Point(-1, -1))
pc._pagesInfoVec[i].GetRegion().Clear()
count = pc._nFrom
#----------------------------------------------------------
# Go over and draw the visible tabs
#----------------------------------------------------------
x1 = x2 = -1
for i in xrange(pc._nFrom, len(pc._pagesInfoVec)):
dc.SetPen(borderPen)
if not pc.HasAGWFlag(FNB_FF2):
dc.SetBrush((i==pc.GetSelection() and [selBrush] or [noselBrush])[0])
# Now set the font to the correct font
dc.SetFont((i==pc.GetSelection() and [boldFont] or [normalFont])[0])
# Add the padding to the tab width
# Tab width:
# +-----------------------------------------------------------+
# | PADDING | IMG | IMG_PADDING | TEXT | PADDING | x |PADDING |
# +-----------------------------------------------------------+
tabWidth = self.CalcTabWidth(pageContainer, i, tabHeight)
# Check if we can draw more
if posx + tabWidth + self.GetButtonsAreaLength(pc) >= clientWidth:
break
count = count + 1
# By default we clean the tab region
pc._pagesInfoVec[i].GetRegion().Clear()
# Clean the 'x' buttn on the tab.
# A 'Clean' rectangle, is a rectangle with width or height
# with values lower than or equal to 0
pc._pagesInfoVec[i].GetXRect().SetSize(wx.Size(-1, -1))
# Draw the tab (border, text, image & 'x' on tab)
self.DrawTab(pc, dc, posx, i, tabWidth, tabHeight, pc._nTabXButtonStatus)
if pc.GetSelection() == i:
x1 = posx
x2 = posx + tabWidth + 2
# Restore the text forground
dc.SetTextForeground(pc._activeTextColour)
# Update the tab position & size
posy = (pc.HasAGWFlag(FNB_BOTTOM) and [0] or [VERTICAL_BORDER_PADDING])[0]
pc._pagesInfoVec[i].SetPosition(wx.Point(posx, posy))
pc._pagesInfoVec[i].SetSize(wx.Size(tabWidth, tabHeight))
self.DrawFocusRectangle(dc, pc, pc._pagesInfoVec[i])
posx += tabWidth
# Update all tabs that can not fit into the screen as non-visible
for i in xrange(count, len(pc._pagesInfoVec)):
pc._pagesInfoVec[i].SetPosition(wx.Point(-1, -1))
pc._pagesInfoVec[i].GetRegion().Clear()
# Draw the left/right/close buttons
# Left arrow
self.DrawLeftArrow(pc, dc)
self.DrawRightArrow(pc, dc)
self.DrawX(pc, dc)
self.DrawDropDownArrow(pc, dc)
if pc.HasAGWFlag(FNB_FF2):
self.DrawTabsLine(pc, dc, x1, x2)
def DrawFocusRectangle(self, dc, pageContainer, page):
"""
Draws a focus rectangle like the native :class:`Notebook`.
:param `dc`: an instance of :class:`DC`;
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `page`: an instance of :class:`PageInfo`, representing a page in the notebook.
"""
if not page._hasFocus:
return
tabPos = wx.Point(*page.GetPosition())
if pageContainer.GetParent().GetAGWWindowStyleFlag() & FNB_VC8:
vc8ShapeLen = self.CalcTabHeight(pageContainer) - VERTICAL_BORDER_PADDING - 2
tabPos.x += vc8ShapeLen
rect = wx.RectPS(tabPos, page.GetSize())
rect = wx.Rect(rect.x+2, rect.y+2, rect.width-4, rect.height-8)
if wx.Platform == '__WXMAC__':
rect.SetWidth(rect.GetWidth() + 1)
dc.SetBrush(wx.TRANSPARENT_BRUSH)
dc.SetPen(self._focusPen)
dc.DrawRoundedRectangleRect(rect, 2)
def DrawDragHint(self, pc, tabIdx):
"""
Draws tab drag hint, the default implementation is to do nothing.
You can override this function to provide a nice feedback to user.
:param `pc`: an instance of :class:`FlatNotebook`;
:param `tabIdx`: the index of the tab we are dragging.
:note: To show your own custom drag and drop UI feedback, you must override
this method in your derived class.
"""
pass
def NumberTabsCanFit(self, pageContainer, fr=-1):
"""
Calculates the number of tabs that can fit on the available space on screen.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `fr`: the current first visible tab.
"""
pc = pageContainer
rect = pc.GetClientRect()
clientWidth = rect.width
vTabInfo = []
tabHeight = self.CalcTabHeight(pageContainer)
# The drawing starts from posx
posx = pc._pParent.GetPadding()
if fr < 0:
fr = pc._nFrom
for i in xrange(fr, len(pc._pagesInfoVec)):
tabWidth = self.CalcTabWidth(pageContainer, i, tabHeight)
if posx + tabWidth + self.GetButtonsAreaLength(pc) >= clientWidth:
break;
# Add a result to the returned vector
tabRect = wx.Rect(posx, VERTICAL_BORDER_PADDING, tabWidth , tabHeight)
vTabInfo.append(tabRect)
# Advance posx
posx += tabWidth + FNB_HEIGHT_SPACER
return vTabInfo
# ---------------------------------------------------------------------------- #
# Class FNBRendererMgr
# A manager that handles all the renderers defined below and calls the
# appropriate one when drawing is needed
# ---------------------------------------------------------------------------- #
class FNBRendererMgr(object):
"""
This class represents a manager that handles all the 6 renderers defined
and calls the appropriate one when drawing is needed.
"""
def __init__(self):
""" Default class constructor. """
# register renderers
self._renderers = {}
self._renderers.update({-1: FNBRendererDefault()})
self._renderers.update({FNB_VC71: FNBRendererVC71()})
self._renderers.update({FNB_FANCY_TABS: FNBRendererFancy()})
self._renderers.update({FNB_VC8: FNBRendererVC8()})
self._renderers.update({FNB_RIBBON_TABS: FNBRendererRibbonTabs()})
self._renderers.update({FNB_FF2: FNBRendererFirefox2()})
def GetRenderer(self, style):
"""
Returns the current renderer based on the style selected.
:param `style`: represents one of the 6 implemented styles for :class:`FlatNotebook`,
namely one of these bits:
===================== ========= ======================
Tabs style Hex Value Description
===================== ========= ======================
``FNB_VC71`` 0x1 Use Visual Studio 2003 (VC7.1) style for tabs
``FNB_FANCY_TABS`` 0x2 Use fancy style - square tabs filled with gradient colouring
``FNB_VC8`` 0x100 Use Visual Studio 2005 (VC8) style for tabs
``FNB_FF2`` 0x20000 Use Firefox 2 style for tabs
``FNB_RIBBON_TABS`` 0x80000 Use the Ribbon Tabs style to render the tabs
===================== ========= ======================
"""
if style & FNB_VC71:
return self._renderers[FNB_VC71]
if style & FNB_FANCY_TABS:
return self._renderers[FNB_FANCY_TABS]
if style & FNB_VC8:
return self._renderers[FNB_VC8]
if style & FNB_FF2:
return self._renderers[FNB_FF2]
if style & FNB_RIBBON_TABS:
return self._renderers[FNB_RIBBON_TABS]
# the default is to return the default renderer
return self._renderers[-1]
#------------------------------------------
# Default renderer
#------------------------------------------
class FNBRendererDefault(FNBRenderer):
"""
This class handles the drawing of tabs using the standard renderer.
"""
def __init__(self):
""" Default class constructor. """
FNBRenderer.__init__(self)
def DrawTab(self, pageContainer, dc, posx, tabIdx, tabWidth, tabHeight, btnStatus):
"""
Draws a tab using the `Standard` style.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `posx`: the x position of the tab;
:param `tabIdx`: the index of the tab;
:param `tabWidth`: the tab's width;
:param `tabHeight`: the tab's height;
:param `btnStatus`: the status of the 'X' button inside this tab.
"""
# Default style
borderPen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW))
pc = pageContainer
tabPoints = [wx.Point() for ii in xrange(7)]
tabPoints[0].x = posx
tabPoints[0].y = (pc.HasAGWFlag(FNB_BOTTOM) and [2] or [tabHeight - 2])[0]
tabPoints[1].x = int(posx+(tabHeight-2)*math.tan(float(pc._pagesInfoVec[tabIdx].GetTabAngle())/180.0*math.pi))
tabPoints[1].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - (VERTICAL_BORDER_PADDING+2)] or [(VERTICAL_BORDER_PADDING+2)])[0]
tabPoints[2].x = tabPoints[1].x+2
tabPoints[2].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - VERTICAL_BORDER_PADDING] or [VERTICAL_BORDER_PADDING])[0]
tabPoints[3].x = int(posx+tabWidth-(tabHeight-2)*math.tan(float(pc._pagesInfoVec[tabIdx].GetTabAngle())/180.0*math.pi))-2
tabPoints[3].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - VERTICAL_BORDER_PADDING] or [VERTICAL_BORDER_PADDING])[0]
tabPoints[4].x = tabPoints[3].x+2
tabPoints[4].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - (VERTICAL_BORDER_PADDING+2)] or [(VERTICAL_BORDER_PADDING+2)])[0]
tabPoints[5].x = int(tabPoints[4].x+(tabHeight-2)*math.tan(float(pc._pagesInfoVec[tabIdx].GetTabAngle())/180.0*math.pi))
tabPoints[5].y = (pc.HasAGWFlag(FNB_BOTTOM) and [2] or [tabHeight - 2])[0]
tabPoints[6].x = tabPoints[0].x
tabPoints[6].y = tabPoints[0].y
if tabIdx == pc.GetSelection():
# Draw the tab as rounded rectangle
dc.DrawPolygon(tabPoints)
else:
if tabIdx != pc.GetSelection() - 1:
# Draw a vertical line to the right of the text
pt1x = tabPoints[5].x
pt1y = (pc.HasAGWFlag(FNB_BOTTOM) and [4] or [tabHeight - 6])[0]
pt2x = tabPoints[5].x
pt2y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - 4] or [4])[0]
dc.DrawLine(pt1x, pt1y, pt2x, pt2y)
if tabIdx == pc.GetSelection():
savePen = dc.GetPen()
whitePen = wx.Pen(wx.WHITE)
whitePen.SetWidth(1)
dc.SetPen(whitePen)
secPt = wx.Point(tabPoints[5].x + 1, tabPoints[5].y)
dc.DrawLine(tabPoints[0].x, tabPoints[0].y, secPt.x, secPt.y)
# Restore the pen
dc.SetPen(savePen)
# -----------------------------------
# Text and image drawing
# -----------------------------------
# Text drawing offset from the left border of the
# rectangle
# The width of the images are 16 pixels
padding = pc.GetParent().GetPadding()
shapePoints = int(tabHeight*math.tan(float(pc._pagesInfoVec[tabIdx].GetTabAngle())/180.0*math.pi))
hasImage = pc._pagesInfoVec[tabIdx].GetImageIndex() != -1
imageYCoord = (pc.HasAGWFlag(FNB_BOTTOM) and [6] or [8])[0]
if hasImage:
textOffset = 2*pc._pParent._nPadding + 16 + shapePoints/2
else:
textOffset = pc._pParent._nPadding + shapePoints/2
textOffset += 2
if tabIdx != pc.GetSelection():
# Set the text background to be like the vertical lines
dc.SetTextForeground(pc._pParent.GetNonActiveTabTextColour())
if hasImage:
imageXOffset = textOffset - 16 - padding
pc._ImageList.Draw(pc._pagesInfoVec[tabIdx].GetImageIndex(), dc,
posx + imageXOffset, imageYCoord,
wx.IMAGELIST_DRAW_TRANSPARENT, True)
pageTextColour = pc._pParent.GetPageTextColour(tabIdx)
if pageTextColour is not None:
dc.SetTextForeground(pageTextColour)
dc.DrawText(pc.GetPageText(tabIdx), posx + textOffset, imageYCoord)
# draw 'x' on tab (if enabled)
if pc.HasAGWFlag(FNB_X_ON_TAB) and tabIdx == pc.GetSelection():
textWidth, textHeight = dc.GetTextExtent(pc.GetPageText(tabIdx))
tabCloseButtonXCoord = posx + textOffset + textWidth + 1
# take a bitmap from the position of the 'x' button (the x on tab button)
# this bitmap will be used later to delete old buttons
tabCloseButtonYCoord = imageYCoord
x_rect = wx.Rect(tabCloseButtonXCoord, tabCloseButtonYCoord, 16, 16)
# Draw the tab
self.DrawTabX(pc, dc, x_rect, tabIdx, btnStatus)
#------------------------------------------
# Firefox2 renderer
#------------------------------------------
class FNBRendererFirefox2(FNBRenderer):
"""
This class handles the drawing of tabs using the `Firefox 2` renderer.
"""
def __init__(self):
""" Default class constructor. """
FNBRenderer.__init__(self)
def DrawTab(self, pageContainer, dc, posx, tabIdx, tabWidth, tabHeight, btnStatus):
"""
Draws a tab using the `Firefox 2` style.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `posx`: the x position of the tab;
:param `tabIdx`: the index of the tab;
:param `tabWidth`: the tab's width;
:param `tabHeight`: the tab's height;
:param `btnStatus`: the status of the 'X' button inside this tab.
"""
borderPen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW))
pc = pageContainer
tabPoints = [wx.Point() for indx in xrange(7)]
tabPoints[0].x = posx + 2
tabPoints[0].y = (pc.HasAGWFlag(FNB_BOTTOM) and [2] or [tabHeight - 2])[0]
tabPoints[1].x = tabPoints[0].x
tabPoints[1].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - (VERTICAL_BORDER_PADDING+2)] or [(VERTICAL_BORDER_PADDING+2)])[0]
tabPoints[2].x = tabPoints[1].x+2
tabPoints[2].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - VERTICAL_BORDER_PADDING] or [VERTICAL_BORDER_PADDING])[0]
tabPoints[3].x = posx + tabWidth - 2
tabPoints[3].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - VERTICAL_BORDER_PADDING] or [VERTICAL_BORDER_PADDING])[0]
tabPoints[4].x = tabPoints[3].x + 2
tabPoints[4].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - (VERTICAL_BORDER_PADDING+2)] or [(VERTICAL_BORDER_PADDING+2)])[0]
tabPoints[5].x = tabPoints[4].x
tabPoints[5].y = (pc.HasAGWFlag(FNB_BOTTOM) and [2] or [tabHeight - 2])[0]
tabPoints[6].x = tabPoints[0].x
tabPoints[6].y = tabPoints[0].y
#------------------------------------
# Paint the tab with gradient
#------------------------------------
rr = wx.RectPP(tabPoints[2], tabPoints[5])
DrawButton(dc, rr, pc.GetSelection() == tabIdx , not pc.HasAGWFlag(FNB_BOTTOM))
dc.SetBrush(wx.TRANSPARENT_BRUSH)
dc.SetPen(borderPen)
# Draw the tab as rounded rectangle
dc.DrawPolygon(tabPoints)
# -----------------------------------
# Text and image drawing
# -----------------------------------
# The width of the images are 16 pixels
padding = pc.GetParent().GetPadding()
shapePoints = int(tabHeight*math.tan(float(pc._pagesInfoVec[tabIdx].GetTabAngle())/180.0*math.pi))
hasImage = pc._pagesInfoVec[tabIdx].GetImageIndex() != -1
imageYCoord = (pc.HasAGWFlag(FNB_BOTTOM) and [6] or [8])[0]
if hasImage:
textOffset = 2*padding + 16 + shapePoints/2
else:
textOffset = padding + shapePoints/2
textOffset += 2
if tabIdx != pc.GetSelection():
# Set the text background to be like the vertical lines
dc.SetTextForeground(pc._pParent.GetNonActiveTabTextColour())
if hasImage:
imageXOffset = textOffset - 16 - padding
pc._ImageList.Draw(pc._pagesInfoVec[tabIdx].GetImageIndex(), dc,
posx + imageXOffset, imageYCoord,
wx.IMAGELIST_DRAW_TRANSPARENT, True)
pageTextColour = pc._pParent.GetPageTextColour(tabIdx)
if pageTextColour is not None:
dc.SetTextForeground(pageTextColour)
dc.DrawText(pc.GetPageText(tabIdx), posx + textOffset, imageYCoord)
# draw 'x' on tab (if enabled)
if pc.HasAGWFlag(FNB_X_ON_TAB) and tabIdx == pc.GetSelection():
textWidth, textHeight = dc.GetTextExtent(pc.GetPageText(tabIdx))
tabCloseButtonXCoord = posx + textOffset + textWidth + 1
# take a bitmap from the position of the 'x' button (the x on tab button)
# this bitmap will be used later to delete old buttons
tabCloseButtonYCoord = imageYCoord
x_rect = wx.Rect(tabCloseButtonXCoord, tabCloseButtonYCoord, 16, 16)
# Draw the tab
self.DrawTabX(pc, dc, x_rect, tabIdx, btnStatus)
#------------------------------------------------------------------
# Visual studio 7.1
#------------------------------------------------------------------
class FNBRendererVC71(FNBRenderer):
"""
This class handles the drawing of tabs using the `VC71` renderer.
"""
def __init__(self):
""" Default class constructor. """
FNBRenderer.__init__(self)
def DrawTab(self, pageContainer, dc, posx, tabIdx, tabWidth, tabHeight, btnStatus):
"""
Draws a tab using the `VC71` style.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `posx`: the x position of the tab;
:param `tabIdx`: the index of the tab;
:param `tabWidth`: the tab's width;
:param `tabHeight`: the tab's height;
:param `btnStatus`: the status of the 'X' button inside this tab.
"""
# Visual studio 7.1 style
borderPen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW))
pc = pageContainer
dc.SetPen((tabIdx == pc.GetSelection() and [wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE))] or [borderPen])[0])
dc.SetBrush((tabIdx == pc.GetSelection() and [wx.Brush(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE))] or [wx.Brush(wx.Colour(247, 243, 233))])[0])
if tabIdx == pc.GetSelection():
posy = (pc.HasAGWFlag(FNB_BOTTOM) and [0] or [VERTICAL_BORDER_PADDING])[0]
tabH = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - 5] or [tabHeight - 3])[0]
dc.DrawRectangle(posx, posy, tabWidth, tabH)
# Draw a black line on the left side of the
# rectangle
dc.SetPen(wx.BLACK_PEN)
blackLineY1 = VERTICAL_BORDER_PADDING
blackLineY2 = tabH
dc.DrawLine(posx + tabWidth, blackLineY1, posx + tabWidth, blackLineY2)
# To give the tab more 3D look we do the following
# Incase the tab is on top,
# Draw a thik white line on topof the rectangle
# Otherwise, draw a thin (1 pixel) black line at the bottom
pen = wx.Pen((pc.HasAGWFlag(FNB_BOTTOM) and [wx.BLACK] or [wx.WHITE])[0])
dc.SetPen(pen)
whiteLinePosY = (pc.HasAGWFlag(FNB_BOTTOM) and [blackLineY2] or [VERTICAL_BORDER_PADDING ])[0]
dc.DrawLine(posx , whiteLinePosY, posx + tabWidth + 1, whiteLinePosY)
# Draw a white vertical line to the left of the tab
dc.SetPen(wx.WHITE_PEN)
if not pc.HasAGWFlag(FNB_BOTTOM):
blackLineY2 += 1
dc.DrawLine(posx, blackLineY1, posx, blackLineY2)
else:
# We dont draw a rectangle for non selected tabs, but only
# vertical line on the left
blackLineY1 = (pc.HasAGWFlag(FNB_BOTTOM) and [VERTICAL_BORDER_PADDING + 2] or [VERTICAL_BORDER_PADDING + 1])[0]
blackLineY2 = pc.GetSize().y - 5
dc.DrawLine(posx + tabWidth, blackLineY1, posx + tabWidth, blackLineY2)
# -----------------------------------
# Text and image drawing
# -----------------------------------
# Text drawing offset from the left border of the
# rectangle
# The width of the images are 16 pixels
padding = pc.GetParent().GetPadding()
hasImage = pc._pagesInfoVec[tabIdx].GetImageIndex() != -1
imageYCoord = (pc.HasAGWFlag(FNB_BOTTOM) and [5] or [8])[0]
if hasImage:
textOffset = 2*pc._pParent._nPadding + 16
else:
textOffset = pc._pParent._nPadding
if tabIdx != pc.GetSelection():
# Set the text background to be like the vertical lines
dc.SetTextForeground(pc._pParent.GetNonActiveTabTextColour())
if hasImage:
imageXOffset = textOffset - 16 - padding
pc._ImageList.Draw(pc._pagesInfoVec[tabIdx].GetImageIndex(), dc,
posx + imageXOffset, imageYCoord,
wx.IMAGELIST_DRAW_TRANSPARENT, True)
pageTextColour = pc._pParent.GetPageTextColour(tabIdx)
if pageTextColour is not None:
dc.SetTextForeground(pageTextColour)
dc.DrawText(pc.GetPageText(tabIdx), posx + textOffset, imageYCoord)
# draw 'x' on tab (if enabled)
if pc.HasAGWFlag(FNB_X_ON_TAB) and tabIdx == pc.GetSelection():
textWidth, textHeight = dc.GetTextExtent(pc.GetPageText(tabIdx))
tabCloseButtonXCoord = posx + textOffset + textWidth + 1
# take a bitmap from the position of the 'x' button (the x on tab button)
# this bitmap will be used later to delete old buttons
tabCloseButtonYCoord = imageYCoord
x_rect = wx.Rect(tabCloseButtonXCoord, tabCloseButtonYCoord, 16, 16)
# Draw the tab
self.DrawTabX(pc, dc, x_rect, tabIdx, btnStatus)
#------------------------------------------------------------------
# Fancy style
#------------------------------------------------------------------
class FNBRendererFancy(FNBRenderer):
"""
This class handles the drawing of tabs using the `Fancy` renderer.
"""
def __init__(self):
""" Default class constructor. """
FNBRenderer.__init__(self)
def DrawTab(self, pageContainer, dc, posx, tabIdx, tabWidth, tabHeight, btnStatus):
"""
Draws a tab using the `Fancy` style, similar to the `VC71` one but with gradients.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `posx`: the x position of the tab;
:param `tabIdx`: the index of the tab;
:param `tabWidth`: the tab's width;
:param `tabHeight`: the tab's height;
:param `btnStatus`: the status of the 'X' button inside this tab.
"""
# Fancy tabs - like with VC71 but with the following differences:
# - The Selected tab is coloured with gradient colour
borderPen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW))
pc = pageContainer
pen = (tabIdx == pc.GetSelection() and [wx.Pen(pc._pParent.GetBorderColour())] or [wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE))])[0]
if tabIdx == pc.GetSelection():
posy = (pc.HasAGWFlag(FNB_BOTTOM) and [2] or [VERTICAL_BORDER_PADDING])[0]
th = tabHeight - 5
rect = wx.Rect(posx, posy, tabWidth, th)
col2 = (pc.HasAGWFlag(FNB_BOTTOM) and [pc._pParent.GetGradientColourTo()] or [pc._pParent.GetGradientColourFrom()])[0]
col1 = (pc.HasAGWFlag(FNB_BOTTOM) and [pc._pParent.GetGradientColourFrom()] or [pc._pParent.GetGradientColourTo()])[0]
PaintStraightGradientBox(dc, rect, col1, col2)
dc.SetBrush(wx.TRANSPARENT_BRUSH)
dc.SetPen(pen)
dc.DrawRectangleRect(rect)
# erase the bottom/top line of the rectangle
dc.SetPen(wx.Pen(pc._pParent.GetGradientColourFrom()))
if pc.HasAGWFlag(FNB_BOTTOM):
dc.DrawLine(rect.x, 2, rect.x + rect.width, 2)
else:
dc.DrawLine(rect.x, rect.y + rect.height - 1, rect.x + rect.width, rect.y + rect.height - 1)
else:
# We dont draw a rectangle for non selected tabs, but only
# vertical line on the left
dc.SetPen(borderPen)
dc.DrawLine(posx + tabWidth, VERTICAL_BORDER_PADDING + 3, posx + tabWidth, tabHeight - 4)
# -----------------------------------
# Text and image drawing
# -----------------------------------
# Text drawing offset from the left border of the
# rectangle
# The width of the images are 16 pixels
padding = pc.GetParent().GetPadding()
hasImage = pc._pagesInfoVec[tabIdx].GetImageIndex() != -1
imageYCoord = (pc.HasAGWFlag(FNB_BOTTOM) and [6] or [8])[0]
if hasImage:
textOffset = 2*pc._pParent._nPadding + 16
else:
textOffset = pc._pParent._nPadding
textOffset += 2
if tabIdx != pc.GetSelection():
# Set the text background to be like the vertical lines
dc.SetTextForeground(pc._pParent.GetNonActiveTabTextColour())
if hasImage:
imageXOffset = textOffset - 16 - padding
pc._ImageList.Draw(pc._pagesInfoVec[tabIdx].GetImageIndex(), dc,
posx + imageXOffset, imageYCoord,
wx.IMAGELIST_DRAW_TRANSPARENT, True)
pageTextColour = pc._pParent.GetPageTextColour(tabIdx)
if pageTextColour is not None:
dc.SetTextForeground(pageTextColour)
dc.DrawText(pc.GetPageText(tabIdx), posx + textOffset, imageYCoord)
# draw 'x' on tab (if enabled)
if pc.HasAGWFlag(FNB_X_ON_TAB) and tabIdx == pc.GetSelection():
textWidth, textHeight = dc.GetTextExtent(pc.GetPageText(tabIdx))
tabCloseButtonXCoord = posx + textOffset + textWidth + 1
# take a bitmap from the position of the 'x' button (the x on tab button)
# this bitmap will be used later to delete old buttons
tabCloseButtonYCoord = imageYCoord
x_rect = wx.Rect(tabCloseButtonXCoord, tabCloseButtonYCoord, 16, 16)
# Draw the tab
self.DrawTabX(pc, dc, x_rect, tabIdx, btnStatus)
#------------------------------------------------------------------
# Visual studio 2005 (VS8)
#------------------------------------------------------------------
class FNBRendererVC8(FNBRenderer):
"""
This class handles the drawing of tabs using the `VC8` renderer.
"""
def __init__(self):
""" Default class constructor. """
FNBRenderer.__init__(self)
self._first = True
self._factor = 1
def DrawTabs(self, pageContainer, dc):
"""
Draws all the tabs using `VC8` style.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`.
"""
pc = pageContainer
if "__WXMAC__" in wx.PlatformInfo:
# Works well on MSW & GTK, however this lines should be skipped on MAC
if not pc._pagesInfoVec or pc._nFrom >= len(pc._pagesInfoVec):
pc.Hide()
return
# Get the text hight
tabHeight = self.CalcTabHeight(pageContainer)
# Set the font for measuring the tab height
normalFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
boldFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
boldFont.SetWeight(wx.FONTWEIGHT_BOLD)
# Calculate the number of rows required for drawing the tabs
rect = pc.GetClientRect()
# Set the maximum client size
pc.SetSizeHints(self.GetButtonsAreaLength(pc), tabHeight)
borderPen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW))
# Create brushes
backBrush = wx.Brush(pc._tabAreaColour)
noselBrush = wx.Brush(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNFACE))
selBrush = wx.Brush(pc._activeTabColour)
size = pc.GetSize()
# Background
dc.SetTextBackground(pc.GetBackgroundColour())
dc.SetTextForeground(pc._activeTextColour)
# If border style is set, set the pen to be border pen
if pc.HasAGWFlag(FNB_TABS_BORDER_SIMPLE):
dc.SetPen(borderPen)
else:
dc.SetPen(wx.TRANSPARENT_PEN)
lightFactor = (pc.HasAGWFlag(FNB_BACKGROUND_GRADIENT) and [70] or [0])[0]
# For VC8 style, we colour the tab area in gradient colouring
lightcolour = LightColour(pc._tabAreaColour, lightFactor)
PaintStraightGradientBox(dc, pc.GetClientRect(), pc._tabAreaColour, lightcolour)
dc.SetBrush(wx.TRANSPARENT_BRUSH)
dc.DrawRectangle(0, 0, size.x, size.y)
# We always draw the bottom/upper line of the tabs
# regradless the style
dc.SetPen(borderPen)
self.DrawTabsLine(pc, dc)
# Restore the pen
dc.SetPen(borderPen)
# Draw labels
dc.SetFont(boldFont)
# Update all the tabs from 0 to 'pc.self._nFrom' to be non visible
for i in xrange(pc._nFrom):
pc._pagesInfoVec[i].SetPosition(wx.Point(-1, -1))
pc._pagesInfoVec[i].GetRegion().Clear()
# Draw the visible tabs, in VC8 style, we draw them from right to left
vTabsInfo = self.NumberTabsCanFit(pc)
activeTabPosx = 0
activeTabWidth = 0
activeTabHeight = 0
for cur in xrange(len(vTabsInfo)-1, -1, -1):
# 'i' points to the index of the currently drawn tab
# in pc.GetPageInfoVector() vector
i = pc._nFrom + cur
dc.SetPen(borderPen)
dc.SetBrush((i==pc.GetSelection() and [selBrush] or [noselBrush])[0])
# Now set the font to the correct font
dc.SetFont((i==pc.GetSelection() and [boldFont] or [normalFont])[0])
# Add the padding to the tab width
# Tab width:
# +-----------------------------------------------------------+
# | PADDING | IMG | IMG_PADDING | TEXT | PADDING | x |PADDING |
# +-----------------------------------------------------------+
tabWidth = self.CalcTabWidth(pageContainer, i, tabHeight)
posx = vTabsInfo[cur].x
# By default we clean the tab region
# incase we use the VC8 style which requires
# the region, it will be filled by the function
# drawVc8Tab
pc._pagesInfoVec[i].GetRegion().Clear()
# Clean the 'x' buttn on the tab
# 'Clean' rectanlge is a rectangle with width or height
# with values lower than or equal to 0
pc._pagesInfoVec[i].GetXRect().SetSize(wx.Size(-1, -1))
# Draw the tab
# Incase we are drawing the active tab
# we need to redraw so it will appear on top
# of all other tabs
# when using the vc8 style, we keep the position of the active tab so we will draw it again later
if i == pc.GetSelection() and pc.HasAGWFlag(FNB_VC8):
activeTabPosx = posx
activeTabWidth = tabWidth
activeTabHeight = tabHeight
else:
self.DrawTab(pc, dc, posx, i, tabWidth, tabHeight, pc._nTabXButtonStatus)
# Restore the text forground
dc.SetTextForeground(pc._activeTextColour)
# Update the tab position & size
pc._pagesInfoVec[i].SetPosition(wx.Point(posx, VERTICAL_BORDER_PADDING))
pc._pagesInfoVec[i].SetSize(wx.Size(tabWidth, tabHeight))
# Incase we are in VC8 style, redraw the active tab (incase it is visible)
if pc.GetSelection() >= pc._nFrom and pc.GetSelection() < pc._nFrom + len(vTabsInfo):
self.DrawTab(pc, dc, activeTabPosx, pc.GetSelection(), activeTabWidth, activeTabHeight, pc._nTabXButtonStatus)
# Update all tabs that can not fit into the screen as non-visible
for xx in xrange(pc._nFrom + len(vTabsInfo), len(pc._pagesInfoVec)):
pc._pagesInfoVec[xx].SetPosition(wx.Point(-1, -1))
pc._pagesInfoVec[xx].GetRegion().Clear()
# Draw the left/right/close buttons
# Left arrow
self.DrawLeftArrow(pc, dc)
self.DrawRightArrow(pc, dc)
self.DrawX(pc, dc)
self.DrawDropDownArrow(pc, dc)
def DrawTab(self, pageContainer, dc, posx, tabIdx, tabWidth, tabHeight, btnStatus):
"""
Draws a tab using the `VC8` style.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `posx`: the x position of the tab;
:param `tabIdx`: the index of the tab;
:param `tabWidth`: the tab's width;
:param `tabHeight`: the tab's height;
:param `btnStatus`: the status of the 'X' button inside this tab.
"""
pc = pageContainer
borderPen = wx.Pen(pc._pParent.GetBorderColour())
tabPoints = [wx.Point() for ii in xrange(8)]
# If we draw the first tab or the active tab,
# we draw a full tab, else we draw a truncated tab
#
# X(2) X(3)
# X(1) X(4)
#
# X(5)
#
# X(0),(7) X(6)
#
#
tabPoints[0].x = (pc.HasAGWFlag(FNB_BOTTOM) and [posx] or [posx+self._factor])[0]
tabPoints[0].y = (pc.HasAGWFlag(FNB_BOTTOM) and [2] or [tabHeight - 3])[0]
tabPoints[1].x = tabPoints[0].x + tabHeight - VERTICAL_BORDER_PADDING - 3 - self._factor
tabPoints[1].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - (VERTICAL_BORDER_PADDING+2)] or [(VERTICAL_BORDER_PADDING+2)])[0]
tabPoints[2].x = tabPoints[1].x + 4
tabPoints[2].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - VERTICAL_BORDER_PADDING] or [VERTICAL_BORDER_PADDING])[0]
tabPoints[3].x = tabPoints[2].x + tabWidth - 2
tabPoints[3].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabHeight - VERTICAL_BORDER_PADDING] or [VERTICAL_BORDER_PADDING])[0]
tabPoints[4].x = tabPoints[3].x + 1
tabPoints[4].y = (pc.HasAGWFlag(FNB_BOTTOM) and [tabPoints[3].y - 1] or [tabPoints[3].y + 1])[0]
tabPoints[5].x = tabPoints[4].x + 1
tabPoints[5].y = (pc.HasAGWFlag(FNB_BOTTOM) and [(tabPoints[4].y - 1)] or [tabPoints[4].y + 1])[0]
tabPoints[6].x = tabPoints[2].x + tabWidth
tabPoints[6].y = tabPoints[0].y
tabPoints[7].x = tabPoints[0].x
tabPoints[7].y = tabPoints[0].y
pc._pagesInfoVec[tabIdx].SetRegion(tabPoints)
# Draw the polygon
br = dc.GetBrush()
dc.SetBrush(wx.Brush((tabIdx == pc.GetSelection() and [pc._activeTabColour] or [pc._colourTo])[0]))
dc.SetPen(wx.Pen((tabIdx == pc.GetSelection() and [wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW)] or [pc._colourBorder])[0]))
dc.DrawPolygon(tabPoints)
# Restore the brush
dc.SetBrush(br)
rect = pc.GetClientRect()
if tabIdx != pc.GetSelection() and not pc.HasAGWFlag(FNB_BOTTOM):
# Top default tabs
dc.SetPen(wx.Pen(pc._pParent.GetBorderColour()))
lineY = rect.height
curPen = dc.GetPen()
curPen.SetWidth(1)
dc.SetPen(curPen)
dc.DrawLine(posx, lineY, posx+rect.width, lineY)
# Incase we are drawing the selected tab, we draw the border of it as well
# but without the bottom (upper line incase of wxBOTTOM)
if tabIdx == pc.GetSelection():
borderPen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW))
dc.SetPen(borderPen)
dc.SetBrush(wx.TRANSPARENT_BRUSH)
dc.DrawPolygon(tabPoints)
# Delete the bottom line (or the upper one, incase we use wxBOTTOM)
dc.SetPen(wx.WHITE_PEN)
dc.DrawLine(tabPoints[0].x, tabPoints[0].y, tabPoints[6].x, tabPoints[6].y)
self.FillVC8GradientColour(pc, dc, tabPoints, tabIdx == pc.GetSelection(), tabIdx)
# Draw a thin line to the right of the non-selected tab
if tabIdx != pc.GetSelection():
dc.SetPen(wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE)))
dc.DrawLine(tabPoints[4].x-1, tabPoints[4].y, tabPoints[5].x-1, tabPoints[5].y)
dc.DrawLine(tabPoints[5].x-1, tabPoints[5].y, tabPoints[6].x-1, tabPoints[6].y)
# Text drawing offset from the left border of the
# rectangle
# The width of the images are 16 pixels
vc8ShapeLen = tabHeight - VERTICAL_BORDER_PADDING - 2
if pc.TabHasImage(tabIdx):
textOffset = 2*pc._pParent.GetPadding() + 16 + vc8ShapeLen
else:
textOffset = pc._pParent.GetPadding() + vc8ShapeLen
# Draw the image for the tab if any
imageYCoord = (pc.HasAGWFlag(FNB_BOTTOM) and [6] or [8])[0]
if pc.TabHasImage(tabIdx):
imageXOffset = textOffset - 16 - pc._pParent.GetPadding()
pc._ImageList.Draw(pc._pagesInfoVec[tabIdx].GetImageIndex(), dc,
posx + imageXOffset, imageYCoord,
wx.IMAGELIST_DRAW_TRANSPARENT, True)
boldFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
# if selected tab, draw text in bold
if tabIdx == pc.GetSelection():
boldFont.SetWeight(wx.FONTWEIGHT_BOLD)
dc.SetFont(boldFont)
pageTextColour = pc._pParent.GetPageTextColour(tabIdx)
if pageTextColour is not None:
dc.SetTextForeground(pageTextColour)
dc.DrawText(pc.GetPageText(tabIdx), posx + textOffset, imageYCoord)
# draw 'x' on tab (if enabled)
if pc.HasAGWFlag(FNB_X_ON_TAB) and tabIdx == pc.GetSelection():
textWidth, textHeight = dc.GetTextExtent(pc.GetPageText(tabIdx))
tabCloseButtonXCoord = posx + textOffset + textWidth + 1
# take a bitmap from the position of the 'x' button (the x on tab button)
# this bitmap will be used later to delete old buttons
tabCloseButtonYCoord = imageYCoord
x_rect = wx.Rect(tabCloseButtonXCoord, tabCloseButtonYCoord, 16, 16)
# Draw the tab
self.DrawTabX(pc, dc, x_rect, tabIdx, btnStatus)
self.DrawFocusRectangle(dc, pc, pc._pagesInfoVec[tabIdx])
def FillVC8GradientColour(self, pageContainer, dc, tabPoints, bSelectedTab, tabIdx):
"""
Fills a tab with a gradient shading.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `tabPoints`: a Python list of :class:`Point` representing the tab outline;
:param `bSelectedTab`: ``True`` if the tab is selected, ``False`` otherwise;
:param `tabIdx`: the index of the tab;
"""
# calculate gradient coefficients
pc = pageContainer
if self._first:
self._first = False
pc._colourTo = LightColour(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE), 0)
pc._colourFrom = LightColour(wx.SystemSettings_GetColour(wx.SYS_COLOUR_3DFACE), 60)
col2 = pc._pParent.GetGradientColourTo()
col1 = pc._pParent.GetGradientColourFrom()
# If colourful tabs style is set, override the tab colour
if pc.HasAGWFlag(FNB_COLOURFUL_TABS):
if not pc._pagesInfoVec[tabIdx].GetColour():
# First time, generate colour, and keep it in the vector
tabColour = RandomColour()
pc._pagesInfoVec[tabIdx].SetColour(tabColour)
if pc.HasAGWFlag(FNB_BOTTOM):
col2 = LightColour(pc._pagesInfoVec[tabIdx].GetColour(), 50)
col1 = LightColour(pc._pagesInfoVec[tabIdx].GetColour(), 80)
else:
col1 = LightColour(pc._pagesInfoVec[tabIdx].GetColour(), 50)
col2 = LightColour(pc._pagesInfoVec[tabIdx].GetColour(), 80)
size = abs(tabPoints[2].y - tabPoints[0].y) - 1
rf, gf, bf = 0, 0, 0
rstep = float(col2.Red() - col1.Red())/float(size)
gstep = float(col2.Green() - col1.Green())/float(size)
bstep = float(col2.Blue() - col1.Blue())/float(size)
y = tabPoints[0].y
# If we are drawing the selected tab, we need also to draw a line
# from 0.tabPoints[0].x and tabPoints[6].x . end, we achieve this
# by drawing the rectangle with transparent brush
# the line under the selected tab will be deleted by the drwaing loop
if bSelectedTab:
self.DrawTabsLine(pc, dc)
while 1:
if pc.HasAGWFlag(FNB_BOTTOM):
if y > tabPoints[0].y + size:
break
else:
if y < tabPoints[0].y - size:
break
currCol = wx.Colour(col1.Red() + rf, col1.Green() + gf, col1.Blue() + bf)
dc.SetPen((bSelectedTab and [wx.Pen(pc._activeTabColour)] or [wx.Pen(currCol)])[0])
startX = self.GetStartX(tabPoints, y, pc.GetParent().GetAGWWindowStyleFlag())
endX = self.GetEndX(tabPoints, y, pc.GetParent().GetAGWWindowStyleFlag())
dc.DrawLine(startX, y, endX, y)
# Draw the border using the 'edge' point
dc.SetPen(wx.Pen((bSelectedTab and [wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW)] or [pc._colourBorder])[0]))
dc.DrawPoint(startX, y)
dc.DrawPoint(endX, y)
# Progress the colour
rf += rstep
gf += gstep
bf += bstep
if pc.HasAGWFlag(FNB_BOTTOM):
y = y + 1
else:
y = y - 1
def GetStartX(self, tabPoints, y, style):
"""
Returns the `x` start position of a tab.
:param `tabPoints`: a Python list of :class:`Point` representing the tab outline;
:param `y`: the y start position of the tab;
:param `style`: can be ``FNB_BOTTOM`` or the default (tabs at top).
"""
x1, x2, y1, y2 = 0.0, 0.0, 0.0, 0.0
# We check the 3 points to the left
bBottomStyle = (style & FNB_BOTTOM and [True] or [False])[0]
match = False
if bBottomStyle:
for i in xrange(3):
if y >= tabPoints[i].y and y < tabPoints[i+1].y:
x1 = tabPoints[i].x
x2 = tabPoints[i+1].x
y1 = tabPoints[i].y
y2 = tabPoints[i+1].y
match = True
break
else:
for i in xrange(3):
if y <= tabPoints[i].y and y > tabPoints[i+1].y:
x1 = tabPoints[i].x
x2 = tabPoints[i+1].x
y1 = tabPoints[i].y
y2 = tabPoints[i+1].y
match = True
break
if not match:
return tabPoints[2].x
# According to the equation y = ax + b => x = (y-b)/a
# We know the first 2 points
x1, x2, y1, y2 = map(float, (x1, x2, y1, y2))
if abs(x2 - x1) < 1e-6:
return x2
else:
a = (y2 - y1)/(x2 - x1)
b = y1 - ((y2 - y1)/(x2 - x1))*x1
if a == 0:
return int(x1)
x = (y - b)/a
return int(x)
def GetEndX(self, tabPoints, y, style):
"""
Returns the `x` end position of a tab.
:param `tabPoints`: a Python list of :class:`Point` representing the tab outline;
:param `y`: the y end position of the tab;
:param `style`: can be ``FNB_BOTTOM`` or the default (tabs at top).
"""
x1, x2, y1, y2 = 0.0, 0.0, 0.0, 0.0
# We check the 3 points to the left
bBottomStyle = (style & FNB_BOTTOM and [True] or [False])[0]
match = False
if bBottomStyle:
for i in xrange(7, 3, -1):
if y >= tabPoints[i].y and y < tabPoints[i-1].y:
x1 = tabPoints[i].x
x2 = tabPoints[i-1].x
y1 = tabPoints[i].y
y2 = tabPoints[i-1].y
match = True
break
else:
for i in xrange(7, 3, -1):
if y <= tabPoints[i].y and y > tabPoints[i-1].y:
x1 = tabPoints[i].x
x2 = tabPoints[i-1].x
y1 = tabPoints[i].y
y2 = tabPoints[i-1].y
match = True
break
if not match:
return tabPoints[3].x
# According to the equation y = ax + b => x = (y-b)/a
# We know the first 2 points
# Vertical line
if x1 == x2:
return int(x1)
a = (y2 - y1)/(x2 - x1)
b = y1 - ((y2 - y1)/(x2 - x1))*x1
if a == 0:
return int(x1)
x = (y - b)/a
return int(x)
def NumberTabsCanFit(self, pageContainer, fr=-1):
"""
Calculates the number of tabs that can fit on the available space on screen.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `fr`: the current first visible tab.
"""
pc = pageContainer
rect = pc.GetClientRect()
clientWidth = rect.width
# Empty results
vTabInfo = []
tabHeight = self.CalcTabHeight(pageContainer)
# The drawing starts from posx
posx = pc._pParent.GetPadding()
if fr < 0:
fr = pc._nFrom
for i in xrange(fr, len(pc._pagesInfoVec)):
vc8glitch = tabHeight + FNB_HEIGHT_SPACER
tabWidth = self.CalcTabWidth(pageContainer, i, tabHeight)
if posx + tabWidth + vc8glitch + self.GetButtonsAreaLength(pc) >= clientWidth:
break
# Add a result to the returned vector
tabRect = wx.Rect(posx, VERTICAL_BORDER_PADDING, tabWidth, tabHeight)
vTabInfo.append(tabRect)
# Advance posx
posx += tabWidth + FNB_HEIGHT_SPACER
return vTabInfo
#------------------------------------------------------------------
# Ribbon Tabs style
#------------------------------------------------------------------
class FNBRendererRibbonTabs(FNBRenderer):
"""
This class handles the drawing of tabs using the `Ribbon Tabs` renderer.
"""
def __init__(self):
""" Default class constructor. """
FNBRenderer.__init__(self)
self._first = True
self._factor = 1
# definte this because we don't want to use the bold font
def CalcTabWidth(self, pageContainer, tabIdx, tabHeight):
"""
Calculates the width of the input tab.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `tabIdx`: the index of the input tab;
:param `tabHeight`: the height of the tab.
"""
pc = pageContainer
dc = wx.MemoryDC()
dc.SelectObject(wx.EmptyBitmap(1,1))
font = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
if pc.IsDefaultTabs():
shapePoints = int(tabHeight*math.tan(float(pc._pagesInfoVec[tabIdx].GetTabAngle())/180.0*math.pi))
dc.SetFont(font)
width, pom = dc.GetTextExtent(pc.GetPageText(tabIdx))
# Set a minimum size to a tab
if width < 20:
width = 20
tabWidth = 2*pc._pParent.GetPadding() + width
# Style to add a small 'x' button on the top right
# of the tab
if pc.HasAGWFlag(FNB_X_ON_TAB) and tabIdx == pc.GetSelection():
# The xpm image that contains the 'x' button is 9 pixels
spacer = 9
if pc.HasAGWFlag(FNB_VC8):
spacer = 4
tabWidth += pc._pParent.GetPadding() + spacer
if pc.IsDefaultTabs():
# Default style
tabWidth += 2*shapePoints
hasImage = pc._ImageList != None and pc._pagesInfoVec[tabIdx].GetImageIndex() != -1
# For VC71 style, we only add the icon size (16 pixels)
if hasImage:
if not pc.IsDefaultTabs():
tabWidth += 16 + pc._pParent.GetPadding()
else:
# Default style
tabWidth += 16 + pc._pParent.GetPadding() + shapePoints/2
return tabWidth
def DrawTab(self, pageContainer, dc, posx, tabIdx, tabWidth, tabHeight, btnStatus):
"""
Draws a tab using the `Ribbon Tabs` style.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`;
:param `posx`: the x position of the tab;
:param `tabIdx`: the index of the tab;
:param `tabWidth`: the tab's width;
:param `tabHeight`: the tab's height;
:param `btnStatus`: the status of the 'X' button inside this tab.
"""
pc = pageContainer
gc = wx.GraphicsContext.Create(dc)
gc.SetPen(dc.GetPen())
gc.SetBrush(dc.GetBrush())
spacer = math.ceil(float(FNB_HEIGHT_SPACER)/2/2)
gc.DrawRoundedRectangle(posx+1,spacer,tabWidth-1,tabHeight-spacer*2,5)
if tabIdx == pc.GetSelection():
pass
else:
if tabIdx != pc.GetSelection() - 1:
pass
# -----------------------------------
# Text and image drawing
# -----------------------------------
# Text drawing offset from the left border of the
# rectangle
# The width of the images are 16 pixels
padding = pc.GetParent().GetPadding()
hasImage = pc._pagesInfoVec[tabIdx].GetImageIndex() != -1
imageYCoord = FNB_HEIGHT_SPACER/2
if hasImage:
textOffset = 2*pc._pParent._nPadding + 16
else:
textOffset = pc._pParent._nPadding
textOffset += 2
if tabIdx != pc.GetSelection():
# Set the text background to be like the vertical lines
dc.SetTextForeground(pc._pParent.GetNonActiveTabTextColour())
if hasImage:
imageXOffset = textOffset - 16 - padding
pc._ImageList.Draw(pc._pagesInfoVec[tabIdx].GetImageIndex(), dc,
posx + imageXOffset, imageYCoord,
wx.IMAGELIST_DRAW_TRANSPARENT, True)
pageTextColour = pc._pParent.GetPageTextColour(tabIdx)
if pageTextColour is not None:
dc.SetTextForeground(pageTextColour)
dc.DrawText(pc.GetPageText(tabIdx), posx + textOffset, imageYCoord)
# draw 'x' on tab (if enabled)
if pc.HasAGWFlag(FNB_X_ON_TAB) and tabIdx == pc.GetSelection():
textWidth, textHeight = dc.GetTextExtent(pc.GetPageText(tabIdx))
tabCloseButtonXCoord = posx + textOffset + textWidth + 1
# take a bitmap from the position of the 'x' button (the x on tab button)
# this bitmap will be used later to delete old buttons
tabCloseButtonYCoord = imageYCoord
x_rect = wx.Rect(tabCloseButtonXCoord, tabCloseButtonYCoord, 16, 16)
# Draw the tab
self.DrawTabX(pc, dc, x_rect, tabIdx, btnStatus)
def DrawTabs(self, pageContainer, dc):
"""
Actually draws the tabs in :class:`FlatNotebook`.
:param `pageContainer`: an instance of :class:`FlatNotebook`;
:param `dc`: an instance of :class:`DC`.
"""
pc = pageContainer
#style = pc.GetParent().GetWindowStyleFlag()
if "__WXMAC__" in wx.PlatformInfo:
# Works well on MSW & GTK, however this lines should be skipped on MAC
if not pc._pagesInfoVec or pc._nFrom >= len(pc._pagesInfoVec):
pc.Hide()
return
# Get the text height
tabHeight = self.CalcTabHeight(pageContainer)
# Calculate the number of rows required for drawing the tabs
rect = pc.GetClientRect()
clientWidth = rect.width
# Set the maximum client size
pc.SetSizeHints(self.GetButtonsAreaLength(pc), tabHeight)
size = pc.GetSize()
# Background
dc.SetTextBackground(pc.GetBackgroundColour())
dc.SetTextForeground(pc._activeTextColour)
borderPen = wx.Pen(wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW))
backBrush = wx.Brush(pc._tabAreaColour)
# If border style is set, set the pen to be border pen
if pc.HasAGWFlag(FNB_TABS_BORDER_SIMPLE):
dc.SetPen(borderPen)
else:
dc.SetPen(wx.Pen(pc._tabAreaColour))
dc.SetBrush(backBrush)
dc.DrawRectangle(0, 0, size.x, size.y)
# Draw labels
font = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
dc.SetFont(font)
posx = pc._pParent.GetPadding()
# Update all the tabs from 0 to 'pc._nFrom' to be non visible
for i in xrange(pc._nFrom):
pc._pagesInfoVec[i].SetPosition(wx.Point(-1, -1))
count = pc._nFrom
#----------------------------------------------------------
# Go over and draw the visible tabs
#----------------------------------------------------------
selPen = wx.Pen(adjust_colour(pc._tabAreaColour, -20))
noselPen = wx.Pen(pc._tabAreaColour)
noselBrush = wx.Brush(pc._tabAreaColour)
selBrush = wx.Brush(LightColour(pc._tabAreaColour,60))
for i in xrange(pc._nFrom, len(pc._pagesInfoVec)):
# This style highlights the selected tab and the tab the mouse is over
highlight = (i==pc.GetSelection()) or pc.IsMouseHovering(i)
dc.SetPen((highlight and [selPen] or [noselPen])[0])
dc.SetBrush((highlight and [selBrush] or [noselBrush])[0])
# Add the padding to the tab width
# Tab width:
# +-----------------------------------------------------------+
# | PADDING | IMG | IMG_PADDING | TEXT | PADDING | x |PADDING |
# +-----------------------------------------------------------+
tabWidth = self.CalcTabWidth(pageContainer, i, tabHeight)
# Check if we can draw more
if posx + tabWidth + self.GetButtonsAreaLength(pc) >= clientWidth:
break
count = count + 1
# By default we clean the tab region
#pc._pagesInfoVec[i].GetRegion().Clear()
# Clean the 'x' buttn on the tab.
# A 'Clean' rectangle, is a rectangle with width or height
# with values lower than or equal to 0
pc._pagesInfoVec[i].GetXRect().SetSize(wx.Size(-1, -1))
# Draw the tab (border, text, image & 'x' on tab)
self.DrawTab(pc, dc, posx, i, tabWidth, tabHeight, pc._nTabXButtonStatus)
# Restore the text forground
dc.SetTextForeground(pc._activeTextColour)
# Update the tab position & size
posy = (pc.HasAGWFlag(FNB_BOTTOM) and [0] or [VERTICAL_BORDER_PADDING])[0]
pc._pagesInfoVec[i].SetPosition(wx.Point(posx, posy))
pc._pagesInfoVec[i].SetSize(wx.Size(tabWidth, tabHeight))
posx += tabWidth
# Update all tabs that can not fit into the screen as non-visible
for i in xrange(count, len(pc._pagesInfoVec)):
pc._pagesInfoVec[i].SetPosition(wx.Point(-1, -1))
pc._pagesInfoVec[i].GetRegion().Clear()
# Draw the left/right/close buttons
# Left arrow
self.DrawLeftArrow(pc, dc)
self.DrawRightArrow(pc, dc)
self.DrawX(pc, dc)
self.DrawDropDownArrow(pc, dc)
# ---------------------------------------------------------------------------- #
# Class FlatNotebook
# ---------------------------------------------------------------------------- #
class FlatNotebook(wx.PyPanel):
"""
The :class:`FlatNotebook` is a full implementation of the :class:`Notebook`, and designed to be
a drop-in replacement for :class:`Notebook`. The API functions are similar so one can
expect the function to behave in the same way.
"""
def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize,
style=0, agwStyle=0, name="FlatNotebook"):
"""
Default class constructor.
:param `parent`: the :class:`FlatNotebook` parent;
:param `id`: an identifier for the control: a value of -1 is taken to mean a default;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param `style`: the underlying :class:`PyPanel` window style;
:param `agwStyle`: the AGW-specific window style. This can be a combination of the
following bits:
================================ =========== ==================================================
Window Styles Hex Value Description
================================ =========== ==================================================
``FNB_VC71`` 0x1 Use Visual Studio 2003 (VC7.1) style for tabs.
``FNB_FANCY_TABS`` 0x2 Use fancy style - square tabs filled with gradient colouring.
``FNB_TABS_BORDER_SIMPLE`` 0x4 Draw thin border around the page.
``FNB_NO_X_BUTTON`` 0x8 Do not display the 'X' button.
``FNB_NO_NAV_BUTTONS`` 0x10 Do not display the right/left arrows.
``FNB_MOUSE_MIDDLE_CLOSES_TABS`` 0x20 Use the mouse middle button for cloing tabs.
``FNB_BOTTOM`` 0x40 Place tabs at bottom - the default is to place them at top.
``FNB_NODRAG`` 0x80 Disable dragging of tabs.
``FNB_VC8`` 0x100 Use Visual Studio 2005 (VC8) style for tabs.
``FNB_X_ON_TAB`` 0x200 Place 'X' close button on the active tab.
``FNB_BACKGROUND_GRADIENT`` 0x400 Use gradients to paint the tabs background.
``FNB_COLOURFUL_TABS`` 0x800 Use colourful tabs (VC8 style only).
``FNB_DCLICK_CLOSES_TABS`` 0x1000 Style to close tab using double click.
``FNB_SMART_TABS`` 0x2000 Use `Smart Tabbing`, like ``Alt`` + ``Tab`` on Windows.
``FNB_DROPDOWN_TABS_LIST`` 0x4000 Use a dropdown menu on the left in place of the arrows.
``FNB_ALLOW_FOREIGN_DND`` 0x8000 Allows drag 'n' drop operations between different :class:`FlatNotebook`.
``FNB_HIDE_ON_SINGLE_TAB`` 0x10000 Hides the Page Container when there is one or fewer tabs.
``FNB_DEFAULT_STYLE`` 0x10020 :class:`FlatNotebook` default style.
``FNB_FF2`` 0x20000 Use Firefox 2 style for tabs.
``FNB_NO_TAB_FOCUS`` 0x40000 Does not allow tabs to have focus.
``FNB_RIBBON_TABS`` 0x80000 Use the Ribbon Tabs style.
``FNB_HIDE_TABS`` 0x100000 Hides the Page Container allowing only keyboard navigation
``FNB_NAV_BUTTONS_WHEN_NEEDED`` 0x200000 Hides the navigation left/right arrows if all tabs fit
================================ =========== ==================================================
:param `name`: the window name.
"""
self._bForceSelection = False
self._nPadding = 6
self._nFrom = 0
style |= wx.TAB_TRAVERSAL
self._pages = None
self._windows = []
self._popupWin = None
self._naviIcon = None
self._agwStyle = agwStyle
self._orientation = None
self._customPanel = None
wx.PyPanel.__init__(self, parent, id, pos, size, style)
attr = self.GetDefaultAttributes()
self.SetOwnForegroundColour(attr.colFg)
self.SetOwnBackgroundColour(attr.colBg)
self._pages = PageContainer(self, wx.ID_ANY, wx.DefaultPosition, wx.DefaultSize, style)
self.Bind(wx.EVT_NAVIGATION_KEY, self.OnNavigationKey)
self.Init()
def Init(self):
""" Initializes all the class attributes. """
self._pages._colourBorder = wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNSHADOW)
self._mainSizer = wx.BoxSizer(wx.VERTICAL)
self.SetSizer(self._mainSizer)
# The child panels will inherit this bg colour, so leave it at the default value
#self.SetBackgroundColour(wx.SystemSettings_GetColour(wx.SYS_COLOUR_APPWORKSPACE))
# Set default page height
dc = wx.ClientDC(self)
if "__WXGTK__" in wx.PlatformInfo:
# For GTK it seems that we must do this steps in order
# for the tabs will get the proper height on initialization
# on MSW, preforming these steps yields wierd results
boldFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
boldFont.SetWeight(wx.FONTWEIGHT_BOLD)
dc.SetFont(boldFont)
height = dc.GetCharHeight()
tabHeight = height + FNB_HEIGHT_SPACER # We use 8 pixels as padding
if "__WXGTK__" in wx.PlatformInfo:
tabHeight += 6
self._pages.SetSizeHints(-1, tabHeight)
# Add the tab container to the sizer
self._mainSizer.Insert(0, self._pages, 0, wx.EXPAND)
self._mainSizer.Layout()
self._pages._nFrom = self._nFrom
self._pDropTarget = FNBDropTarget(self)
self.SetDropTarget(self._pDropTarget)
def DoGetBestSize(self):
"""
Gets the size which best suits the window: for a control, it would be the
minimal size which doesn't truncate the control, for a panel - the same
size as it would have after a call to `Fit()`.
:note: Overridden from :class:`PyPanel`.
"""
if not self._windows:
# Something is better than nothing... no pages!
return wx.Size(20, 20)
maxWidth = maxHeight = 0
tabHeight = self.GetPageBestSize().height
for win in self._windows:
# Loop over all the windows to get their best size
width, height = win.GetBestSize()
maxWidth, maxHeight = max(maxWidth, width), max(maxHeight, height)
return wx.Size(maxWidth, maxHeight+tabHeight)
def Tile(self, orient=None):
"""
Shows pages in column/row mode (one panel after the other in columns/rows).
:param `orient`: this parameter represents the orientation of the stacked
panels. Pass ``wx.VERTICAL`` to get vertically stacked panels, ``wx.HORIZONTAL``
to get horizontally stacked panels or ``None`` to return to the default
:class:`FlatNotebook` behaviour with tabs.
"""
if orient == self._orientation:
return
self.Freeze()
self._orientation = orient
self._mainSizer.Detach(self._pages)
for win in self._windows:
self._mainSizer.Detach(win)
## self._mainSizer.Destroy()
if orient is not None:
self._mainSizer = wx.BoxSizer(orient)
self._mainSizer.Add(self._pages)
for win in self._windows:
self._mainSizer.Add(win, 1, wx.EXPAND | wx.ALL, 2)
win.Show()
else:
self._mainSizer = wx.BoxSizer(wx.VERTICAL)
# Add the tab container to the sizer
self._mainSizer.Insert(0, self._pages, 0, wx.EXPAND)
curr = self._pages.GetSelection()
for indx, win in enumerate(self._windows):
if indx == curr:
if self.GetAGWWindowStyleFlag() & FNB_BOTTOM:
self._mainSizer.Insert(0, win, 1, wx.EXPAND)
else:
# We leave a space of 1 pixel around the window
self._mainSizer.Add(win, 1, wx.EXPAND)
win.Show()
else:
win.Hide()
self.SetSizer(self._mainSizer)
self._mainSizer.Layout()
self.Layout()
if orient is None:
self.SetSelection(self._pages._iActivePage)
self._pages._ReShow()
self.Thaw()
def GetTileOrientation(self):
"""
Returns the orientation when on tiling mode. This method can return
``wx.VERTICAL`` when the panels are vertically stacked, ``wx.HORIZONTAL``
when they are horizontally stacked panels or ``None`` when there is no
stacking and :class:`FlatNotebook` behaves like a normal notebook.
"""
return self._orientation
def SetCustomPage(self, panel):
"""
Sets a custom panel to show when there are no pages left in :class:`FlatNotebook`.
:param `panel`: any subclass of :class:`Window` will do, as long as it is suitable
to be used as a notebook page. Examples include :class:`Panel`, :class:`ScrolledWindow`,
and so on.
"""
self.Freeze()
if panel is None:
if self._customPanel is not None:
self._mainSizer.Detach(self._customPanel)
self._customPanel.Show(False)
else:
if self._customPanel is not None:
self._mainSizer.Detach(self._customPanel)
self._customPanel.Show(False)
self._customPanel.Destroy()
self._customPanel = panel
self.ShowCustomPage(True)
self._pages._ReShow()
self._mainSizer.Layout()
self.Thaw()
def GetCustomPage(self):
""" Returns a custom panel to show when there are no pages left in :class:`FlatNotebook`. """
return self._customPanel
def ShowCustomPage(self, show=True):
""" Hides the custom panel which is shown when there are no pages left in :class:`FlatNotebook`. """
if self._customPanel is None:
return
self.Freeze()
self._customPanel.Show(False)
if show:
if self.GetPageCount() == 0:
self._mainSizer.Add(self._customPanel, 1, wx.EXPAND | wx.ALL, 2)
self._customPanel.Show(True)
else:
if self._customPanel.GetContainingSizer() is not None:
self._mainSizer.Detach(self._customPanel)
self._mainSizer.Layout()
self.Thaw()
def SetActiveTabTextColour(self, textColour):
"""
Sets the text colour for the active tab.
:param `textColour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython
to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple).
"""
self._pages._activeTextColour = FormatColour(textColour)
def OnDropTarget(self, x, y, nTabPage, wnd_oldContainer):
"""
Handles the drop action from a drag and drop operation.
:param `x`: the x position of the drop action;
:param `y`: the y position of the drop action;
:param `nTabPage`: the index of the tab being dropped;
:param `wnd_oldContainer`: the :class:`FlatNotebook` to which the dropped tab previously
belonged to.
"""
return self._pages.OnDropTarget(x, y, nTabPage, wnd_oldContainer)
def GetPreviousSelection(self):
""" Returns the previous selection. """
return self._pages._iPreviousActivePage
def AddPage(self, page, text, select=False, imageId=-1):
"""
Adds a page to the :class:`FlatNotebook`.
:param `page`: specifies the new page;
:param `text`: specifies the text for the new page;
:param `select`: specifies whether the page should be selected;
:param `imageId`: specifies the optional image index for the new page.
:return: ``True`` if successful, ``False`` otherwise.
"""
# sanity check
if not page:
return False
min_size = page.GetMinSize()
if not min_size.IsFullySpecified():
page.SetMinSize((1, 1))
self.ShowCustomPage(False)
# reparent the window to us
page.Reparent(self)
# Add tab
bSelected = select or len(self._windows) == 0
if bSelected:
bSelected = False
# Check for selection and send events
oldSelection = self._pages._iActivePage
tabIdx = len(self._windows)
event = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_CHANGING, self.GetId())
event.SetSelection(tabIdx)
event.SetOldSelection(oldSelection)
event.SetEventObject(self)
if not self.GetEventHandler().ProcessEvent(event) or event.IsAllowed() or len(self._windows) == 0:
bSelected = True
curSel = self._pages.GetSelection()
if not self._pages.IsShown():
self._pages.Show()
self._pages.AddPage(text, bSelected, imageId)
self._windows.append(page)
self.Freeze()
# Check if a new selection was made
if bSelected:
if curSel >= 0:
# Remove the window from the main sizer
self._mainSizer.Detach(self._windows[curSel])
self._windows[curSel].Hide()
if self.GetAGWWindowStyleFlag() & FNB_BOTTOM:
self._mainSizer.Insert(0, page, 1, wx.EXPAND)
else:
# We leave a space of 1 pixel around the window
self._mainSizer.Add(page, 1, wx.EXPAND)
# Fire a wxEVT_FLATNOTEBOOK_PAGE_CHANGED event
event.SetEventType(wxEVT_FLATNOTEBOOK_PAGE_CHANGED)
event.SetOldSelection(oldSelection)
self.GetEventHandler().ProcessEvent(event)
else:
# Hide the page
page.Hide()
self.Tile(self._orientation)
self.Thaw()
self._mainSizer.Layout()
self.Refresh()
return True
def SetImageList(self, imageList):
"""
Sets the image list for the page control.
:param `imageList`: an instance of :class:`ImageList`.
"""
self._pages.SetImageList(imageList)
def AssignImageList(self, imageList):
"""
Assigns the image list for the page control.
:param `imageList`: an instance of :class:`ImageList`.
"""
self._pages.AssignImageList(imageList)
def GetImageList(self):
""" Returns the associated image list. """
return self._pages.GetImageList()
def InsertPage(self, indx, page, text, select=True, imageId=-1):
"""
Inserts a new page at the specified position.
:param `indx`: specifies the position of the new page;
:param `page`: specifies the new page;
:param `text`: specifies the text for the new page;
:param `select`: specifies whether the page should be selected;
:param `imageId`: specifies the optional image index for the new page.
:return: ``True`` if successful, ``False`` otherwise.
"""
# sanity check
if not page:
return False
self.ShowCustomPage(False)
# reparent the window to us
page.Reparent(self)
if not self._windows:
self.AddPage(page, text, select, imageId)
return True
# Insert tab
bSelected = select or not self._windows
curSel = self._pages.GetSelection()
indx = max(0, min(indx, len(self._windows)))
if indx <= len(self._windows):
self._windows.insert(indx, page)
else:
self._windows.append(page)
if bSelected:
bSelected = False
# Check for selection and send events
oldSelection = self._pages._iActivePage
event = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_CHANGING, self.GetId())
event.SetSelection(indx)
event.SetOldSelection(oldSelection)
event.SetEventObject(self)
if not self.GetEventHandler().ProcessEvent(event) or event.IsAllowed() or len(self._windows) == 0:
bSelected = True
self._pages.InsertPage(indx, text, bSelected, imageId)
if indx <= curSel:
curSel = curSel + 1
self.Freeze()
# Check if a new selection was made
if bSelected:
if curSel >= 0:
# Remove the window from the main sizer
self._mainSizer.Detach(self._windows[curSel])
self._windows[curSel].Hide()
self._pages.SetSelection(indx)
# Fire a wxEVT_FLATNOTEBOOK_PAGE_CHANGED event
event.SetEventType(wxEVT_FLATNOTEBOOK_PAGE_CHANGED)
event.SetOldSelection(oldSelection)
self.GetEventHandler().ProcessEvent(event)
else:
# Hide the page
page.Hide()
self.Tile(self._orientation)
self.Thaw()
self._mainSizer.Layout()
self.Refresh()
return True
def SetSelection(self, page):
"""
Sets the selection for the given page.
:param `page`: an integer specifying the new selected page.
:note: The call to this function **does not** generate the page changing events.
"""
if page >= len(self._windows) or not self._windows:
return
# Support for disabed tabs
if not self._pages.GetEnabled(page) and len(self._windows) > 1 and not self._bForceSelection:
return
if self._orientation is not None:
return
curSel = self._pages.GetSelection()
# program allows the page change
self.Freeze()
if curSel >= 0:
# Remove the window from the main sizer
self._mainSizer.Detach(self._windows[curSel])
self._windows[curSel].Hide()
if self.GetAGWWindowStyleFlag() & FNB_BOTTOM:
self._mainSizer.Insert(0, self._windows[page], 1, wx.EXPAND)
else:
# We leave a space of 1 pixel around the window
self._mainSizer.Add(self._windows[page], 1, wx.EXPAND)
self._windows[page].Show()
self.Thaw()
self._mainSizer.Layout()
if page != self._pages._iActivePage:
# there is a real page changing
self._pages._iPreviousActivePage = self._pages._iActivePage
self._pages._iActivePage = page
self._pages.DoSetSelection(page)
def DeletePage(self, page):
"""
Deletes the specified page, and the associated window.
:param `page`: an integer specifying the new selected page.
:note: The call to this function generates the page changing events.
"""
if page >= len(self._windows) or page < 0:
return
# Fire a closing event
event = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_CLOSING, self.GetId())
event.SetSelection(page)
event.SetEventObject(self)
self.GetEventHandler().ProcessEvent(event)
# The event handler allows it?
if not event.IsAllowed():
return
self.Freeze()
# Delete the requested page
pageRemoved = self._windows[page]
# If the page is the current window, remove it from the sizer
# as well
if page == self._pages.GetSelection():
self._mainSizer.Detach(pageRemoved)
# Remove it from the array as well
self._windows.pop(page)
# Now we can destroy it in wxWidgets use Destroy instead of delete
pageRemoved.Destroy()
self.Thaw()
self._pages.DoDeletePage(page)
self.Tile(self._orientation)
self.ShowCustomPage(True)
self.Refresh()
self.Update()
# Fire a closed event
closedEvent = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_CLOSED, self.GetId())
closedEvent.SetSelection(page)
closedEvent.SetEventObject(self)
self.GetEventHandler().ProcessEvent(closedEvent)
def DeleteAllPages(self):
""" Deletes all the pages in the :class:`FlatNotebook`. """
if not self._windows:
return False
self.Freeze()
for page in self._windows:
page.Destroy()
self._windows = []
self.Thaw()
# Clear the container of the tabs as well
self._pages.DeleteAllPages()
self.ShowCustomPage(True)
return True
def GetCurrentPage(self):
""" Returns the currently selected notebook page or ``None`` if none is selected. """
sel = self._pages.GetSelection()
if sel < 0 or sel >= len(self._windows):
return None
return self._windows[sel]
def GetPage(self, page):
""" Returns the window at the given page position, or ``None``. """
if page >= len(self._windows):
return None
return self._windows[page]
def GetPageIndex(self, win):
"""
Returns the index at which the window is found.
:param `win`: an instance of :class:`Window`.
"""
try:
return self._windows.index(win)
except:
return -1
def GetSelection(self):
""" Returns the currently selected page, or -1 if none was selected. """
return self._pages.GetSelection()
def AdvanceSelection(self, forward=True):
"""
Cycles through the tabs.
:param `forward`: if ``True``, the selection is advanced in ascending order
(to the right), otherwise the selection is advanced in descending order.
:note: The call to this function generates the page changing events.
"""
self._pages.AdvanceSelection(forward)
def GetPageCount(self):
""" Returns the number of pages in the :class:`FlatNotebook` control. """
return self._pages.GetPageCount()
def SetNavigatorIcon(self, bmp):
"""
Set the icon used by the :class:`TabNavigatorWindow`.
:param `bmp`: a valid :class:`Bitmap` object.
"""
if isinstance(bmp, wx.Bitmap) and bmp.IsOk():
# Make sure image is proper size
if bmp.GetSize() != (16, 16):
img = bmp.ConvertToImage()
img.Rescale(16, 16, wx.IMAGE_QUALITY_HIGH)
bmp = wx.BitmapFromImage(img)
self._naviIcon = bmp
else:
raise TypeError("SetNavigatorIcon requires a valid bitmap")
def OnNavigationKey(self, event):
"""
Handles the ``wx.EVT_NAVIGATION_KEY`` event for :class:`FlatNotebook`.
:param `event`: a :class:`NavigationKeyEvent` event to be processed.
"""
if event.IsWindowChange():
if len(self._windows) == 0:
return
# change pages
if self.HasAGWFlag(FNB_SMART_TABS):
if not self._popupWin:
self._popupWin = TabNavigatorWindow(self, self._naviIcon)
self._popupWin.SetReturnCode(wx.ID_OK)
self._popupWin.ShowModal()
self._popupWin.Destroy()
self._popupWin = None
else:
# a dialog is already opened
self._popupWin.OnNavigationKey(event)
return
else:
# change pages
self.AdvanceSelection(event.GetDirection())
else:
event.Skip()
def GetPageShapeAngle(self, page_index):
"""
Returns the angle associated to a tab.
:param `page_index`: the index of the tab for which we wish to get the shape angle.
"""
if page_index < 0 or page_index >= len(self._pages._pagesInfoVec):
return None, False
result = self._pages._pagesInfoVec[page_index].GetTabAngle()
return result, True
def SetPageShapeAngle(self, page_index, angle):
"""
Sets the angle associated to a tab.
:param `page_index`: the index of the tab for which we wish to get the shape angle;
:param `angle`: the new shape angle for the tab (must be less than 15 degrees).
"""
if page_index < 0 or page_index >= len(self._pages._pagesInfoVec):
return
if angle > 15:
return
self._pages._pagesInfoVec[page_index].SetTabAngle(angle)
def SetAllPagesShapeAngle(self, angle):
"""
Sets the angle associated to all the tab.
:param `angle`: the new shape angle for the tab (must be less than 15 degrees).
"""
if angle > 15:
return
for ii in xrange(len(self._pages._pagesInfoVec)):
self._pages._pagesInfoVec[ii].SetTabAngle(angle)
self.Refresh()
def GetPageBestSize(self):
""" Return the page best size. """
return self._pages.GetClientSize()
def SetPageText(self, page, text):
"""
Sets the text for the given page.
:param `page`: an integer specifying the page index;
:param `text`: the new tab label.
"""
bVal = self._pages.SetPageText(page, text)
self._pages.Refresh()
return bVal
def SetPadding(self, padding):
"""
Sets the amount of space around each page's icon and label, in pixels.
:param `padding`: the amount of space around each page's icon and label,
in pixels.
:note: Only the horizontal padding is considered.
"""
self._nPadding = padding.GetWidth()
def GetTabArea(self):
""" Returns the associated page. """
return self._pages
def GetPadding(self):
""" Returns the amount of space around each page's icon and label, in pixels. """
return self._nPadding
def SetAGWWindowStyleFlag(self, agwStyle):
"""
Sets the :class:`FlatNotebook` window style flags.
:param `agwStyle`: the AGW-specific window style. This can be a combination of the
following bits:
================================ =========== ==================================================
Window Styles Hex Value Description
================================ =========== ==================================================
``FNB_VC71`` 0x1 Use Visual Studio 2003 (VC7.1) style for tabs.
``FNB_FANCY_TABS`` 0x2 Use fancy style - square tabs filled with gradient colouring.
``FNB_TABS_BORDER_SIMPLE`` 0x4 Draw thin border around the page.
``FNB_NO_X_BUTTON`` 0x8 Do not display the 'X' button.
``FNB_NO_NAV_BUTTONS`` 0x10 Do not display the right/left arrows.
``FNB_MOUSE_MIDDLE_CLOSES_TABS`` 0x20 Use the mouse middle button for cloing tabs.
``FNB_BOTTOM`` 0x40 Place tabs at bottom - the default is to place them at top.
``FNB_NODRAG`` 0x80 Disable dragging of tabs.
``FNB_VC8`` 0x100 Use Visual Studio 2005 (VC8) style for tabs.
``FNB_X_ON_TAB`` 0x200 Place 'X' close button on the active tab.
``FNB_BACKGROUND_GRADIENT`` 0x400 Use gradients to paint the tabs background.
``FNB_COLOURFUL_TABS`` 0x800 Use colourful tabs (VC8 style only).
``FNB_DCLICK_CLOSES_TABS`` 0x1000 Style to close tab using double click.
``FNB_SMART_TABS`` 0x2000 Use `Smart Tabbing`, like ``Alt`` + ``Tab`` on Windows.
``FNB_DROPDOWN_TABS_LIST`` 0x4000 Use a dropdown menu on the left in place of the arrows.
``FNB_ALLOW_FOREIGN_DND`` 0x8000 Allows drag 'n' drop operations between different :class:`FlatNotebook`.
``FNB_HIDE_ON_SINGLE_TAB`` 0x10000 Hides the Page Container when there is one or fewer tabs.
``FNB_DEFAULT_STYLE`` 0x10020 :class:`FlatNotebook` default style.
``FNB_FF2`` 0x20000 Use Firefox 2 style for tabs.
``FNB_NO_TAB_FOCUS`` 0x40000 Does not allow tabs to have focus.
``FNB_RIBBON_TABS`` 0x80000 Use the Ribbon Tabs style.
``FNB_HIDE_TABS`` 0x100000 Hides the Page Container allowing only keyboard navigation
``FNB_NAV_BUTTONS_WHEN_NEEDED`` 0x200000 Hides the navigation left/right arrows if all tabs fit
================================ =========== ==================================================
"""
oldStyle = self._agwStyle
self._agwStyle = agwStyle
renderer = self._pages._mgr.GetRenderer(agwStyle)
renderer._tabHeight = None
if self._pages:
# For changing the tab position (i.e. placing them top/bottom)
# refreshing the tab container is not enough
self.SetSelection(self._pages._iActivePage)
# If we just hid the tabs we must Refresh()
if (not (oldStyle & FNB_HIDE_TABS) and agwStyle & FNB_HIDE_TABS) or \
(not (oldStyle & FNB_HIDE_ON_SINGLE_TAB) and agwStyle & FNB_HIDE_ON_SINGLE_TAB):
self.Refresh()
if (oldStyle & FNB_HIDE_TABS and not (agwStyle & FNB_HIDE_TABS)) or \
(oldStyle & FNB_HIDE_ON_SINGLE_TAB and not self.HasAGWFlag(FNB_HIDE_ON_SINGLE_TAB)):
#For Redrawing the Tabs once you remove the Hide tyle
self._pages._ReShow()
def GetAGWWindowStyleFlag(self):
"""
Returns the :class:`FlatNotebook` window style.
:see: :meth:`~FlatNotebook.SetAGWWindowStyleFlag` for a list of valid window styles.
"""
return self._agwStyle
def HasAGWFlag(self, flag):
"""
Returns whether a flag is present in the :class:`FlatNotebook` style.
:param `flag`: one of the possible :class:`FlatNotebook` window styles.
:see: :meth:`~FlatNotebook.SetAGWWindowStyleFlag` for a list of possible window style flags.
"""
agwStyle = self.GetAGWWindowStyleFlag()
res = (agwStyle & flag and [True] or [False])[0]
return res
def HideTabs(self):
""" Hides the tabs. """
agwStyle = self.GetAGWWindowStyleFlag()
agwStyle |= FNB_HIDE_TABS
self.SetAGWWindowStyleFlag(agwStyle)
def ShowTabs(self):
""" Shows the tabs if hidden previously. """
agwStyle = self.GetAGWWindowStyleFlag()
agwStyle &= ~FNB_HIDE_TABS
self.SetAGWWindowStyleFlag(agwStyle)
def RemovePage(self, page):
"""
Deletes the specified page, without deleting the associated window.
:param `page`: an integer specifying the page index.
"""
if page >= len(self._windows):
return False
# Fire a closing event
event = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_CLOSING, self.GetId())
event.SetSelection(page)
event.SetEventObject(self)
self.GetEventHandler().ProcessEvent(event)
# The event handler allows it?
if not event.IsAllowed():
return False
self.Freeze()
# Remove the requested page
pageRemoved = self._windows[page]
# If the page is the current window, remove it from the sizer
# as well
if page == self._pages.GetSelection():
self._mainSizer.Detach(pageRemoved)
# Remove it from the array as well
self._windows.pop(page)
self.Tile(self._orientation)
self.ShowCustomPage(True)
self.Thaw()
self._pages.DoDeletePage(page)
return True
def SetRightClickMenu(self, menu):
"""
Sets the popup menu associated to a right click on a tab.
:param `menu`: an instance of :class:`Menu`.
"""
self._pages._pRightClickMenu = menu
def GetPageText(self, page):
"""
Returns the string for the given page.
:param `page`: an integer specifying the page index.
"""
return self._pages.GetPageText(page)
def SetGradientColours(self, fr, to, border):
"""
Sets the gradient colours for the tab.
:param `fr`: the first gradient colour, an instance of :class:`Colour`;
:param `to`: the second gradient colour, an instance of :class:`Colour`;
:param `border`: the border colour, an instance of :class:`Colour`.
"""
self._pages._colourFrom = fr
self._pages._colourTo = to
self._pages._colourBorder = border
def SetGradientColourFrom(self, fr):
"""
Sets the starting colour for the gradient.
:param `fr`: the first gradient colour, an instance of :class:`Colour`.
"""
self._pages._colourFrom = fr
def SetGradientColourTo(self, to):
"""
Sets the ending colour for the gradient.
:param `to`: the second gradient colour, an instance of :class:`Colour`;
"""
self._pages._colourTo = to
def SetGradientColourBorder(self, border):
"""
Sets the tab border colour.
:param `border`: the border colour, an instance of :class:`Colour`.
"""
self._pages._colourBorder = border
def GetGradientColourFrom(self):
""" Gets first gradient colour. """
return self._pages._colourFrom
def GetGradientColourTo(self):
""" Gets second gradient colour. """
return self._pages._colourTo
def GetGradientColourBorder(self):
""" Gets the tab border colour. """
return self._pages._colourBorder
def GetBorderColour(self):
""" Returns the border colour. """
return self._pages._colourBorder
def GetActiveTabTextColour(self):
""" Get the active tab text colour. """
return self._pages._activeTextColour
def SetPageImage(self, page, image):
"""
Sets the image index for the given page.
:param `page`: an integer specifying the page index;
:param `image`: an index into the image list which was set with :meth:`~FlatNotebook.SetImageList`.
"""
self._pages.SetPageImage(page, image)
def GetPageImage(self, page):
"""
Returns the image index for the given page.
:param `page`: an integer specifying the page index.
"""
return self._pages.GetPageImage(page)
def GetEnabled(self, page):
"""
Returns whether a tab is enabled or not.
:param `page`: an integer specifying the page index.
"""
return self._pages.GetEnabled(page)
def EnableTab(self, page, enabled=True):
"""
Enables or disables a tab.
:param `page`: an integer specifying the page index;
:param `enabled`: ``True`` to enable a tab, ``False`` to disable it.
"""
if page >= len(self._windows):
return
self._windows[page].Enable(enabled)
self._pages.EnableTab(page, enabled)
def GetNonActiveTabTextColour(self):
""" Returns the non active tabs text colour. """
return self._pages._nonActiveTextColour
def SetNonActiveTabTextColour(self, colour):
"""
Sets the non active tabs text colour.
:param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython
to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple).
"""
self._pages._nonActiveTextColour = FormatColour(colour)
def GetPageTextColour(self, page):
"""
Returns the tab text colour if it has been set previously, or ``None`` otherwise.
:param `page`: an integer specifying the page index.
"""
return self._pages.GetPageTextColour(page)
def SetPageTextColour(self, page, colour):
"""
Sets the tab text colour individually.
:param `page`: an integer specifying the page index;
:param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython
to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). You can
pass ``None`` or :class:`NullColour` to return to the default page text colour.
"""
self._pages.SetPageTextColour(page, colour)
def SetTabAreaColour(self, colour):
"""
Sets the area behind the tabs colour.
:param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython
to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple).
"""
self._pages._tabAreaColour = FormatColour(colour)
def GetTabAreaColour(self):
""" Returns the area behind the tabs colour. """
return self._pages._tabAreaColour
def SetActiveTabColour(self, colour):
"""
Sets the active tab colour.
:param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython
to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple).
"""
self._pages._activeTabColour = FormatColour(colour)
def GetActiveTabColour(self):
""" Returns the active tab colour. """
return self._pages._activeTabColour
def EnsureVisible(self, page):
"""
Ensures that a tab is visible.
:param `page`: an integer specifying the page index.
"""
self._pages.DoSetSelection(page)
# ---------------------------------------------------------------------------- #
# Class PageContainer
# Acts as a container for the pages you add to FlatNotebook
# ---------------------------------------------------------------------------- #
class PageContainer(wx.PyPanel):
"""
This class acts as a container for the pages you add to :class:`FlatNotebook`.
"""
def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition,
size=wx.DefaultSize, style=0):
"""
Default class constructor.
Used internally, do not call it in your code!
:param `parent`: the :class:`PageContainer` parent;
:param `id`: an identifier for the control: a value of -1 is taken to mean a default;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param `style`: the window style.
"""
self._ImageList = None
self._iActivePage = -1
self._pDropTarget = None
self._nLeftClickZone = FNB_NOWHERE
self._iPreviousActivePage = -1
self._pRightClickMenu = None
self._nXButtonStatus = FNB_BTN_NONE
self._nArrowDownButtonStatus = FNB_BTN_NONE
self._pParent = parent
self._nRightButtonStatus = FNB_BTN_NONE
self._nLeftButtonStatus = FNB_BTN_NONE
self._nTabXButtonStatus = FNB_BTN_NONE
self._nHoveringOverTabIndex = -1
self._nHoveringOverLastTabIndex = -1
self._setCursor = False
self._pagesInfoVec = []
self._colourTo = wx.SystemSettings_GetColour(wx.SYS_COLOUR_ACTIVECAPTION)
self._colourFrom = wx.WHITE
self._activeTabColour = wx.WHITE
self._activeTextColour = wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNTEXT)
self._nonActiveTextColour = wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNTEXT)
self._tabAreaColour = wx.SystemSettings_GetColour(wx.SYS_COLOUR_BTNFACE)
self._nFrom = 0
self._isdragging = False
# Set default page height, this is done according to the system font
memDc = wx.MemoryDC()
memDc.SelectObject(wx.EmptyBitmap(1,1))
if "__WXGTK__" in wx.PlatformInfo:
boldFont = wx.SystemSettings_GetFont(wx.SYS_DEFAULT_GUI_FONT)
boldFont.SetWeight(wx.BOLD)
memDc.SetFont(boldFont)
height = memDc.GetCharHeight()
tabHeight = height + FNB_HEIGHT_SPACER # We use 10 pixels as padding
wx.PyPanel.__init__(self, parent, id, pos, wx.Size(size.x, tabHeight),
style|wx.NO_BORDER|wx.NO_FULL_REPAINT_ON_RESIZE|wx.WANTS_CHARS)
attr = self.GetDefaultAttributes()
self.SetOwnForegroundColour(attr.colFg)
self.SetOwnBackgroundColour(attr.colBg)
self._pDropTarget = FNBDropTarget(self)
self.SetDropTarget(self._pDropTarget)
self._mgr = FNBRendererMgr()
self.Bind(wx.EVT_PAINT, self.OnPaint)
self.Bind(wx.EVT_SIZE, self.OnSize)
self.Bind(wx.EVT_LEFT_DOWN, self.OnLeftDown)
self.Bind(wx.EVT_LEFT_UP, self.OnLeftUp)
self.Bind(wx.EVT_RIGHT_DOWN, self.OnRightDown)
self.Bind(wx.EVT_MIDDLE_DOWN, self.OnMiddleDown)
self.Bind(wx.EVT_MOTION, self.OnMouseMove)
self.Bind(wx.EVT_MOUSEWHEEL, self.OnMouseWheel)
self.Bind(wx.EVT_ERASE_BACKGROUND, self.OnEraseBackground)
self.Bind(wx.EVT_LEAVE_WINDOW, self.OnMouseLeave)
self.Bind(wx.EVT_ENTER_WINDOW, self.OnMouseEnterWindow)
self.Bind(wx.EVT_LEFT_DCLICK, self.OnLeftDClick)
self.Bind(wx.EVT_SET_FOCUS, self.OnSetFocus)
self.Bind(wx.EVT_KILL_FOCUS, self.OnKillFocus)
self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
def OnEraseBackground(self, event):
"""
Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`PageContainer`.
:param `event`: a :class:`EraseEvent` event to be processed.
:note: This method is intentionally empty to reduce flicker.
"""
pass
def _ReShow(self):
"""
Handles the redraw of the tabs when the ``FNB_HIDE_ON_SINGLE_TAB`` has been removed.
"""
self.Show()
self.GetParent()._mainSizer.Layout()
self.Refresh()
def OnPaint(self, event):
"""
Handles the ``wx.EVT_PAINT`` event for :class:`PageContainer`.
:param `event`: a :class:`PaintEvent` event to be processed.
"""
dc = wx.BufferedPaintDC(self)
parent = self.GetParent()
renderer = self._mgr.GetRenderer(parent.GetAGWWindowStyleFlag())
renderer.DrawTabs(self, dc)
if self.HasAGWFlag(FNB_HIDE_ON_SINGLE_TAB) and len(self._pagesInfoVec) <= 1 or \
self.HasAGWFlag(FNB_HIDE_TABS) or parent._orientation or \
(parent._customPanel and len(self._pagesInfoVec) == 0):
self.Hide()
self.GetParent()._mainSizer.Layout()
self.Refresh()
def AddPage(self, caption, selected=False, imgindex=-1):
"""
Adds a page to the :class:`PageContainer`.
:param `page`: specifies the new page;
:param `text`: specifies the text for the new page;
:param `select`: specifies whether the page should be selected;
:param `imageId`: specifies the optional image index for the new page.
"""
if selected:
self._iPreviousActivePage = self._iActivePage
self._iActivePage = len(self._pagesInfoVec)
# Create page info and add it to the vector
pageInfo = PageInfo(caption, imgindex)
self._pagesInfoVec.append(pageInfo)
self.Refresh()
def InsertPage(self, indx, text, selected=True, imgindex=-1):
"""
Inserts a new page at the specified position.
:param `indx`: specifies the position of the new page;
:param `page`: specifies the new page;
:param `text`: specifies the text for the new page;
:param `select`: specifies whether the page should be selected;
:param `imageId`: specifies the optional image index for the new page.
"""
if selected:
self._iPreviousActivePage = self._iActivePage
self._iActivePage = len(self._pagesInfoVec)
self._pagesInfoVec.insert(indx, PageInfo(text, imgindex))
self.Refresh()
return True
def OnSize(self, event):
"""
Handles the ``wx.EVT_SIZE`` event for :class:`PageContainer`.
:param `event`: a :class:`SizeEvent` event to be processed.
"""
# When resizing the control, try to fit to screen as many tabs as we can
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
renderer = self._mgr.GetRenderer(agwStyle)
fr = 0
page = self.GetSelection()
for fr in xrange(self._nFrom):
vTabInfo = renderer.NumberTabsCanFit(self, fr)
if page - fr >= len(vTabInfo):
continue
break
self._nFrom = fr
self.Refresh() # Call on paint
event.Skip()
def OnMiddleDown(self, event):
"""
Handles the ``wx.EVT_MIDDLE_DOWN`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
# Test if this style is enabled
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
if not agwStyle & FNB_MOUSE_MIDDLE_CLOSES_TABS:
return
where, tabIdx = self.HitTest(event.GetPosition())
if where == FNB_TAB:
self.DeletePage(tabIdx)
event.Skip()
def OnMouseWheel(self, event):
"""
Handles the ``wx.EVT_MOUSEWHEEL`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
rotation = event.GetWheelRotation()
delta = event.GetWheelDelta()
steps = int(rotation/delta)
for tab in xrange(abs(steps)):
if steps > 0:
before = self._nLeftButtonStatus
self._nLeftButtonStatus = FNB_BTN_PRESSED
self.RotateLeft()
self._nLeftButtonStatus = before
else:
before = self._nRightButtonStatus
self._nRightButtonStatus = FNB_BTN_PRESSED
self.RotateRight()
self._nRightButtonStatus = before
event.Skip()
def OnRightDown(self, event):
"""
Handles the ``wx.EVT_RIGHT_DOWN`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
where, tabIdx = self.HitTest(event.GetPosition())
if where in [FNB_TAB, FNB_TAB_X]:
if self._pagesInfoVec[tabIdx].GetEnabled():
# This shouldn't really change the selection, so it's commented out
# Fire events and eventually (if allowed) change selection
# self.FireEvent(tabIdx)
# send a message to popup a custom menu
event = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_CONTEXT_MENU, self.GetParent().GetId())
event.SetSelection(tabIdx)
event.SetOldSelection(self._iActivePage)
event.SetEventObject(self.GetParent())
self.GetParent().GetEventHandler().ProcessEvent(event)
if self._pRightClickMenu:
self.PopupMenu(self._pRightClickMenu)
event.Skip()
def OnLeftDown(self, event):
"""
Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
# Reset buttons status
self._nXButtonStatus = FNB_BTN_NONE
self._nLeftButtonStatus = FNB_BTN_NONE
self._nRightButtonStatus = FNB_BTN_NONE
self._nTabXButtonStatus = FNB_BTN_NONE
self._nArrowDownButtonStatus = FNB_BTN_NONE
self._nLeftClickZone, tabIdx = self.HitTest(event.GetPosition())
if self._nLeftClickZone == FNB_DROP_DOWN_ARROW:
self._nArrowDownButtonStatus = FNB_BTN_PRESSED
self.Refresh()
elif self._nLeftClickZone == FNB_LEFT_ARROW:
self._nLeftButtonStatus = FNB_BTN_PRESSED
self.Refresh()
elif self._nLeftClickZone == FNB_RIGHT_ARROW:
self._nRightButtonStatus = FNB_BTN_PRESSED
self.Refresh()
elif self._nLeftClickZone == FNB_X:
self._nXButtonStatus = FNB_BTN_PRESSED
self.Refresh()
elif self._nLeftClickZone == FNB_TAB_X:
self._nTabXButtonStatus = FNB_BTN_PRESSED
self.Refresh()
elif self._nLeftClickZone == FNB_TAB:
if self._iActivePage != tabIdx:
# In case the tab is disabled, we dont allow to choose it
if len(self._pagesInfoVec) > tabIdx and \
self._pagesInfoVec[tabIdx].GetEnabled():
self.FireEvent(tabIdx)
def RotateLeft(self):
""" Scrolls tabs to the left by bulk of 5 tabs. """
if self._nFrom == 0:
return
# Make sure that the button was pressed before
if self._nLeftButtonStatus != FNB_BTN_PRESSED:
return
self._nLeftButtonStatus = FNB_BTN_HOVER
# We scroll left with bulks of 5
scrollLeft = self.GetNumTabsCanScrollLeft()
self._nFrom -= scrollLeft
if self._nFrom < 0:
self._nFrom = 0
self.Refresh()
def RotateRight(self):
""" Scrolls tabs to the right by bulk of 5 tabs. """
if self._nFrom >= len(self._pagesInfoVec) - 1:
return
# Make sure that the button was pressed before
if self._nRightButtonStatus != FNB_BTN_PRESSED:
return
self._nRightButtonStatus = FNB_BTN_HOVER
# Check if the right most tab is visible, if it is
# don't rotate right anymore
if self._pagesInfoVec[len(self._pagesInfoVec)-1].GetPosition() != wx.Point(-1, -1):
return
self._nFrom += 1
self.Refresh()
def OnLeftUp(self, event):
"""
Handles the ``wx.EVT_LEFT_UP`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
# forget the zone that was initially clicked
self._nLeftClickZone = FNB_NOWHERE
where, tabIdx = self.HitTest(event.GetPosition())
if not self.HasAGWFlag(FNB_NO_TAB_FOCUS):
# Make sure selected tab has focus
self.SetFocus()
if where == FNB_LEFT_ARROW:
self.RotateLeft()
elif where == FNB_RIGHT_ARROW:
self.RotateRight()
elif where == FNB_X:
# Make sure that the button was pressed before
if self._nXButtonStatus != FNB_BTN_PRESSED:
return
self._nXButtonStatus = FNB_BTN_HOVER
self.DeletePage(self._iActivePage)
elif where == FNB_TAB_X:
# Make sure that the button was pressed before
if self._nTabXButtonStatus != FNB_BTN_PRESSED:
return
self._nTabXButtonStatus = FNB_BTN_HOVER
self.DeletePage(self._iActivePage)
elif where == FNB_DROP_DOWN_ARROW:
# Make sure that the button was pressed before
if self._nArrowDownButtonStatus != FNB_BTN_PRESSED:
return
self._nArrowDownButtonStatus = FNB_BTN_NONE
# Refresh the button status
renderer = self._mgr.GetRenderer(self.GetParent().GetAGWWindowStyleFlag())
dc = wx.ClientDC(self)
renderer.DrawDropDownArrow(self, dc)
self.PopupTabsMenu()
event.Skip()
def HitTest(self, pt):
"""
HitTest method for :class:`PageContainer`.
:param `pt`: an instance of :class:`Point`, to test for hits.
:return: The hit test flag (if any) and the hit page index (if any). The return
value can be one of the following bits:
========================= ======= =================================
HitTest Flag Value Description
========================= ======= =================================
``FNB_NOWHERE`` 0 Indicates mouse coordinates not on any tab of the notebook
``FNB_TAB`` 1 Indicates mouse coordinates inside a tab
``FNB_X`` 2 Indicates mouse coordinates inside the 'X' button region
``FNB_TAB_X`` 3 Indicates mouse coordinates inside the 'X' region in a tab
``FNB_LEFT_ARROW`` 4 Indicates mouse coordinates inside the left arrow region
``FNB_RIGHT_ARROW`` 5 Indicates mouse coordinates inside the right arrow region
``FNB_DROP_DOWN_ARROW`` 6 Indicates mouse coordinates inside the drop down arrow region
========================= ======= =================================
"""
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
render = self._mgr.GetRenderer(agwStyle)
fullrect = self.GetClientRect()
btnLeftPos = render.GetLeftButtonPos(self)
btnRightPos = render.GetRightButtonPos(self)
btnXPos = render.GetXPos(self)
tabIdx = -1
if len(self._pagesInfoVec) == 0:
return FNB_NOWHERE, tabIdx
rect = wx.Rect(btnXPos, 8, 16, 16)
if rect.Contains(pt):
return (agwStyle & FNB_NO_X_BUTTON and [FNB_NOWHERE] or [FNB_X])[0], tabIdx
rect = wx.Rect(btnRightPos, 8, 16, 16)
if agwStyle & FNB_DROPDOWN_TABS_LIST:
rect = wx.Rect(render.GetDropArrowButtonPos(self), 8, 16, 16)
if rect.Contains(pt):
return FNB_DROP_DOWN_ARROW, tabIdx
if rect.Contains(pt):
return (agwStyle & FNB_NO_NAV_BUTTONS and [FNB_NOWHERE] or [FNB_RIGHT_ARROW])[0], tabIdx
rect = wx.Rect(btnLeftPos, 8, 16, 16)
if rect.Contains(pt):
return (agwStyle & FNB_NO_NAV_BUTTONS and [FNB_NOWHERE] or [FNB_LEFT_ARROW])[0], tabIdx
# Test whether a left click was made on a tab
bFoundMatch = False
for cur in xrange(self._nFrom, len(self._pagesInfoVec)):
pgInfo = self._pagesInfoVec[cur]
if pgInfo.GetPosition() == wx.Point(-1, -1):
continue
if agwStyle & FNB_X_ON_TAB and cur == self.GetSelection():
# 'x' button exists on a tab
if self._pagesInfoVec[cur].GetXRect().Contains(pt):
return FNB_TAB_X, cur
if agwStyle & FNB_VC8:
if self._pagesInfoVec[cur].GetRegion().Contains(pt.x, pt.y):
if bFoundMatch or cur == self.GetSelection():
return FNB_TAB, cur
tabIdx = cur
bFoundMatch = True
else:
tabRect = wx.Rect(pgInfo.GetPosition().x, pgInfo.GetPosition().y,
pgInfo.GetSize().x, pgInfo.GetSize().y)
if tabRect.Contains(pt):
# We have a match
return FNB_TAB, cur
if bFoundMatch:
return FNB_TAB, tabIdx
if self._isdragging:
# We are doing DND, so check also the region outside the tabs
# try before the first tab
pgInfo = self._pagesInfoVec[0]
tabRect = wx.Rect(0, pgInfo.GetPosition().y, pgInfo.GetPosition().x, self.GetParent().GetSize().y)
if tabRect.Contains(pt):
return FNB_TAB, 0
# try after the last tab
pgInfo = self._pagesInfoVec[-1]
startpos = pgInfo.GetPosition().x+pgInfo.GetSize().x
tabRect = wx.Rect(startpos, pgInfo.GetPosition().y, fullrect.width-startpos, self.GetParent().GetSize().y)
if tabRect.Contains(pt):
return FNB_TAB, len(self._pagesInfoVec)
# Default
return FNB_NOWHERE, -1
def SetSelection(self, page):
"""
Sets the selected page.
:param `page`: an integer specifying the page index.
"""
book = self.GetParent()
FlatNotebook.SetSelection(book, page)
## self.DoSetSelection(page)
def DoSetSelection(self, page):
"""
Does the actual selection of a page.
:param `page`: an integer specifying the page index.
"""
if page < len(self._pagesInfoVec):
#! fix for tabfocus
da_page = self._pParent.GetPage(page)
if da_page != None:
da_page.SetFocus()
if not self.IsTabVisible(page):
# Try to remove one tab from start and try again
if not self.CanFitToScreen(page):
if self._nFrom > page:
self._nFrom = page
else:
while self._nFrom < page:
self._nFrom += 1
if self.CanFitToScreen(page):
break
self.Refresh()
def DeletePage(self, page):
"""
Delete the specified page from :class:`PageContainer`.
:param `page`: an integer specifying the page index.
"""
book = self.GetParent()
book.DeletePage(page)
book.Refresh()
def IsMouseHovering(self, page):
"""
Returns whether or not the mouse is hovering over this page's tab
:param `page`: an integer specifying the page index.
"""
return page == self._nHoveringOverTabIndex
def IsTabVisible(self, page):
"""
Returns whether a tab is visible or not.
:param `page`: an integer specifying the page index.
"""
iLastVisiblePage = self.GetLastVisibleTab()
return page <= iLastVisiblePage and page >= self._nFrom
def DoDeletePage(self, page):
"""
Does the actual page deletion.
:param `page`: an integer specifying the page index.
"""
# Remove the page from the vector
book = self.GetParent()
self._pagesInfoVec.pop(page)
# Thanks to Yiaanis AKA Mandrav
if self._iActivePage >= page:
self._iActivePage = self._iActivePage - 1
self._iPreviousActivePage = -1
# The delete page was the last first on the array,
# but the book still has more pages, so we set the
# active page to be the first one (0)
if self._iActivePage < 0 and len(self._pagesInfoVec) > 0:
self._iActivePage = 0
self._iPreviousActivePage = -1
# Refresh the tabs
if self._iActivePage >= 0:
book._bForceSelection = True
# Check for selection and send event
event = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_CHANGING, self.GetParent().GetId())
event.SetSelection(self._iActivePage)
event.SetOldSelection(self._iPreviousActivePage)
event.SetEventObject(self.GetParent())
self.GetParent().GetEventHandler().ProcessEvent(event)
book.SetSelection(self._iActivePage)
book._bForceSelection = False
# Fire a wxEVT_FLATNOTEBOOK_PAGE_CHANGED event
event.SetEventType(wxEVT_FLATNOTEBOOK_PAGE_CHANGED)
event.SetOldSelection(self._iPreviousActivePage)
self.GetParent().GetEventHandler().ProcessEvent(event)
#if not self._pagesInfoVec:
# # Erase the page container drawings
# dc = wx.ClientDC(self)
# dc.Clear()
def DeleteAllPages(self):
""" Deletes all the pages in the :class:`PageContainer`. """
self._iActivePage = -1
self._iPreviousActivePage = -1
self._nFrom = 0
self._pagesInfoVec = []
# Erase the page container drawings
dc = wx.ClientDC(self)
dc.Clear()
def OnMouseMove(self, event):
"""
Handles the ``wx.EVT_MOTION`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
if self._pagesInfoVec and self.IsShown():
xButtonStatus = self._nXButtonStatus
xTabButtonStatus = self._nTabXButtonStatus
rightButtonStatus = self._nRightButtonStatus
leftButtonStatus = self._nLeftButtonStatus
dropDownButtonStatus = self._nArrowDownButtonStatus
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
self._nXButtonStatus = FNB_BTN_NONE
self._nRightButtonStatus = FNB_BTN_NONE
self._nLeftButtonStatus = FNB_BTN_NONE
self._nTabXButtonStatus = FNB_BTN_NONE
self._nArrowDownButtonStatus = FNB_BTN_NONE
bRedrawTabs = False
self._nHoveringOverTabIndex = -1
where, tabIdx = self.HitTest(event.GetPosition())
if where == FNB_X:
if event.LeftIsDown():
self._nXButtonStatus = (self._nLeftClickZone==FNB_X and [FNB_BTN_PRESSED] or [FNB_BTN_NONE])[0]
else:
self._nXButtonStatus = FNB_BTN_HOVER
elif where == FNB_DROP_DOWN_ARROW:
if event.LeftIsDown():
self._nArrowDownButtonStatus = (self._nLeftClickZone==FNB_DROP_DOWN_ARROW and [FNB_BTN_PRESSED] or [FNB_BTN_NONE])[0]
else:
self._nArrowDownButtonStatus = FNB_BTN_HOVER
elif where == FNB_TAB_X:
if event.LeftIsDown():
self._nTabXButtonStatus = (self._nLeftClickZone==FNB_TAB_X and [FNB_BTN_PRESSED] or [FNB_BTN_NONE])[0]
else:
self._nTabXButtonStatus = FNB_BTN_HOVER
elif where == FNB_RIGHT_ARROW:
if event.LeftIsDown():
self._nRightButtonStatus = (self._nLeftClickZone==FNB_RIGHT_ARROW and [FNB_BTN_PRESSED] or [FNB_BTN_NONE])[0]
else:
self._nRightButtonStatus = FNB_BTN_HOVER
elif where == FNB_LEFT_ARROW:
if event.LeftIsDown():
self._nLeftButtonStatus = (self._nLeftClickZone==FNB_LEFT_ARROW and [FNB_BTN_PRESSED] or [FNB_BTN_NONE])[0]
else:
self._nLeftButtonStatus = FNB_BTN_HOVER
elif where == FNB_TAB:
# Call virtual method for showing tooltip
self.ShowTabTooltip(tabIdx)
if not self.GetEnabled(tabIdx):
# Set the cursor to be 'No-entry'
wx.SetCursor(wx.StockCursor(wx.CURSOR_NO_ENTRY))
self._setCursor = True
else:
self._nHoveringOverTabIndex = tabIdx
if self._setCursor:
wx.SetCursor(wx.StockCursor(wx.CURSOR_ARROW))
self._setCursor = False
# Support for drag and drop
if event.Dragging() and not (agwStyle & FNB_NODRAG):
self._isdragging = True
draginfo = FNBDragInfo(self, tabIdx)
drginfo = cPickle.dumps(draginfo)
dataobject = wx.CustomDataObject(wx.CustomDataFormat("FlatNotebook"))
dataobject.SetData(drginfo)
dragSource = FNBDropSource(self)
dragSource.SetData(dataobject)
dragSource.DoDragDrop(wx.Drag_DefaultMove)
if self._nHoveringOverTabIndex != self._nHoveringOverLastTabIndex:
self._nHoveringOverLastTabIndex = self._nHoveringOverTabIndex
if self._nHoveringOverTabIndex >= 0:
bRedrawTabs = True
bRedrawX = self._nXButtonStatus != xButtonStatus
bRedrawRight = self._nRightButtonStatus != rightButtonStatus
bRedrawLeft = self._nLeftButtonStatus != leftButtonStatus
bRedrawTabX = self._nTabXButtonStatus != xTabButtonStatus
bRedrawDropArrow = self._nArrowDownButtonStatus != dropDownButtonStatus
render = self._mgr.GetRenderer(agwStyle)
if (bRedrawX or bRedrawRight or bRedrawLeft or bRedrawTabX or bRedrawDropArrow or bRedrawTabs):
dc = wx.ClientDC(self)
if bRedrawX:
render.DrawX(self, dc)
if bRedrawLeft:
render.DrawLeftArrow(self, dc)
if bRedrawRight:
render.DrawRightArrow(self, dc)
if bRedrawTabX or bRedrawTabs:
self.Refresh()
if bRedrawDropArrow:
render.DrawDropDownArrow(self, dc)
event.Skip()
def GetLastVisibleTab(self):
""" Returns the last visible tab in the tab area. """
if self._nFrom < 0:
return -1
ii = 0
for ii in xrange(self._nFrom, len(self._pagesInfoVec)):
if self._pagesInfoVec[ii].GetPosition() == wx.Point(-1, -1):
break
return ii-1
def GetNumTabsCanScrollLeft(self):
""" Returns the number of tabs than can be scrolled left. """
if self._nFrom - 1 >= 0:
return 1
return 0
def IsDefaultTabs(self):
""" Returns whether a tab has a default style. """
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
res = (agwStyle & FNB_VC71) or (agwStyle & FNB_FANCY_TABS) or (agwStyle & FNB_VC8)
return not res
def AdvanceSelection(self, forward=True):
"""
Cycles through the tabs.
:param `forward`: if ``True``, the selection is advanced in ascending order
(to the right), otherwise the selection is advanced in descending order.
:note: The call to this function generates the page changing events.
"""
nSel = self.GetSelection()
if nSel < 0:
return
nMax = self.GetPageCount() - 1
if forward:
newSelection = (nSel == nMax and [0] or [nSel + 1])[0]
else:
newSelection = (nSel == 0 and [nMax] or [nSel - 1])[0]
if not self._pagesInfoVec[newSelection].GetEnabled():
return
self.FireEvent(newSelection)
def OnMouseLeave(self, event):
"""
Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
self._nLeftButtonStatus = FNB_BTN_NONE
self._nXButtonStatus = FNB_BTN_NONE
self._nRightButtonStatus = FNB_BTN_NONE
self._nTabXButtonStatus = FNB_BTN_NONE
self._nArrowDownButtonStatus = FNB_BTN_NONE
self._nHoveringOverTabIndex = -1
self._nHoveringOverLastTabIndex = -1
self.Refresh()
selection = self.GetSelection()
if selection == -1:
event.Skip()
return
if not self.IsTabVisible(selection):
if selection == len(self._pagesInfoVec) - 1:
if not self.CanFitToScreen(selection):
event.Skip()
return
else:
event.Skip()
return
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
render = self._mgr.GetRenderer(agwStyle)
dc = wx.ClientDC(self)
render.DrawTabX(self, dc, self._pagesInfoVec[selection].GetXRect(), selection, self._nTabXButtonStatus)
if not agwStyle & FNB_RIBBON_TABS:
render.DrawFocusRectangle(dc, self, self._pagesInfoVec[selection])
event.Skip()
def OnMouseEnterWindow(self, event):
"""
Handles the ``wx.EVT_ENTER_WINDOW`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
self._nLeftButtonStatus = FNB_BTN_NONE
self._nXButtonStatus = FNB_BTN_NONE
self._nRightButtonStatus = FNB_BTN_NONE
self._nLeftClickZone = FNB_BTN_NONE
self._nArrowDownButtonStatus = FNB_BTN_NONE
event.Skip()
def ShowTabTooltip(self, tabIdx):
"""
Shows a tab tooltip.
:param `tabIdx`: an integer specifying the page index.
"""
pWindow = self._pParent.GetPage(tabIdx)
if pWindow:
pToolTip = pWindow.GetToolTip()
if pToolTip and pToolTip.GetWindow() == pWindow:
self.SetToolTipString(pToolTip.GetTip())
def SetPageImage(self, page, image):
"""
Sets the image index for the given page.
:param `page`: an integer specifying the page index;
:param `image`: an index into the image list which was set with :meth:`~PageContainer.SetImageList`.
"""
if page < len(self._pagesInfoVec):
self._pagesInfoVec[page].SetImageIndex(image)
self.Refresh()
def GetPageImage(self, page):
"""
Returns the image index associated to a page.
:param `page`: an integer specifying the page index.
"""
if page < len(self._pagesInfoVec):
return self._pagesInfoVec[page].GetImageIndex()
return -1
def GetPageTextColour(self, page):
"""
Returns the tab text colour if it has been set previously, or ``None`` otherwise.
:param `page`: an integer specifying the page index.
"""
if page < len(self._pagesInfoVec):
return self._pagesInfoVec[page].GetPageTextColour()
return None
def SetPageTextColour(self, page, colour):
"""
Sets the tab text colour individually.
:param `page`: an integer specifying the page index;
:param `colour`: a valid :class:`Colour` object or any typemap supported by wxWidgets/wxPython
to generate a colour (i.e., a hex string, a colour name, a 3 or 4 integer tuple). You can
pass ``None`` or :class:`NullColour` to return to the default page text colour.
"""
if page < len(self._pagesInfoVec):
self._pagesInfoVec[page].SetPageTextColour(colour)
self.Refresh()
def OnDropTarget(self, x, y, nTabPage, wnd_oldContainer):
"""
Handles the drop action from a drag and drop operation.
:param `x`: the x position of the drop action;
:param `y`: the y position of the drop action;
:param `nTabPage`: the index of the tab being dropped;
:param `wnd_oldContainer`: the :class:`FlatNotebook` to which the dropped tab previously
belonged to.
"""
# Disable drag'n'drop for disabled tab
if len(wnd_oldContainer._pagesInfoVec) > nTabPage and \
not wnd_oldContainer._pagesInfoVec[nTabPage].GetEnabled():
return wx.DragCancel
self._isdragging = True
oldContainer = wnd_oldContainer
nIndex = -1
where, nIndex = self.HitTest(wx.Point(x, y))
oldNotebook = oldContainer.GetParent()
newNotebook = self.GetParent()
if oldNotebook == newNotebook:
if nTabPage >= 0:
if where == FNB_TAB:
self.MoveTabPage(nTabPage, nIndex)
event = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_DROPPED, self.GetParent().GetId())
event.SetSelection(nIndex)
event.SetOldSelection(nTabPage)
event.SetEventObject(self.GetParent())
self.GetParent().GetEventHandler().ProcessEvent(event)
elif self.GetParent().GetAGWWindowStyleFlag() & FNB_ALLOW_FOREIGN_DND:
if wx.Platform in ["__WXMSW__", "__WXGTK__", "__WXMAC__"]:
if nTabPage >= 0:
window = oldNotebook.GetPage(nTabPage)
if window:
where, nIndex = newNotebook._pages.HitTest(wx.Point(x, y))
caption = oldContainer.GetPageText(nTabPage)
imageindex = oldContainer.GetPageImage(nTabPage)
oldNotebook.RemovePage(nTabPage)
window.Reparent(newNotebook)
if imageindex >= 0:
bmp = oldNotebook.GetImageList().GetBitmap(imageindex)
newImageList = newNotebook.GetImageList()
if not newImageList:
xbmp, ybmp = bmp.GetWidth(), bmp.GetHeight()
newImageList = wx.ImageList(xbmp, ybmp)
imageindex = 0
else:
imageindex = newImageList.GetImageCount()
newImageList.Add(bmp)
newNotebook.SetImageList(newImageList)
newNotebook.InsertPage(nIndex, window, caption, True, imageindex)
event = FlatNotebookDragEvent(wxEVT_FLATNOTEBOOK_PAGE_DROPPED_FOREIGN, self.GetParent().GetId())
event.SetSelection(nIndex)
event.SetOldSelection(nTabPage)
event.SetNotebook(newNotebook)
event.SetOldNotebook(oldNotebook)
event.SetEventObject(self.GetParent())
self.GetParent().GetEventHandler().ProcessEvent(event)
self._isdragging = False
return wx.DragMove
def MoveTabPage(self, nMove, nMoveTo):
"""
Moves a tab inside the same :class:`FlatNotebook`.
:param `nMove`: the start index of the moved tab;
:param `nMoveTo`: the destination index of the moved tab.
"""
if nMove == nMoveTo:
return
elif nMoveTo < len(self._pParent._windows):
nMoveTo = nMoveTo + 1
self._pParent.Freeze()
# Remove the window from the main sizer
nCurSel = self._pParent._pages.GetSelection()
self._pParent._mainSizer.Detach(self._pParent._windows[nCurSel])
self._pParent._windows[nCurSel].Hide()
pWindow = self._pParent._windows[nMove]
self._pParent._windows.pop(nMove)
self._pParent._windows.insert(nMoveTo-1, pWindow)
pgInfo = self._pagesInfoVec[nMove]
self._pagesInfoVec.pop(nMove)
self._pagesInfoVec.insert(nMoveTo - 1, pgInfo)
# Add the page according to the style
pSizer = self._pParent._mainSizer
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
if agwStyle & FNB_BOTTOM:
pSizer.Insert(0, pWindow, 1, wx.EXPAND)
else:
# We leave a space of 1 pixel around the window
pSizer.Add(pWindow, 1, wx.EXPAND)
pWindow.Show()
pSizer.Layout()
self._iActivePage = nMoveTo - 1
self._iPreviousActivePage = -1
self.DoSetSelection(self._iActivePage)
self.Refresh()
self._pParent.Thaw()
def CanFitToScreen(self, page):
"""
Returns wheter a tab can fit in the left space in the screen or not.
:param `page`: an integer specifying the page index.
"""
# Incase the from is greater than page,
# we need to reset the self._nFrom, so in order
# to force the caller to do so, we return false
if self._nFrom > page:
return False
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
render = self._mgr.GetRenderer(agwStyle)
vTabInfo = render.NumberTabsCanFit(self)
if page - self._nFrom >= len(vTabInfo):
return False
return True
def GetNumOfVisibleTabs(self):
""" Returns the number of visible tabs. """
count = 0
for ii in xrange(self._nFrom, len(self._pagesInfoVec)):
if self._pagesInfoVec[ii].GetPosition() == wx.Point(-1, -1):
break
count = count + 1
return count
def GetEnabled(self, page):
"""
Returns whether a tab is enabled or not.
:param `page`: an integer specifying the page index.
"""
if page >= len(self._pagesInfoVec):
return True # Seems strange, but this is the default
return self._pagesInfoVec[page].GetEnabled()
def EnableTab(self, page, enabled=True):
"""
Enables or disables a tab.
:param `page`: an integer specifying the page index;
:param `enabled`: ``True`` to enable a tab, ``False`` to disable it.
"""
if page >= len(self._pagesInfoVec):
return
self._pagesInfoVec[page].EnableTab(enabled)
def GetSingleLineBorderColour(self):
""" Returns the colour for the single line border. """
if self.HasAGWFlag(FNB_FANCY_TABS):
return self._colourFrom
return wx.WHITE
def HasAGWFlag(self, flag):
"""
Returns whether a flag is present in the :class:`FlatNotebook` style.
:param `flag`: one of the possible :class:`FlatNotebook` window styles.
:see: :meth:`FlatNotebook.SetAGWWindowStyleFlag() <FlatNotebook.SetAGWWindowStyleFlag>` for a list of possible window
style flags.
"""
agwStyle = self.GetParent().GetAGWWindowStyleFlag()
res = (agwStyle & flag and [True] or [False])[0]
return res
def ClearAGWFlag(self, flag):
"""
Deletes a flag from the :class:`FlatNotebook` style.
:param `flag`: one of the possible :class:`FlatNotebook` window styles.
:see: :meth:`FlatNotebook.SetAGWWindowStyleFlag() <FlatNotebook.SetAGWWindowStyleFlag>` for a list of possible window
style flags.
"""
parent = self.GetParent()
agwStyle = parent.GetAGWWindowStyleFlag()
agwStyle &= ~flag
parent.SetAGWWindowStyleFlag(agwStyle)
def SetAGWWindowStyleFlag(self, agwStyle):
"""
Sets the :class:`FlatNotebook` window style.
:param `agwStyle`: the new :class:`FlatNotebook` window style.
:see: The :meth:`FlatNotebook.__init__() <FlatNotebook.__init__>` method for the `agwStyle` parameter description.
"""
self.GetParent().SetAGWWindowStyleFlag(agwStyle)
def GetAGWWindowStyleFlag(self):
"""
Returns the :class:`FlatNotebook` window style.
:see: The :meth:`FlatNotebook.__init__() <FlatNotebook.__init__>` method for the `agwStyle` parameter description.
"""
return self.GetParent().GetAGWWindowStyleFlag()
def TabHasImage(self, tabIdx):
"""
Returns whether a tab has an associated image index or not.
:param `tabIdx`: an integer specifying the page index.
"""
if self._ImageList:
return self._pagesInfoVec[tabIdx].GetImageIndex() != -1
return False
def OnLeftDClick(self, event):
"""
Handles the ``wx.EVT_LEFT_DCLICK`` event for :class:`PageContainer`.
:param `event`: a :class:`MouseEvent` event to be processed.
"""
where, tabIdx = self.HitTest(event.GetPosition())
if where == FNB_RIGHT_ARROW:
self._nRightButtonStatus = FNB_BTN_PRESSED
self.RotateRight()
elif where == FNB_LEFT_ARROW:
self._nLeftButtonStatus = FNB_BTN_PRESSED
self.RotateLeft()
elif self.HasAGWFlag(FNB_DCLICK_CLOSES_TABS):
if where == FNB_TAB:
self.DeletePage(tabIdx)
else:
event.Skip()
def OnSetFocus(self, event):
"""
Handles the ``wx.EVT_SET_FOCUS`` event for :class:`PageContainer`.
:param `event`: a :class:`FocusEvent` event to be processed.
"""
if self._iActivePage < 0:
event.Skip()
return
self.SetFocusedPage(self._iActivePage)
def OnKillFocus(self, event):
"""
Handles the ``wx.EVT_KILL_FOCUS`` event for :class:`PageContainer`.
:param `event`: a :class:`FocusEvent` event to be processed.
"""
self.SetFocusedPage()
def OnKeyDown(self, event):
"""
Handles the ``wx.EVT_KEY_DOWN`` event for :class:`PageContainer`.
:param `event`: a :class:`KeyEvent` event to be processed.
:note: When the :class:`PageContainer` has the focus tabs can be changed with
the left/right arrow keys.
"""
key = event.GetKeyCode()
if key == wx.WXK_LEFT:
self.GetParent().AdvanceSelection(False)
self.SetFocus()
elif key == wx.WXK_RIGHT:
self.GetParent().AdvanceSelection(True)
self.SetFocus()
elif key == wx.WXK_TAB and not event.ControlDown():
flags = 0
if not event.ShiftDown(): flags |= wx.NavigationKeyEvent.IsForward
if event.CmdDown(): flags |= wx.NavigationKeyEvent.WinChange
self.Navigate(flags)
else:
event.Skip()
def SetFocusedPage(self, pageIndex=-1):
"""
Sets/Unsets the focus on the appropriate page.
:param `pageIndex`: an integer specifying the page index. If `pageIndex`
is defaulted to -1, we have lost focus and no focus indicator is drawn.
"""
for indx, page in enumerate(self._pagesInfoVec):
if indx == pageIndex:
page._hasFocus = True
else:
page._hasFocus = False
self.Refresh()
def PopupTabsMenu(self):
""" Pops up the menu activated with the drop down arrow in the navigation area. """
popupMenu = wx.Menu()
for i in xrange(len(self._pagesInfoVec)):
pi = self._pagesInfoVec[i]
item = wx.MenuItem(popupMenu, i+1, pi.GetCaption(), pi.GetCaption(), wx.ITEM_NORMAL)
self.Bind(wx.EVT_MENU, self.OnTabMenuSelection, item)
# There is an alignment problem with wx2.6.3 & Menus so only use
# images for versions above 2.6.3
if wx.VERSION > (2, 6, 3, 0) and self.TabHasImage(i):
item.SetBitmap(self.GetImageList().GetBitmap(pi.GetImageIndex()))
popupMenu.AppendItem(item)
item.Enable(pi.GetEnabled())
self.PopupMenu(popupMenu)
def OnTabMenuSelection(self, event):
"""
Handles the ``wx.EVT_MENU`` event for :class:`PageContainer`.
:param `event`: a :class:`MenuEvent` event to be processed.
"""
selection = event.GetId() - 1
self.FireEvent(selection)
def FireEvent(self, selection):
"""
Fires the ``EVT_FLATNOTEBOOK_PAGE_CHANGING`` and ``EVT_FLATNOTEBOOK_PAGE_CHANGED``
events called from other methods (from menu selection or `Smart Tabbing`).
This is an utility function.
:param `selection`: the new selection inside :class:`FlatNotebook`.
"""
if selection == self._iActivePage:
# No events for the same selection
return
oldSelection = self._iActivePage
event = FlatNotebookEvent(wxEVT_FLATNOTEBOOK_PAGE_CHANGING, self.GetParent().GetId())
event.SetSelection(selection)
event.SetOldSelection(oldSelection)
event.SetEventObject(self.GetParent())
if not self.GetParent().GetEventHandler().ProcessEvent(event) or event.IsAllowed():
self.SetSelection(selection)
# Fire a wxEVT_FLATNOTEBOOK_PAGE_CHANGED event
event.SetEventType(wxEVT_FLATNOTEBOOK_PAGE_CHANGED)
event.SetOldSelection(oldSelection)
self.GetParent().GetEventHandler().ProcessEvent(event)
if not self.HasAGWFlag(FNB_NO_TAB_FOCUS):
self.SetFocus()
def SetImageList(self, imglist):
"""
Sets the image list for the :class:`PageContainer`.
:param `imageList`: an instance of :class:`ImageList`.
"""
self._ImageList = imglist
def AssignImageList(self, imglist):
"""
Assigns the image list for the :class:`PageContainer`.
:param `imageList`: an instance of :class:`ImageList`.
"""
self._ImageList = imglist
def GetImageList(self):
""" Returns the image list for the page control. """
return self._ImageList
def GetSelection(self):
""" Returns the current selected page. """
return self._iActivePage
def GetPageCount(self):
""" Returns the number of tabs in the :class:`FlatNotebook` control. """
return len(self._pagesInfoVec)
def GetPageText(self, page):
"""
Returns the tab caption of the page.
:param `page`: an integer specifying the page index.
"""
if page < len(self._pagesInfoVec):
return self._pagesInfoVec[page].GetCaption()
else:
return u''
def SetPageText(self, page, text):
"""
Sets the tab caption of the page.
:param `page`: an integer specifying the page index;
:param `text`: the new tab label.
"""
if page < len(self._pagesInfoVec):
self._pagesInfoVec[page].SetCaption(text)
return True
else:
return False
def DrawDragHint(self):
""" Draws small arrow at the place that the tab will be placed. """
# get the index of tab that will be replaced with the dragged tab
pt = wx.GetMousePosition()
client_pt = self.ScreenToClient(pt)
where, tabIdx = self.HitTest(client_pt)
self._mgr.GetRenderer(self.GetParent().GetAGWWindowStyleFlag()).DrawDragHint(self, tabIdx)
# ---------------------------------------------------------------------------- #
# Class FlatNotebookCompatible
# This class is more compatible with the wx.Notebook API.
# ---------------------------------------------------------------------------- #
class FlatNotebookCompatible(FlatNotebook):
"""
This class is more compatible with the :class:`Notebook` API, especially regarding
page changing events. Use the :meth:`FlatNotebookCompatible.SetSelection() <FlatNotebookCompatible.SetSelection>` method if you wish to send page
changing events, or :meth:`FlatNotebookCompatible.ChangeSelection() <FlatNotebookCompatible.ChangeSelection>` otherwise.
"""
def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize,
style=0, agwStyle=0, name="FlatNotebook"):
"""
Default class constructor.
:param `parent`: the :class:`FlatNotebook` parent;
:param `id`: an identifier for the control: a value of -1 is taken to mean a default;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param `style`: the underlying :class:`PyPanel` window style;
:param `agwStyle`: the AGW-specific window style. This can be a combination of the
following bits:
================================ =========== ==================================================
Window Styles Hex Value Description
================================ =========== ==================================================
``FNB_VC71`` 0x1 Use Visual Studio 2003 (VC7.1) style for tabs.
``FNB_FANCY_TABS`` 0x2 Use fancy style - square tabs filled with gradient colouring.
``FNB_TABS_BORDER_SIMPLE`` 0x4 Draw thin border around the page.
``FNB_NO_X_BUTTON`` 0x8 Do not display the 'X' button.
``FNB_NO_NAV_BUTTONS`` 0x10 Do not display the right/left arrows.
``FNB_MOUSE_MIDDLE_CLOSES_TABS`` 0x20 Use the mouse middle button for cloing tabs.
``FNB_BOTTOM`` 0x40 Place tabs at bottom - the default is to place them at top.
``FNB_NODRAG`` 0x80 Disable dragging of tabs.
``FNB_VC8`` 0x100 Use Visual Studio 2005 (VC8) style for tabs.
``FNB_X_ON_TAB`` 0x200 Place 'X' close button on the active tab.
``FNB_BACKGROUND_GRADIENT`` 0x400 Use gradients to paint the tabs background.
``FNB_COLOURFUL_TABS`` 0x800 Use colourful tabs (VC8 style only).
``FNB_DCLICK_CLOSES_TABS`` 0x1000 Style to close tab using double click.
``FNB_SMART_TABS`` 0x2000 Use `Smart Tabbing`, like ``Alt`` + ``Tab`` on Windows.
``FNB_DROPDOWN_TABS_LIST`` 0x4000 Use a dropdown menu on the left in place of the arrows.
``FNB_ALLOW_FOREIGN_DND`` 0x8000 Allows drag 'n' drop operations between different :class:`FlatNotebook`.
``FNB_HIDE_ON_SINGLE_TAB`` 0x10000 Hides the Page Container when there is one or fewer tabs.
``FNB_DEFAULT_STYLE`` 0x10020 :class:`FlatNotebook` default style.
``FNB_FF2`` 0x20000 Use Firefox 2 style for tabs.
``FNB_NO_TAB_FOCUS`` 0x40000 Does not allow tabs to have focus.
``FNB_RIBBON_TABS`` 0x80000 Use the Ribbon Tabs style.
``FNB_HIDE_TABS`` 0x100000 Hides the Page Container allowing only keyboard navigation
``FNB_NAV_BUTTONS_WHEN_NEEDED`` 0x200000 Hides the navigation left/right arrows if all tabs fit
================================ =========== ==================================================
:param `name`: the window name.
"""
FlatNotebook.__init__(self, parent, id, pos, size, style, agwStyle, name)
def SetSelection(self, page):
"""
Sets the selection for the given page.
:param `page`: an integer specifying the new selected page.
:note: The call to this function **generates** the page changing events.
"""
if page >= len(self._windows) or not self._windows:
return
# Support for disabed tabs
if not self._pages.GetEnabled(page) and len(self._windows) > 1 and not self._bForceSelection:
return
self._pages.FireEvent(page)
def ChangeSelection(self, page):
"""
Sets the selection for the given page.
:param `page`: an integer specifying the new selected page.
:note: The call to this function **does not** generate the page changing events.
"""
FlatNotebook.SetSelection(self, page)
|