File size: 118,206 Bytes
9375c9a |
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 |
// Copyright (C) 2005 Davis E. King ([email protected]), Keita Mochizuki
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_WIDGETs_ABSTRACT_
#ifdef DLIB_WIDGETs_ABSTRACT_
#include "fonts_abstract.h"
#include "drawable_abstract.h"
#include "base_widgets_abstract.h"
#include "../gui_core.h"
#include <string>
#include <map>
#include "../interfaces/enumerable.h"
#include "style_abstract.h"
#include "../image_processing/full_object_detection_abstract.h"
#include "../geometry/line_abstract.h"
namespace dlib
{
/*!
GENERAL REMARKS
This component is a collection of various windowing widgets such as buttons,
labels, text boxes, and so on. This component also includes the drawable
interface, drawable_window, and font handling objects. The file you are
currently viewing defines all the high level graphical widgets which are
provided by this component that can appear in a drawable_window. To view
the specifications for the other members of this component look at
fonts_abstract.h, base_widgets_abstract.h, and drawable_abstract.h
THREAD SAFETY
All objects and functions defined in this file are thread safe. You may
call them from any thread without serializing access to them.
EVENT HANDLERS
Note that all event handlers, including the user registered callback
functions, are executed in the event handling thread. Additionally,
the drawable::m mutex will always be locked while these event handlers
are running. Also, don't rely on get_thread_id() always returning the
same ID from inside event handlers.
!*/
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// function open_file_box(), open_existing_file_box(), and save_file_box()
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
template <
typename T
>
void open_file_box (
T& object,
void (T::*event_handler)(const std::string&)
);
/*!
requires
- event_handler == a valid pointer to a member function of object T.
ensures
- Displays a window titled "Open File" that will allow the user to select a
file.
- The displayed window will start out showing the directory get_current_dir()
(i.e. it starts in the current working directory)
- The event_handler function is called on object if the user selects
a file. If the user closes the window without selecting a file
then nothing occurs.
!*/
void open_file_box (
const any_function<void(const std::string&)>& event_handler
);
/*!
ensures
- Displays a window titled "Open File" that will allow the user to select a
file.
- The displayed window will start out showing the directory get_current_dir()
(i.e. it starts in the current working directory)
- The event_handler function is called if the user selects
a file. If the user closes the window without selecting a file
then nothing occurs.
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
void open_existing_file_box (
T& object,
void (T::*event_handler)(const std::string&)
);
/*!
requires
- event_handler == a valid pointer to a member function of object T.
ensures
- Displays a window titled "Open File" that will allow the user to select
a file. But only a file that already exists.
- The displayed window will start out showing the directory get_current_dir()
(i.e. it starts in the current working directory)
- The event_handler function is called on object if the user selects
a file. If the user closes the window without selecting a file
then nothing occurs.
!*/
void open_existing_file_box (
const any_function<void(const std::string&)>& event_handler
);
/*!
ensures
- Displays a window titled "Open File" that will allow the user to select
a file. But only a file that already exists.
- The displayed window will start out showing the directory get_current_dir()
(i.e. it starts in the current working directory)
- The event_handler function is called if the user selects
a file. If the user closes the window without selecting a file
then nothing occurs.
!*/
// ----------------------------------------------------------------------------------------
template <
typename T
>
void save_file_box (
T& object,
void (T::*event_handler)(const std::string&)
);
/*!
requires
- event_handler == a valid pointer to a member function of object T.
ensures
- Displays a window titled "Save File" that will allow the user to select
a file.
- The displayed window will start out showing the directory get_current_dir()
(i.e. it starts in the current working directory)
- The event_handler function is called on object if the user selects
a file. If the user closes the window without selecting a file
then nothing occurs.
!*/
void save_file_box (
const any_function<void(const std::string&)>& event_handler
);
/*!
ensures
- Displays a window titled "Save File" that will allow the user to select
a file.
- The displayed window will start out showing the directory get_current_dir()
(i.e. it starts in the current working directory)
- The event_handler function is called if the user selects
a file. If the user closes the window without selecting a file
then nothing occurs.
!*/
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// function message_box()
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
void message_box (
const std::string& title,
const std::string& message
);
/*!
ensures
- displays a message box with the given title and message. It will have a
single button and when the user clicks it the message box will go away.
- this function does not block but instead returns immediately.
!*/
void message_box_blocking (
const std::string& title,
const std::string& message
);
/*!
ensures
- displays a message box with the given title and message. It will have a
single button and when the user clicks it the message box will go away.
- this function blocks until the user clicks on the message box and
causes it to go away.
!*/
template <
typename T
>
void message_box (
const std::string& title,
const std::string& message,
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler == a valid pointer to a member function of object T.
ensures
- Displays a message box with the given title and message. It will have a
single button and when the user clicks it the message box will go away.
- The event_handler function is called on object when the user clicks
ok or otherwise closes the message box window.
- this function does not block but instead returns immediately.
!*/
void message_box (
const std::string& title,
const std::string& message,
const any_function<void()>& event_handler
);
/*!
ensures
- Displays a message box with the given title and message. It will have a
single button and when the user clicks it the message box will go away.
- The event_handler function is called when the user clicks
ok or otherwise closes the message box window.
- this function does not block but instead returns immediately.
!*/
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class label
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class label : public drawable
{
/*!
INITIAL VALUE
text() == ""
the text color will be black
WHAT THIS OBJECT REPRESENTS
This object represents a simple text label. The size of the label
is automatically set to be just big enough to contain its text.
!*/
public:
label(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~label(
);
/*!
ensures
- all resources associated with *this have been released
!*/
void set_text (const std::wstring& text);
void set_text (const dlib::ustring& text);
void set_text (
const std::string& text
);
/*!
ensures
- #text() == text
throws
- std::bad_alloc
!*/
const std::wstring wtext () const;
const dlib::ustring utext () const;
const std::string text (
) const;
/*!
ensures
- returns the text of this label
throws
- std::bad_alloc
!*/
void set_text_color (
const rgb_pixel color
);
/*!
ensures
- #text_color() == color
!*/
const rgb_pixel text_color (
) const;
/*!
ensures
- returns the color used to draw the text in this widget
!*/
private:
// restricted functions
label(label&); // copy constructor
label& operator=(label&); // assignment operator
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class toggle_button
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class toggle_button : public button_action
{
/*!
INITIAL VALUE
name() == ""
is_checked() == false
WHAT THIS OBJECT REPRESENTS
This object represents a simple two state toggle button. Is is either
in the checked or unchecked state and when a user clicks on it it toggles its
state.
When this object is disabled it means it will not respond to user clicks.
!*/
public:
toggle_button(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~toggle_button(
);
/*!
ensures
- all resources associated with *this have been released
!*/
void set_name (const std::wstring& name);
void set_name (const dlib::ustring& name);
void set_name (
const std::string& name
);
/*!
ensures
- #name() == name
- this toggle_button has been resized such that it is big enough to contain
the new name.
throws
- std::bad_alloc
!*/
void set_size (
unsigned long width_,
unsigned long height_
);
/*!
ensures
- if (width and height are big enough to contain the name of this button) then
- #width() == width_
- #height() == height_
- #top() == top()
- #left() == left()
- i.e. The location of the upper left corner of this button stays the
same but its width and height are modified
!*/
void set_tooltip_text (const std::wstring& text);
void set_tooltip_text (const dlib::ustring& text);
void set_tooltip_text (
const std::string& text
);
/*!
ensures
- #tooltip_text() == text
- enables the tooltip for this toggle_button
!*/
const dlib::ustring tooltip_utext () const;
const std::wstring tooltip_wtext () const;
const std::string tooltip_text (
) const;
/*!
ensures
- returns the text that is displayed in the tooltip for this toggle_button
!*/
template <
typename style_type
>
void set_style (
const style_type& style
);
/*!
requires
- style_type == a type that inherits from toggle_button_style
ensures
- this toggle_button object will draw itself using the given
button style
!*/
bool is_checked (
) const;
/*!
ensures
- if (this box is currently checked) then
- returns true
- else
- returns false
!*/
const std::wstring wname () const;
const dlib::ustring uname () const;
const std::string name (
) const;
/*!
ensures
- returns the name of this toggle_button. The name is a string
that appears to the right of the actual check box.
throws
- std::bad_alloc
!*/
void set_checked (
);
/*!
ensures
- #is_checked() == true
!*/
void set_unchecked (
);
/*!
ensures
- #is_checked() == false
!*/
template <
typename T
>
void set_click_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the toggle_button is
toggled by the user.
- this event is NOT triggered by calling set_checked() or set_unchecked().
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_click_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when the toggle_button is
toggled by the user.
- this event is NOT triggered by calling set_checked() or set_unchecked().
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_click_handler (
T& object,
void (T::*event_handler)(toggle_button& self)
);
/*!
requires
- event_handler is a valid pointer to a member function in T.
ensures
- the event_handler function is called on object when the toggle_button is
toggled by the user. self will be a reference to the toggle_button object
that the user clicked.
- this event is NOT triggered by calling set_checked() or set_unchecked().
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_sourced_click_handler (
const any_function<void(toggle_button& self)>& event_handler
);
/*!
ensures
- the event_handler function is called when the toggle_button is
toggled by the user. self will be a reference to the toggle_button object
that the user clicked.
- this event is NOT triggered by calling set_checked() or set_unchecked().
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
private:
// restricted functions
toggle_button(toggle_button&); // copy constructor
toggle_button& operator=(toggle_button&); // assignment operator
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class text_field
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class text_field : public drawable
{
/*!
INITIAL VALUE
- text() == ""
- width() == 10
- height() == a height appropriate for the font used. The text color will
be black.
- has_input_focus() == false
WHAT THIS OBJECT REPRESENTS
This object represents a simple one line text input field.
!*/
public:
text_field(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~text_field(
);
/*!
ensures
- all resources associated with *this have been released
!*/
template <
typename style_type
>
void set_style (
const style_type& style
);
/*!
requires
- style_type == a type that inherits from text_field_style
ensures
- this text_field object will draw itself using the given
text field style
!*/
void set_text (const std::wstring& text);
void set_text (const dlib::ustring& text);
void set_text (
const std::string& text
);
/*!
requires
- text.find_first_of('\n') == std::string::npos
(i.e. there aren't any new lines in text)
ensures
- #text() == text
throws
- std::bad_alloc
!*/
const std::wstring wtext () const;
const dlib::ustring utext () const;
const std::string text (
) const;
/*!
ensures
- returns the text of this text_field
throws
- std::bad_alloc
!*/
void set_width (
unsigned long width_
);
/*!
ensures
- if (width >= 10) then
- #width() == width_
- #height() == height()
- #top() == top()
- #left() == left()
- i.e. The width of this drawable is set to the given width but
nothing else changes.
!*/
void give_input_focus (
);
/*!
ensures
- #has_input_focus() == true
!*/
bool has_input_focus (
);
/*!
ensures
- Returns true if this txt field has input keyboard focus. If this
is the case then it means that when the user types on the keyboard
the output will appear inside the text field.
!*/
void select_all_text (
);
/*!
ensures
- causes all the text in the text field to become selected.
(note that it doesn't give input focus)
!*/
void set_text_color (
const rgb_pixel color
);
/*!
ensures
- #text_color() == color
!*/
const rgb_pixel text_color (
) const;
/*!
ensures
- returns the color used to draw the text in this widget
!*/
void set_background_color (
const rgb_pixel color
);
/*!
ensures
- #background_color() == color
!*/
const rgb_pixel background_color (
) const;
/*!
ensures
- returns the color used to fill in the background of this widget
!*/
template <
typename T
>
void set_text_modified_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the text
in this text_field is modified by the user.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_text_modified_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when the text in this text_field
is modified by the user.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_enter_key_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when this text field
has input focus and the user hits the enter key on their keyboard.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_enter_key_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when this text field has input
focus and the user hits the enter key on their keyboard.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_focus_lost_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when this object
loses input focus due to the user clicking outside the text field
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_focus_lost_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when this object loses input
focus due to the user clicking outside the text field
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
private:
// restricted functions
text_field(text_field&); // copy constructor
text_field& operator=(text_field&); // assignment operator
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class text_box
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class text_box : public scrollable_region
{
/*!
INITIAL VALUE
- text() == ""
- The text color will be black.
- width() == 100
- height() == 100
WHAT THIS OBJECT REPRESENTS
This object represents a simple multi-line text input box.
!*/
public:
text_box(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~text_box(
);
/*!
ensures
- all resources associated with *this have been released
!*/
template <
typename style_type
>
void set_style (
const style_type& style
);
/*!
requires
- style_type == a type that inherits from text_box_style
ensures
- this text_box object will draw itself using the given
text box style
!*/
void set_text (const std::wstring& text);
void set_text (const dlib::ustring& text);
void set_text (
const std::string& text
);
/*!
ensures
- #text() == text
throws
- std::bad_alloc
!*/
const std::wstring wtext () const;
const dlib::ustring utext () const;
const std::string text (
) const;
/*!
ensures
- returns the text of this text_box
throws
- std::bad_alloc
!*/
void set_size (
unsigned long width,
unsigned long height
);
/*!
ensures
- #width() == width_
- #height() == height_
- #top() == top()
- #left() == left()
- i.e. The location of the upper left corner of this widget stays the
same but its width and height are modified
!*/
void set_text_color (
const rgb_pixel color
);
/*!
ensures
- #text_color() == color
!*/
const rgb_pixel text_color (
) const;
/*!
ensures
- returns the color used to draw the text in this widget
!*/
void set_background_color (
const rgb_pixel color
);
/*!
ensures
- #background_color() == color
!*/
const rgb_pixel background_color (
) const;
/*!
ensures
- returns the color used to fill in the background of this widget
!*/
template <
typename T
>
void set_text_modified_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the text
in this text_box is modified by the user.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_text_modified_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when the text in this text_box
is modified by the user.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_enter_key_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when this text box
has input focus and the user hits the enter key on their keyboard.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_enter_key_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when this text box has input
focus and the user hits the enter key on their keyboard.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_focus_lost_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when this object
loses input focus due to the user clicking outside the text box
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_focus_lost_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when this object loses input
focus due to the user clicking outside the text box
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
private:
// restricted functions
text_box(text_box&); // copy constructor
text_box& operator=(text_box&); // assignment operator
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class check_box
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class check_box : public toggle_button
{
/*!
This is just a toggle button with the style set to
toggle_button_style_check_box.
!*/
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class radio_button
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class radio_button : public toggle_button
{
/*!
This is just a toggle button with the style set to
toggle_button_style_radio_button.
!*/
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class tabbed_display
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class tabbed_display : public drawable
{
/*!
INITIAL VALUE
number_of_tabs() == 1
selected_tab() == 0
WHAT THIS OBJECT REPRESENTS
This object represents a row of tabs that are user selectable.
When this object is disabled it means it will not respond to user clicks.
!*/
public:
tabbed_display(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~tabbed_display(
);
/*!
ensures
- all resources associated with *this have been released
!*/
void set_size (
unsigned long width_,
unsigned long height_
);
/*!
ensures
- if (width and height are big enough to contain the tabs) then
- #width() == width_
- #height() == height_
- #top() == top()
- #left() == left()
- i.e. The location of the upper left corner of this widget stays the
same but its width and height are modified
!*/
void set_number_of_tabs (
unsigned long num
);
/*!
requires
- num > 0
ensures
- #number_of_tabs() == num
- no tabs have any widget_groups associated with them.
- for all valid idx:
- #tab_name(idx) == ""
throws
- std::bad_alloc
!*/
unsigned long selected_tab (
) const;
/*!
ensures
- returns the index of the currently selected tab
!*/
unsigned long number_of_tabs (
) const;
/*!
ensures
- returns the number of tabs in this tabbed_display
!*/
const std::wstring& tab_wname (unsigned long idx) const;
const dlib::ustring& tab_uname (unsigned long idx) const;
const std::string& tab_name (
unsigned long idx
) const;
/*!
requires
- idx < number_of_tabs()
ensures
- returns a const reference to the name of the tab given by idx
!*/
void set_tab_name (unsigned long idx, const std::wstring& new_name);
void set_tab_name (unsigned long idx, const dlib::ustring& new_name);
void set_tab_name (
unsigned long idx,
const std::string& new_name
);
/*!
requires
- idx < number_of_tabs()
ensures
- #tab_name(idx) == new_name
throws
- std::bad_alloc
!*/
void set_tab_group (
unsigned long idx,
widget_group& group
);
/*!
requires
- idx < number_of_tabs()
ensures
- if (is_hidden()) then
- group.is_hidden() == true
- else
- whenever the tab with index idx is selected group.is_hidden() == false
- whenever the tab with index idx is deselected group.is_hidden() == true
- whenever the position of *this changes the position of group will be
updated so that it is still inside the tabbed_display. The position of group
will also be updated after this call to set_tab_group().
- any previous calls to set_tab_group() with this index are overridden by this
new call. (i.e. you can only have one widget_group associated with a single
tab at a time)
!*/
void fit_to_contents (
);
/*!
ensures
- Adjusts the size this tabbed_display so that it nicely contains
all of its widget_group objects.
- does not change the position of this object.
(i.e. the upper left corner of get_rect() remains at the same position)
!*/
template <
typename T
>
void set_click_handler (
T& object,
void (T::*event_handler)(unsigned long new_idx, unsigned long old_idx)
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- The event_handler function is called on object when the user clicks
on a tab that isn't already selected. new_idx will give the index of
the newly selected tab and old_idx will give the index of the tab
that was previously selected.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_click_handler (
const any_function<void(unsigned long new_idx, unsigned long old_idx)>& eh
);
/*!
ensures
- The event_handler function is called when the user clicks on a tab
that isn't already selected. new_idx will give the index of the
newly selected tab and old_idx will give the index of the tab that
was previously selected.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
private:
// restricted functions
tabbed_display(tabbed_display&); // copy constructor
tabbed_display& operator=(tabbed_display&); // assignment operator
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class named_rectangle
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class named_rectangle : public drawable
{
/*!
INITIAL VALUE
name() == ""
WHAT THIS OBJECT REPRESENTS
This object represents a simple named rectangle.
!*/
public:
named_rectangle(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~named_rectangle(
);
/*!
ensures
- all resources associated with *this have been released
!*/
void set_size (
unsigned long width_,
unsigned long height_
);
/*!
ensures
- #width() == width_
- #height() == height_
- #top() == top()
- #left() == left()
- i.e. The location of the upper left corner of this widget stays the
same but its width and height are modified
!*/
void wrap_around (
const rectangle& rect
);
/*!
ensures
- This object will be repositioned and sized so that it fits
around the given rectangle.
!*/
void set_name (const std::wstring& name);
void set_name (const dlib::ustring& name);
void set_name (
const std::string& name
);
/*!
ensures
- #name() == name
throws
- std::bad_alloc
!*/
const std::wstring wname () const;
const dlib::ustring uname () const;
const std::string name (
) const;
/*!
ensures
- returns the name of this named_rectangle
throws
- std::bad_alloc
!*/
private:
// restricted functions
named_rectangle(named_rectangle&); // copy constructor
named_rectangle& operator=(named_rectangle&); // assignment operator
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class mouse_tracker
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class mouse_tracker : public draggable
{
/*!
INITIAL VALUE
draggable_area() == rectangle(0,0,500,500)
WHAT THIS OBJECT REPRESENTS
This object represents a simple draggable box that displays the
current location of the mouse.
Also, if you hold shift and left click on the parent window then the
mouse_tracker will place a single red pixel where you clicked and will
display the mouse position relative to that point.
!*/
public:
mouse_tracker(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~mouse_tracker(
);
/*!
ensures
- all resources associated with *this have been released
!*/
private:
// restricted functions
mouse_tracker(mouse_tracker&); // copy constructor
mouse_tracker& operator=(mouse_tracker&); // assignment operator
};
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class list_box
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class list_box : public scrollable_region,
public enumerable<const std::string>
{
/*!
INITIAL VALUE
multiple_select_enabled() == false
size() == 0
ENUMERATION ORDER
The enumerator will iterate over the elements in the list_box from
the 0th element to the (size()-1)th element. i.e. (*this)[0] to
(*this)[size()-1].
WHAT THIS OBJECT REPRESENTS
This object represents a simple textual list box. It contains a
vertical list of strings which the user may select from.
!*/
public:
list_box(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~list_box(
);
/*!
ensures
- all resources associated with *this have been released
!*/
template <
typename style_type
>
void set_style (
const style_type& style
);
/*!
requires
- style_type == a type that inherits from list_box_style
ensures
- this list_box object will draw itself using the given style
!*/
void set_size (
unsigned long width_,
unsigned long height_
);
/*!
ensures
- #width() == width_
- #height() == height_
- #top() == top()
- #left() == left()
- i.e. The location of the upper left corner of this widget stays the
same but its width and height are modified
!*/
bool is_selected (
unsigned long index
) const;
/*!
requires
- index < size()
ensures
- if (the item given by index is currently selected) then
- returns true
- else
- returns false
!*/
void select (
unsigned long index
);
/*!
requires
- index < size()
ensures
- #is_selected(index) == true
!*/
void unselect (
unsigned long index
);
/*!
requires
- index < size()
ensures
- #is_selected(index) == false
!*/
template <typename T>
void get_selected (
T& list
) const;
/*!
requires
- T == an implementation of dlib/queue/queue_kernel_abstract.h
- T::type == unsigned long
ensures
- #list == a list of all the currently selected indices for this list_box.
!*/
unsigned long get_selected (
) const;
/*!
requires
- multiple_select_enabled() == false
ensures
- if (there is currently something selected) then
- returns the index of the selected item
- else
- returns size()
!*/
template <typename T>
void load (
const T& list
);
/*!
requires
- T == compatible with dlib::enumerable<std::string>
ensures
- #size() == list.size()
- Copies all the strings from list into *this in the order in which they are enumerated.
(i.e. The first one goes into (*this)[0], the second into (*this)[1], and so on...)
!*/
const std::string& operator[] (
unsigned long index
) const;
/*!
requires
- index < size()
ensures
- returns the name of the indexth item/row in this list box.
!*/
bool multiple_select_enabled (
) const;
/*!
ensures
- if (this object will allow the user to select more than one item at a time) then
- returns true
- else
- returns false
!*/
void enable_multiple_select (
);
/*!
ensures
- #multiple_select_enabled() == true
!*/
void disable_multiple_select (
);
/*!
ensures
- #multiple_select_enabled() == false
!*/
template <
typename T
>
void set_double_click_handler (
T& object,
void (T::*event_handler)(unsigned long index)
);
/*!
requires
- event_handler is a valid pointer to a member function in T.
ensures
- The event_handler function is called on object when the user double
clicks on one of the rows in this list box. index gives the row
number for the item the user clicked.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_double_click_handler (
const any_function<void(unsigned long index)>& event_handler
);
/*!
ensures
- The event_handler function is called when the user double clicks on
one of the rows in this list box. index gives the row number for
the item the user clicked.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_click_handler (
T& object,
void (T::*event_handler)(unsigned long index)
);
/*!
requires
- event_handler is a valid pointer to a member function in T.
ensures
- The event_handler function is called on object when the user
clicks on one of the rows in this list box. index gives the row
number for the item the user clicked. (Note that the second click
in a double click triggers the double click handler above instead
of this event)
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_click_handler (
const any_function<void(unsigned long index)>& event_handler
);
/*!
ensures
- The event_handler function is called when the user clicks on one
of the rows in this list box. index gives the row number for the
item the user clicked. (Note that the second click in a double
click triggers the double click handler above instead of this event)
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
private:
// restricted functions
list_box(list_box&); // copy constructor
list_box& operator=(list_box&); // assignment operator
};
class wlist_box : public scrollable_region,
public enumerable<const std::wstring>;
/*!
same as list_box except for std::wstring instead of std::string
!*/
class ulist_box : public scrollable_region,
public enumerable<const dlib::ustring>;
/*!
same as list_box except for dlib::ustring instead of std::string
!*/
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
// class menu_bar
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
class menu_bar : public drawable
{
/*!
INITIAL VALUE
- number_of_menus() == 0
WHAT THIS OBJECT REPRESENTS
This object represents a menu bar that appears at the top of a
window.
!*/
public:
menu_bar(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~menu_bar(
);
/*!
ensures
- all resources associated with *this have been released
!*/
void set_number_of_menus (
unsigned long num
);
/*!
ensures
- #number_of_menus() == num
!*/
unsigned long number_of_menus (
) const;
/*!
ensures
- returns the number of menus in this menu_bar
!*/
void set_menu_name (unsigned long idx, const std::wstring name, char underline_ch = '\0');
void set_menu_name (unsigned long idx, const dlib::ustring name, char underline_ch = '\0');
void set_menu_name (
unsigned long idx,
const std::string name,
char underline_ch = '\0'
);
/*!
requires
- idx < number_of_menus()
ensures
- #menu_name(idx) == name
- if (underline_ch is present in name) then
- The menu with index idx will have the first underline_ch character
in its name underlined and users will be able to activate the menu
by hitting alt+underline_char
!*/
const std::wstring menu_wname (unsigned long idx) const;
const dlib::ustring menu_uname (unsigned long idx) const;
const std::string menu_name (
unsigned long idx
) const;
/*!
requires
- idx < number_of_menus()
ensures
- returns the name of the menu with index idx
!*/
popup_menu& menu (
unsigned long idx
);
/*!
requires
- idx < number_of_menus()
ensures
- returns a non-const reference to the popup_menu for the menu with
index idx.
!*/
const popup_menu& menu (
unsigned long idx
) const;
/*!
requires
- idx < number_of_menus()
ensures
- returns a const reference to the popup_menu for the menu with
index idx.
!*/
private:
// restricted functions
menu_bar(menu_bar&); // copy constructor
menu_bar& operator=(menu_bar&); // assignment operator
};
// ----------------------------------------------------------------------------------------
template <
typename graph_type
>
class directed_graph_drawer : public zoomable_region
{
/*!
REQUIREMENTS ON graph_type
- must be an implementation of directed_graph/directed_graph_kernel_abstract.h
INITIAL VALUE
- get_graph().size() == 0
WHAT THIS OBJECT REPRESENTS
This object represents a graphical widget that allows the user to draw
a directed graph.
The user can create nodes by right clicking on the draw area and add
edges by selecting a node (via left clicking on it) and then holding
shift and clicking on the node that is to be the child node of the
selected node.
!*/
public:
directed_graph_drawer (
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~directed_graph_drawer (
);
/*!
ensures
- all resources associated with *this have been released
!*/
const graph_type& graph (
) const;
/*!
requires
- drawable::m is locked
ensures
- returns a const reference to the graph that this widget has been drawing
!*/
unsigned long number_of_nodes (
) const;
/*!
ensures
- returns graph().number_of_nodes()
!*/
void clear_graph (
);
/*!
ensures
- #number_of_nodes() == 0
!*/
const typename graph_type::node_type& graph_node (
unsigned long i
) const;
/*!
requires
- drawable::m is locked
- i < number_of_nodes()
ensures
- returns a const reference to get_graph().node(i)
!*/
typename graph_type::node_type& graph_node (
unsigned long i
);
/*!
requires
- drawable::m is locked
- i < number_of_nodes()
ensures
- returns a non-const reference to get_graph().node(i)
!*/
void save_graph (
std::ostream& out
);
/*!
ensures
- saves the state of the graph to the output stream. Does so in a
way that not only preserves the state of the graph this->graph()
but also preserves the graphical layout of the graph in this
GUI widget.
- Also, the first part of the saved state is a serialized
version of this->graph(). Thus, you can deserialize just the
this->graph() object from the serialized data if you like.
!*/
void load_graph (
std::istream& in
);
/*!
ensures
- loads a saved graph from the given input stream.
!*/
void set_node_label (unsigned long i, const std::wstring& label);
void set_node_label (unsigned long i, const dlib::ustring& label);
void set_node_label (
unsigned long i,
const std::string& label
);
/*!
requires
- i < number_of_nodes()
ensures
- #node_label(i) == label
!*/
void set_node_color (
unsigned long i,
rgb_pixel color
);
/*!
requires
- i < number_of_nodes()
ensures
- #node_color(i) == color
!*/
rgb_pixel node_color (
unsigned long i
) const;
/*!
requires
- i < number_of_nodes()
ensures
- returns the color used to draw node graph_node(i)
!*/
const std::wstring node_wlabel (unsigned long i) const;
const dlib::ustring node_ulabel (unsigned long i) const;
const std::string node_label (
unsigned long i
) const;
/*!
requires
- i < number_of_nodes()
ensures
- returns the text label for node graph_node(i)
!*/
template <
typename T
>
void set_node_selected_handler (
T& object,
void (T::*event_handler)(unsigned long node_index)
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the user selects
a node.
- node_index == the index of the node that was selected
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_node_selected_handler (
const any_function<void(unsigned long node_index)>& event_handler
);
/*!
ensures
- the event_handler function is called when the user selects
a node.
- node_index == the index of the node that was selected
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_node_deselected_handler (
T& object,
void (T::*event_handler)(unsigned long node_index)
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the user
deselects a node.
- node_index == the index of the node that was deselected
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_node_deselected_handler (
const any_function<void(unsigned long node_index)>& event_handler
);
/*!
ensures
- the event_handler function is called when the user deselects a node.
- node_index == the index of the node that was deselected
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_node_deleted_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the user
deletes a node.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_node_deleted_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when the user deletes a node.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
template <
typename T
>
void set_graph_modified_handler (
T& object,
void (T::*event_handler)()
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the user
modifies the graph (i.e. adds or removes a node or edge)
- the event_handler function is not called when the user just
moves nodes around on the screen.
- This event is always dispatched before any more specific event
that results from the user modifying the graph.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_graph_modified_handler (
const any_function<void()>& event_handler
);
/*!
ensures
- the event_handler function is called when the user modifies
the graph (i.e. adds or removes a node or edge)
- the event_handler function is not called when the user just
moves nodes around on the screen.
- This event is always dispatched before any more specific event
that results from the user modifying the graph.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
private:
// restricted functions
directed_graph_drawer(directed_graph_drawer&); // copy constructor
directed_graph_drawer& operator=(directed_graph_drawer&); // assignment operator
};
// ----------------------------------------------------------------------------------------
class text_grid : public scrollable_region
{
/*!
INITIAL VALUE
- vertical_scroll_increment() == 10
- horizontal_scroll_increment() == 10
- border_color() == rgb_pixel(128,128,128)
- number_of_columns() == 0
- number_of_rows() == 0
WHAT THIS OBJECT REPRESENTS
This object represents a simple grid of square text fields that
looks more or less like a spreadsheet grid.
!*/
public:
text_grid (
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
throws
- std::bad_alloc
- dlib::thread_error
!*/
virtual ~text_grid (
);
/*!
ensures
- all resources associated with *this have been released
!*/
void set_grid_size (
unsigned long rows,
unsigned long cols
);
/*!
ensures
- #number_of_rows() == rows
- #number_of_columns() == cols
- for all valid r and c:
- #text(r,c) == ""
- #text_color(r,c) == rgb_pixel(0,0,0)
- #background_color(r,c) == rgb_pixel(255,255,255)
- #is_editable(r,c) == true
!*/
unsigned long number_of_columns (
) const;
/*!
ensures
- returns the number of columns contained in this grid
!*/
unsigned long number_of_rows (
) const;
/*!
ensures
- returns the number of rows contained in this grid
!*/
rgb_pixel border_color (
) const;
/*!
ensures
- returns the color of the lines drawn between the grid elements
!*/
void set_border_color (
rgb_pixel color
);
/*!
ensures
- #border_color() == color
!*/
const std::wstring wtext (unsigned long row, unsigned long col) const;
const dlib::ustring utext (unsigned long row, unsigned long col) const;
const std::string text (
unsigned long row,
unsigned long col
) const;
/*!
requires
- row < number_of_rows()
- col < number_of_columns()
ensures
- returns the text in the given grid location
!*/
void set_text (unsigned long row, unsigned long col, const std::wstring& str);
void set_text (unsigned long row, unsigned long col, const dlib::ustring& str);
void set_text (
unsigned long row,
unsigned long col,
const std::string& str
);
/*!
requires
- row < number_of_rows()
- col < number_of_columns()
ensures
- #text(row,col) == str
!*/
const rgb_pixel text_color (
unsigned long row,
unsigned long col
) const;
/*!
requires
- row < number_of_rows()
- col < number_of_columns()
ensures
- returns the color of the text in the given grid location
!*/
void set_text_color (
unsigned long row,
unsigned long col,
const rgb_pixel color
);
/*!
requires
- row < number_of_rows()
- col < number_of_columns()
ensures
- #text_color(row,col) == color
!*/
const rgb_pixel background_color (
unsigned long row,
unsigned long col
) const;
/*!
requires
- row < number_of_rows()
- col < number_of_columns()
ensures
- returns the background color of the given grid location
!*/
void set_background_color (
unsigned long row,
unsigned long col,
const rgb_pixel color
);
/*!
requires
- row < number_of_rows()
- col < number_of_columns()
ensures
- #background_color(row,col) == color
!*/
bool is_editable (
unsigned long row,
unsigned long col
) const;
/*!
requires
- row < number_of_rows()
- col < number_of_columns()
ensures
- if (the given grid location is editable by the user) then
- returns true
- else
- returns false
!*/
void set_editable (
unsigned long row,
unsigned long col,
bool editable
);
/*!
requires
- row < number_of_rows()
- col < number_of_columns()
ensures
- #is_editable(row,col) == editable
!*/
void set_column_width (
unsigned long col,
unsigned long width
);
/*!
requires
- col < number_of_columns()
ensures
- the given column will be displayed such that it is width pixels wide
!*/
void set_row_height (
unsigned long row,
unsigned long height
);
/*!
requires
- row < number_of_rows()
ensures
- the given row will be displayed such that it is height pixels wide
!*/
template <
typename T
>
void set_text_modified_handler (
T& object,
void (T::*event_handler)(unsigned long row, unsigned long col)
);
/*!
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the user selects
a node.
- row == row will give the row of the grid item that was modified
- col == col will give the column of the grid item that was modified
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
void set_text_modified_handler (
const any_function<void(unsigned long row, unsigned long col)>& event_handler
);
/*!
ensures
- the event_handler function is called when the user selects a node.
- row == row will give the row of the grid item that was modified
- col == col will give the column of the grid item that was modified
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
!*/
private:
// restricted functions
text_grid(text_grid&); // copy constructor
text_grid& operator=(text_grid&); // assignment operator
};
// ----------------------------------------------------------------------------------------
class image_display : public scrollable_region
{
/*!
INITIAL VALUE
- This object isn't displaying anything.
- get_overlay_rects().size() == 0
- get_default_overlay_rect_label() == ""
- get_default_overlay_rect_color() == rgb_alpha_pixel(255,0,0,255) (i.e. RED)
- This object does not have any user labelable parts defined.
- overlay_editing_is_enabled() == true
WHAT THIS OBJECT REPRESENTS
This object represents an image inside a scrollable region.
You give it an image to display by calling set_image().
This widget also allows you to add rectangle and line overlays that
will be drawn on top of the image.
If you hold the Ctrl key you can zoom in and out using the mouse wheel.
You can also add new overlay rectangles by holding shift, left clicking,
and dragging the mouse. Additionally, you can delete an overlay rectangle
by double clicking on it and hitting delete or backspace. Finally, you
can also add part labels (if they have been defined by calling add_labelable_part_name())
by selecting an overlay rectangle with the mouse and then right clicking
on the part. If you want to move any rectangle or an object part then
shift+right click and drag it. Alternatively, if you haven't added any
part labels via add_labelable_part_name() you can add parts to a rectangle
by simply shift left clicking while it's selected. This will add parts
with integer names and the integer names begin with 0 and increase. This
feature is only activated if the rectangle has no parts or all the parts
are already integer names.
Finally, if you hold Ctrl and left click an overlay rectangle it will
change its label to get_default_overlay_rect_label() and color to
get_default_overlay_rect_color().
The image is drawn such that:
- the pixel img[0][0] is the upper left corner of the image.
- the pixel img[img.nr()-1][0] is the lower left corner of the image.
- the pixel img[0][img.nc()-1] is the upper right corner of the image.
- the pixel img[img.nr()-1][img.nc()-1] is the lower right corner of the image.
!*/
public:
image_display(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
!*/
~image_display(
);
/*!
ensures
- all resources associated with *this have been released
!*/
template <
typename image_type
>
void set_image (
const image_type& new_img
);
/*!
requires
- image_type == an implementation of array2d/array2d_kernel_abstract.h or
a dlib::matrix or something convertible to a matrix via mat()
- pixel_traits<typename image_type::type> must be defined
ensures
- #*this widget is now displaying the given image new_img.
!*/
struct overlay_rect
{
/*!
WHAT THIS OBJECT REPRESENTS
This object represents a rectangle that is drawn on top of the
image shown by this object. Each rectangle is represented by
a rectangle object as well as a color and text label. The label
is drawn below the lower right corner of the rectangle.
Moreover, the rectangle can have sub-parts. Each part is listed
in the parts member variable. This variable maps the name of the
part to its position.
Rectangles with crossed_out == true will be drawn with an X through
them.
!*/
rectangle rect;
rgb_alpha_pixel color;
std::string label;
std::map<std::string,point> parts;
bool crossed_out;
overlay_rect(
);
/*!
ensures
- #color == rgb_alpha_pixel(0,0,0,0)
- #rect == rectangle()
- #label.size() == 0
- #crossed_out == false
!*/
template <typename pixel_type>
overlay_rect(
const rectangle& r,
pixel_type p
);
/*!
ensures
- #rect == r
- performs assign_pixel(color, p)
- #label.size() == 0
- #crossed_out == false
!*/
template <typename pixel_type>
overlay_rect(
const rectangle& r,
pixel_type p,
const std::string& l
);
/*!
ensures
- #rect == r
- performs assign_pixel(color, p)
- #label == l
- #crossed_out == false
!*/
template <typename pixel_type>
overlay_rect(
const rectangle& r,
pixel_type p,
const std::string& l,
const std::map<std::string,point>& parts_
);
/*!
ensures
- #rect == r
- performs assign_pixel(color, p)
- #label == l
- #parts == parts_
- #crossed_out == false
!*/
};
struct overlay_line
{
/*!
WHAT THIS OBJECT REPRESENTS
This object represents a line that is drawn on top of the
image shown by this object. Each line is represented by
its two end points (p1 and p2) as well as a color.
!*/
dpoint p1;
dpoint p2;
rgb_alpha_pixel color;
overlay_line(
);
/*!
ensures
- #color == rgb_alpha_pixel(0,0,0,0)
- #p1 == point()
- #p2 == point()
!*/
template <typename pixel_type>
overlay_line(
const dpoint& p1_,
const dpoint& p2_,
pixel_type p
);
/*!
ensures
- performs assign_pixel(color, p)
- #p1 == p1_
- #p2 == p2_
!*/
};
struct overlay_circle
{
/*!
WHAT THIS OBJECT REPRESENTS
This object represents a circle that is drawn on top of the
image shown by this object. Each circle is represented by
its center, radius, and color. It can also have an optional
text label which will appear below the circle.
!*/
point center;
int radius;
rgb_alpha_pixel color;
std::string label;
overlay_circle(
);
/*!
ensures
- #center == point(0,0)
- #radius == 0
- #color == rgb_alpha_pixel(0,0,0,0)
- #label.size() == 0
!*/
template <typename pixel_type>
overlay_circle(
const point& center_,
const int radius_,
pixel_type p
);
/*!
ensures
- performs assign_pixel(color, p)
- #center == center_
- #radius == radius_
!*/
template <typename pixel_type>
overlay_circle(
const point& center_,
const int radius_,
pixel_type p,
const std::string& label_
);
/*!
ensures
- performs assign_pixel(color, p)
- #center == center_
- #radius == radius_
- #label == label_
!*/
};
void add_overlay (
const overlay_rect& overlay
);
/*!
ensures
- adds the given overlay rectangle into this object such
that it will be displayed.
!*/
void add_overlay (
const overlay_line& overlay
);
/*!
ensures
- adds the given overlay line into this object such
that it will be displayed.
!*/
void add_overlay (
const overlay_circle& overlay
);
/*!
ensures
- adds the given overlay circle into this object such
that it will be displayed.
!*/
void add_overlay (
const std::vector<overlay_rect>& overlay
);
/*!
ensures
- adds the given set of overlay rectangles into this object such
that they will be displayed.
!*/
void add_overlay (
const std::vector<overlay_line>& overlay
);
/*!
ensures
- adds the given set of overlay lines into this object such
that they will be displayed.
!*/
void add_overlay (
const std::vector<overlay_circle>& overlay
);
/*!
ensures
- adds the given set of overlay circles into this object such
that they will be displayed.
!*/
void clear_overlay (
);
/*!
ensures
- removes all overlays from this object.
- #get_overlay_rects().size() == 0
!*/
std::vector<overlay_rect> get_overlay_rects (
) const;
/*!
ensures
- returns a copy of all the overlay_rect objects currently displayed.
!*/
void set_default_overlay_rect_label (
const std::string& label
);
/*!
ensures
- #get_default_overlay_rect_label() == label
!*/
std::string get_default_overlay_rect_label (
) const;
/*!
ensures
- returns the label given to new overlay rectangles created by the user
(i.e. when the user holds shift and adds them with the mouse)
!*/
void set_default_overlay_rect_color (
const rgb_alpha_pixel& color
);
/*!
ensures
- #get_default_overlay_rect_color() == color
!*/
rgb_alpha_pixel get_default_overlay_rect_color (
) const;
/*!
ensures
- returns the color given to new overlay rectangles created by the user
(i.e. when the user holds shift and adds them with the mouse)
!*/
void add_labelable_part_name (
const std::string& name
);
/*!
ensures
- adds a user labelable part with the given name. If the name has
already been added then this function has no effect.
- These parts can be added by the user by selecting an overlay box
and then right clicking anywhere in it. A popup menu will appear
listing the parts. The user can then click a part name and it will
add it into the overlay_rect::parts variable and also show it on the
screen.
!*/
void clear_labelable_part_names (
);
/*!
ensures
- removes all use labelable parts. Calling this function undoes
all previous calls to add_labelable_part_name(). Therefore, the
user won't be able to label any parts after clear_labelable_part_names()
is called.
!*/
rectangle get_image_display_rect (
) const;
/*!
ensures
- returns a rectangle R that tells you how big the image inside the
display is when it appears on the screen. Note that it takes the
current zoom level into account.
- R.width() == the width of the displayed image
- R.height() == the height of the displayed image
- R.tl_corner() == (0,0)
!*/
void enable_overlay_editing (
);
/*!
ensures
- #overlay_editing_is_enabled() == true
!*/
void disable_overlay_editing (
);
/*!
ensures
- #overlay_editing_is_enabled() == false
!*/
bool overlay_editing_is_enabled (
) const;
/*!
ensures
- if this function returns true then it is possible for the user to add or
remove overlay objects (e.g. rectangles) using the mouse and keyboard.
If it returns false then the overlay is not user editable.
!*/
void zoom_in (
);
/*!
ensures
- performs a zoom in as if the user tried to zoom by scrolling the mouse wheel.
!*/
void zoom_out (
);
/*!
ensures
- performs a zoom out as if the user tried to zoom by scrolling the mouse wheel.
!*/
template <
typename T
>
void set_overlay_rects_changed_handler (
T& object,
void (T::*event_handler)()
);
/*
requires
- event_handler is a valid pointer to a member function in T
ensures
- the event_handler function is called on object when the user adds,
removes, or modifies an overlay rectangle.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
*/
void set_overlay_rects_changed_handler (
const any_function<void()>& event_handler
);
/*
ensures
- the event_handler function is called when the user adds or removes
an overlay rectangle.
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
*/
template <
typename T
>
void set_overlay_rect_selected_handler (
T& object,
void (T::*event_handler)(const overlay_rect& orect)
);
/*
requires
- event_handler is a valid pointer to a member function in T
ensures
- The event_handler function is called on object when the user selects
an overlay rectangle by double clicking on it. The selected rectangle
will be passed to event_handler().
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
*/
void set_overlay_rect_selected_handler (
const any_function<void(const overlay_rect& orect)>& event_handler
);
/*
ensures
- The event_handler function is called when the user selects an overlay
rectangle by double clicking on it. The selected rectangle will be
passed to event_handler().
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
*/
template <
typename T
>
void set_image_clicked_handler (
T& object,
void (T::*event_handler)(const point& p, bool is_double_click, unsigned long btn)
);
/*
requires
- event_handler is a valid pointer to a member function in T
ensures
- The event_handler function is called on object when the user left clicks
anywhere on the image. When they do so this callback is called with the
location of the image pixel which was clicked. The is_double_click bool
will also tell you if it was a double click or single click.
- btn == the button that was released. (either base_window::LEFT, base_window::MIDDLE, or base_window::RIGHT)
- any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
throws
- std::bad_alloc
*/
void set_image_clicked_handler (
const any_function<void(const point& p, bool is_double_click, unsigned long btn)>& event_handler
);
/*
ensures
- The event_handler function is called when the user left clicks anywhere
on the image. When they do so this callback is called with the location
of the image pixel which was clicked. The is_double_click bool will also
tell you if it was a double click or single click.
- btn == the button that was released. (either base_window::LEFT, base_window::MIDDLE, or base_window::RIGHT)
- Any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this event at a
time)
throws
- std::bad_alloc
*/
private:
// restricted functions
image_display(image_display&); // copy constructor
image_display& operator=(image_display&); // assignment operator
};
// ----------------------------------------------------------------------------------------
class image_window : public drawable_window
{
/*!
INITIAL VALUE
- initially, this object is visible on the screen
- events_tied() == false
WHAT THIS OBJECT REPRESENTS
This is a simple window that is just a container for an image_display.
It exists to make it easy to throw image_displays onto the screen
without having to put together your own drawable_window objects.
!*/
public:
typedef image_display::overlay_rect overlay_rect;
typedef image_display::overlay_line overlay_line;
typedef image_display::overlay_circle overlay_circle;
image_window(
);
/*!
ensures
- this object is properly initialized
!*/
template <typename image_type>
image_window(
const image_type& img
);
/*!
requires
- image_type == an implementation of array2d/array2d_kernel_abstract.h or
a dlib::matrix or something convertible to a matrix via mat()
- pixel_traits<typename image_type::type> must be defined
ensures
- this object is properly initialized
- #*this window is now displaying the given image img.
!*/
template < typename image_type>
image_window(
const image_type& img,
const std::string& title
);
/*!
requires
- image_type == an implementation of array2d/array2d_kernel_abstract.h or
a dlib::matrix or something convertible to a matrix via mat()
- pixel_traits<typename image_type::type> must be defined
ensures
- this object is properly initialized
- #*this window is now displaying the given image img.
- The title of the window will be set to the given title string.
!*/
~image_window(
);
/*!
ensures
- any resources associated with this object have been released
!*/
template <typename image_type>
void set_image (
const image_type& img
);
/*!
requires
- image_type == an implementation of array2d/array2d_kernel_abstract.h
- pixel_traits<typename image_type::type> must be defined
ensures
- #*this window is now displaying the given image img.
!*/
void add_overlay (
const overlay_rect& overlay
);
/*!
ensures
- adds the given overlay rectangle into this object such
that it will be displayed.
!*/
template <typename pixel_type>
void add_overlay(
const rectangle& r,
pixel_type p = rgb_pixel(255,0,0)
);
/*!
ensures
- performs: add_overlay(overlay_rect(r,p));
!*/
template <typename pixel_type>
void add_overlay(
const rectangle& r,
pixel_type p,
const std::string& l
);
/*!
ensures
- performs: add_overlay(overlay_rect(r,p,l));
!*/
template <typename pixel_type>
void add_overlay(
const std::vector<rectangle>& r,
pixel_type p = rgb_pixel(255,0,0)
);
/*!
ensures
- adds the given set of rectangles into this object such
that they will be displayed with the color specific by p.
!*/
void add_overlay(
const full_object_detection& object,
const std::vector<std::string>& part_names
);
/*!
ensures
- adds the given full_object_detection to the overlays
and shows it on the screen. This includes any of its
parts that are not set equal to OBJECT_PART_NOT_PRESENT.
- for all valid i < part_names.size():
- the part object.part(i) will be labeled with the string
part_names[i].
!*/
void add_overlay(
const full_object_detection& object
);
/*!
ensures
- adds the given full_object_detection to the overlays
and shows it on the screen. This includes any of its
parts that are not set equal to OBJECT_PART_NOT_PRESENT.
!*/
void add_overlay(
const std::vector<full_object_detection>& objects,
const std::vector<std::string>& part_names
);
/*!
ensures
- calling this function is equivalent to calling the following
sequence of functions, for all valid i:
- add_overlay(objects[i], part_names);
!*/
void add_overlay(
const std::vector<full_object_detection>& objects
);
/*!
ensures
- calling this function is equivalent to calling the following
sequence of functions, for all valid i:
- add_overlay(objects[i]);
!*/
void add_overlay (
const overlay_line& overlay
);
/*!
ensures
- adds the given overlay line into this object such
that it will be displayed.
!*/
template <typename pixel_type>
void add_overlay(
const line& l,
pixel_type p
);
/*!
ensures
- performs: add_overlay(overlay_line(l.p1(),l.p2(),p));
!*/
void add_overlay (
const overlay_circle& overlay
);
/*!
ensures
- adds the given overlay circle into this object such
that it will be displayed.
!*/
template <typename pixel_type>
void add_overlay(
const point& p1,
const point& p2,
pixel_type p
);
/*!
ensures
- performs: add_overlay(overlay_line(p1,p2,p));
!*/
void add_overlay (
const std::vector<overlay_rect>& overlay
);
/*!
ensures
- adds the given set of overlay rectangles into this object such
that they will be displayed.
!*/
void add_overlay (
const std::vector<overlay_line>& overlay
);
/*!
ensures
- adds the given set of overlay lines into this object such
that they will be displayed.
!*/
void add_overlay (
const std::vector<overlay_circle>& overlay
);
/*!
ensures
- adds the given set of overlay circles into this object such
that they will be displayed.
!*/
void clear_overlay (
);
/*!
ensures
- removes all overlays from this object.
!*/
void tie_events (
);
/*!
ensures
- #events_tied() == true
!*/
void untie_events (
);
/*!
ensures
- #events_tied() == false
!*/
bool events_tied (
) const;
/*!
ensures
- returns true if and only if the get_next_double_click() and
get_next_keypress() events are tied together. If they are tied it means
that you can use a loop of the following form to listen for both events
simultaneously:
while (mywindow.get_next_double_click(p) || mywindow.get_next_keypress(key,printable))
{
if (p.x() < 0)
// Do something with the keyboard event
else
// Do something with the mouse event
}
!*/
bool get_next_double_click (
point& p
);
/*!
ensures
- This function blocks until the user double clicks on the image or the
window is closed by the user. It will also unblock for a keyboard key
press if events_tied() == true.
- if (this function returns true) then
- This means the user double clicked the mouse.
- #p == the next image pixel the user clicked.
- else
- #p == point(-1,1)
!*/
bool get_next_double_click (
point& p,
unsigned long& mouse_button
);
/*!
ensures
- This function blocks until the user double clicks on the image or the
window is closed by the user. It will also unblock for a keyboard key
press if events_tied() == true.
- if (this function returns true) then
- This means the user double clicked the mouse.
- #p == the next image pixel the user clicked.
- #mouse_button == the mouse button which was used to double click.
This will be either dlib::base_window::LEFT,
dlib::base_window::MIDDLE, or dlib::base_window::RIGHT
- else
- #p == point(-1,1)
(Note that this point is outside any possible image)
!*/
bool get_next_keypress (
unsigned long& key,
bool& is_printable,
unsigned long& state
);
/*!
ensures
- This function blocks until the user presses a keyboard key or the
window is closed by the user. It will also unblock for a mouse double
click if events_tied() == true.
- if (this function returns true) then
- This means the user pressed a keyboard key.
- The keyboard button press is recorded into #key, #is_printable, and
#state. In particular, these variables are populated with the three
identically named arguments to the base_window::on_keydown(key,is_printable,state)
event.
!*/
bool get_next_keypress (
unsigned long& key,
bool& is_printable
);
/*!
ensures
- This function blocks until the user presses a keyboard key or the
window is closed by the user. It will also unblock for a mouse double
click if events_tied() == true.
- This function is the equivalent to calling get_next_keypress(key,is_printable,temp)
and then discarding temp.
!*/
private:
// restricted functions
image_window(image_window&);
image_window& operator= (image_window&);
};
// ----------------------------------------------------------------------------------------
class perspective_display : public drawable, noncopyable
{
/*!
WHAT THIS OBJECT REPRESENTS
This object is a tool for displaying 3D point clouds on a screen. You can
navigate the display with the mouse. Left click and drag rotates the
camera around the displayed data. Scrolling the mouse wheel zooms and
shift+left click (or just right click) and drag pans the view around.
!*/
public:
perspective_display(
drawable_window& w
);
/*!
ensures
- #*this is properly initialized
- #*this has been added to window w
- #parent_window() == w
!*/
~perspective_display(
);
/*!
ensures
- all resources associated with *this have been released
!*/
void set_size (
unsigned long width,
unsigned long height
);
/*!
ensures
- #width() == width
- #height() == height
- #top() == top()
- #left() == left()
- i.e. The location of the upper left corner of this widget stays the
same but its width and height are modified.
!*/
struct overlay_line
{
/*!
WHAT THIS OBJECT REPRESENTS
This object represents a line that is drawn on the screen. Each line
is represented by its two end points (p1 and p2) as well as a color.
!*/
overlay_line() { assign_pixel(color, 0);}
overlay_line(const vector<double>& p1_, const vector<double>& p2_)
: p1(p1_), p2(p2_) { assign_pixel(color, 255); }
template <typename pixel_type>
overlay_line(const vector<double>& p1_, const vector<double>& p2_, pixel_type p)
: p1(p1_), p2(p2_) { assign_pixel(color, p); }
vector<double> p1;
vector<double> p2;
rgb_pixel color;
};
struct overlay_dot
{
/*!
WHAT THIS OBJECT REPRESENTS
This object represents a dot that is drawn on the screen. Each dot is
represented by one point and a color.
!*/
overlay_dot() { assign_pixel(color, 0);}
overlay_dot(const vector<double>& p_)
: p(p_) { assign_pixel(color, 255); }
template <typename pixel_type>
overlay_dot(const vector<double>& p_, pixel_type color_)
: p(p_) { assign_pixel(color, color_); }
vector<double> p; // The location of the dot
rgb_pixel color;
};
void add_overlay (
const std::vector<overlay_line>& overlay
);
/*!
ensures
- Adds the given overlay lines into this object such that it will be
displayed.
!*/
void add_overlay (
const std::vector<overlay_dot>& overlay
);
/*!
ensures
- Adds the given overlay dots into this object such that it will be
displayed.
!*/
void clear_overlay (
);
/*!
ensures
- Removes all overlays from this object. The display will be empty.
!*/
template <typename T>
void set_dot_double_clicked_handler (
T& object,
void (T::*event_handler)(const vector<double>&)
);
/*
requires
- event_handler is a valid pointer to a member function in T
ensures
- The event_handler function is called on object when the user double
clicks on one of the overlay dots. The selected dot will be passed to
event_handler().
- Any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
*/
void set_dot_double_clicked_handler (
const any_function<void(const vector<double>&)>& event_handler
);
/*
ensures
- The event_handler function is called when the user double clicks on one
of the overlay dots. The selected dot will be passed to event_handler().
- Any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
*/
};
// ----------------------------------------------------------------------------------------
class perspective_window : public drawable_window, noncopyable
{
/*!
WHAT THIS OBJECT REPRESENTS
This is a simple window that is just a container for a perspective_display.
It exists to make it easy to throw perspective_displays onto the screen
without having to put together your own drawable_window objects.
!*/
public:
typedef perspective_display::overlay_line overlay_line;
typedef perspective_display::overlay_dot overlay_dot;
perspective_window(
);
/*!
ensures
- The window is displayed on the screen and is 100x100 pixels in size.
!*/
perspective_window(
const std::vector<dlib::vector<double> >& point_cloud
);
/*!
ensures
- The window is displayed on the screen and is 100x100 pixels in size.
- This window will have point_cloud added to it via add_overlay() and the
points will all be white.
!*/
perspective_window(
const std::vector<dlib::vector<double> >& point_cloud,
const std::string& title
);
/*!
ensures
- The window is displayed on the screen and is 100x100 pixels in size.
- This window will have point_cloud added to it via add_overlay() and the
points will all be white.
- The title of the window will be set to the given title string.
!*/
~perspective_window(
);
/*!
ensures
- any resources associated with this object have been released
!*/
void add_overlay (
const std::vector<overlay_line>& overlay
);
/*!
ensures
- Adds the given overlay lines into this object such that it will be
displayed.
!*/
void add_overlay (
const std::vector<overlay_dot>& overlay
);
/*!
ensures
- Adds the given overlay dots into this object such that it will be
displayed.
!*/
void clear_overlay (
);
/*!
ensures
- Removes all overlays from this object. The display will be empty.
!*/
void add_overlay(
const std::vector<dlib::vector<double> >& d
);
/*!
ensures
- Adds the given dots into this object such that it will be
displayed. They will be colored white.
!*/
template <typename pixel_type>
void add_overlay(
const std::vector<dlib::vector<double> >& d,
pixel_type p
);
/*!
ensures
- Adds the given dots into this object such that it will be
displayed. They will be colored by pixel color p.
!*/
template <typename pixel_type>
void add_overlay(
const vector<double>& p1,
const vector<double>& p2,
pixel_type color
);
/*!
ensures
- Adds an overlay line going from p1 to p2 with the given color.
!*/
template < typename T >
void set_dot_double_clicked_handler (
T& object,
void (T::*event_handler)(const vector<double>&)
);
/*
requires
- event_handler is a valid pointer to a member function in T
ensures
- The event_handler function is called on object when the user double
clicks on one of the overlay dots. The selected dot will be passed to
event_handler().
- Any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
*/
void set_dot_double_clicked_handler (
const any_function<void(const vector<double>&)>& event_handler
);
/*
ensures
- The event_handler function is called when the user double clicks on one
of the overlay dots. The selected dot will be passed to event_handler().
- Any previous calls to this function are overridden by this new call.
(i.e. you can only have one event handler associated with this
event at a time)
*/
};
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_WIDGETs_ABSTRACT_
|