1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
Forms
====================================================================
-->
<module name="Forms">
<short>
Implements Forms, which are the basis for the Lazarus Graphical User Interface.
</short>
<descr>
<p>
<file>forms.pp</file> contains classes, types, and routines used to implement forms, which are used as the basis a graphical user interface in the Lazarus Component Library (<b>LCL</b>).
</p>
<p>
The following components are added to the Lazarus IDE component palette:
</p>
<p>
<b>Standard</b> Tab
</p>
<ul>
<li>TFrame</li>
</ul>
<p>
<b>Additional</b> Tab
</p>
<ul>
<li>TScrollBox</li>
<li>TApplicationProperties</li>
</ul>
<p>
The unit also includes the <var>TApplication</var> and <var>TScreen</var> classes used in the <var>Application</var> and <var>Screen</var> singletons.
</p>
</descr>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Types"/>
<element name="TypInfo"/>
<element name="Math"/>
<element name="CustApp"/>
<element name="LCLStrConsts"/>
<element name="LCLType"/>
<element name="LCLProc"/>
<element name="LCLIntf"/>
<element name="LCLVersion"/>
<element name="LCLClasses"/>
<element name="InterfaceBase"/>
<element name="LResources"/>
<element name="Graphics"/>
<element name="Menus"/>
<element name="LMessages"/>
<element name="CustomTimer"/>
<element name="ActnList"/>
<element name="ClipBrd"/>
<element name="HelpIntfs"/>
<element name="Controls"/>
<element name="ImgList"/>
<element name="Themes"/>
<element name="LazFileUtils"/>
<element name="LazUTF8"/>
<element name="Maps"/>
<element name="IntegerList"/>
<element name="LazMethodList"/>
<element name="LazLoggerBase"/>
<element name="LazUtilities"/>
<element name="GraphType"/>
<element name="UITypes"/>
<element name="gettext"/>
<element name="TProcedure">
<short>Type used for a procedure that takes no arguments.</short>
<descr>
<p>
Used to define members in control classes.
</p>
</descr>
<seealso/>
</element>
<element name="TProcedureOfObject">
<short>Type used for an object procedure that takes no arguments.</short>
<descr>
<p>
Used to define members in control classes.
</p>
</descr>
<seealso/>
</element>
<element name="TPosition">
<short>Represents the Position and Size of a Form on Screen.</short>
<descr>
<p>
<var>TPosition</var> is an enumerated type with values that describe the policy used to position and size a form instance in an application. TPosition is the type used to implement the <var>Position</var> property in <var>TCustomForm</var>. TPosition is used in the implementation of the <var>MoveToDefaultPosition</var> method in TCustomForm.
</p>
</descr>
<seealso>
<link id="TCustomForm.Position"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
</seealso>
</element>
<element name="TPosition.poDesigned">
<short>
The Form appears exactly as it is positioned and sized in the Form Designer.
</short>
</element>
<element name="TPosition.poDefault">
<short>
The window manager decides how the form is to appear, in a default position and size.
</short>
</element>
<element name="TPosition.poDefaultPosOnly">
<short>
Keeps the designed form size, but position determined by window manager.
</short>
</element>
<element name="TPosition.poDefaultSizeOnly">
<short>
Keeps the designed form position, but size determined by window manager.
</short>
</element>
<element name="TPosition.poScreenCenter">
<short>Centers the form on screen.</short>
</element>
<element name="TPosition.poDesktopCenter">
<short>
Centers the form on the desktop (not recommended, use poScreenCenter).
</short>
</element>
<element name="TPosition.poMainFormCenter">
<short>Centers the form on the Main Form.</short>
</element>
<element name="TPosition.poOwnerFormCenter">
<short>Centers the form on its Owner form.</short>
</element>
<element name="TWindowState">
<short>Represents the actual State of the window on the screen.</short>
<descr>
<p>
The actual meaning of each value depends on the platform:
</p>
<dl>
<dt>Windows and Mac OS X</dt>
<dd>These operating systems support all values.</dd>
<dt>X11</dt>
<dd>
The window state is a hint sent to the Window Manager, so more primitive Window Managers might ignore these hints.
</dd>
<dt>Windows CE</dt>
<dd>
In Windows CE platforms where Application.ApplicationType = atKeyPadDevice or atPDA (like in Windows Phone, PocketPC and Windows Mobile), wsMinimized and wsNormal are understood as wsMaximized, which is the normal state for windows in this platform. An exception are windows with BorderStyle=bsDialog or bsNone, which are allowed to have a custom position and size. For more information please read the <url href="http://wiki.lazarus.freepascal.org/Windows_CE_Development_Notes#Positioning_and_size_of_Dialogs_and_Forms">Lazarus Wiki article</url>.
</dd>
<dt>Android</dt>
<dd>In this platform windows are always fullscreen.</dd>
</dl>
</descr>
<seealso/>
</element>
<element name="TWindowState.wsNormal">
<short>Neither maximized nor minimized.</short>
</element>
<element name="TWindowState.wsMinimized">
<short>The window is minimized and is not shown in the screen, but only in the taskbar.</short>
</element>
<element name="TWindowState.wsMaximized">
<short>
The window appears maximized. The exact behavior is up to the window manager, but usually the window appear occupying all of the work area of a monitor.
</short>
</element>
<element name="TWindowState.wsFullScreen">
<short>
The window appears in full screen mode, when allowed by the platform. It will, for example, attempt to appear on the top of taskbars and other static platform user interface elements. wsFullScreen is converted to wsMaximized for use on the the Windows platform; the API does not provide a full screen option.
</short>
</element>
<element name="TCloseAction">
<short>What should happen when a form is closed.</short>
<descr/>
<seealso>
<link id="TCustomForm.OnClose">TCustomForm.OnClose</link>
</seealso>
</element>
<element name="TCloseAction.caNone">
<short>Do nothing.</short>
</element>
<element name="TCloseAction.caHide">
<short>The form is hidden.</short>
</element>
<element name="TCloseAction.caFree">
<short>The form is destroyed.</short>
</element>
<element name="TCloseAction.caMinimize">
<short>The form is minimized.</short>
</element>
<element name="TCustomHintAction">
<short>
Represents a standard action used to get a Hint value.
</short>
<descr>
<p>
<var>TCustomHintAction</var> is a <var>TCustomAction</var> descendant. TCustomHintAction publishes the Hint property available in the ancestor. TCustomHintAction is the base class for THintAction defined in the <file>StdActns</file> unit.
</p>
<p>
TCustomHintAction is used in <var>TApplication</var> when setting the value for its Hint property and its <var>OnHint</var> event handler has not been assigned. TCustomHintAction is also used in the <var>ExecuteAction</var> method in <var>TStatusBar</var> when its <var>AutoHint</var> property is enabled.
</p>
</descr>
<seealso>
<link id="TApplication.Hint"/>
<link id="TApplication.OnHint"/>
<link id="#lcl.comctrls.TStatusBar.ExecuteAction">TStatusBar.ExecuteAction</link>
<link id="#lcl.stdactns.THintAction">THintAction</link>
</seealso>
</element>
<element name="TCustomHintAction.Hint" link="#lcl.actnlist.TCustomAction.Hint">
<short>The text used for the Hint.</short>
<descr/>
<seealso/>
</element>
<element name="TScrollBarKind">
<short>The orientation of a scroll bar.</short>
<descr/>
<seealso/>
</element>
<element name="TScrollBarKind.sbHorizontal">
<short>Horizontal scroll bar.</short>
</element>
<element name="TScrollBarKind.sbVertical">
<short>Vertical scroll bar.</short>
</element>
<element name="TScrollBarInc">
<short>The range for scroll bar increments.</short>
<descr/>
<seealso/>
</element>
<element name="TScrollBarStyle">
<short>Scroll bar style flags.</short>
<descr/>
<seealso/>
</element>
<element name="TScrollBarStyle.ssRegular">
<short>Default style; not used in the current LCL version.</short>
</element>
<element name="TScrollBarStyle.ssFlat">
<short>
Scroll bar appears flat; Not used in the current LCL version.
</short>
</element>
<element name="TScrollBarStyle.ssHotTrack">
<short>
Scroll bar sends HotTrack messages; Not used in the current LCL version.
</short>
</element>
<element name="EScrollBar">
<short>Exception class raised in <link id="TControlScrollBar"/>.</short>
<descr/>
<seealso/>
</element>
<element name="TControlScrollBar">
<short>Scroll bar type used in TScrollingWinControl.</short>
<descr>
<p>
Scrollable controls supply their own <b>integrated</b> scroll bars, one for horizontal and one for vertical scrolling. This class allows access to (one of) these integrated scroll bars.
</p>
<p>
A scrollable control has both a physical (visible) client size, and a logical (virtual) client size.
</p>
<p>
The <var>Range</var> property reflects the total virtual client size, in pixels.
</p>
<p>
The <var>Page</var> property corresponds to physical (visible) client size, in pixels, excluding the scroll bars. It also determines the size of the slider, relative to the total Range.
</p>
<p>
The <var>Position</var> property reflects the virtual origin of the visible client area, equivalent to the top coordinate of the slider. The Position can be changed by the user or by code.
</p>
<p>
Scroll bars usually appear only when Range is higher than Page, i.e. when the entire content cannot be shown at the same time. See the scroll bar properties in <var>TScrollingWinControl</var> for more details.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl"/>
<link id="TScrollBox"/>
<link id="TCustomForm"/>
</seealso>
</element>
<element name="TControlScrollBar.FAutoRange">
<short>
The virtual scroll range (Range - ClientSize), at least zero and never negative.
</short>
</element>
<element name="TControlScrollBar.FIncrement" link="#lcl.forms.TControlScrollBar.Increment"/>
<element name="TControlScrollBar.FKind" link="#lcl.forms.TControlScrollBar.Kind"/>
<element name="TControlScrollBar.FPage" link="#lcl.forms.TControlScrollBar.Page"/>
<element name="TControlScrollBar.FRange" link="#lcl.forms.TControlScrollBar.Range"/>
<element name="TControlScrollBar.FSmooth" link="#lcl.forms.TControlScrollBar.Smooth"/>
<element name="TControlScrollBar.FTracking" link="#lcl.forms.TControlScrollBar.Tracking"/>
<element name="TControlScrollBar.FVisible" link="#lcl.forms.TControlScrollBar.Visible"/>
<element name="TControlScrollBar.FOldScrollInfo"/>
<element name="TControlScrollBar.FOldScrollInfoValid"/>
<element name="TControlScrollBar.FControl">
<short>The associated TScrollingWinControl instance.</short>
</element>
<element name="TControlScrollBar.FPosition" link="#lcl.forms.TControlScrollBar.Position"/>
<element name="TControlScrollBar.ControlHandle">
<short>Gets the Handle for the associated TScrollingWinControl instance.</short>
<descr>
<p>
Provides the handle passed as an argument to routines in the LCL interface, including:
</p>
<ul>
<li>GetScrollInfo</li>
<li>SetScrollInfo</li>
<li>GetScrollbarSize</li>
<li>GetScrollbarVisible</li>
</ul>
</descr>
<seealso>
<link id="#lcl.lclintf.GetScrollInfo">GetScrollInfo</link>
<link id="#lcl.lclintf.SetScrollInfo">SetScrollInfo</link>
<link id="#lcl.lclintf.GetScrollbarSize">GetScrollbarSize</link>
<link id="#lcl.lclintf.GetScrollbarVisible">GetScrollbarVisible</link>
</seealso>
</element>
<element name="TControlScrollBar.ControlHandle.Result">
<short>The handle for the associated control.</short>
</element>
<element name="TControlScrollBar.GetAutoScroll">
<short>The AutoScroll state for the associated TScrollingWinControl control.</short>
<descr>
<remark>
<var>GetAutoScroll</var> is <b>not</b> used as the read access specifier for the AutoScroll property. It is used in methods to ensure that the class reflects the current state for its associated control.
</remark>
</descr>
<seealso>
<link id="TScrollingWinControl.AutoScroll"/>
</seealso>
</element>
<element name="TControlScrollBar.GetAutoScroll.Result">
<short>
True when the Control for the class instance has set its AutoScroll property.
</short>
</element>
<element name="TControlScrollBar.GetIncrement">
<short>Gets the value for the Increment property.</short>
<descr/>
<seealso>
<link id="TControlScrollBar.Increment"/>
</seealso>
</element>
<element name="TControlScrollBar.GetIncrement.Result">
<short>Value for the property.</short>
</element>
<element name="TControlScrollBar.GetPage">
<short>Gets the value for the Page property.</short>
<descr/>
<seealso>
<link id="TControlScrollBar.Page"/>
</seealso>
</element>
<element name="TControlScrollBar.GetPage.Result">
<short>Value for the property.</short>
</element>
<element name="TControlScrollBar.GetPosition">
<short>Gets the value for the Position property.</short>
<descr/>
<seealso>
<link id="TControlScrollBar.Position"/>
</seealso>
</element>
<element name="TControlScrollBar.GetPosition.Result">
<short>Value for the property.</short>
</element>
<element name="TControlScrollBar.GetRange">
<short>Gets the value for the Range property.</short>
<descr/>
<seealso>
<link id="TControlScrollBar.Range"/>
</seealso>
</element>
<element name="TControlScrollBar.GetRange.Result">
<short>Value for the property.</short>
</element>
<element name="TControlScrollBar.GetSize">
<short>Gets the value for the Size property.</short>
<descr/>
<seealso>
<link id="TControlScrollBar.Size"/>
</seealso>
</element>
<element name="TControlScrollBar.GetSize.Result">
<short>Value for the property.</short>
</element>
<element name="TControlScrollBar.GetSmooth">
<short>Gets the value for the Smooth property.</short>
<descr/>
<seealso>
<link id="TControlScrollBar.Smooth"/>
</seealso>
</element>
<element name="TControlScrollBar.GetSmooth.Result">
<short>Value for the property.</short>
</element>
<element name="TControlScrollBar.HandleAllocated">
<short>True when the associated TScrollingWinControl and its handle are valid.</short>
<descr>
<p>
Used in methods which call LCL interface routines to avoid exceptions resulting from an unassigned control or an invalid handle value.
</p>
</descr>
<seealso/>
</element>
<element name="TControlScrollBar.HandleAllocated.Result">
<short>True when the associated TScrollingWinControl and its handle are valid.</short>
</element>
<element name="TControlScrollBar.IsRangeStored">
<short>Implements the storage specifier for the Range property.</short>
<descr/>
<seealso>
<link id="TControlScrollBar.Range"/>
<link id="TScrollingWinControl.AutoScroll"/>
</seealso>
</element>
<element name="TControlScrollBar.IsRangeStored.Result">
<short>True when AutoScroll is enabled for the scroll bar.</short>
</element>
<element name="TControlScrollBar.ControlUpdateScrollBars">
<short>Forces the associated control to update its scroll bars.</short>
<descr>
<p>
Calls the <var>UpdateScrollBars</var> method in the associated <var>TScrollingWinControl</var> instance when its handle has been allocated. No actions are performed in the method during LCL component streaming and when the component is freed.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.UpdateScrollBars"/>
</seealso>
</element>
<element name="TControlScrollBar.InternalSetRange">
<short>Validates and applies the specified Range and updates the scroll bars.</short>
<descr>
<p>
Ensures that <var>AValue</var> is not less than zero (<b>0</b>). Applies the range limited value to the member for the <var>Range</var> property, and calls <var>ControlUpdateScrollBars</var> to refresh the scroll bars for the associated <var>TScrollingWinControl</var> instance.
</p>
<p>
InternalSetRange is called when the <var>SetRange</var> method updates the value for the Range property.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.ControlUpdateScrollBars"/>
<link id="TControlScrollBar.SetRange"/>
<link id="TControlScrollBar.Range"/>
<link id="TScrollingWinControl.UpdateScrollBars"/>
</seealso>
</element>
<element name="TControlScrollBar.InternalSetRange.AValue">
<short>Value checked and applied to the Range property.</short>
</element>
<element name="TControlScrollBar.ScrollHandler">
<short>Handler for scroll bar movement messages.</short>
<descr>
<p>
<var>ScrollHandler</var> is a method used to ensure that the control message in <var>Message</var> is applied to the <var>Position</var> property for the scroll bar. ScrollHandler uses the <var>ScrollCode</var> member from the <var>TLMScroll</var> instance to determine the actions needed in the method. It handles the following ScrollCode values:
</p>
<dl>
<dt>SB_LINEUP</dt>
<dd>Decreases Position by the value in Increment.</dd>
<dt>SB_LINEDOWN</dt>
<dd>Increases Position by the value in Increment.</dd>
<dt>SB_PAGEUP</dt>
<dd>Decreases Position by the value in Page.</dd>
<dt>SB_PAGEDOWN</dt>
<dd>Increases Position by the value in Page.</dd>
<dt>SB_THUMBPOSITION</dt>
<dd>Sets Position to the value in the Pos member in Message.</dd>
<dt>SB_THUMBTRACK</dt>
<dd>
Sets Position to the value in the Pos member in Message when Tracking is enabled. No actions are performed when Tracking is set to False.
</dd>
<dt>SB_TOP</dt>
<dd>Sets Position to 0 (zero).</dd>
<dt>SB_BOTTOM</dt>
<dd>Sets Position to the value in the Range property.</dd>
</dl>
<p>
No actions are performed in the method if Message has any other value in its ScrollCode member. No actions are performed in the method at design-time.
</p>
<p>
ScrollHandler ensures the the new value for the Position property is in the range <b>0..<var>Range</var></b>. Calls <var>InvalidateScrollInfo</var> to force scroll bar information to be re-initialized. Calls <var>SetPosition</var> to apply the new value for the Position property and scrolls the associated <var>TScrollingWinControl</var> accordingly. Sets the <var>Result</var> member in Message to <b>1</b> to indicate the control message was handled in the method.
</p>
<p>
ScrollHandler is called when the <var>WMHScroll</var> or <var>WMVScroll</var> methods in the associated TScrollingWinControl instance are used to handle scroll messages.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.Increment"/>
<link id="TControlScrollBar.Page"/>
<link id="TControlScrollBar.Position"/>
<link id="TControlScrollBar.Range"/>
<link id="TScrollingWinControl.WMHScroll"/>
<link id="TScrollingWinControl.WMVScroll"/>
</seealso>
</element>
<element name="TControlScrollBar.ScrollHandler.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TControlScrollBar.SetIncrement" link="#lcl.forms.TControlScrollBar.Increment"/>
<element name="TControlScrollBar.SetIncrement.AValue">
<short>New value for the property.</short>
</element>
<element name="TControlScrollBar.SetPage" link="#lcl.forms.TControlScrollBar.Page"/>
<element name="TControlScrollBar.SetPage.AValue">
<short>New value for the property.</short>
</element>
<element name="TControlScrollBar.SetPosition" link="#lcl.forms.TControlScrollBar.Position"/>
<element name="TControlScrollBar.SetPosition.Value">
<short>New value for the property.</short>
</element>
<element name="TControlScrollBar.SetRange" link="#lcl.forms.TControlScrollBar.Range"/>
<element name="TControlScrollBar.SetRange.AValue">
<short>New value for the property.</short>
</element>
<element name="TControlScrollBar.SetSize" link="#lcl.forms.TControlScrollBar.Size"/>
<element name="TControlScrollBar.SetSize.AValue">
<short>New value for the property.</short>
</element>
<element name="TControlScrollBar.SetSmooth" link="#lcl.forms.TControlScrollBar.Smooth"/>
<element name="TControlScrollBar.SetSmooth.AValue">
<short>New value for the property.</short>
</element>
<element name="TControlScrollBar.SetTracking" link="#lcl.forms.TControlScrollBar.Tracking"/>
<element name="TControlScrollBar.SetTracking.AValue">
<short>New value for the property.</short>
</element>
<element name="TControlScrollBar.SetVisible" link="#lcl.forms.TControlScrollBar.Visible"/>
<element name="TControlScrollBar.SetVisible.AValue">
<short>New value for the property.</short>
</element>
<element name="TControlScrollBar.UpdateScrollBar">
<short>
Updates the state and position for the scroll bar in the associated Control.
</short>
<descr>
<p>
<var>UpdateScrollBar</var> is a procedure used to update the state and position for the scroll bar in the associated <var>Control</var>.
</p>
<p>
When <var>Control</var> is a <var>TScrollingWinControl</var> instance, <var>TScrollInfo</var> is captured using the <var>Range</var>, <var>Position</var>, and <var>Page</var> properties. The scroll bar information is applied to the associated control by calling <var>SetScrollInfo</var>.
</p>
<remark>
<var>TScrollInfo</var> values are not applied when a handle has not been allocated for the control, or when <var>Control</var> is not a <var>TScrollingWinControl</var> class instance.
</remark>
<p>
<var>UpdateScrollBar</var> calls <var>SetPosition</var> to apply the current value in <var>Position</var> to a visible scroll bar in the class instance. When <var>Control</var> is a <var>TScrollingWinControl</var> instance, the <var>Smooth</var> property is used to determine if <var>Increment</var> needs to be adjusted to a value that is 10% of the <var>Page</var> size for the control.
</p>
<p>
<var>UpdateScrollBar</var> is used in the implementation of the <var>ControlUpdateScrollBars</var> method.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.Increment"/>
<link id="TControlScrollBar.Page"/>
<link id="TControlScrollBar.Smooth"/>
<link id="TControlScrollBar.Range"/>
<link id="TControlScrollBar.ControlUpdateScrollBars"/>
</seealso>
</element>
<element name="TControlScrollBar.InvalidateScrollInfo">
<short>Renders scroll information invalid for the control.</short>
<descr>
<p>
<var>InvalidateScrollInfo</var> is used to mark the current <var>TScrollInfo</var> in the control as invalid. This occurs when a new value is assigned to the <var>Position</var> property, and when <var>ScrollHandler</var> applies position information found in <var>TLMScroll</var> messages. Calling InvalidateScrollInfo results in TScrollInfo being updated and applied for scrolling window controls in the <var>UpdateScrollBar</var> method.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.Position"/>
<link id="TControlScrollBar.UpdateScrollBar"/>
<link id="TControlScrollBar.ScrollHandler"/>
<link id="#lcl.lmessages.TLMScroll">TLMScroll</link>
</seealso>
</element>
<element name="TControlScrollBar.GetHorzScrollBar">
<short>Gets the horizontal scroll bar for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TControlScrollBar.GetHorzScrollBar.Result">
<short>TControlScrollBar instance representing the scroll bar.</short>
</element>
<element name="TControlScrollBar.GetVertScrollBar">
<short>Get the vertical scroll bar for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TControlScrollBar.GetVertScrollBar.Result">
<short>
Scroll bar for the control, or Nil when not a TScrollingWinControl descendant.
</short>
</element>
<element name="TControlScrollBar.ScrollBarShouldBeVisible">
<short>Determines whether a scroll bar is required.</short>
<descr/>
<seealso>
<link id="TControlScrollBar.Page"/>
<link id="TControlScrollBar.Range"/>
<link id="TControlScrollBar.Visible"/>
</seealso>
</element>
<element name="TControlScrollBar.ScrollBarShouldBeVisible.Result">
<short>True when Visible, and Range is larger than the Page size.</short>
</element>
<element name="TControlScrollBar.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the constructor for the class instance, and calls the inherited constructor on entry.
</p>
<p>
Create sets the associated control for the class instance and the Kind property to the values specified in the AControl and AKind arguments. Create sets the default values for properties, including:
</p>
<dl>
<dt>Page</dt>
<dd>Set to 80.</dd>
<dt>Increment</dt>
<dd>Set to 8.</dd>
<dt>Position and Range</dt>
<dd>Set to 0 (zero).</dd>
<dt>Smooth and Tracking</dt>
<dd>Set to False.</dd>
<dt>Visible</dt>
<dd>Set to True.</dd>
</dl>
</descr>
<seealso>
<link id="#rtl.system.TObject.Create">TObject.Create</link>
</seealso>
</element>
<element name="TControlScrollBar.Create.AControl">
<short>The windowed control in which the scroll bar is found.</short>
</element>
<element name="TControlScrollBar.Create.AKind">
<short>The scroll bar orientation.</short>
</element>
<element name="TControlScrollBar.Assign">
<short>
If Source is a <var>TControlScrollBar</var>, copies properties to itself, else performs inherited <var>Assign</var>.
</short>
<descr>
<p>
Assigns the contents of the source object to the current object; in particular finds the Increment, Position, Range and whether smooth scrolling is to be feature and whether the scroll bar is visible.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.Increment"/>
<link id="TControlScrollBar.Position"/>
<link id="TControlScrollBar.Range"/>
<link id="#rtl.classes.TPersistent.Assign">TPersistent.Assign</link>
</seealso>
</element>
<element name="TControlScrollBar.Assign.Source">
<short>
TControlScrollBar instance with the values copied in the method.
</short>
</element>
<element name="TControlScrollBar.IsScrollBarVisible">
<short>
Determines if the scroll bar is visible using the state from the widgetset class.
</short>
<descr>
<p>
<var>IsScrollBarVisible</var> is a <var>Boolean</var> function used to determine if the scroll bar for the associated control is visible. The return value defaults to the value in the <var>Visible</var> property. If the handle has been allocated for the control, the <var>GetScrollbarVisible</var> routine from the LCL interface is used to get the visibility for the scroll bar <var>Kind</var>.
</p>
<p>
IsScrollBarVisible is used in the implementation of the <var>ClientSizeWithBar</var> and <var>ClientSizeWithoutBar</var> methods.
</p>
</descr>
<seealso/>
</element>
<element name="TControlScrollBar.IsScrollBarVisible.Result">
<short>True if the scroll bar is visible.</short>
</element>
<element name="TControlScrollBar.ScrollPos">
<short>The Position for the scroll bar, or zero if not Visible.</short>
<descr/>
<seealso/>
</element>
<element name="TControlScrollBar.ScrollPos.Result">
<short>The scroll bar Position, or zero if not Visible.</short>
</element>
<element name="TControlScrollBar.GetOtherScrollBar">
<short>
Gets the scroll bar with the opposite orientation (horz/vert) of the current instance.
</short>
<descr/>
<seealso/>
</element>
<element name="TControlScrollBar.GetOtherScrollBar.Result">
<short>TControlScrollBar instance for the opposite orientation.</short>
</element>
<element name="TControlScrollBar.Size">
<short>The adjustable size of the scroll bar.</short>
<descr>
<p>
The length of the bar is the Width (or Height) of the Parent Control, the Size is the other (free) coordinate.
</p>
</descr>
<seealso/>
</element>
<element name="TControlScrollBar.ControlSize">
<short>Returns the size for the associated control.</short>
<descr>
<p>
<var>ControlSize</var> is an <var>Integer</var> function used to get the size for the associated control in the class instance. Uses the value in <var>Kind</var> to determine the control property used as the return value. When Kind is <var>sbVertical</var>, the <var>Width</var> for the associated Control is used. When Kind is <var>sbHorizontal</var>, the <var>Height</var> for the associated Control is used.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.Kind"/>
<link id="TControlScrollBar.Create"/>
<link id="TScrollBarKind"/>
</seealso>
</element>
<element name="TControlScrollBar.ControlSize.Result">
<short>Size for the associated control.</short>
</element>
<element name="TControlScrollBar.ClientSize">
<short>
Gets the size for the scroll bar based on the client area in the associated control.
</short>
<descr>
<p>
<var>ClientSize</var> is an <var>Integer</var> function used to get the size from the client area in the associated control. ClientSize uses the value in Kind to determine whether the height or width for the associated control is used as the return value. For example:
</p>
<dl>
<dt>sbVertical</dt>
<dd>Returns the client width from the associated control.</dd>
<dt>sbHorizontal</dt>
<dd>Returns the client height from the associated control.</dd>
</dl>
<p>
ClientSize is used in methods like <var>ClientSizeWithBar</var> and <var>ClientSizeWithoutBar</var> to get the size for the scroll bar adjusted for scroll bar spacing returned from <var>GetSystemMetrics</var>.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.Kind"/>
<link id="TControlScrollBar.FControl"/>
<link id="TControlScrollBar.ClientSizeWithBar"/>
<link id="TControlScrollBar.ClientSizeWithoutBar"/>
</seealso>
</element>
<element name="TControlScrollBar.ClientSize.Result">
<short>Size from the client area in the associated control.</short>
</element>
<element name="TControlScrollBar.ClientSizeWithBar">
<short>
Calculates the size of the associated control when the scroll bar is Visible.
</short>
<descr>
<p>
<var>ClientSizeWithBar</var> is an <var>Integer</var> function used to calculate the client area for the associated control when the scroll bar is <var>Visible</var>. The return value contains the calculated value from <var>ClientSize</var>. If the scroll bar is not Visible, additional spacing (for the SM_SWSCROLLBARSPACING system metric) between the scroll bar and its associated control is removed from the return value.
</p>
<p>
ClientSizeWithBar is used in the implementation of the <var>ComputeScrollbars</var> method in <var>TScrollingWinControl</var> when the <var>Range</var> for the scroll bar would exceed the space available on the control, and in the <var>GetPreferredSizeClientFrame</var> method.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.ClientSize"/>
<link id="TControlScrollBar.Visible"/>
<link id="TControlScrollBar.Range"/>
<link id="TScrollingWinControl.ComputeScrollbars"/>
<link id="TScrollingWinControl.GetPreferredSizeClientFrame"/>
</seealso>
</element>
<element name="TControlScrollBar.ClientSizeWithBar.Result">
<short>
Size for the client area after adjusting for a visible scroll bar.
</short>
</element>
<element name="TControlScrollBar.ClientSizeWithoutBar">
<short>
Calculates the size of the associated control when the scroll bar is not Visible.
</short>
<descr>
<p>
<var>ClientSizeWithoutBar</var> is an <var>Integer</var> function used to calculate the client area for the associated control when the scroll bar is <var>Visible</var>. The return value contains the calculated value from <var>ClientSize</var>. If the scroll bar is Visible, additional spacing (for the SM_SWSCROLLBARSPACING system metric) between the scroll bar and its associated control is added to the return value.
</p>
<p>
ClientSizeWithoutBar is used in the implementation of the <var>ComputeScrollbars</var> and <var>GetPreferredSizeClientFrame</var> methods in <var>TScrollingWinControl</var>.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.ClientSize"/>
<link id="TControlScrollBar.Visible"/>
<link id="TControlScrollBar.Range"/>
<link id="TScrollingWinControl.ComputeScrollbars"/>
<link id="TScrollingWinControl.GetPreferredSizeClientFrame"/>
</seealso>
</element>
<element name="TControlScrollBar.ClientSizeWithoutBar.Result">
<short>Size for the client area when the scroll bar is hidden.</short>
</element>
<element name="TControlScrollBar.Increment">
<short>
The small Position increment, applicable to the scroll bar arrows.
</short>
<descr>
<p>
<var>Increment</var> is a <var>TScrollBarInc</var> property which indicates the amount the client area in the associated control is scrolled when the <b>Up</b> or <b>Down</b> navigation arrows on the scroll bar are clicked. The default value is <b>8</b>.
</p>
<p>
The value in Increment may be automatically recalculated in the <var>UpdateScrollBar</var> method when the <var>Smooth</var> property is enabled and the associated control is a <var>TScrollingWinControl</var> descendant. This is done to ensure that Increment contains 10% of the value for the <var>Page</var> property.
</p>
<p>
Increment is used in the <var>ScrollHandler</var> method when updating the <var>Position</var> property for scroll bar messages received in the control.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.UpdateScrollBar"/>
<link id="TControlScrollBar.ControlUpdateScrollBars"/>
<link id="TControlScrollBar.Smooth"/>
<link id="TControlScrollBar.Page"/>
<link id="TControlScrollBar.ScrollHandler"/>
<link id="TScrollingWinControl"/>
<link id="TScrollBarInc"/>
</seealso>
</element>
<element name="TControlScrollBar.Kind">
<short>The orientation for the scroll bar: horizontal or vertical.</short>
<descr>
<p>
<var>Kind</var> is a read-only <var>TScrollBarKind</var> property which indicates the orientation for the scroll bar. The value for Kind is passed as an argument to the <var>Create</var> constructor, and stored in the property. The value in Kind is used in methods which update properties or state for the control, such as:
</p>
<ul>
<li>Position</li>
<li>Range</li>
<li>Page</li>
<li>Tracking</li>
<li>Size</li>
<li>ClientSize</li>
<li>ControlSize</li>
<li>IsScrollBarVisible</li>
<li>GetOtherScrollBar</li>
<li>UpdateScrollBar</li>
</ul>
</descr>
<seealso>
<link id="TControlScrollBar.Create"/>
</seealso>
</element>
<element name="TControlScrollBar.Page">
<short>
The slider size, position increment applicable to the scroll bar area beneath the slider.
</short>
<descr>
<p>
The amount by which the scroll indicator moves if the cursor selects the scroll bar above, below or on either side of the scroll indicator. The default value is 80.
</p>
</descr>
<seealso/>
</element>
<element name="TControlScrollBar.Smooth">
<short>
Enables smooth scrolling, with automatic adjustment of Increment and Page.
</short>
<descr>
<p>
<var>Smooth</var> is a <var>Boolean</var> property that indicates if the associated control is scrolled using an Increment value computed to be 10% of the Page size for the scroll bar. Set Smooth to <b>True</b> when the scroll bar should use a scrolling increment based on the size of the client area in the associated control. When Smooth is set to <b>False</b>, the <var>Increment</var> property determines the size for the scroll operation when the Up or Down arrows are clicked.
</p>
<p>
Smooth is used in the <var>UpdateScrollBar</var> method, and when set to <b>True</b> causes the value in Increment to be recalculated using the proportional size value. Smooth is relevant when the associated control is descended from <var>TScrollingWinControl</var>.
</p>
<p>
The default value for the property is <b>False</b>.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.Increment"/>
<link id="TControlScrollBar.Page"/>
<link id="TControlScrollBar.UpdateScrollBar"/>
<link id="TScrollingWinControl"/>
</seealso>
</element>
<element name="TControlScrollBar.Position">
<short>Position of the slider, 0..Range-Page.</short>
<descr>
<p>
The Position reflects the top coordinate of the slider, which is Range-Page when the slider is at the bottom of the bar.
</p>
</descr>
<seealso/>
</element>
<element name="TControlScrollBar.Range">
<short>The virtual size of the Parent Control.</short>
<descr>
</descr>
<seealso/>
</element>
<element name="TControlScrollBar.Tracking">
<short>Gives feedback while the slider is dragged.</short>
<descr>
<p>
When it takes a significant amount of time to repaint the parent control at a new position, Tracking should be False to prevent flicker. This causes the control to be updated only when the slider is released.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TControlScrollBar.Visible">
<short>Hides the scroll bar when False (default True).</short>
<descr>
<p>
The scroll bar widget is visible only if (Visible=True) <b>and</b> (Range>Page).
</p>
<p>
Set Visible to False to disallow the user to scroll the content, while the content still can be scrolled by code.
</p>
<p>
Use IsScrollBarVisible to get the current visible state of the widget.
</p>
</descr>
<seealso>
<link id="TControlScrollBar.IsScrollBarVisible"/>
</seealso>
</element>
<element name="TScrollingWinControl">
<short>Class of a windowed control with incorporated scroll bars.</short>
<descr>
<p>
This class introduces a logical (virtual) client area, part of which is visible in the physical (visible) client area. <link id="TControlScrollBar">ScrollBars</link> allow the user to scroll through the logical client area.
</p>
<p>
TScrollingWinControl is the ancestor for components like <var>TScrollBox</var> and <var>TCustomDesignControl</var>, and indirectly for <var>TCustomFrame</var> and <var>TCustomForm</var>.
</p>
</descr>
<seealso>
<link id="TControlScrollBar"/>
<link id="TScrollBox"/>
<link id="TCustomDesignControl"/>
<link id="TCustomFrame"/>
<link id="TCustomForm"/>
<link id="TFrame"/>
<link id="TForm"/>
</seealso>
</element>
<element name="TScrollingWinControl.FHorzScrollBar"/>
<element name="TScrollingWinControl.FVertScrollBar"/>
<element name="TScrollingWinControl.FAutoScroll"/>
<element name="TScrollingWinControl.FIsUpdating">
<short>Prevents recursive updates, True while an update is already in progress.</short>
</element>
<element name="TScrollingWinControl.SetHorzScrollBar"/>
<element name="TScrollingWinControl.SetHorzScrollBar.Value"/>
<element name="TScrollingWinControl.SetVertScrollBar"/>
<element name="TScrollingWinControl.SetVertScrollBar.Value"/>
<element name="TScrollingWinControl.HideScrollbars">
<short>Hides scroll bars with valid handles.</short>
</element>
<element name="TScrollingWinControl.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TScrollingWinControl.AlignControls">
<short>Aligns the controls which have the class instance as their parent.</short>
<descr>
<p>
Calls the inherited method to align the specified control and its children to the parent control. Ensures that the page, range, and position in the scroll bars are recalculated when <var>AutoScroll</var> is enabled and both <var>HorzScrollBar</var> and <var>VertScrollBar</var> are in use.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.AutoScroll"/>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.VertScrollBar"/>
<link id="#LCL.Controls.TWinControl.AlignControls">TWinControl.AlignControls</link>
</seealso>
</element>
<element name="TScrollingWinControl.AlignControls.AControl">
<short>Control aligned in the method.</short>
</element>
<element name="TScrollingWinControl.AlignControls.ARect">
<short>Client rectangle used in the operation.</short>
</element>
<element name="TScrollingWinControl.AutoScrollEnabled">
<short>Indicates if automatic scrolling is enabled for the control.</short>
<descr>
<p>
<var>AutoScrollEnabled</var> is a <var>Boolean</var> function which indicates if automatic scrolling is enabled for the control. The return value is <b>True</b> when the control is <b>NOT</b> automatically resized, or used as a dock site by an active docking manager.
</p>
<p>
Use the <var>AutoSize</var> property to enabled or disable automatic control resizing. Set the <var>UseDockManager</var> property to <b>False</b> to disable use of the <var>DockSite</var> for the control.
</p>
</descr>
<seealso>
<link id="TScrollBox.AutoSize"/>
<link id="TScrollBox.DockSite"/>
<link id="TWinControl.UseDockManager"/>
</seealso>
</element>
<element name="TScrollingWinControl.AutoScrollEnabled.Result">
<short>True when not automatically resized or used as a dock site.</short>
</element>
<element name="TScrollingWinControl.CalculateAutoRanges">
<short>Sets or resets the ranges used for scroll bars in the control.</short>
<descr>Used in the implementation of the ComputeScrollbars method.</descr>
<seealso>
<link id="TScrollingWinControl.ComputeScrollbars"/>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.VertScrollBar"/>
</seealso>
</element>
<element name="TScrollingWinControl.CreateWnd">
<short>Creates the window handle for the control.</short>
<descr>
<p>
Ensures that the scroll bar page, range, and visibility are established when the handles for the windowed control are created. Temporarily disables auto-sizing in the method, and re-enables auto-sizing prior to exit. Calls the inherited method to create the window and its handles.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.UpdateScrollBars"/>
<link id="#lcl.controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
</seealso>
</element>
<element name="TScrollingWinControl.GetClientScrollOffset">
<short>The origin for the physical client area.</short>
<descr/>
<seealso>
<link id="#LCL.Controls.TControl.GetClientScrollOffset">TControl.GetClientScrollOffset</link>
</seealso>
</element>
<element name="TScrollingWinControl.GetClientScrollOffset.Result">
<short>The scroll bar Positions, or (0,0) if no scroll bars in use.</short>
</element>
<element name="TScrollingWinControl.GetLogicalClientRect" link="#lcl.controls.TControl.GetLogicalClientRect">
<short>Returns the full virtual ClientRect.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.GetLogicalClientRect">TControl.GetLogicalClientRect</link>
</seealso>
</element>
<element name="TScrollingWinControl.GetLogicalClientRect.Result">
<short>
TRect instance with the client rectangle adjusted for scroll bars visible on the control.
</short>
</element>
<element name="TScrollingWinControl.DoOnResize" link="#lcl.controls.TControl.DoOnResize">
<short>Also updates scroll bars if needed.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.DoOnResize">TControl.DoOnResize</link>
</seealso>
</element>
<element name="TScrollingWinControl.GetPreferredSizeClientFrame">
<short>
Calculates the size of the client area for the control excluding visible scroll bars.
</short>
<descr/>
<seealso>
<link id="TScrollingWinControl.AutoScroll"/>
<link id="TScrollingWinControl.VertScrollBar"/>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="#lcl.controls.TControl.Height">TControl.Height</link>
<link id="#lcl.controls.TControl.Width">TControl.Width</link>
<link id="#lcl.controls.TControl.ClientHeight">TControl.ClientHeight</link>
<link id="#lcl.controls.TControl.ClientWidth">TControl.ClientWidth</link>
</seealso>
</element>
<element name="TScrollingWinControl.GetPreferredSizeClientFrame.aWidth">
<short>Width of the client area.</short>
</element>
<element name="TScrollingWinControl.GetPreferredSizeClientFrame.aHeight">
<short>Height of the client area.</short>
</element>
<element name="TScrollingWinControl.WMSize">
<short>Performs actions needed to handle WMSize messages.</short>
<descr>
<p>
<var>WMSize</var> is a procedure used to perform actions needed to handle WMSize messages for the control. WMSize calls the inherited WMSize method to set the bounds for the control, optionally using the bounds from the parent control.
</p>
<p>
WMSize provides support for setting the window state based on size messages that originate in the LCL interface, and calls <var>Resizing</var> to realize the new window state.
</p>
</descr>
<seealso>
<link id="TCustomForm.WMSize"/>
<link id="TControl.WMSize"/>
<link id="TScrollingWinControl.Resizing"/>
<link id="TWindowState"/>
</seealso>
</element>
<element name="TScrollingWinControl.WMSize.Message">
<short>Message examined in the method.</short>
</element>
<element name="TScrollingWinControl.WMHScroll">
<short>
Delegates scroll messages to the handler for the horizontal scroll bar.
</short>
<descr/>
<seealso>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TControlScrollBar.ScrollHandler"/>
</seealso>
</element>
<element name="TScrollingWinControl.WMHScroll.Message">
<short>
Message forwarded to the scroll bar.
</short>
</element>
<element name="TScrollingWinControl.WMVScroll">
<short>
Delegates scroll messages to the handler for the vertical scroll bar.
</short>
<descr/>
<seealso>
<link id="TScrollingWinControl.VertScrollBar"/>
<link id="TControlScrollBar.ScrollHandler"/>
</seealso>
</element>
<element name="TScrollingWinControl.WMVScroll.Message">
<short>
Message forwarded to the scroll bar.
</short>
</element>
<element name="TScrollingWinControl.ComputeScrollbars">
<short>
Updates Page, AutoRange, IsScrollBarVisible, and returns True when changed.
</short>
<descr/>
<seealso/>
</element>
<element name="TScrollingWinControl.ComputeScrollbars.Result">
<short>
True when something has been changed in the scroll bar settings.
</short>
</element>
<element name="TScrollingWinControl.SetAutoScroll">
<short>Sets the value for the AutoScroll property.</short>
<descr>
<p>
When the property is changed to <b>True</b>, the <var>UpdateScrollBars</var> method is called to calculate the page, range, and visibility for <var>HorzScrollBar</var> and <var>VertScrollBar</var>. When changed to <b>False</b>, the <var>HideScrollbars</var> method is called to reset the page, range, and visibility for the scroll bars. If the BoundsRect is updated in either method, the original value is restored prior to exit.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.VertScrollBar"/>
<link id="TScrollingWinControl.UpdateScrollBars"/>
<link id="#lcl.forms.TScrollingWinControl.AutoScroll"/>
</seealso>
</element>
<element name="TScrollingWinControl.SetAutoScroll.Value">
<short>New value for the property.</short>
</element>
<element name="TScrollingWinControl.Loaded">
<short>
Performs actions when the component has been loaded from the LCL streaming mechanism.
</short>
<descr>
<p>
<var>Loaded</var> is an overridden method in <var>TScrollingWinControl</var>, and calls the inherited method on entry. It calls <var>UpdateScrollBars</var> to compute the page, auto ranges, and visibility for the scroll bars when <var>AutoScroll</var> is enabled.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.AutoScroll"/>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.VertScrollBar"/>
<link id="TScrollingWinControl.UpdateScrollBars"/>
<link id="#LCL.Controls.TWinControl.Loaded">TWinControl.Loaded</link>
</seealso>
</element>
<element name="TScrollingWinControl.Resizing">
<short>
Performs actions needed when the control processes the WMSize message.
</short>
<descr>
<p>
Resizing is an empty implementation in TScrollingWinControl. It must be implemented in a descendent class.
</p>
</descr>
<seealso>
<link id="TCustomForm.WindowState"/>
<link id="TCustomForm.Resizing"/>
<link id="TWindowState"/>
</seealso>
</element>
<element name="TScrollingWinControl.Resizing.State">
<short>
Window state for the windowed control.
</short>
</element>
<element name="TScrollingWinControl.AutoScroll">
<short>
Indicates whether scroll bars are automatically displayed or hidden when needed.
</short>
<descr>
<p>
<var>AutoScroll</var> is a <var>Boolean</var> property which indicates if scroll bars are automatically displayed or hidden on the control as needed. The default value for the property is <b>False</b>.
</p>
<p>
Changing the value for the property causes the <var>Visible</var> property in both <var>HorzScrollBar</var> and <var>VertScrollBar</var> to be updated (if needed). When set to <b>True</b>, the <var>UpdateScrollBars</var> method is called to calculate the page, range, and visibility for the scroll bars. When set to <var>False</var>, the <var>HideScrollbars</var> method is called to reset and hide the scroll bars (when assigned).
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.UpdateScrollbars"/>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.VertScrollBar"/>
</seealso>
</element>
<element name="TScrollingWinControl.SetAutoSize">
<short>Sets the value for the AutoSize property.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
</seealso>
</element>
<element name="TScrollingWinControl.SetAutoSize.Value">
<short>New value for the property.</short>
</element>
<element name="TScrollingWinControl.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method on entry. It allocates resources needed for the <var>VertScrollBar</var> and <var>HorzScrollBar</var> properties, sets the default value in <var>AutoScroll</var> to <b>False</b>, and sets the initial bounds for the class instance.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.VertScrollBar"/>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.AutoScroll"/>
</seealso>
</element>
<element name="TScrollingWinControl.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TScrollingWinControl.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy frees resources allocated for the <var>HorzScrollBar</var> and <var>VertScrollBar</var> properties. Destroy calls the inherited destructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.VertScrollBar"/>
</seealso>
</element>
<element name="TScrollingWinControl.ScreenToClient" link="#lcl.controls.TControl.ScreenToClient"/>
<element name="TScrollingWinControl.ScreenToClient.Result">
<short/>
</element>
<element name="TScrollingWinControl.ScreenToClient.APoint">
<short/>
</element>
<element name="TScrollingWinControl.ClientToScreen" link="#lcl.controls.TControl.ClientToScreen"/>
<element name="TScrollingWinControl.ClientToScreen.Result">
<short/>
</element>
<element name="TScrollingWinControl.ClientToScreen.APoint">
<short/>
</element>
<element name="TScrollingWinControl.UpdateScrollbars">
<short>Initializes or updates the scroll bars for the control.</short>
<descr>
<p>
<var>UpdateScrollbars</var> is a method used to update the scroll bars used on the windowed control.
</p>
<p>
When automatic scrollbars are enabled using AutoScroll, the scroll bar information is initialized as needed for the visible scroll bars. The UpdateScrollBar method in both VertScrollBar and HorzScrollBar is called to recalculate the current page and range in the scroll bars.
</p>
<p>
No actions are performed in the method if a handle has not been allocated for the control, or when either HorzScrollBar or VertScrollBar has not been assigned.
</p>
<p>
Recursive calls to the method are also ignored.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.AutoScroll"/>
<link id="TScrollingWinControl.ComputeScrollbars"/>
<link id="TControlScrollBar.UpdateScrollBar"/>
</seealso>
</element>
<element name="TScrollingWinControl.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TScrollingWinControl.GetControlClassDefaultSize.Result">
<short/>
</element>
<element name="TScrollingWinControl.ScrollBy">
<short>
Tells the widget to scroll the client area by the specified relative values.
</short>
<descr>
<p>
ScrollBy calls the inherited ScrollBy_WS to apply the relative horizontal and vertical values to the widgetset class instance. An exception is raised if the handle has not been allocated. The still visible part doesn't deserve a repaint (optimization).
</p>
</descr>
<seealso/>
</element>
<element name="TScrollingWinControl.ScrollBy.DeltaX">
<short>Horizontal distance for the scroll operation.</short>
</element>
<element name="TScrollingWinControl.ScrollBy.DeltaY">
<short>Vertical distance for the scroll operation.</short>
</element>
<element name="TScrollingWinControl.ScrollInView">
<short>
Aligns the specified control to its parent and scrolls it into view.
</short>
<descr>
<p>
<var>ScrollInView</var> is a method used to align and scroll the control in <var>AControl</var> into the visible area for the scrolling window control. No actions are performed in the method under the following conditions:
</p>
<ul>
<li>AControl has not been assigned (contains <b>Nil</b>).</li>
<li>The control is not the Parent (or ancestor) for AControl.</li>
<li>Neither horizontal nor vertical scroll bars are displayed for the control.</li>
</ul>
<p>
The origin for AControl relative to its <var>Parent</var> is determined by calling the <var>ClientToParent</var> method. <var>OffsetRect</var> is called to apply the offset to the display rectangle for AControl. The adjusted coordinates are used to reposition the visible scroll bars so that AControl is visible in the client area for the scrolling window control.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.VertScrollBar"/>
<link id="TScrollingWinControl.HorzScrollBar"/>
<link id="TScrollingWinControl.AlignControls"/>
<link id="TControlScrollBar.Position"/>
<link id="#lcl.controls.TControl.ClientToParent">TControl.ClientToParent</link>
<link id="#lcl.lclintf.OffsetRect">OffsetRect</link>
</seealso>
</element>
<element name="TScrollingWinControl.ScrollInView.AControl">
<short>Control to make visible in the scrolling window control.</short>
</element>
<element name="TScrollingWinControl.HorzScrollBar">
<short>The horizontal scroll bar for the control.</short>
<descr>
<p>
<var>HorzScrollBar</var> is a <var>TControlScrollBar</var> property with the horizontal scroll bar for the scrolling window control. The scroll bar is displayed for the control when its <var>Visible</var> property is <b>True</b>, or when <var>Width</var> is larger than the <var>ClientWidth</var> for the control and <var>AutoScroll</var> is enabled.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.AutoScroll"/>
<link id="TScrollingWinControl.AutoScrollEnabled"/>
<link id="TControlScrollBar.Visible"/>
<link id="#lcl.controls.TControl.ClientWidth">TControl.ClientWidth</link>
<link id="#lcl.controls.TControl.Width">TControl.Width</link>
</seealso>
</element>
<element name="TScrollingWinControl.VertScrollBar">
<short>The vertical scroll bar for the control.</short>
<descr>
<p>
VertScrollBar is a TControlScrollBar property with the vertical scroll bar for the scrolling window control. The scroll bar is displayed for the control when its <var>Visible</var> property is <b>True</b>, or when <var>Height</var> is larger than the <var>ClientHeight</var> for the control and <var>AutoScroll</var> is enabled.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.AutoScroll"/>
<link id="TScrollingWinControl.AutoScrollEnabled"/>
<link id="TControlScrollBar.Visible"/>
<link id="#lcl.controls.TControl.ClientHeight">TControl.ClientHeight</link>
<link id="#lcl.controls.TControl.Height">TControl.Height</link>
</seealso>
</element>
<element name="TScrollBox">
<short>Implements a windowed control with scroll bars.</short>
<descr>
<p>
<var>TScrollBox</var> is a <var>TScrollingWinControl</var> descendant that implements a windowed control with scroll bars. TScrollBox sets the visibility for properties inherited from the ancestor class. TScrollBox includes an overridden constructor which sets the default values for properties in the class instance.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl"/>
</seealso>
</element>
<element name="TScrollBox.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TScrollBox.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. It calls the inherited method on entry, an updates the component and control style flags as needed for the class instance. It sets the default values for the following properties:
</p>
<ul>
<li>AutoScroll (True)</li>
<li>BorderStyle (bsSingle)</li>
</ul>
</descr>
<seealso>
<link id="#lcl.forms.TScrollingWinControl.Create">TScrollingWinControl.Create</link>
</seealso>
</element>
<element name="TScrollBox.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TScrollBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TScrollBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TScrollBox.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TScrollBox.AutoScroll">
<short>
Indicates whether scroll bars are automatically displayed or hidden when needed.
</short>
<descr>
<p>
<var>AutoScroll</var> is a <var>Boolean</var> property which indicates if scroll bars are automatically displayed or hidden on the control as needed. The default value for the property is <b>True</b> in TScrollBox.
</p>
<p>
Changing the value for the property causes the Visible property in both HorzScrollBar and VertScrollBar to be updated (if needed). When set to <b>True</b>, the UpdateScrollBars method is called to calculate the page, range, and visibility for the scroll bars. When set to <b>False</b>, the HideScrollbars method is called to reset and hide the scroll bars (when assigned).
</p>
</descr>
<seealso>
<link id="#lcl.forms.TScrollingWinControl.AutoScroll">TScrollingWinControl.AutoScroll</link>
<link id="#lcl.forms.TScrollingWinControl.UpdateScrollbars">TScrollingWinControl.UpdateScrollbars</link>
<link id="#lcl.forms.TScrollingWinControl.HorzScrollBar">TScrollingWinControl.HorzScrollBar</link>
<link id="#lcl.forms.TScrollingWinControl.VertScrollBar">TScrollingWinControl.VertScrollBar</link>
</seealso>
</element>
<element name="TScrollBox.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TScrollBox.BiDiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TScrollBox.BorderStyle">
<short>Line style used to draw the border around the control.</short>
<descr>
<p>
The default value for the property is bsSingle in TScrollBox.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.BorderStyle">TWinControl.BorderStyle</link>
</seealso>
</element>
<element name="TScrollBox.ChildSizing" link="#lcl.controls.TWinControl.ChildSizing"/>
<element name="TScrollBox.ClientHeight" link="#lcl.controls.TControl.ClientHeight"/>
<element name="TScrollBox.ClientWidth" link="#lcl.controls.TControl.ClientWidth"/>
<element name="TScrollBox.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TScrollBox.DockSite" link="#lcl.controls.TWinControl.DockSite"/>
<element name="TScrollBox.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TScrollBox.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TScrollBox.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TScrollBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TScrollBox.Color" link="#lcl.controls.TControl.Color"/>
<element name="TScrollBox.Font" link="#lcl.controls.TControl.Font"/>
<element name="TScrollBox.ParentBackground">
<short>
Indicates if the control uses the background from its Parent control.
</short>
<descr>
<p>
ParentBackground is a Boolean property which indicates if the background for the Parent control is drawn as the background for the current control instance. The default value in TScrollBox is False.
</p>
<p>
ParentBackground is True when csParentBackground is included in the ControlStyle property. Setting the value in ParentBackground causes ControlStyle to be updated to include or exclude the csParentBackground enumeration value; it is included when True.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.ParentBackground">TWinControl.ParentBackground</link>
<link id="#lcl.controls.TControl.ControlStyle">TControl.ControlStyle</link>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
<link id="#lcl.controls.TControlStyle">TControlStyle</link>
<link id="#lcl.controls.TControlStyleType">TControlStyleType</link>
</seealso>
</element>
<element name="TScrollBox.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TScrollBox.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TScrollBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TScrollBox.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TScrollBox.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TScrollBox.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TScrollBox.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TScrollBox.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
<element name="TScrollBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TScrollBox.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TScrollBox.OnConstrainedResize" link="#lcl.controls.TControl.OnConstrainedResize"/>
<element name="TScrollBox.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TScrollBox.OnDockDrop" link="#lcl.controls.TWinControl.OnDockDrop"/>
<element name="TScrollBox.OnDockOver" link="#lcl.controls.TWinControl.OnDockOver"/>
<element name="TScrollBox.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TScrollBox.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TScrollBox.OnEndDock" link="#lcl.controls.TControl.OnEndDock"/>
<element name="TScrollBox.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TScrollBox.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TScrollBox.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TScrollBox.OnGetSiteInfo" link="#lcl.controls.TWinControl.OnGetSiteInfo"/>
<element name="TScrollBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TScrollBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TScrollBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TScrollBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TScrollBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TScrollBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TScrollBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TScrollBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TScrollBox.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TScrollBox.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TScrollBox.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TScrollBox.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TScrollBox.OnStartDock" link="#lcl.controls.TControl.OnStartDock"/>
<element name="TScrollBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TScrollBox.OnUnDock" link="#lcl.controls.TWinControl.OnUnDock"/>
<element name="TScrollBox.OnPaint" link="#lcl.controls.TCustomControl.OnPaint"/>
<element name="TCustomDesignControl">
<short>Provides a designer surface for scaling and layout of its child controls.</short>
<descr>
<p>
<var>TCustomDesignControl</var> is a <var>TScrollingWinControl</var> descendant which provides a designer surface used for scaling and layout of its child controls.
</p>
<p>
Properties are provided to set the display density (Pixels Per Inch) for design-time and run-time usage, and to Scale child controls. Methods are also provided to use <var>TLayoutAdjustmentPolicy</var> to layout and to re-size the child controls.
</p>
<p>
An overridden <var>Loaded</var> method is provided to adjust the design-time PPI (when scaling is enabled in the application).
</p>
<p>
TCustomDesignControl is used as the ancestor for <var>TCustomFrame</var> and <var>TCustomForm</var>.
</p>
</descr>
<seealso>
<link id="TApplication.Scaled"/>
<link id="TCustomForm"/>
<link id="TCustomFrame"/>
<link id="GetParentDesignControl"/>
<link id="NeedParentDesignControl"/>
</seealso>
</element>
<element name="TCustomDesignControl.FScaled"/>
<element name="TCustomDesignControl.FDesignTimePPI"/>
<element name="TCustomDesignControl.FPixelsPerInch"/>
<element name="TCustomDesignControl.DesignTimePPIIsStored">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCustomDesignControl.DesignTimePPIIsStored.Result">
<short/>
</element>
<element name="TCustomDesignControl.SetDesignTimePPI">
<short>Sets the value for the DesignTimePPI property.</short>
<descr/>
<seealso>
<link id="TCustomDesignControl.DesignTimePPI"/>
</seealso>
</element>
<element name="TCustomDesignControl.SetDesignTimePPI.ADesignTimePPI">
<short>New value for the property.</short>
</element>
<element name="TCustomDesignControl.SetScaled">
<short>Sets the value for the Scaled property.</short>
<descr/>
<seealso>
<link id="TCustomDesignControl.Scaled"/>
</seealso>
</element>
<element name="TCustomDesignControl.SetScaled.AScaled">
<short>New value for the property.</short>
</element>
<element name="TCustomDesignControl.DoAutoAdjustLayout">
<short>
Applies size and layout changes to the design surface and its Parent control.
</short>
<descr>
<p>
<var>DoAutoAdjustLayout</var> is a procedure used to perform actions needed to apply size and layout changes to the design surface and its <var>Parent</var> control.
</p>
<p>
<var>DoAutoAdjustLayout</var> adjusts the height and width for the design surface by the specified scaling factors. Similarly, the <var>BorderSpacing</var> and <var>Constraints</var> in the control are adjusted using the scaling factors. Finally, the <var>SetBounds</var> method is called to apply the new values for Height and Width to the design surface.
</p>
<remark>
No actions are performed in the method when the Parent property has not been assigned (contains <b>Nil</b>). In addition, no actions are performed when <var>AMode</var> omits the <var>lapAutoAdjustWithoutHorizontalScrolling</var> and <var>lapAutoAdjustForDPI</var> enumeration values.
</remark>
</descr>
<seealso>
<link id="#lcl.controls.TControl.AutoAdjustLayout">TControl.AutoAdjustLayout</link>
<link id="#lcl.controls.TControl.Constraints">TControl.Constraints</link>
<link id="#lcl.controls.TControl.BorderSpacing">TControl.BorderSpacing</link>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
<link id="#lcl.controls.TLayoutAdjustmentPolicy"/>
</seealso>
</element>
<element name="TCustomDesignControl.DoAutoAdjustLayout.AMode">
<short>TLayoutAdjustmentPolicy applied in the method.</short>
</element>
<element name="TCustomDesignControl.DoAutoAdjustLayout.AXProportion">
<short>Horizontal scaling factor applied in the method.</short>
</element>
<element name="TCustomDesignControl.DoAutoAdjustLayout.AYProportion">
<short>Vertical scaling factor applied in the method.</short>
</element>
<element name="TCustomDesignControl.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. Create calls the inherited method using the value in <var>TheOwner</var> as the the owner of the class instance. Create sets the default values for the following properties:
</p>
<ul>
<li>Scaled</li>
<li>DesignTimePPI</li>
<li>PixelsPerInch</li>
</ul>
<p>
When scaling is enabled in the Application, the value in <var>DesignTimePPI</var> is used as the <var>PixelsPerInch</var> setting in the <var>Font</var> property.
</p>
</descr>
<seealso>
<link id="TCustomDesignControl.Scaled"/>
<link id="TCustomDesignControl.PixelsPerInch"/>
<link id="TCustomDesignControl.Scaled"/>
<link id="TApplication.Scaled"/>
<link id="#lcl.controls.TControl.Font">TControl.Font</link>
</seealso>
</element>
<element name="TCustomDesignControl.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomDesignControl.AutoAdjustLayout">
<short>
Applies a new display density (Pixels Per Inch) for a layout policy to the control.
</short>
<descr>
<p>
<var>AutoAdjustLayout</var> is used to set the value in the <var>PixelsPerInch</var> property to the value specified in <var>AToPPI</var> for the <var>lapAutoAdjustForDPI</var> layout policy. AutoAdjustLayout calls the inherited method.
</p>
<remark>
No additional actions are performed in the method when <var>AMode</var> contains a value other than <var>lapAutoAdjustForDPI</var>.
</remark>
</descr>
<seealso>
<link id="TCustomDesignControl.PixelsPerInch"/>
<link id="TCustomDesignControl.DoAutoAdjustLayout"/>
<link id="TLayoutAdjustmentPolicy"/>
</seealso>
</element>
<element name="TCustomDesignControl.AutoAdjustLayout.AMode">
<short>Layout policy to use for the design surface.</short>
</element>
<element name="TCustomDesignControl.AutoAdjustLayout.AFromPPI">
<short>Original display density setting.</short>
</element>
<element name="TCustomDesignControl.AutoAdjustLayout.AToPPI">
<short>New display density setting.</short>
</element>
<element name="TCustomDesignControl.AutoAdjustLayout.AOldFormWidth">
<short>Original form width.</short>
</element>
<element name="TCustomDesignControl.AutoAdjustLayout.ANewFormWidth">
<short>New form width.</short>
</element>
<element name="TCustomDesignControl.DesignTimePPI">
<short>Design-time Pixels Per Inch for the designer surface.</short>
<descr>
<p>
<var>DesignTimePPI</var> is an <var>Integer</var> property that contains the display density (or Pixels Per Inch) used on the designer surface. The default value for the property is <b>96</b>.
</p>
<p>
The property value is normally set when the component is loaded using the LCL streaming mechanism. It can be assigned at design-time to the value in <var>ADesignTimePPI</var> only when the new value matches the display density for the current Screen where the designer surface is used. The value can be changed at run-time, but the programmer must ensure that the value is valid for the intended usage.
</p>
<p>
An <var>EInvalidOperation</var> exception is raised if an invalid value is specified at design-time.
</p>
<p>
When scaling is enabled in the Application, the value in DesignTimePPI is assigned to the <var>Font</var> for the designer surface.
</p>
<p>
Use <var>PixelsPerInch</var> to access the run-time display density for the designer surface.
</p>
</descr>
<seealso>
<link id="TCustomDesignControl.PixelsPerInch"/>
<link id="TCustomDesignControl.Scaled"/>
<link id="TApplication.Scaled"/>
<link id="#lcl.controls.TControl.Font">TControl.Font</link>
</seealso>
</element>
<element name="TCustomDesignControl.PixelsPerInch">
<short>Run-time Pixels Per Inch for the designer surface.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomDesignControl.Scaled">
<short>
Indicates if the design surface is scaled to reflect changes in display density (Pixels Per Inch).
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomFrame">
<short>The base type for <var>TFrame</var>.</short>
<descr>
<p>
<var>TCustomFrame</var> is a <var>TCustomDesignControl</var> descendant which implements the base class for <var>TFrame</var>. A Frame is a named container for related components. Groups of controls can be place on a frame, and re-used in your applications.
</p>
<p>
A Frame has behavior very similar to a Form. Their unique ability is that they can be embedded into forms or other frames in the designer. Like forms, they are stored in two separate files: the code is stored in a .pas unit file, and the design is stored in a .lfm file.
</p>
<p>
Frames can be created and designed in the Lazarus IDE by creating a new Frame module, and using the unit in your application. An existing frame can be added using the TFrame component on the Standard tab in the Lazarus IDE; you will be prompted for the TFrame class to use for the component.
</p>
<p>
Frames can also be created entirely in code at run-time. They do not have to be installed in the Lazarus IDE. One drawback is that complex inheritance hierarchies for <var>TFrame</var> classes can be problematic; they do not propagate changes to all derived frames in a multi-level inheritance tree.
</p>
</descr>
<seealso>
<link id="TFrame"/>
<link id="TCustomDesignControl"/>
</seealso>
</element>
<element name="TCustomFrame.AddActionList">
<short>Adds the specified list of Actions to the Parent form for the frame class.</short>
<descr>
<remark>
No actions are performed in the method when a Parent form has not been assigned for the class instance.
</remark>
<p>
AddActionList is called from the Notification method when a TCustomActionList instance has been added to the control. This occurs when a new Parent is assigned for the frame instance.
</p>
</descr>
<seealso>
<link id="TCustomFrame.Notification"/>
<link id="GetParentForm"/>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
</seealso>
</element>
<element name="TCustomFrame.AddActionList.ActionList">
<short>List of Actions added in the method.</short>
</element>
<element name="TCustomFrame.RemoveActionList">
<short>Removes the specified list of Actions from the Parent form.</short>
<descr>
<remark>
No actions are performed in the method when a Parent form has not been assigned for the class instance.
</remark>
<p>
RemoveActionList is called from the Notification method when the TCustomActionList instance has been added to the control. This occurs when a new Parent which contains an action list is assigned for the frame instance.
</p>
</descr>
<seealso>
<link id="TCustomFrame.Notification"/>
<link id="GetParentForm"/>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
</seealso>
</element>
<element name="TCustomFrame.RemoveActionList.ActionList">
<short>List of Actions removed in the method.</short>
</element>
<element name="TCustomFrame.ReadDesignLeft">
<short>Implements reading the Left property for the designer surface.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomFrame.ReadDesignLeft.Reader">
<short/>
</element>
<element name="TCustomFrame.ReadDesignTop">
<short>Implements reading the Right property for the designer surface.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomFrame.ReadDesignTop.Reader">
<short/>
</element>
<element name="TCustomFrame.WriteDesignLeft">
<short>Implements writing the Left property for the designer surface.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomFrame.WriteDesignLeft.Writer">
<short/>
</element>
<element name="TCustomFrame.WriteDesignTop">
<short>Implements writing the Top property for the designer surface.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomFrame.WriteDesignTop.Writer">
<short/>
</element>
<element name="TCustomFrame.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomFrame.GetChildren">
<short>
Invokes <var>Proc</var> for all Controls and also for all Components without a Parent.
</short>
<descr/>
<seealso>
<link id="#LCL.Controls.TWinControl.GetChildren">TWinControl.GetChildren</link>
</seealso>
</element>
<element name="TCustomFrame.GetChildren.Proc">
<short>The callback method.</short>
</element>
<element name="TCustomFrame.GetChildren.Root">
<short>Components are enumerated only if Root=Self.</short>
</element>
<element name="TCustomFrame.Notification">
<short>Adds or removes an action list for the control.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.Notification">TControl.Notification</link>
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
</seealso>
</element>
<element name="TCustomFrame.Notification.AComponent">
<short>Component for the notification.</short>
</element>
<element name="TCustomFrame.Notification.Operation">
<short>Operation for the notification.</short>
</element>
<element name="TCustomFrame.SetColor">
<short>Sets the value for the Color property.</short>
<descr>
<p>
<var>SetColor</var> is an overridden method in <var>TCustomFrame</var> used to set the value for the <var>Color</var> property. It calls the inherited method on entry.
</p>
<p>
When the value for the Color property is set to <var>clDefault</var>, or has the same value as the Color property in <var>Parent</var>, no additional actions are performed in the method. Otherwise, the value in ParentBackground is set to <b>False</b>.
</p>
</descr>
<seealso>
<link id="TCustomFrame.ParentBackground"/>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
</seealso>
</element>
<element name="TCustomFrame.SetColor.Value">
<short>New value for the property.</short>
</element>
<element name="TCustomFrame.SetParent">
<short>Sets the value for the Parent property.</short>
<descr>
<p>
Updates the action list for child components or nested frames by calling AddActionList or RemoveActionList. Frees the Handle for the control when Parent has not already been assigned. Calls the inherited method to update the value in Parent. Performs automatic layout adjustments when the PixelsPerInch settings for the Parent and the frame instance have different value.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
<link id="#lcl.controls.TControl.SetParent">TControl.SetParent</link>
</seealso>
</element>
<element name="TCustomFrame.SetParent.AParent">
<short>New value for the Parent property.</short>
</element>
<element name="TCustomFrame.SetParentBackground">
<short>Sets the value for the ParentBackground property.</short>
<descr>
<p>
Ensures that Color is changed to the value in the Parent control when the property is set to True. Color is set to clDefault when the property is set to False. Calls UpdateOpaque to ensure that the csOpaque style flag is applied to the ControlStyle property as needed.
</p>
</descr>
<seealso>
<link id="TCustomFrame.ParentBackground"/>
</seealso>
</element>
<element name="TCustomFrame.SetParentBackground.AParentBackground">
<short>New value for the ParentBackground property.</short>
</element>
<element name="TCustomFrame.CMParentColorChanged">
<short>Handles the CM_PARENTCOLORCHANGED message for the control.</short>
<descr>
<p>
CMParentColorChanged is an overridden method in TCustomFrame. It calls the inherited method on entry to update the values in Color and ParentColor. If the control has finished loading using the LCL component streaming mechanism, the UpdateOpaque method is called to update flag values in the ControlStyle property. ControlStyle is not updated if csLoading is included in the ComponentState property.
</p>
</descr>
<seealso>
<link id="TCustomFrame.UpdateOpaque"/>
<link id="#lcl.controls.TControl.CMParentColorChanged">TControl.CMParentColorChanged</link>
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
<link id="#rtl.classes.TComponent.ComponentState"/>
</seealso>
</element>
<element name="TCustomFrame.CMParentColorChanged.Message">
<short>Control message handled in the method.</short>
</element>
<element name="TCustomFrame.DefineProperties">
<short>
Defines non-published properties that are included in LCL component streaming.
</short>
<descr>
<p>
<var>DefineProperties</var> is an overridden method used to include non-published properties in the values read and written during LCL component streaming. In TCustomFrame, design-time information for the Top and Left coordinates for the frame are included (when available) in the specified TFiler instance.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.DefineProperties">TControl.DefineProperties</link>
</seealso>
</element>
<element name="TCustomFrame.DefineProperties.Filer">
<short>TFiler instance where property definitions are added.</short>
</element>
<element name="TCustomFrame.CalculatePreferredSize">
<short>Gets the preferred height and width for the control used during auto-sizing.</short>
<descr>
<p>
<var>CalculatePreferredSize</var> is an overridden method in <var>TCustomFrame</var>. It ensures that the inherited method is <b>not</b> called when the frame is an un-parented component and visible on the form designer. This allows the dimensions to be freely resized on the design surface. Values in the PreferredWidth, PreferredHeight, and WithThemeSpace arguments are not modified at design-time.
</p>
<p>
If the frame has an Owner (parent form) at run-time, the inherited method is called to get the values used in the LCL auto-sizing algorithms.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.CalculatePreferredSize">TWinControl.CalculatePreferredSize</link>
</seealso>
</element>
<element name="TCustomFrame.CalculatePreferredSize.PreferredWidth">
<short>Preferred width for the control.</short>
</element>
<element name="TCustomFrame.CalculatePreferredSize.PreferredHeight">
<short>Preferred height for the control.</short>
</element>
<element name="TCustomFrame.CalculatePreferredSize.WithThemeSpace">
<short>True if additional space is reserved in the width or height for theme details.</short>
</element>
<element name="TCustomFrame.UpdateOpaque">
<short>Updates control style flags to reflect the transparency for the frame.</short>
<descr>
<p>
<var>UpdateOpaque</var> is a method used to update <var>ControlStyle</var> flags to reflect the transparency for the frame. When <var>ParentBackground</var> is <b>True</b>, the value <var>csOpaque</var> is excluded from the <var>ControlStyle</var> property to allow the frame to be drawn with transparency. When set to <b>False</b>, csOpaque is included in ControlStyle.
</p>
<p>
UpdateOpaque is called when the value for the ParentBackground has been changed, and when the <var>CM_PARENTCOLORCHANGED</var> control message is handled for the frame.
</p>
</descr>
<seealso>
<link id="TCustomFrame.ParentBackground"/>
<link id="#lcl.controls.TControl.ControlStyle">TControl.ControlStyle</link>
</seealso>
</element>
<element name="TCustomFrame.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overridden constructor for the class instance. Create calls the inherited method using AOwner as the owner for the class instance. Create sets the ControlStyle property to the following enumeration values:
</p>
<ul>
<li>csAcceptsControls</li>
<li>csCaptureMouse</li>
<li>csClickEvents</li>
<li>csSetCaption</li>
<li>csDoubleClicks</li>
<li>csParentBackground</li>
</ul>
<p>
Create uses the default size for its class type to set the initial bounds for the control.
</p>
</descr>
<errors>
Raises an EResNotFound exception at run-time if the ClassType for the class instance
is not derived from TFrame.
</errors>
<seealso>
<link id="#rtl.classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<element name="TCustomFrame.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomFrame.GetControlClassDefaultSize">
<short>Gets the default dimensions for a new instance of the class.</short>
<descr>
<p>
GetControlClassDefaultSize is an overridden method in TCustomFrame, and does not call the inherited method. The return value is a TSize instance with the width and height for the new class instance in its X and Y members. The default dimensions in TCustomFrame are 320 pixels wide (X member) by 240 pixels tall (Y member).
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.GetControlClassDefaultSize"/>
</seealso>
</element>
<element name="TCustomFrame.GetControlClassDefaultSize.Result">
<short>TSize type with the width and height for the new class instance.</short>
</element>
<element name="TCustomFrame.ParentBackground">
<short>Indicates if the control uses the background from the parent.</short>
<descr>
<p>
The write access specifier is overridden in <var>TCustomFrame</var>. It calls the inherited method on entry.
</p>
<p>
If the new property value is <b>True</b> and ParentColor is <b>True</b>, the color assigned to the <var>Parent</var> control is stored in the <var>Color</var> property. Otherwise, Color is set to the value <var>clDefault</var>. The <var>UpdateOpaque</var> method is called to adjust the control style flags for the control.
</p>
<p>
The default value for the property is <b>True</b>.
</p>
</descr>
<seealso>
<link id="TCustomFrame.UpdateOpaque"/>
<link id="#lcl.controls.TWinControl.ParentBackground">TWinControl.ParentBackground</link>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
</seealso>
</element>
<element name="TCustomFrameClass">
<short>Class type used to create new instances of TCustomFrame.</short>
<descr/>
<seealso>
<link id="TCustomFrame"/>
</seealso>
</element>
<element name="TFrame">
<short>
Frames can be designed like Forms and used like custom controls, without much coding or installation in the IDE.
</short>
<descr>
<p>
<var>TFrame</var> is a <var>TCustomFrame</var> descendant which implements a named container for related components. Groups of controls can be place on a frame, and re-used in your applications.
</p>
<p>
A Frame has behavior very similar to a Form. Their unique ability is that they can be embedded into forms or other frames in the designer. Like forms, they are stored in two separate files: the code is stored in a .pas unit file, and the design is stored in a .lfm file.
</p>
<p>
Frames can be created and designed in the Lazarus IDE by creating a new Frame module, and using the unit in your application. An existing frame can be added using the TFrame component on the Standard tab in the Lazarus IDE; you will be prompted for the TFrame class to use for the component.
</p>
<p>
Frames can also be created entirely in code at run-time. They do not have to be installed in the Lazarus IDE. One drawback is that complex inheritance hierarchies for <var>TFrame</var> classes can be problematic; they do not propagate changes to all derived frames in the entire inheritance tree.
</p>
<p>
TFrame contains a new property which indicates the LCL (Lazarus Component Library) version number used in the container. An overridden constructor is also introduced to initialize the value in the LCLVersion property. TFrame sets the visibility for properties defines in ancestor classes.
</p>
</descr>
<seealso/>
</element>
<element name="TFrame.FLCLVersion" link="#lcl.forms.TFrame.LCLVersion"/>
<element name="TFrame.LCLVersionIsStored" link="#lcl.forms.TFrame.LCLVersion"/>
<element name="TFrame.LCLVersionIsStored.Result"/>
<element name="TFrame.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. It sets the value for the LCLVersion property to the lcl_version constant defined in the <file>lclversion.pas</file> unit. Create calls the inherited constructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TFrame.LCLVersion"/>
<link id="TCustomFrame.Create"/>
<link id="#lcl.lclversion.lcl_version"/>
</seealso>
</element>
<element name="TFrame.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TFrame.Align" link="#lcl.controls.TControl.Align"/>
<element name="TFrame.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TFrame.AutoScroll" link="#lcl.forms.TScrollingWinControl.AutoScroll"/>
<element name="TFrame.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TFrame.BiDiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TFrame.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TFrame.ChildSizing" link="#lcl.controls.TWinControl.ChildSizing"/>
<element name="TFrame.ClientHeight" link="#lcl.controls.TControl.ClientHeight"/>
<element name="TFrame.ClientWidth" link="#lcl.controls.TControl.ClientWidth"/>
<element name="TFrame.Color" link="#lcl.controls.TControl.Color"/>
<element name="TFrame.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TFrame.DesignTimePPI" link="#lcl.forms.TCustomDesignControl.DesignTimePPI"/>
<element name="TFrame.DockSite" link="#lcl.controls.TWinControl.DockSite"/>
<element name="TFrame.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TFrame.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TFrame.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TFrame.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TFrame.Font" link="#lcl.controls.TControl.Font"/>
<element name="TFrame.LCLVersion">
<short>LCL version number for the frame instance.</short>
<descr>
<p>
The value in <var>LCLVersion</var> is assigned in the Create constructor using the lcl_version constant defined in the <file>lclversion.pas</file> unit. Its value is stored during LCL component streaming if a value has not been assigned to the Parent for the control.
</p>
</descr>
<seealso>
<link id="TForm.LCLVersion"/>
<link id="TForm.Create"/>
<link id="#lcl.controls.TControl.Parent"/>
<link id="#lcl.lclversion.lcl_version"/>
</seealso>
</element>
<element name="TFrame.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TFrame.OnConstrainedResize" link="#lcl.controls.TControl.OnConstrainedResize"/>
<element name="TFrame.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TFrame.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TFrame.OnDockDrop" link="#lcl.controls.TWinControl.OnDockDrop"/>
<element name="TFrame.OnDockOver" link="#lcl.controls.TWinControl.OnDockOver"/>
<element name="TFrame.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TFrame.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TFrame.OnEndDock" link="#lcl.controls.TControl.OnEndDock"/>
<element name="TFrame.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TFrame.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TFrame.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TFrame.OnGetSiteInfo" link="#lcl.controls.TWinControl.OnGetSiteInfo"/>
<element name="TFrame.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TFrame.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TFrame.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TFrame.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TFrame.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TFrame.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TFrame.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TFrame.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TFrame.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TFrame.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TFrame.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TFrame.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TFrame.OnStartDock" link="#lcl.controls.TControl.OnStartDock"/>
<element name="TFrame.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TFrame.OnUnDock" link="#lcl.controls.TWinControl.OnUnDock"/>
<element name="TFrame.ParentBackground" link="#lcl.forms.TCustomFrame.ParentBackground"/>
<element name="TFrame.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TFrame.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TFrame.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TFrame.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TFrame.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TFrame.Scaled" link="#lcl.forms.TCustomDesignControl.Scaled"/>
<element name="TFrame.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TFrame.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TFrame.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
<element name="TFrame.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TBorderIcon">
<short>
Represents a visual element in a window title bar; depends on window manager support.
</short>
<descr>
<dl>
<dt>biSystemMenu</dt>
<dd>The form has a System menu (Maybe not all windowmanager supports this)</dd>
<dt>biMinimize</dt>
<dd>The form has an minimize button</dd>
<dt>biMaximize</dt>
<dd>The form has a maximize button</dd>
<dt>biHelp</dt>
<dd>When you click this button a Question Cursor appears, and the help routines are
called if you click on an control</dd>
</dl>
</descr>
<seealso/>
</element>
<element name="TBorderIcon.biSystemMenu">
<short>Window has a system menu.</short>
</element>
<element name="TBorderIcon.biMinimize">
<short>Window has an Minimize button.</short>
</element>
<element name="TBorderIcon.biMaximize">
<short>Window has an Maximize button.</short>
</element>
<element name="TBorderIcon.biHelp">
<short>Window has an Help button.</short>
</element>
<element name="TBorderIcons" link="#lcl.forms.TBorderIcon"/>
<element name="TDefaultMonitor">
<short>The preferred monitor for showing a form.</short>
<descr>
<p>
When a form is not assigned to a specific monitor, assume the following display context:
</p>
<dl>
<dt>dmDesktop</dt>
<dd>No attempt to choose specific monitor</dd>
<dt>dmPrimary</dt>
<dd>On the primary monitor</dd>
<dt>dmMainForm</dt>
<dd>On the same monitor as the main form; if there is no main form then use
dmPrimary behavior</dd>
<dt>dmActiveForm</dt>
<dd>On the same monitor as the currently active form; if there is no active form
then use dmMainForm behavior</dd>
</dl>
</descr>
</element>
<element name="TDefaultMonitor.dmDesktop">
<short>Place the form on the full desktop.</short>
</element>
<element name="TDefaultMonitor.dmPrimary">
<short>Place the form on the primary monitor.</short>
</element>
<element name="TDefaultMonitor.dmMainForm">
<short>
Place the form on the same monitor as the main form. If there is no such form then use the primary monitor.
</short>
</element>
<element name="TDefaultMonitor.dmActiveForm">
<short>
Place the form on the same monitor as the currently active form. If there is no such form then use the primary monitor.
</short>
</element>
<element name="TFormStateType">
<short>Form state flags.</short>
<descr>
<p>The form states are:</p>
<dl>
<dt>fsCreating</dt>
<dd>initializing (form streaming)</dd>
<dt>fsVisible</dt>
<dd>form should be shown</dd>
<dt>fsShowing</dt>
<dd>form handling WM_SHOWWINDOW message</dd>
<dt>fsModal</dt>
<dd>form is modal</dd>
<dt>fsCreatedMDIChild</dt>
<dd>not yet implemented</dd>
<dt>fsBorderStyleChanged</dt>
<dd>border style changed before window handle creation</dd>
<dt>fsFormStyleChanged</dt>
<dd>form style is changed before window handle creation</dd>
<dt>fsFirstShow</dt>
<dd>form is shown for the first time</dd>
<dt>fsDisableAutoSize</dt>
<dd>disable auto-size</dd>
</dl>
</descr>
<seealso/>
</element>
<element name="TFormStateType.fsCreating">
<short>initializing (form streaming).</short>
</element>
<element name="TFormStateType.fsVisible">
<short>form should be shown.</short>
</element>
<element name="TFormStateType.fsShowing">
<short>form handling WM_SHOWWINDOW message.</short>
</element>
<element name="TFormStateType.fsModal">
<short>form is modal.</short>
</element>
<element name="TFormStateType.fsCreatedMDIChild">
<short>not yet implemented.</short>
</element>
<element name="TFormStateType.fsBorderStyleChanged">
<short>border style changed before window handle creation.</short>
</element>
<element name="TFormStateType.fsFormStyleChanged">
<short>form style is changed before window handle creation.</short>
</element>
<element name="TFormStateType.fsFirstShow">
<short>form is shown for the first time.</short>
</element>
<element name="TFormStateType.fsDisableAutoSize">
<short>disable auto-size.</short>
</element>
<element name="TFormState" link="#lcl.forms.TFormStateType">
<short>Set type used to store values from the TFormState enumeration.</short>
<descr>
<p>
TFormState is the type used to implement the FormState property in TCustomForm and descendent classes.
</p>
</descr>
<seealso>
<link id="TCustomForm.FormState"/>
</seealso>
</element>
<element name="TModalResult">
<short>Dummy type for the values that can be returned as a modal result.</short>
<descr>
<p>
Even though the type is defined as an integer, only the defined constant values should be used (mrOK, mrCancel, et. al.).
</p>
</descr>
<seealso>
<link id="controls.mrNone"/>
<link id="controls.mrOK"/>
<link id="controls.mrCancel"/>
<link id="controls.mrAbort"/>
<link id="controls.mrRetry"/>
<link id="controls.mrIgnore"/>
<link id="controls.mrYes"/>
<link id="controls.mrNo"/>
<link id="controls.mrAll"/>
</seealso>
</element>
<element name="PModalResult" link="#lcl.forms.TModalResult"/>
<element name="TFormHandlerType">
<short>TForm Notification handler types.</short>
<descr/>
<seealso/>
</element>
<element name="TFormHandlerType.fhtFirstShow">
<short>Notified on first form Show.</short>
</element>
<element name="TFormHandlerType.fhtClose">
<short>Notified on form Close.</short>
</element>
<element name="TFormHandlerType.fhtCreate">
<short>Notified after form Create.</short>
</element>
<element name="TShowInTaskbar">
<short>How a form is represented in the TaskBar.</short>
<descr/>
<seealso/>
</element>
<element name="TShowInTaskbar.stDefault">
<short>
Uses the default rules from the platform for showing the form in the TaskBar.
</short>
</element>
<element name="TShowInTaskbar.stAlways">
<short>Always show the form in the TaskBar.</short>
</element>
<element name="TShowInTaskbar.stNever">
<short>Never show the form in the TaskBar.</short>
</element>
<element name="TPopupMode">
<short>Defines the handling performed for a parent window in forms and dialogs.</short>
<descr>
<p>
<var>TPopupMode</var> is an enumerated type with values that specify how the parent is determined for a form or dialog. <var>TPopupMode</var> is the type used for the <var>PopupMode</var> property in <var>TCustomForm</var>.
</p>
</descr>
<seealso>
<link id="TCustomForm.PopupMode"/>
<link id="TCustomForm.PopupParent"/>
<link id="TCustomForm.GetRealPopupParent"/>
</seealso>
</element>
<element name="TPopupMode.pmNone">
<short>
modal: align to active form or main form; non-modal: no window parent.
</short>
<descr>
<p>
For modal windows, the handle has to be recreated in ShowModal. If this is not wanted, please use explicitly pmAuto before calling ShowModal.
</p>
</descr>
</element>
<element name="TPopupMode.pmAuto">
<short>
modal and non-modal: align to active form or main form.
</short>
</element>
<element name="TPopupMode.pmExplicit">
<short>
modal and non-modal: align to PopupParent or main form.
</short>
</element>
<element name="TCloseEvent">
<short>Type used for an OnClose event handler in a form.</short>
<descr>
<p>Closing a form can have several meanings:</p>
<dl>
<dt>caNone</dt>
<dd>Do nothing (don't close).</dd>
<dt>caHide</dt>
<dd>Hide the form (default for modal forms).</dd>
<dt>caFree</dt>
<dd>Destroy the form.</dd>
<dt>caMinimize</dt>
<dd>Minimize the form (MDI child default).</dd>
</dl>
<p>The handler can set CloseAction to the desired value for the action.</p>
</descr>
<seealso/>
</element>
<element name="TCloseEvent.Sender">
<short>The form that received an Close request.</short>
</element>
<element name="TCloseEvent.CloseAction">
<short>Set this to caNone, to prevent the form from closing.</short>
</element>
<element name="TCloseQueryEvent">
<short>Specifies an OnCloseQuery handler event handler.</short>
<descr>
<p>
<var>TCloseQueryEvent</var> is an object procedure type which specifies the event handler signalled to determine if a form can be closed.
</p>
<p>
TCloseQueryEvent is the type used to implement the <var>OnCloseQuery</var> property in <var>TCustomForm</var>. An application must implement an object procedure using the signature for the event handler to allow responding to the notification.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnCloseQuery"/>
</seealso>
</element>
<element name="TCloseQueryEvent.Sender">
<short>The form that received an Close request.</short>
</element>
<element name="TCloseQueryEvent.CanClose">
<short>Set to False to deny closing.</short>
</element>
<element name="TDropFilesEvent">
<short>Type used for an OnDropFiles event handler.</short>
<descr>
<p>
<var>TDropFilesEvent</var> is an object procedure which specifies an event handler triggered when files are dropped on a drag and drop-enabled control.
</p>
<p>
<var>TDropFilesEvent</var> is the type used to implement the <var>OnDropFiles</var> property in <var>TCustomForm</var> and <var>TApplication</var>. Applications must implement a procedure using the signature for the event handler, and assign it to the property.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnDropFiles"/>
<link id="TApplication.OnDropFiles"/>
<link id="TApplicationProperties.OnDropFiles"/>
</seealso>
</element>
<element name="TDropFilesEvent.Sender">
<short>The control that received the dropped files.</short>
</element>
<element name="TDropFilesEvent.FileNames">
<short>The list of the dropped files.</short>
</element>
<element name="THelpEvent">
<short>Type used for an OnHelp event handler.</short>
<descr>
<p>
<var>THelpEvent</var> is an object function which specifies an event handler signalled when Help is requested in an application or form. <var>THelpEvent</var> is the type used to implement the <var>OnHelp</var> event handler in <var>TCustomForm</var> and <var>TApplication</var>. Applications must implement a function using the signature for the event handler, and assign it to the property.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnHelp"/>
<link id="TApplication.OnHelp"/>
<link id="TApplicationProperties.OnHelp"/>
</seealso>
</element>
<element name="THelpEvent.Result">
<short>
Indicates if the help request is satisfied by the event handler; False causes the default help handler for the application to be used.
</short>
</element>
<element name="THelpEvent.Command">
<short>Help command type requested; either HELP_CONTEXT or HELP_COMMAND.</short>
</element>
<element name="THelpEvent.Data">
<short>Context data for the help request.</short>
</element>
<element name="THelpEvent.CallHelp">
<short>False suppresses help display.</short>
</element>
<element name="TShortCutEvent">
<short>Type used for an OnShortcut event handler.</short>
<descr>
<p>
A shortcut handler is invoked when a key is pressed, before any other processing. It can interpret the key as an shortcut and act accordingly. In this case, <var>Handled</var> should be set to <b>True</b> to prevent further processing of the key.
</p>
</descr>
<seealso/>
</element>
<element name="TShortCutEvent.Msg">
<short>The key event message.</short>
</element>
<element name="TShortCutEvent.Handled">
<short>Set Handled to True to prevent further processing of the key.</short>
</element>
<element name="TModalDialogFinished">
<short>
Specifies an event handler signalled when a modal message dialog is completed.
</short>
<descr>
<p>
<var>TModalDialogFinished</var> is an object procedure which specifies an event handler signalled when a modal message dialog is completed. The <var>AResult</var> argument contains the modal result constant returned from the message dialog.
</p>
<p>
<var>TModalDialogFinished</var> is the type used to implement the <var>TCustomForm.OnShowModalFinished</var> and <var>TApplication.OnMessageDialogFinished</var> properties.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnShowModalFinished"/>
<link id="TApplication.OnMessageDialogFinished"/>
<link id="TModalResult"/>
</seealso>
</element>
<element name="TModalDialogFinished.Sender">
<short>TObject instance for the event notification.</short>
</element>
<element name="TModalDialogFinished.AResult">
<short>Modal result value from the dialog.</short>
</element>
<element name="TCustomForm">
<short>The base type for <var>TForm</var> classes.</short>
<descr>
<p>
<var>TCustomForm</var> is a <var>TCustomDesignControl</var> descendant that implements the base type for <var>TForm</var> classes.
</p>
<p>
Forms represent a window or a dialog used as the user interface for a GUI application. It is a container where visual components (such as buttons, labels, edit fields, images, etc.) can be placed. It is also a designer surface which provides design-time support for configuration and layout of the content placed on the form.
</p>
<p>
<var>TCustomForm</var> acts an abstraction layer which masks implementation-specific routines required for the various widgetsets supported in the Lazarus Component Library (<b>LCL</b>). Methods and properties are provided which interact with the underlying Operating System or platform, and provide a common API for form-related operations.
</p>
</descr>
<seealso>
<link id="TForm"/>
<link id="TCustomDesignControl"/>
</seealso>
</element>
<element name="TCustomForm.FActive" link="#lcl.forms.TCustomForm.Active"/>
<element name="TCustomForm.FActiveControl" link="#lcl.forms.TCustomForm.ActiveControl"/>
<element name="TCustomForm.FActiveDefaultControl" link="#lcl.forms.TCustomForm.ActiveDefaultControl"/>
<element name="TCustomForm.FAllowDropFiles" link="#lcl.forms.TCustomForm.AllowDropFiles"/>
<element name="TCustomForm.FAlphaBlend" link="#lcl.forms.TCustomForm.AlphaBlend"/>
<element name="TCustomForm.FAlphaBlendValue" link="#lcl.forms.TCustomForm.AlphaBlendValue"/>
<element name="TCustomForm.FBorderIcons" link="#lcl.forms.TCustomForm.BorderIcons"/>
<element name="TCustomForm.FDefaultControl" link="#lcl.forms.TCustomForm.DefaultControl"/>
<element name="TCustomForm.FCancelControl" link="#lcl.forms.TCustomForm.CancelControl"/>
<element name="TCustomForm.FDefaultMonitor" link="#lcl.forms.TCustomForm.DefaultMonitor"/>
<element name="TCustomForm.FDesigner" link="#lcl.forms.TCustomForm.Designer"/>
<element name="TCustomForm.FFormStyle" link="#lcl.forms.TCustomForm.FormStyle"/>
<element name="TCustomForm.FFormUpdateCount" link="#lcl.forms.TCustomForm.FormIsUpdating"/>
<element name="TCustomForm.FFormHandlers">
<short>Lists of installed Form notification handlers.</short>
</element>
<element name="TCustomForm.FHelpFile" link="#lcl.forms.TCustomForm.HelpFile"/>
<element name="TCustomForm.FIcon" link="#lcl.forms.TCustomForm.Icon"/>
<element name="TCustomForm.FOnShowModalFinished" link="#lcl.forms.TCustomForm.OnShowModalFinished"/>
<element name="TCustomForm.FPopupMode" link="#lcl.forms.TCustomForm.PopupMode"/>
<element name="TCustomForm.FPopupParent" link="#lcl.forms.TCustomForm.PopupParent"/>
<element name="TCustomForm.FSmallIconHandle" link="#lcl.forms.TCustomForm.SmallIconHandle"/>
<element name="TCustomForm.FBigIconHandle" link="#lcl.forms.TCustomForm.BigIconHandle"/>
<element name="TCustomForm.FKeyPreview" link="#lcl.forms.TCustomForm.KeyPreview"/>
<element name="TCustomForm.FMenu" link="#lcl.forms.TCustomForm.Menu"/>
<element name="TCustomForm.FModalResult" link="#lcl.forms.TCustomForm.ModalResult"/>
<element name="TCustomForm.FLastFocusedControl" link="#lcl.forms.TCustomForm.SetLastFocusedControl">
<short>Used to track Focus changes (Enter/Exit events).</short>
</element>
<element name="TCustomForm.FOldBorderStyle" link="#lcl.forms.TCustomForm.DoDock"/>
<element name="TCustomForm.FOnActivate" link="#lcl.forms.TCustomForm.OnActivate"/>
<element name="TCustomForm.FOnClose" link="#lcl.forms.TCustomForm.OnClose"/>
<element name="TCustomForm.FOnCloseQuery" link="#lcl.forms.TCustomForm.OnCloseQuery"/>
<element name="TCustomForm.FOnCreate" link="#lcl.forms.TCustomForm.OnCreate"/>
<element name="TCustomForm.FOnDeactivate" link="#lcl.forms.TCustomForm.OnDeactivate"/>
<element name="TCustomForm.FOnDestroy" link="#lcl.forms.TCustomForm.OnDestroy"/>
<element name="TCustomForm.FOnDropFiles" link="#lcl.forms.TCustomForm.OnDropFiles"/>
<element name="TCustomForm.FOnHelp" link="#lcl.forms.TCustomForm.OnHelp"/>
<element name="TCustomForm.FOnHide" link="#lcl.forms.TCustomForm.OnHide"/>
<element name="TCustomForm.FOnShortcut" link="#lcl.forms.TCustomForm.OnShortcut"/>
<element name="TCustomForm.FOnShow" link="#lcl.forms.TCustomForm.OnShow"/>
<element name="TCustomForm.FOnWindowStateChange" link="#lcl.forms.TCustomForm.OnWindowStateChange"/>
<element name="TCustomForm.FPosition" link="#lcl.forms.TCustomForm.Position"/>
<element name="TCustomForm.FRestoredLeft" link="#lcl.forms.TCustomForm.RestoredLeft"/>
<element name="TCustomForm.FRestoredTop" link="#lcl.forms.TCustomForm.RestoredTop"/>
<element name="TCustomForm.FRestoredWidth" link="#lcl.forms.TCustomForm.RestoredWidth"/>
<element name="TCustomForm.FRestoredHeight" link="#lcl.forms.TCustomForm.RestoredHeight"/>
<element name="TCustomForm.FShowInTaskbar" link="#lcl.forms.TCustomForm.ShowInTaskBar"/>
<element name="TCustomForm.FWindowState" link="#lcl.forms.TCustomForm.WindowState"/>
<element name="TCustomForm.FDelayedEventCtr"/>
<element name="TCustomForm.FDelayedOnChangeBounds"/>
<element name="TCustomForm.FDelayedOnResize"/>
<element name="TCustomForm.FIsFirstOnShow"/>
<element name="TCustomForm.FIsFirstOnActivate"/>
<element name="TCustomForm.GetClientHandle" link="#lcl.forms.TCustomForm.ClientHandle"/>
<element name="TCustomForm.GetClientHandle.Result">
<short/>
</element>
<element name="TCustomForm.GetEffectiveShowInTaskBar">
<short>
Tries to resolve <var>stDefault</var> in <var>ShowInTaskBar</var> using <var>Application</var> settings.
</short>
<descr>
<p>
Calls ShowInTaskBar to get the visibility of an icon for the form.
</p>
<p>
When the return value is stDefault (or when called at design-time), the TaskBarBehavior property in Application is taken into consideration to get the actual return value. If the application displays a single button for the executable and its forms, the return value is set to stNever. If multiple buttons can be displayed in the task bar, the value stAlways is used. If the Application uses the value tbDefault, the value stDefault is retained in the return value.
</p>
</descr>
<seealso>
<link id="TCustomForm.ShowInTaskBar"/>
<link id="TApplication.TaskBarBehavior"/>
<link id="TShowInTaskbar"/>
<link id="Application"/>
</seealso>
</element>
<element name="TCustomForm.GetEffectiveShowInTaskBar.Result">
<short>Effect visibility for the form icon in the task bar.</short>
</element>
<element name="TCustomForm.GetMonitor">
<short>Gets the value for the Monitor property.</short>
<seealso>
<link id="TCustomForm.Monitor"/>
</seealso>
</element>
<element name="TCustomForm.GetMonitor.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomForm.IsAutoScrollStored" link="#lcl.forms.TCustomForm.AutoScroll"/>
<element name="TCustomForm.IsAutoScrollStored.Result">
<short/>
</element>
<element name="TCustomForm.IsForm">
<short>Indicates whether Form properties should be stored in the stream.</short>
<descr>
<p>
<var>IsForm</var> is used as the storage specifier for selected properties in the class instance. Always returns <b>True</b> in <var>TCustomForm</var>.
</p>
</descr>
<seealso>
<link id="TCustomForm.Caption"/>
<link id="TCustomForm.OnClose"/>
<link id="TCustomForm.OnCloseQuery"/>
<link id="TCustomForm.OnResize"/>
<link id="TCustomForm.IsIconStored"/>
<link id="TCustomForm.IsAutoScrollStored"/>
</seealso>
</element>
<element name="TCustomForm.IsForm.Result">
<short>
True when the value for the various properties should be included in the LCL streaming mechanism.
</short>
</element>
<element name="TCustomForm.IsIconStored" link="#lcl.forms.TCustomForm.Icon"/>
<element name="TCustomForm.IsIconStored.Result">
<short/>
</element>
<element name="TCustomForm.CloseModal">
<short>Closes a modal form.</short>
<descr>
<p>
<var>CloseModal</var> is a procedure which attempts to close a form that has been displayed by calling the <var>ShowModal</var> method.
</p>
<p>
CloseModal calls <var>CloseQuery</var> to determine the action performed in the method. When CloseQuery returns <b>True</b>, the close action is set to <var>caHide</var> and the <var>OnClose</var> event handler is signalled when assigned. Form handlers are notified of the close action.
</p>
<p>
When CloseQuery is <b>False</b>, the close action is used to determine how the request is handled. If the CloseAction is <var>caNone</var>, the value in <var>ModalResult</var> is set to <b>0</b> (<b>zero</b>). If the CloseAction is <var>caFree</var>, the <var>Release</var> method is called to allow the <var>Application</var> to free the form component.
</p>
<p>
If an exception occurs in the method, the value in <var>ModalResult</var> is set to <b>0</b> (<b>zero</b>) and the <var>Application.HandleException</var> method is called.
</p>
<remark>
<var>CloseModal</var> does not forward the action to the widgetset class; that is performed in the <var>ShowModal</var> method to ensure it is executed in the widgetset class.
</remark>
</descr>
<seealso>
<link id="TCustomForm.CloseQuery"/>
<link id="TCustomForm.OnClose"/>
<link id="TCustomForm.ModalResult"/>
<link id="TCustomForm.Release"/>
<link id="TCustomForm.AddHandlerClose"/>
<link id="TApplication.HandleException"/>
<link id="TCloseAction"/>
</seealso>
</element>
<element name="TCustomForm.FreeIconHandles">
<short>Destroys the form icons.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.IconChanged">
<short>Loads the new form icons, and notifies the widgetset and all forms.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.IconChanged.Sender">
<short/>
</element>
<element name="TCustomForm.DelayedEvent">
<short>
Performs actions needed for delayed window move, resize, show, and activate messages.
</short>
<descr>
<p>
<var>DelayedEvent</var> is a mechanism used to reduce the number of move, resize, show, and activate messages that occur for forms and their child controls.
</p>
<p>
<var>DelayedEvent</var> discards duplicate calls to the method; only the most recent message is processed. It is used in conjunction with the <var>QueueAsyncCall</var> method in <var>TApplication</var>. DelayedEvent decrements an internal counter used to track the number of pending delayed event messages. When the counter reaches zero (0), the message is applied.
</p>
<p>
When <var>WindowState</var> is changed to <var>wsNormal</var>, the window origin or size is restored. For delayed <var>OnChangeBounds</var> and <var>OnChangeBounds</var> messages, the <var>DoOnShow</var> and/or <var>Activate</var> methods are called when the form is <var>Active</var>. If the form has not already been displayed and activated, the DoOnResize or the DoOnChangeBounds method is called for the corresponding delayed message.
</p>
</descr>
<seealso>
<link id="TApplication.QueueAsyncCall"/>
<link id="TCustomForm.WindowState"/>
<link id="TCustomForm.WMSize"/>
<link id="TCustomForm.Activate"/>
<link id="TCustomForm.DoShow"/>
<link id="TScrollingWinControl.DoOnResize"/>
<link id="TControl.DoOnChangeBounds"/>
</seealso>
</element>
<element name="TCustomForm.DelayedEvent.Data">
<short>
An integer pointer to the data for the event; not used in the current implementation.
</short>
</element>
<element name="TCustomForm.SetActive" link="#lcl.forms.TCustomForm.Active"/>
<element name="TCustomForm.SetActive.AValue">
<short/>
</element>
<element name="TCustomForm.SetActiveControl" link="#lcl.forms.TCustomForm.ActiveControl"/>
<element name="TCustomForm.SetActiveControl.AWinControl">
<short/>
</element>
<element name="TCustomForm.SetActiveDefaultControl" link="#lcl.forms.TCustomForm.ActiveDefaultControl"/>
<element name="TCustomForm.SetActiveDefaultControl.AControl">
<short/>
</element>
<element name="TCustomForm.SetAllowDropFiles" link="#lcl.forms.TCustomForm.AllowDropFiles"/>
<element name="TCustomForm.SetAllowDropFiles.AValue">
<short/>
</element>
<element name="TCustomForm.SetAlphaBlend" link="#lcl.forms.TCustomForm.AlphaBlend"/>
<element name="TCustomForm.SetAlphaBlend.AValue">
<short/>
</element>
<element name="TCustomForm.SetAlphaBlendValue" link="#lcl.forms.TCustomForm.AlphaBlendValue"/>
<element name="TCustomForm.SetAlphaBlendValue.AValue">
<short/>
</element>
<element name="TCustomForm.SetBorderIcons" link="#lcl.forms.TCustomForm.BorderIcons"/>
<element name="TCustomForm.SetBorderIcons.NewIcons">
<short/>
</element>
<element name="TCustomForm.SetFormBorderStyle" link="#lcl.forms.TCustomForm.BorderStyle"/>
<element name="TCustomForm.SetFormBorderStyle.NewStyle">
<short/>
</element>
<element name="TCustomForm.SetCancelControl" link="#lcl.forms.TCustomForm.CancelControl"/>
<element name="TCustomForm.SetCancelControl.NewControl">
<short/>
</element>
<element name="TCustomForm.SetDefaultControl" link="#lcl.forms.TCustomForm.DefaultControl"/>
<element name="TCustomForm.SetDefaultControl.NewControl">
<short/>
</element>
<element name="TCustomForm.SetFormStyle" link="#lcl.forms.TCustomForm.FormStyle"/>
<element name="TCustomForm.SetFormStyle.Value">
<short/>
</element>
<element name="TCustomForm.SetIcon" link="#lcl.forms.TCustomForm.Icon"/>
<element name="TCustomForm.SetIcon.AValue">
<short/>
</element>
<element name="TCustomForm.SetMenu" link="#lcl.forms.TCustomForm.Menu"/>
<element name="TCustomForm.SetMenu.Value">
<short/>
</element>
<element name="TCustomForm.SetModalResult" link="#lcl.forms.TCustomForm.ModalResult"/>
<element name="TCustomForm.SetModalResult.AValue">
<short/>
</element>
<element name="TCustomForm.SetPopupMode" link="#lcl.forms.TCustomForm.PopupMode"/>
<element name="TCustomForm.SetPopupMode.AValue">
<short/>
</element>
<element name="TCustomForm.SetPopupParent" link="#lcl.forms.TCustomForm.PopupParent"/>
<element name="TCustomForm.SetPopupParent.AValue">
<short/>
</element>
<element name="TCustomForm.SetPosition" link="#lcl.forms.TCustomForm.Position"/>
<element name="TCustomForm.SetPosition.Value">
<short/>
</element>
<element name="TCustomForm.SetShowInTaskbar" link="#lcl.forms.TCustomForm.ShowInTaskBar"/>
<element name="TCustomForm.SetShowInTaskbar.Value">
<short/>
</element>
<element name="TCustomForm.SetLastFocusedControl">
<short>Remembers the last focused control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.SetLastFocusedControl.AControl">
<short/>
</element>
<element name="TCustomForm.SetWindowFocus">
<short>Called when the Focus changed.</short>
<descr>
<p>
<var>SetWindowFocus</var> is a procedure used to ensure that the active control in the form instance has the input focus when the forms receives focus. At run-time, the control in <var>ActiveControl</var> (when assigned) is used as the active control. At design-time, the active control is the design surface for the current form instance.
</p>
<p>
No actions are performed in the method when a handle has not been allocated for the active control, or the control cannot be focused.
</p>
<p>
SetWindowFocus calls the <var>SetFocus</var> routine in <file>LCLIntf</file> to change the focus to the handle for the active control, and when successful calls the <var>Perform</var> method in the control to post the <b>CM_UIACTIVATE</b> control message.
</p>
<p>
SetWindowFocus is used in the implementation of the <var>SetFocus</var> and SetActive methods.
</p>
</descr>
<seealso>
<link id="TCustomForm.SetFocus"/>
<link id="TCustomForm.WMActivate"/>
<link id="TCustomForm.ActiveControl"/>
<link id="TCustomForm.Active"/>
</seealso>
</element>
<element name="TCustomForm.SetWindowState">
<short>Sets the value for the WindowState property.</short>
<descr>
<p>
<var>SetWindowState</var> sets the value for the <var>WindowState</var> property. Calls the <var>ShowWindow</var> routine at run-time when <var>Showing</var> is set to <b>True</b>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.SetWindowState.Value">
<short>New value for the property.</short>
</element>
<element name="TCustomForm.AddHandler">
<short>
Adds a form notification handler with the specified type and code.
</short>
<descr>
<p>
<var>AddHandler</var> is a procedure used to add a form notification handler to the list of handlers in the form instance.
</p>
<p>
<var>HandlerType</var> is a <var>TFormHandlerType</var> enumeration value that defines the situation(s) where the form handler can be executed. See <link id="TFormHandlerType">TFormHandlerType</link> for more information about values in the enumeration.
</p>
<p>
<var>Handler</var> is a <var>TMethod</var> record with pointers to the code and optional data executed when the handler is invoked.
</p>
<p>
<var>AsFirst</var> indicates if the handler should be inserted as the initial handler in the method list (when <b>True</b>), or appended to the end of the list (when <b>False</b>).
</p>
<p>
AddHandler calls <var>RaiseGDBException</var> to raise an exception when the pointer to the Code in Handler has not been assigned.
</p>
<p>
AddHandler ensures that a <var>TMethodList</var> exists for handlers using the value in HandlerType, and calls the <var>Add</var> method in the <var>TMethodList</var> to store the Handler at the position needed for AsFirst.
</p>
<p>
AddHandler is called from the implementation of more specialized methods like <var>AddHandlerClose</var>, <var>AddHandlerCreate</var>, and <var>AddHandlerFirstShow</var>.
</p>
</descr>
<errors>
<p>
Raises a catchable exception if the Code property has not been assigned for the TMethod instance in Handler. Raised with the message 'TCustomForm.AddHandler'.
</p>
</errors>
<seealso>
<link id="TCustomForm.AddHandlerClose"/>
<link id="TCustomForm.AddHandlerCreate"/>
<link id="TCustomForm.AddHandlerFirstShow"/>
<link id="TFormHandlerType"/>
<link id="#lazutils.lazmethodlist.TMethodList">TMethodList</link>
<link id="#rtl.classes.TMethod">TMethod</link>
</seealso>
</element>
<element name="TCustomForm.AddHandler.HandlerType">
<short>Form handler type added in the method.</short>
</element>
<element name="TCustomForm.AddHandler.Handler">
<short>Code to execute for the form handler.</short>
</element>
<element name="TCustomForm.AddHandler.AsFirst">
<short>
<b>True</b> if the new form handler is stored first in the list of handlers.
</short>
</element>
<element name="TCustomForm.RemoveHandler">
<short>Removes a form notification handler of the specified type.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.RemoveHandler.HandlerType">
<short/>
</element>
<element name="TCustomForm.RemoveHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TCustomForm.FindDefaultForActiveControl">
<short>Returns the first control in the form Tab order.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.FindDefaultForActiveControl.Result">
<short/>
</element>
<element name="TCustomForm.UpdateMenu">
<short>Called when the main menu has been changed.</short>
<descr>
<p>
Ensures that handles for the <var>Menu</var> are valid for the form display style. The Menu is not displayed at run-time for a modal dialog form (<var>BorderStyle</var> is set to <var>bsDialog</var>); in this case, the <var>DestroyHandle</var> method in Menu is called to free the <var>Handle</var> for the Menu. (This is Delphi compatible).
</p>
<p>
The <var>WindowHandle</var> for the Menu is set to the Handle property from the form instance.
</p>
<p>
No actions are performed in the method if the Handle has not been allocated, or when Menu has not been assigned for the form.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.UpdateShowInTaskBar">
<short>
Updates the widgetset class with the effective form visibility in the task bar.
</short>
<descr>
<p>
Uses values in ShowInTaskBar and the TaskBarBehavior setting in Application to determine the effective visibility for the form in the task bar. Calls the SetShowInTaskbar method in the widgetset class to update the effective form visibility.
</p>
<p>
No actions are performed in the method for the following conditions:
</p>
<ul>
<li>
When the form instance is the MainForm for the Application (it is handled by the application).
</li>
<li>
When the handle has not been allocated for the form instance.
</li>
<li>
When the form has a Parent control, or has been configured as a MDI Child form (FormStyle is fsMDIChild).
</li>
<li>
The form has not been made visible (Showing is False).
</li>
</ul>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WMActivate">
<short>Handles the LM_ACTIVATE message which activates or deactivates the form.</short>
<descr>
<p>
Calls SetActive to update the value in the Active property to reflect the value for the Active member in Message.
</p>
<p>
When the form is being de-activated, the Deactivate method in Application is called. Otherwise, the Activate method in Application is called. The UpdateShowInTaskBar method is called ShowInTaskBar to determine the effective visibility for the form in the task bar.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WMActivate.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.WMCloseQuery">
<short>Handles the LM_CLOSEQUERY message used to close the window.</short>
<descr>
<p>
Calls the Close method to process and apply the ModalResult and CloseAction for the form. Sets the Result member in Message to 0 (zero) to indicate that WndProc should ignore the message; it has been handled in this method (and Close).
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WMCloseQuery.message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.WMHelp">
<short>Handles the LM_HELP window message for the form.</short>
<descr>
<p>
No actions are performed in the method at design-time, or when values have not been assigned to the HelpInfo member in Message.
</p>
<p>
When HelpInfo has a HELPINFO_WINDOW context type, FindControl is called to locate and display the help for the control with the item handle in Message. When HELPINFO_MENUITEM is the context type, GetHelpContext in Menu is called to locate the control ID in Message. If not found, the item handle in Message is used. As a default, the value in the Context property is used to display the context help.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WMHelp.Message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomForm.WMShowWindow">
<short>Handles the LM_SHOWWINDOW window message for the form.</short>
<descr>
<p>
No actions are performed in the method when the form has already been made visible (FormState contains the value fsShowing).
</p>
<p>
Updates FormState to include the value fsShowing. Calls DoShowWindow to focus a control on the form (when needed). Removes fsShowing from FormState prior to exiting from the method.
</p>
<p>
Re-implements the method from the ancestor class; does not call the inherited method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WMShowWindow.message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomForm.WMSize">
<short>Handles the LM_SIZE window message for the form.</short>
<descr>
<p>
Re-implements the method from the ancestor class.
</p>
<p>
Ensures that auto-sizing is disabled for a size message for a top-level form (where <var>Parent</var> is not assigned) or from the LCL interface. This is done by including the value <var>fsDisableAutoSize</var> in the <var>FormState</var> property.
</p>
<p>
Calls the inherited method to apply the width, height, and window state values in <var>Message</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WMSize.message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomForm.WMWindowPosChanged">
<short>Handles the LM_WINDOWPOSCHANGED window message for the form.</short>
<descr>
<p>
Re-implements the method from the ancestor class.
</p>
<p>
Ensures that auto-sizing is disabled for a position message to a top-level form (where <var>Parent</var> is not assigned), or from the LCL interface when new height or width values are provided. This is done by including the value <var>fsDisableAutoSize</var> in the <var>FormState</var> property.
</p>
<p>
Calls the inherited method prior to exit to apply the position and bounds for the form.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WMWindowPosChanged.Message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomForm.CMBiDiModeChanged">
<short>Handles the CM_BIDIMODECHANGED control message for the form.</short>
<descr>
<p>
Re-implements the method from the ancestor class. Calls the inherited method on entry using the value in Message to set the BiDi and adjust the size for the control.
</p>
<p>
Ensures that all components owned by the form are notified of the change to the BiDiMode property. This is needed for menus on the form. A TLMessage instance is constructed with the CM_PARENTBIDIMODECHANGED message and displatched to all of the Components on the form not derived from TWinControl. TWinControl handles the notification for its descendants. Alignment is temporarily disabled during the process, and re-enabled prior to exiting from the method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMBiDiModeChanged.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.CMParentBiDiModeChanged">
<short>Handles the CM_PARENTBIDIMODECHANGED control message for the form.</short>
<descr>
<p>
Sets the BidiMode property to the value in Parent when ParentBiDiMode is True and Parent has been assigned. When Parent has not been assigned, the BiDiMode property in Application is copied to the form instance.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMParentBiDiModeChanged.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.CMAppShowBtnGlyphChanged">
<short>Handles the CM_APPSHOWBTNGLYPHCHANGED control message for the form.</short>
<descr>
<p>
Ensures that controls with a Glyph are notified when a change has occurred to a button glyph. Calls NotifyControls to broadcast Message to all Controls on the form.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMAppShowBtnGlyphChanged.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.CMAppShowMenuGlyphChanged">
<short>Handles the CM_APPSHOWMENUGLYPHCHANGED control message for the form.</short>
<descr>
<p>
Ensures that menus and menus items are notified of a change to a Glyph. Dispatches the value in Message to all Components on the form.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMAppShowMenuGlyphChanged.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.CMIconChanged">
<short>Handles the CM_ICONCHANGED control message for the form.</short>
<descr>
<p>
Frees and re-creates handle(s) for icons used on the form, and notifies the widgetset class by calling its SetIcon method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMIconChanged.Message">
<short>Control message for the notification.</short>
</element>
<element name="TCustomForm.CMRelease">
<short>Handles the CM_RELEASE control message for the form.</short>
<descr>
<p>
Calls the Free method to destroy the form instance.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMRelease.Message">
<short>Control message for the notification.</short>
</element>
<element name="TCustomForm.CMActivate">
<short>Handles the CM_ACTIVATE control message for the form.</short>
<descr>
<p>
Ensures that the Menu for the MainForm in the Application is merged into the Menu for the form instance when FormStyle is fsMDIChild. This action is not performed at design-time, or when the MainForm or the Menu for the Application has not been assigned.
</p>
<p>
Calls Activate to signal the OnActivate event handler (when assigned) if needed.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMActivate.Message">
<short>Control message for the notification.</short>
</element>
<element name="TCustomForm.CMDeactivate">
<short>Handles the CM_DEACTIVATE control message for the form.</short>
<descr>
<p>
This message occurs when the form loses focus within the application.
</p>
<p>
Calls the Deactivate method to signal the OnDeactivate event handler (when assigned). Ensures that the Menu merged to the application MainForm during activation is removed from the Menu for the Application. This action is not performed at design-time, or when Menu has not been assigned. It applies to a form using the fsMDIChild form style in an application using the fsMDIForm style in its MainForm.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMDeactivate.Message">
<short>Control message processed in the method.</short>
</element>
<element name="TCustomForm.CMShowingChanged">
<short>Handles the CM_SHOWINGCHANGED control message for the form.</short>
<descr>
<p>
Uses the value in <var>Showing</var> to determine whether the <var>DoShow</var> or the <var>DoHide</var> method is called. When Showing is <b>True</b>, the DoShow method is called to signal the <var>OnShow</var> event handler (when assigned) if needed. When Showing is <b>False</b>, the DoHide method is called to signal the <var>OnHide</var> event handler (when assigned).
</p>
<p>
If either event handler raises an <var>Exception</var>, it is ignored when <var>HandleShowHideException</var> is set to <b>True</b>. It is re-raised when HandleShowHideException is <b>False</b>.
</p>
<p>
Calls the inherited method prior to exit to notify the widgetset class of the window state change, and to update window control flags for the form.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMShowingChanged.Message">
<short>Control message processed in the method.</short>
</element>
<element name="TCustomForm.WMDPIChanged">
<short>Handles the LM_DPICHANGED window message for the form.</short>
<descr>
<p>
Calls AutoAdjustLayout to apply the DPI setting in Message. This action is performed when:
</p>
<ul>
<li>The Parent for the form has not been assigned.</li>
<li>Scaled is enabled for both the Application and the form instance.</li>
<li>
The DPI setting in Message is different than the PixelsPerInch value for the form.
</li>
</ul>
</descr>
<seealso/>
<notes>
<note>
Problem (Windows): if the form is shown the first time on a secondary monitor with a different DPI settings, the WM_DPICHANGED message is sent within UpdateBounds when BoundsLockCount>0 which means the bounds are not scaled. We force to update the bounds. See issue 32162. (A better solution is welcome.)
</note>
</notes>
</element>
<element name="TCustomForm.WMDPIChanged.Msg">
<short>Window message handled in the method.</short>
</element>
<element name="TCustomForm.FActionLists">
<short>Member used to store the action lists associated with the form.</short>
</element>
<element name="TCustomForm.FFormBorderStyle" link="#lcl.forms.TCustomForm.BorderStyle"/>
<element name="TCustomForm.FFormState" link="#lcl.forms.TCustomForm.FormState"/>
<element name="TCustomForm.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomForm.DoShowWindow">
<short>
Chooses the active control when the form becomes visible at run-time.
</short>
<descr>
<p>
Calls a private method to locate the first visible and enabled control in the tab order for the form. Sets the value in ActiveControl to the control instance located in the method.
</p>
<p>
No actions are performed in the method at design-time, when ActiveControl has already been assigned, or when the form instance has a Parent.
</p>
<p>
DoShowWindow is called from the WMShowWindow method where the LM_SHOWWINDOW window message is handled for the form.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.Activate">
<short>Notifies the OnActivate event handler.</short>
<descr>
<p>
<var>Activate</var> is a procedure used to signal the <var>OnActivate</var> event handler (if assigned) when the form is activated. Activate is called when the <b>CM_Activate</b> message is handled for the form.
</p>
<p>
Activate uses an internal member to determine whether the form is being displayed for the first time, or following a change of focus between forms. No actions are performed in the method when the form is being displayed for the first time and the <var>WindowState</var> property contains <var>wsMaximized</var> or <var>wsFullScreen</var>.
</p>
<p>
Use <var>OnShow</var> to respond to the event notification performed when the form is displayed for the first time.
</p>
<p>
Use <var>OnChangeBounds</var> or <var>OnResize</var> to respond to delayed changes to the form bounds (position) or resize events.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnActivate"/>
<link id="TCustomForm.OnShow"/>
<link id="TCustomForm.OnResize"/>
<link id="TCustomForm.WindowState"/>
<link id="#lcl.controls.TControl.OnChangeBounds">TControl.OnChangeBounds</link>
</seealso>
</element>
<element name="TCustomForm.ActiveChanged">
<short>An empty implementation in TCustomForm.</short>
<descr>
Can be implemented in a descendant to perform actions needed when the active form is changed. Just like Delphi VCL.
</descr>
<seealso/>
</element>
<element name="TCustomForm.AdjustClientRect">
<short>Excludes borders from the given rectangle.</short>
<descr>
<p>
<var>AdjustClientRect</var> is an overridden method in <var>TCustomForm</var> which re-implements the method from the ancestor class. It is used to decrease the width and height for the client rectangle specified in <var>Rect</var> by the number of pixels in the <var>BorderWidth</var> property. It is used in the <var>AlignControls</var> method, and when auto-sizing is performed for <var>Controls</var>.
</p>
</descr>
<seealso>
<link id="#LCL.Controls.TWinControl.AdjustClientRect">TWinControl.AdjustClientRect</link>
</seealso>
</element>
<element name="TCustomForm.AdjustClientRect.Rect">
<short>Client rectangle adjusted in the method.</short>
</element>
<element name="TCustomForm.BeginFormUpdate">
<short>
Increments the form update counter, and disables auto-sizing on the initial update lock.
</short>
<descr>
<p>
Used with the <var>EndFormUpdate</var> method to manage auto-sizing during form updates. For the initial call to <var>BeginFormUpdate</var>, <var>DisableAutoSizing</var> is called to suspend auto-sizing.
</p>
<p>
Use <var>EndFormUpdate</var> to decrement the update counter. When the update count reaches <b>0</b>, auto-sizing is re-enabled.
</p>
</descr>
<seealso>
<link id="TCustomForm.EndFormUpdate"/>
<link id="#lcl.controls.TControl.DisableAutoSizing">TControl.DisableAutoSizing</link>
<link id="#lcl.controls.TControl.EnableAutoSizing">TControl.EnableAutoSizing</link>
</seealso>
</element>
<element name="TCustomForm.ColorIsStored">
<short>Implements the storage specifier for the Color property.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
</seealso>
</element>
<element name="TCustomForm.ColorIsStored.Result">
<short>True when Color has value other than clDefault or clBtnFace.</short>
</element>
<element name="TCustomForm.CreateParams">
<short>Initializes parameters used to create the handle for the form instance.</short>
<descr>
<p>
<var>CreateParams</var> is used to initialize parameters needed to create the handle for the form instance.
</p>
<p>
CreateParams is an overridden procedure in <var>TCustomForm</var>, and calls the inherited method on entry. CreateParams ensures that values in the <var>Params</var> argument are valid. This includes setting the realized parent form and window handle for a form which is not the main form in the application. <var>Style</var> flags are also updated to indicate how the form is displayed in the task bar.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.CreateParams">TWinControl.CreateParams</link>
</seealso>
</element>
<element name="TCustomForm.CreateParams.Params">
<short>Values examined and updated in the method.</short>
</element>
<element name="TCustomForm.CreateWnd">
<short>
Creates the handle for the widgetset class and updates it Menu and Icons.
</short>
<descr>
<p>
<var>CreateWnd</var> is an overridden method in <var>TCustomForm</var> used to create (or re-create) the <var>Handle</var> for the widgetset class. It sets the initial values for <var>FormState</var>, and calls the inherited method to handle auto-sizing and scroll bars.
</p>
<p>
CreateWnd ensures that a handle is allocated for the <var>Menu</var> and the Handle for the form is used as its <var>WindowHandle</var>. The <b>CM_ICONCHANGED</b> control message is performed to (re-)create handles for menu glyphs, and to post the changes to the widgetset class.
</p>
</descr>
<seealso>
<link id="#lcl.forms.TScrollingWinControl.CreateWnd">TScrollingWinControl.CreateWnd</link>
<link id="#lcl.controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
</seealso>
</element>
<element name="TCustomForm.Deactivate">
<short>Performs actions when the form loses focus.</short>
<descr>
<p>
Called when the form loses focus in the application. Signals the <var>OnDeactivate</var> event handler (when assigned). Called from the <var>CMDeactivate</var> and <var>WndProc</var> methods.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnDeactivate"/>
<link id="TCustomForm.CMDeactivate"/>
<link id="TCustomForm.WndProc"/>
</seealso>
</element>
<element name="TCustomForm.DoClose">
<short>Notifies handlers of the close action for the form.</short>
<descr>
<p>
<var>DoClose</var> is a method used to notify close handlers for the form instance of the action requested in the <var>CloseAction</var> parameter.
</p>
<p>
It is called from the <var>Close</var> method for a form that is not displayed as a modal dialog; i. e. <var>FormState</var> does not contain <var>fsModal</var>. It occurs after <var>CloseQuery</var> (and <var>OnCloseQuery</var>) have been called to determine if the form can in fact be closed, and the <var>CloseAction</var> has been set for the form style.
</p>
<p>
DoClose signals the <var>OnClose</var> event handler (when assigned) to allow the form instance to modify the CloseAction argument. It iterates over the close handlers in the form instance, and signals each of the <var>TCloseEvent</var> instances in the method list using CloseAction as an argument.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnClose"/>
<link id="TCustomForm.Close"/>
<link id="TCustomForm.CloseQuery"/>
<link id="TCustomForm.OnCloseQuery"/>
<link id="TCustomForm.FormState"/>
<link id="TCustomForm.FormStyle"/>
<link id="TFormHandlerType"/>
<link id="TCloseEvent"/>
</seealso>
</element>
<element name="TCustomForm.DoClose.CloseAction">
<short>Close action to perform for the from instance.</short>
</element>
<element name="TCustomForm.DoCreate">
<short>Notifies the create handlers for the form instance.</short>
<descr>
<p>
<var>DoCreate</var> is a method used to signal the create handlers for the form instance. DoCreate signals the <var>OnCreate</var> event handler (when assigned) to perform any actions needed for the new form instance. DoCreate also signals other create handlers to perform the methods using the current form instance as an argument.
</p>
<p>
If an <var>Exception</var> occurs in one of the event handlers, it is handled in the method when <var>HandleCreateException</var> returns <b>True</b>. When it returns <b>False</b>, the exception is re-raised in the method.
</p>
<p>
DoCreate calls <var>LockRealizeBounds</var> on entry to disable sending bounds changes to the widgetset class. <var>UnlockRealizeBounds</var> is called prior to exit to re-enable sending bounds changes to the widgetset class.
</p>
<p>
DoCreate is a called from the <var>AfterConstruction</var> method after the initial bounds for the form have been set, and before scaling and automatic layout adjustment are performed (if needed) for the new form instance.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnCreate"/>
<link id="TCustomForm.HandleCreateException"/>
<link id="TCustomForm.AfterConstruction"/>
<link id="TFormHandlerType"/>
<link id="#lcl.controls.TWinControl.LockRealizeBounds">TWinControl.LockRealizeBounds</link>
<link id="#lcl.controls.TWinControl.UnlockRealizeBounds">TWinControl.UnlockRealizeBounds</link>
</seealso>
</element>
<element name="TCustomForm.DoDestroy">
<short>Signals the OnDestroy event handler for the form instance.</short>
<descr>
<p>
<var>DoDestroy</var> is a method used to signal the <var>OnDestroy</var> event handlers assigned for the form instance. If an <var>Exception</var> occurs in the event handler, it is handled in the method when <var>HandleDestroyException</var> is set to <b>True</b>. When set to <b>False</b>, the exception is re-raised in the method.
</p>
<p>
DoDestroy is called from the <var>BeforeDestruction</var> method, and allows the application to perform actions needed before the form instance is physically freed. It is called after the form has been removed from the focus list for the <var>Screen</var>, hidden by calling the <var>Hide</var> method, and merged menu items have been removed from the MainForm for the Application.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnDestroy"/>
<link id="TCustomForm.HandleDestroyException"/>
<link id="TCustomForm.BeforeDestruction"/>
<link id="TCustomForm.Hide"/>
<link id="TCustomForm.Menu"/>
<link id="Screen"/>
<link id="TScreen"/>
<link id="Application"/>
<link id="TApplication"/>
</seealso>
</element>
<element name="TCustomForm.DoHide">
<short>Signals the OnHide event handler for the form instance.</short>
<descr>
<p>
Called from the <var>CMShowingChanged</var> method when <var>Showing</var> is set to <b>False</b>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.DoShow">
<short>Signals the OnShow event handler when needed.</short>
<descr>
<p>
No actions are performed in the method when a maximized or full-screen window (<var>WindowState</var> contains <var>wsMaximized</var> or <var>wsFullScreen</var>) is displayed for the first time. It signals the OnShow event handler (when assigned) to perform the event notification.
</p>
<p>
DoShow is called from the <var>DelayedEvent</var> method in response to queued <var>OnResize</var> or <var>OnChangeBounds</var> events, and from the <var>CMShowingChanged</var> method when <var>Showing</var> is set to <b>True</b>.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnShow"/>
<link id="TCustomForm.WindowState"/>
<link id="#lcl.controls.TWinControl.Showing">TWinControl.Showing</link>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
</seealso>
</element>
<element name="TCustomForm.EndFormUpdate">
<short>Unlocks form updates; used with BeginFormUpdate.</short>
<descr>
When the update counter reaches zero, FormEndUpdated is invoked to realize the pending changes.
</descr>
<seealso>
<link id="TCustomForm.BeginFormUpdate"/>
<link id="#lcl.controls.TWinControl.FormEndUpdated">TWinControl.FormEndUpdated</link>
</seealso>
</element>
<element name="TCustomForm.HandleCreateException">
<short>
Indicates if an exception in the OnCreate event handler is handled by the application.
</short>
<descr>
<p>
<var>HandleCreateException</var> is a <var>Boolean</var> function which indicates if an exception raised in the <var>OnCreate</var> event handler is handled in the form instance. The return value is <b>True</b> when the <var>Application.CaptureExceptions</var> property is set to <b>True</b>; the <var>HandleException</var> method in <var>Application</var> is called to notify its exception handlers of the exception. When the return value is False, the exception is re-raised in the caller.
</p>
<p>
HandleCreateException is called from the DoCreate method.
</p>
</descr>
<seealso>
<link id="TApplication.HandleException"/>
<link id="TApplication.CaptureExceptions"/>
</seealso>
</element>
<element name="TCustomForm.HandleCreateException.Result">
<short>True when the exception is handled by the application.</short>
</element>
<element name="TCustomForm.HandleDestroyException">
<short>Placeholder for exception handlers in derived classes.</short>
<descr>By default the Application exception handler is invoked.</descr>
<seealso>
<link id="TApplication.HandleException"/>
<link id="TApplication.CaptureExceptions"/>
</seealso>
</element>
<element name="TCustomForm.HandleDestroyException.Result">
<short>True when the exception was handled.</short>
</element>
<element name="TCustomForm.HandleShowHideException">
<short>Placeholder for exception handlers in derived classes.</short>
<descr>By default the Application exception handler is invoked.</descr>
<seealso>
<link id="TApplication.HandleException"/>
<link id="TApplication.CaptureExceptions"/>
</seealso>
</element>
<element name="TCustomForm.HandleShowHideException.Result">
<short>True when the exception was handled.</short>
</element>
<element name="TCustomForm.InitializeWnd">
<short>Initializes the widget, also for AlphaBlend and AllowDropFiles.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
</seealso>
</element>
<element name="TCustomForm.Loaded">
<short>
Performs actions when the component has been loaded using the LCL streaming mechanism.
</short>
<descr>
<p>
<var>Loaded</var> is an overridden method in <var>TCustomForm</var>.
</p>
<p>
It disables alignment in the form, and adjusts the PixelsPerInch setting for the Font when it differs from the design-time setting. It is performed when <var>Scaled</var> is enabled for the form and the Application. This action is also performed for any child Controls. Calls the inherited Loaded method, and re-enables alignment for the form instance.
</p>
<p>
Ensures that the <var>ActiveControl</var> (when assigned) can receive focus. ActiveControl is set to <b>Nil</b> if the control cannot be focused for the form instance. Sets the <var>Visible</var> property to <var>True</var> when <var>FormState</var> contains the value <var>fsVisible</var>.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.Loaded"/>
<link id="#rtl.classes.TComponent">TComponent</link>
</seealso>
</element>
<element name="TCustomForm.ChildHandlesCreated">
<short>
Called when handles for child control are created in the form instance.
</short>
<descr>
<p>
ChildHandlesCreated is called after all handles for child controls are created. When this is a top-level form (<var>Parent</var> is Nil), the ParentFormHandleInitialized method is also called.
</p>
</descr>
<seealso>
<link id="#LCL.Controls.TWinControl.ChildHandlesCreated">TWinControl.ChildHandlesCreated</link>
</seealso>
</element>
<element name="TCustomForm.Notification">
<short>
Handles the notification when a component is added to or removed from the form.
</short>
<descr>
<p>
<var>Notification</var> is an overridden method in <var>TCustomForm</var> used to handle the notification when the component in <var>AComponent</var> has been added to or removed from the form instance. Operation is the action performed for the component.
</p>
<p>
Notification calls the inherited method on entry, and performs additional actions for the ActionList, Menu, and pop-up parent form used in the control.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Notification">TControl.Notification</link>
</seealso>
</element>
<element name="TCustomForm.Notification.AComponent">
<short>Component for the notification.</short>
</element>
<element name="TCustomForm.Notification.Operation">
<short>Operation performed for the component.</short>
</element>
<element name="TCustomForm.PaintWindow">
<short>
Calls the Paint method using the specified device context in the control Canvas.
</short>
<descr>
<p>
<var>PaintWindow</var> is an overridden method in <var>TCustomForm</var>. It re-implements the method from the ancestor class, and does <b>not</b> call the inherited method.
</p>
<p>
PaintWindow assigns the device context in <var>dc</var> to the <var>Canvas</var> handle. The <var>Paint</var> method is called to signal the <var>OnPaint</var> event handler (when assigned). If a design surface is active for the form instance, its <var>PaintGrid</var> method is called. The Canvas handle is reset to 0 prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TCustomControl.PaintWindow">TCustomControl.PaintWindow</link>
</seealso>
</element>
<element name="TCustomForm.PaintWindow.dc">
<short>Device context (Handle) assigned to the Canvas for the form.</short>
</element>
<element name="TCustomForm.RequestAlign">
<short>
Calls the user Alignment handler (AlignControls). Here: NOP for a top-level form.
</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.RequestAlign">TControl.RequestAlign</link>
</seealso>
</element>
<element name="TCustomForm.Resizing">
<short>
Performs actions needed when the form processes the WMSize message.
</short>
<descr>
<p>
Uses the value in <var>State</var> to determine the action required in the method. The LCL interface is used to determine if the window state is valid for the widgetset. When allowed, the following methods are called for the corresponding <var>TWindowState</var> value:
</p>
<dl>
<dt>wsMinimized</dt>
<dd>Calls the Minimize method in Application, or Restore if the Form is already minimized</dd>
</dl>
<p>
If the value in WindowState has been changed, the method honors the value in the Position property if it was set to maximized at design-time. When the <var>OnWindowStateChange</var> event handler has been assigned for the form, it is signalled for the current class instance.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.Resizing"/>
<link id="TCustomForm.WMSize"/>
<link id="TScrollingWinControl.WMSize"/>
<link id="TCustomForm.OnWindowStateChange"/>
</seealso>
</element>
<element name="TCustomForm.Resizing.State">
<short>Window state applied in the method.</short>
</element>
<element name="TCustomForm.CalculatePreferredSize" link="#lcl.controls.TControl.CalculatePreferredSize">
<short>Here: clip width and height of a top-level form to the monitor WorkArea.</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TCustomForm.CalculatePreferredSize.PreferredWidth">
<short/>
</element>
<element name="TCustomForm.CalculatePreferredSize.PreferredHeight">
<short/>
</element>
<element name="TCustomForm.CalculatePreferredSize.WithThemeSpace">
<short/>
</element>
<element name="TCustomForm.DoOnResize">
<short>Performs a delayed resize action using the DelayedEvent for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.DoOnChangeBounds">
<short>Performs a delayed bounds change using the DelayedEvent for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.SetZOrder">
<short>Moves a top-level form in front or back of all forms.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.SetZOrder.Topmost">
<short>True for BringToFront.</short>
</element>
<element name="TCustomForm.SetParent">
<short>Sets the value for the Parent property.</short>
<descr>
<p>
<var>SetParent</var> is an overridden method in <var>TCustomForm</var> used to set the value for the <var>Parent</var> property.
</p>
<p>
SetParent disables auto-sizing before updating the property value. The <var>Handle</var> for the form is destroyed and re-created when Parent is both assigned and <var>Visible</var>.
</p>
<p>
SetParent ensures that the <var>PixelsPerInch</var> settings for the form instance and its Parent are the same. <var>AutoAdjustLayout</var> is called when the values differ and <var>Scaled</var> has been enabled for both the Parent form and the <var>Application</var>.
</p>
<p>
SetParent re-enables auto-sizing prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
<link id="#lcl.controls.TControl.SetParent">TControl.SetParent</link>
</seealso>
</element>
<element name="TCustomForm.SetParent.NewParent">
<short>New value for the property.</short>
</element>
<element name="TCustomForm.MoveToDefaultPosition">
<short>Moves the form to the location specified in the Position property.</short>
<descr>
<p>
<var>MoveToDefaultPosition</var> is a method used to move the form instance to the location specified in its <var>Position</var> property. Position indicates the size and relative position for the form instance. See <link id="TCustomForm.Position"/> and <link id="TPosition"/> for information about the property values and their meanings.
</p>
<p>
MoveToDefaultPosition gets the display rectangle for the form instance. Its dimensions and coordinates are translated to the Monitor and/or relative layout indicated in <var>Position</var>. <var>SetBounds</var> is called to apply the
translated origin, height and width to the form instance.
</p>
<p>
No actions are performed in the method when either <var>Parent</var> or the <var>ParentWindow</var> handle has been assigned for the form instance. No actions are performed in the method when <var>WindowState</var> contains <var>wsFullScreen</var> or <var>wsMaximized</var>.
</p>
<p>
MoveToDefaultPosition is called from the <var>AllAutoSized</var>, <var>SetRestoredBounds</var>, and <var>UpdateShowing</var> methods. It is also called when a new value is assigned to the Position property.
</p>
</descr>
<seealso>
<link id="TCustomForm.Position"/>
</seealso>
</element>
<element name="TCustomForm.UpdateShowing">
<short>
Configures and position the form when its visibility has been changed.
</short>
<descr>
<p>
<var>UpdateShowing</var> is an overridden method used to configure and position the form instance when the visibility for the form has been changed.
</p>
<p>
When <var>Visible</var> is set to <b>True</b> at run-time, the <var>MoveToDefaultPosition</var> method is called to move the form to the monitor / location in the <var>Position</var> property. This action is not needed (or allowed) at design-time. When <var>FormState</var> indicates it is the first time the form is being displayed, the <var>DoFirstShow</var> method is called to notify event handlers for the form.
</p>
<p>
UpdateShowing calls the inherited method to update the <var>Handle</var> for the form and the visibility for any child <var>Controls</var>.
</p>
<p>
If <var>ActiveControl</var> is not assigned, and there is no <var>Parent</var> form, the <var>FindDefaultForActiveControl</var> method is called to locate the first visible and enabled child control on the form. Its Handle is used to focus the control using the LCL <var>SetFocus</var> routine.
</p>
<p>
Finally, the visibility of the form in the task bar is updated and passed to the widgetset class.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.UpdateShowing">TWinControl.UpdateShowing</link>
</seealso>
</element>
<element name="TCustomForm.SetVisible">
<short>Sets the value for the Visible property.</short>
<descr>
<p>
<var>SetVisible</var> is an overridden method used to set the value for the <var>Visible</var> property. It ensures that <var>FormState</var> is updated to reflect the new value for the property. When set to <b>True</b>, <var>fsVisible</var> is included in the FormState property. Otherwise, fsVisible is excluded from FormState. No actions are performed in the method if FormState already already reflects the new value for the property.
</p>
<p>
SetVisible calls the inherited method to store the new property value, and to perform resizing and control messages as needed. The <var>UpdateVisible</var> method in <var>Application</var> is called to ensure that the application is visible in the task bar when one of its forms is visible.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.SetVisible">TControl.SetVisible</link>
</seealso>
</element>
<element name="TCustomForm.SetVisible.Value">
<short>New value for the property.</short>
</element>
<element name="TCustomForm.AllAutoSized">
<short>If the the form is about to show, calculate its metrics.</short>
<descr>
<p>
<var>AllAutoSized</var> is an overridden method used to apply the position and layout for a visible form that about to be displayed. AllAutoSized implements the virtual method defined in the ancestor class.
</p>
<p>
AllAutoSized is called from the <var>DoAllAutoSize</var> method when <var>AutoSize</var> has been enabled, and occurs after the bounds for the form have been calculated. It calls the <var>MoveToDefaultPosition</var> method to move the form to the monitor and relative location in <var>Position</var>.
</p>
<p>
No actions are performed in the method if the form is already <var>Showing</var> or it is not <var>Visible</var>.
</p>
</descr>
<seealso>
<link id="TCustomForm.Visible"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
<link id="TCustomForm.Position"/>
<link id="#lcl.controls.TWinControl.Showing">TWinControl.Showing</link>
<link id="#lcl.controls.TWinControl.AllAutoSized">TWinControl.AllAutoSized</link>
<link id="#lcl.controls.TWinControl.DoAllAutoSize">TWinControl.DoAllAutoSize</link>
</seealso>
</element>
<element name="TCustomForm.DoFirstShow">
<short>Executes handlers using the FirstShow handler type.</short>
<descr>
<p>
Calls <var>CallNotifyEvents</var> in the internal method list for any methods using the <var>fhtFirstShow</var> handler type. The form instance is passed as an argument to the handler(s).
</p>
<p>
Called from the <var>UpdateShowing</var> method when the form is <var>Visible</var> and its <var>Showing</var> property is changed to <b>True</b>. Occurs after <var>MoveToDefaultPosition</var> has been to called to position the form on its monitor, and after the value <var>fsFirstShow</var> has been included in the <var>FormState</var> property.
</p>
</descr>
<seealso>
<link id="TCustomForm.UpdateShowing"/>
<link id="TCustomForm.Visible"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
<link id="TCustomForm.FormState"/>
<link id="TFormHandlerType"/>
<link id="TFormStateType"/>
<link id="#lcl.controls.TWinControl.Showing">TWinControl.Showing</link>
</seealso>
</element>
<element name="TCustomForm.UpdateWindowState">
<short>UpdateWindowState is an empty implementation in TCustomForm.</short>
<descr>
<p>
Has an empty implementation in the current LCL version.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.VisibleChanging">
<short>Notifies all <var>VisibleChanging</var> handlers.</short>
<descr>
<p>
Calls the inherited method prior to exit. Called prior to setting the new value for the Visible property in a control (or form) in the SetVisible method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.VisibleChanging">TControl.VisibleChanging</link>
</seealso>
</element>
<element name="TCustomForm.VisibleChanged">
<short>Notifies all handlers when the visibility for the form has been changed.</short>
<descr>
<p>
Calls the inherited method on entry.
</p>
<p>
When the <var>Screen</var> singleton has been assigned, its <var>NotifyScreenFormHandler</var> method is called to signal all <var>snFormVisibleChanged</var> handlers in the class instance.
</p>
<p>
Called after a new value has been assigned to the <var>Visible</var> property for the control (or form).
</p>
</descr>
<seealso>
<link id="Screen"/>
<link id="TScreenNotification"/>
</seealso>
</element>
<element name="TCustomForm.WndProc" link="#lcl.controls.TControl.WndProc"/>
<element name="TCustomForm.WndProc.TheMessage">
<short>
Handled messages include: Activate, SetFocus, KillFocus, Exit, Enter, Window Position Changing, and DrawItem.
</short>
<descr>
<p>
<var>WndProc</var> is an overridden method which implements the processing loop for window and control messages received for the form instance. It extends the method from the ancestor class to provide form-specific support for messages including:
</p>
<dl>
<dt>LM_SETFOCUS</dt>
<dd>
Chooses the active control for the form at run-time, and ensures that the control is focused.
</dd>
<dt>CM_EXIT</dt>
<dd>
Deactivates a HostDockSite (when assigned) when the form loses focus.
</dd>
<dt>CM_ENTER</dt>
<dd>
Activates a HostDockSite (when assigned) when the form receives focus.
</dd>
<dt>LM_WINDOWPOSCHANGING</dt>
<dd>
Suppresses move or resize window messages as needed for the Position or BorderStyle properties.
</dd>
<dt>LM_DRAWITEM</dt>
<dd>
Handles owner-drawn Menu items for the item and command in the message.
</dd>
</dl>
<p>
WndProc calls the inherited method to handle control-specific messages not handled in the method.
</p>
</descr>
</element>
<element name="TCustomForm.VisibleIsStored">
<short>Implements the storage specifier for the Visible property.</short>
<descr>
<p>
Returns the value in the Visible property.
</p>
</descr>
<seealso>
<link id="TCustomForm.Visible"/>
</seealso>
</element>
<element name="TCustomForm.VisibleIsStored.Result">
<short>True when the Visible property is set to True.</short>
</element>
<element name="TCustomForm.DoAutoSize" link="#lcl.controls.TControl.DoAutoSize"/>
<element name="TCustomForm.SetAutoSize">
<short>Sets the value for the AutoSize property.</short>
<descr>
<p>
<var>SetAutoSize</var> is an overridden method in <var>TCustomForm</var> used to set the value for the <var>AutoSize</var> property.
</p>
<p>
When set to <b>True</b>, it updates <var>FormState</var> to exclude the value <var>fsDisableAutoSize</var>, and modifies <var>Position</var> to use <var>poDefault</var> when it contains <var>poDefaultPosOnly</var>.
</p>
</descr>
<seealso>
<link id="TScrollingWinControl.SetAutoSize"/>
<link id="TCustomForm.FormState"/>
<link id="TCustomForm.Position"/>
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
</seealso>
</element>
<element name="TCustomForm.SetAutoSize.Value">
<short>New value for the property.</short>
</element>
<element name="TCustomForm.SetAutoScroll">
<short>Sets the value for the AutoScroll property.</short>
<descr>
<p>
<var>SetAutoScroll</var> is an overridden method in <var>TCustomForm</var> used to set the value for the <var>AutoScroll</var> property. It calls the inherited method to apply the new property value, but includes an additional test for the <var>BorderStyle</var> used on the form. AutoScroll <b>cannot</b> be set to <b>True</b> when BorderStyle has a value other than <var>bsSizeable</var> or <var>bsSizeToolWin</var>.
</p>
</descr>
<seealso>
<link id="TCustomForm.AutoScroll"/>
<link id="TCustomForm.BorderStyle"/>
<link id="TScrollingWinControl.SetAutoScroll"/>
</seealso>
</element>
<element name="TCustomForm.SetAutoScroll.Value">
<short>New value for the property.</short>
</element>
<element name="TCustomForm.SetScaled">
<short>Sets the value for the Scaled property.</short>
<descr>
<p>
<var>SetScaled</var> is an overridden method in <var>TCustomForm</var> used to set the value for the <var>Scaled</var> property. It calls the inherited method on entry. At run-time, the <var>AutoScale</var> method is called when the new property value is set to <b>True</b> and differs from the existing property value.
</p>
</descr>
<seealso>
<link id="TCustomForm.AutoScale"/>
<link id="TCustomDesignControl.Scaled"/>
<link id="TCustomDesignControl.SetScaled"/>
<link id="TApplication.Scaled"/>
</seealso>
</element>
<element name="TCustomForm.SetScaled.AScaled">
<short>New value for the property.</short>
</element>
<element name="TCustomForm.DoAddActionList">
<short>Adds the specified list of actions to the ActionList for the form.</short>
<descr>
<p>
Ensures that the <var>TList</var> instance is allocated for the internal member. Calls the <var>IndexOf</var> method in the list to locate the value in the <var>List</var> argument. If it is not found, the <var>Add</var> method for the list is called to append the value.
</p>
<p>
DoAddActionList is called from the <var>Notification</var> method when a <var>TCustomActionList</var> instance is added to the form (during LCL streaming).
</p>
</descr>
<seealso>
<link id="TCustomForm.DoRemoveActionList"/>
</seealso>
</element>
<element name="TCustomForm.DoAddActionList.List">
<short>List with actions added to the form instance.</short>
</element>
<element name="TCustomForm.DoRemoveActionList">
<short>Removes the specified list of actions from the internal list.</short>
<descr>
<p>
Calls the <var>Remove</var> method in the <var>TList</var> member to delete the <var>TCustomActionList</var> specified in <var>List</var>.
</p>
<p>
DoRemoveActionList is called from the <var>Notification</var> method when a <var>TCustomActionList</var> instance is removed from the form.
</p>
</descr>
<seealso>
<link id="TCustomForm.DoAddActionList"/>
<link id="TCustomForm.Notification"/>
<link id="#lcl.actnlist.TCustomActionList">TCustomActionList</link>
</seealso>
</element>
<element name="TCustomForm.DoRemoveActionList.List">
<short>TCustomActionList instance removed in the method.</short>
</element>
<element name="TCustomForm.ProcessResource">
<short>Loads resources needed for the form.</short>
<descr>
Calls <var>InitResourceComponent</var> to load resources for the current form instance.
</descr>
<errors>
Raises an <var>EResNotFound</var> exception if <var>RequireDerivedFormResource</var> is set for the application, and a resource is not found for the form.
</errors>
<seealso/>
</element>
<element name="TCustomForm.BeginAutoDrag">
<short>Re-implements the auto-drag behavior for forms.</short>
<descr>
<p>
<var>BeginAutoDrag</var> is an overridden method in <var>TCustomForm</var> which re-implements the auto-drag and dock behavior for form instances. It allows form dragging only if it is docked (HostDockSite is assigned) to a site where a DockManager is not used (UseDockManager is False). It does <b>not</b> call the inherited method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.HostDockSite">TControl.HostDockSite</link>
<link id="#lcl.controls.TWinControl.UseDockManager">TWinControl.UseDockManager</link>
</seealso>
</element>
<element name="TCustomForm.DoDock">
<short>Docks or undocks the form in the specified dock site.</short>
<descr>
<p>
<var>DoDock</var> is an overridden method used to dock / undock the form instance in the dock site specified in <var>NewDockSite</var>. When NewDockSite is unassigned (contains <b>Nil</b>), the form instance is undocked from the host dock site.
</p>
<p>
<var>ARect</var> contains the bounds for the new dock site after resizing and alignment (when needed).
</p>
<p>
When a form is docked, its <var>BorderStyle</var> is set to <var>bsNone</var>. DoDock ensures that the value in the BorderStyle property is saved or restored for the form when the value in <var>HostDockSite</var> is changed. If NewDockSite has been assigned, the value in BorderStyle is saved to an internal member. If NewDockSite is Nil, the value in BorderStyle is restored from the internal member.
</p>
<remark>
Changes needed for the <var>Align</var> property must be handled in the DockManager.
</remark>
<p>
DoDock calls the inherited method prior to exit.
</p>
<p>
DoDock is called from the Dock method in an ancestor class.
</p>
</descr>
<seealso>
<link id="TCustomForm.BorderStyle"/>
<link id="#lcl.controls.TControl.Dock">TControl.Dock</link>
<link id="#lcl.controls.TControl.DoDock">TControl.DoDock</link>
<link id="#lcl.controls.TControl.HostDockSite">TControl.HostDockSite</link>
</seealso>
</element>
<element name="TCustomForm.DoDock.NewDockSite">
<short>New dock site for the form instance.</short>
</element>
<element name="TCustomForm.DoDock.ARect">
<short>
Rectangle with the bounds for the new dock site after resizing and alignment.
</short>
</element>
<element name="TCustomForm.GetFloating">
<short>Gets the value for the Floating properties.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.Floating">TControl.Floating</link>
<link id="#lcl.controls.TControl.GetFloating">TControl.GetFloating</link>
</seealso>
</element>
<element name="TCustomForm.GetFloating.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomForm.GetDefaultDockCaption">
<short>Default caption displayed when the form is docked.</short>
<descr>
<p>
<var>GetDefaultDockCaption</var> is an overridden <var>String</var> function used to get the default caption displayed when the form is docked. GetDefaultDockCaption returns the value in the <var>Caption</var> property.
</p>
<p>
Called from the <var>GetDockCaption</var> method in an ancestor class. The value is passed as an argument to the <var>OnGetDockCaption</var> event handler.
</p>
</descr>
<seealso>
<link id="TCustomForm.Caption"/>
<link id="#lcl.controls.TWinControl.GetDockCaption">TWinControl.GetDockCaption</link>
<link id="#lcl.controls.TWinControl.OnGetDockCaption">TWinControl.OnGetDockCaption</link>
</seealso>
</element>
<element name="TCustomForm.GetDefaultDockCaption.Result">
<short>Default caption displayed when the form is docked.</short>
</element>
<element name="TCustomForm.CMActionExecute">
<short>Handles the CM_ACTIONEXECUTE control message.</short>
<descr>
<p>
Calls <var>DoExecuteAction</var> to execute the <var>TBasicAction</var> passed as an argument in <var>Message</var>. Sets the <var>Result</var> member in Message to <b>1</b> to indicate that the action was performed in the method.
</p>
<p>
Called when a <var>CM_ACTIONEXECUTE</var> control message dispatched in the <var>WndProc</var> method in <var>TApplication</var> is processed for the form instance.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CMActionExecute.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.CMActionUpdate">
<short>Handles the CM_ACTIONUPDATE control message.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.CMActionUpdate.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.DoExecuteAction">
<short>Asks all applicable components to execute an action.</short>
<descr>
<p>
First, the <var>ActiveControl</var> and the <var>Form</var> itself are asked to execute the action. Then, all child components are tried. The search stops as soon as the action is handled.
</p>
</descr>
</element>
<element name="TCustomForm.DoExecuteAction.Result">
<short>True when the action was handled.</short>
</element>
<element name="TCustomForm.DoExecuteAction.ExeAction">
<short>Action to execute.</short>
</element>
<element name="TCustomForm.DoUpdateAction">
<short>Tries all applicable components to update an action.</short>
<descr/>
<seealso>
<link id="#LCL.Forms.TCustomForm.DoExecuteAction">DoExecuteAction</link>
</seealso>
</element>
<element name="TCustomForm.DoUpdateAction.Result">
<short>True when the action was updated.</short>
</element>
<element name="TCustomForm.DoUpdateAction.TheAction">
<short/>
</element>
<element name="TCustomForm.UpdateActions">
<short>Asks all components on the form to update their actions.</short>
<descr>
<p>
<var>UpdateActions</var> is a procedure used to update actions assigned to components on the form instance. No actions are performed in the method at design-time, or when the <var>Showing</var> property is set to False in the form instance.
</p>
<p>
UpdateActions applies updates for an assigned <var>Menu</var> in the form instance. Items on the Menu update their actions when the menu item is visible. Finally, all controls on the form instance are recursively searched; controls which are action clients update their actions when they are visible.
</p>
<p>
Update actions is called for each of the custom forms when the application enters an idle state, and occurs after processing queued asynchronous calls and the <var>OnIdle</var> event handler in the application.
</p>
</descr>
<seealso>
<link id="TCustomForm.Visible"/>
<link id="TCustomForm.Menu"/>
<link id="TApplication.OnIdle"/>
<link id="TApplication.Idle"/>
<link id="#lcl.controls.TWinControl.Showing">TWinControl.Showing</link>
<link id="#lcl.controls.TControl.InitiateAction">TControl.InitiateAction</link>
</seealso>
</element>
<element name="TCustomForm.ClientHandle">
<short>The Handle of the MDIForm client (container for MDI children).</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TCustomForm.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. Create sets the default values for internal members used in the form instance, and calls the <var>CreateNew</var> method to configure the visible aspects of the form instance. At run-time, it also calls <var>ProcessResource</var> to load the form content from its resource file.
</p>
</descr>
<seealso>
<link id="TCustomForm.CreateNew"/>
<link id="TCustomForm.ProcessResource"/>
<link id="TCustomDesignControl.Create"/>
</seealso>
</element>
<element name="TCustomForm.Create.AOwner">
<short>Owner for the class instance.</short>
</element>
<element name="TCustomForm.CreateNew">
<short>Creates a form instance without a resource (.lfm) file.</short>
<descr>
<p>
<var>CreateNew</var> is an alternate constructor for the class instance. CreateNew is used to create a new <var>TCustomForm</var> instance which is not loaded from a resource file (.lfm). It performs actions to initialize properties for the form instance, including:
</p>
<ul>
<li>Sets the FormState to fsFirstShow and calls BeginFormUpdate.</li>
<li>Sets the default BorderIcons for the form.</li>
<li>Sets the FormStyle, ControlsStyle, and BorderStyle for the form.</li>
<li>Calls the inherited Create constructor.</li>
<li>Sets the default bounds for the form instance.</li>
<li>Sets Visible to False.</li>
<li>Sets WindowState to wsNormal.</li>
<li>Allocates resources for the Icon property but does not assign a bitmap.</li>
<li>Sets the default value for Color.</li>
<li>Calls Screen.AddForm to register the form instance on the current screen.</li>
</ul>
</descr>
<seealso/>
</element>
<element name="TCustomForm.CreateNew.AOwner">
<short>Owner for the new class instance.</short>
</element>
<element name="TCustomForm.CreateNew.Num">
<short>Ignored in the current implementation.</short>
</element>
<element name="TCustomForm.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance.
</p>
<p>
<var>Destroy</var> ensures that unhandled queued asynchronous calls in the <var>Application</var> instance are removed for the form.
</p>
<p>
<var>Destroy</var> disables auto-sizing to prevent resize messages while the form is being freed. Destroy frees resources allocated for the form instance, including its Icon and any allocated icon handles. The form instance is removed from Screen, and its ActionLists are freed. Destroy frees all form handlers added to the class instance.
</p>
<p>
Destroy calls the inherited destructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TCustomForm.Icon"/>
<link id="Application"/>
<link id="Screen"/>
<link id="TApplication"/>
<link id="TScreen"/>
</seealso>
</element>
<element name="TCustomForm.AfterConstruction">
<short>
Performs actions when the form has been created and loaded from its resource file.
</short>
<descr>
<p>
Implements the virtual method defined in the ancestor class.
</p>
<p>
Called after the form instance has been created and loaded from its resource file (when needed).
</p>
<p>
Ensures that the initial bounds for the form are set to the values in the <var>Left</var>, <var>Top</var>, <var>Bottom</var>, and <var>Right</var> properties. Calls <var>DoCreate</var> to signal the <var>OnCreate</var> event handler (when assigned). Ends the form update started in the <var>CreateNew</var> constructor. Ensures that scaling and automatic layout are applied to form instance (if needed) when <var>Scaled</var> is enabled for both the form instance and the <var>Application</var>.
</p>
</descr>
<seealso>
<link id="#rtl.system.TObject.AfterConstruction">TObject.AfterConstruction</link>
</seealso>
</element>
<element name="TCustomForm.BeforeDestruction">
<short>Performs actions before the form instance is physically freed.</short>
<descr>
<p>
Calls the inherited method on entry to signal any <var>OnBeforeDestruction</var> event handlers assigned to the form instance.
</p>
<p>
Removes the form instance from the list of focused forms in the <var>Screen</var> singleton. At run-time, the <var>Hide</var> method is called when the form is not a MDI child form in the application. If the form is a MDI child form, merged menu items are removed from the menu in the <var>MainForm</var> for the <var>Application</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.BeforeDestruction">TControl.BeforeDestruction</link>
</seealso>
</element>
<element name="TCustomForm.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomForm.GetControlClassDefaultSize.Result">
<short/>
</element>
<element name="TCustomForm.BigIconHandle">
<short>Handle for the large icon used on the form.</short>
</element>
<element name="TCustomForm.BigIconHandle.Result">
<short/>
</element>
<element name="TCustomForm.Close">
<short>Closes the form.</short>
<descr>
<p>
Close does not necessarily destroy the form. Modal forms only are hidden. When the MainForm is closed, the application terminates.
</p>
<p>
An <var>OnCloseQuery</var> handler can refuse to allow the form to close.
</p>
</descr>
<seealso>
<link id="TCustomForm.CloseQuery"/>
</seealso>
</element>
<element name="TCustomForm.CloseQuery">
<short>Asks the OnCloseQuery handler whether the form can be closed.</short>
<descr/>
<seealso>
<link id="TCustomForm.OnCloseQuery"/>
</seealso>
</element>
<element name="TCustomForm.CloseQuery.Result">
<short/>
</element>
<element name="TCustomForm.DefocusControl">
<short>Updates ActiveControl if it is to be de-focused.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.DefocusControl.Control">
<short>The control which will lose focus.</short>
</element>
<element name="TCustomForm.DefocusControl.Removing">
<short>True if the control is no longer the ActiveControl.</short>
</element>
<element name="TCustomForm.DestroyWnd" link="#lcl.controls.TWinControl.DestroyWnd"/>
<element name="TCustomForm.EnsureVisible">
<short>
Ensures that the form is fully visible, and optionally brings it in front of all other forms.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.EnsureVisible.AMoveToTop">
<short>Bring the form to front if True.</short>
</element>
<element name="TCustomForm.FocusControl">
<short>
Gives focus to the specified control.
</short>
<descr>
<p>
<var>FocusControl</var> is a procedure used to give focus to the control specified in <var>WinControl</var>. FocusControl ensures that the <var>ActiveControl</var> property is updated when needed, and may raise an exception if WinControl cannot be focused. If the form instance was not already <var>Active</var>, the <var>SetFocus</var> method is called.
</p>
</descr>
<errors>
If the control or one of its parents is not visible or disabled, an exception will be raised (in <var>SetFocus</var>).
</errors>
<seealso/>
</element>
<element name="TCustomForm.FocusControl.WinControl">
<short>The control receiving the focus.</short>
</element>
<element name="TCustomForm.FormIsUpdating">
<short>
Indicates if the BeginFormUpdate method has been called without a corresponding EndFormUpdate method call.
</short>
<descr>
<p>
The method is used in <var>TControl</var> descendants to determine if the parent form for the control is already rendering changes to its content.
</p>
</descr>
<seealso>
<link id="TCustomForm.BeginFormUpdate"/>
<link id="TCustomForm.EndFormUpdate"/>
<link id="#lcl.controls.TControl.FormIsUpdating">TControl.FormIsUpdating</link>
</seealso>
</element>
<element name="TCustomForm.FormIsUpdating.Result">
<short>
Returns True when the internal update counter for the form contains a positive
non-zero value.
</short>
</element>
<element name="TCustomForm.GetFormImage">
<short>Makes a Bitmap image with the Form content.</short>
<descr>
<p>
<var>GetFormImage</var> is a <var>TBitmap</var> function used to get a bitmap image with the contents for the form instance. The return value must be managed by the caller to ensure that the image is freed.
</p>
<p>
GetFormImage sets the size for the TBitmap instance to the values in the <var>ClientWidth</var> and <var>ClientHeight</var> properties. The <var>GetWindowRect</var> routine in <file>lclintf</file> is called to get the display rectangle for the form Handle. The <var>PaintTo</var> method is called to draw the rectangle to the <var>Canvas</var> in the bitmap.
</p>
<p>
The return value can be <b>Nil</b> if an <var>Exception</var> was raised and handled in the method.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TCustomForm.GetFormImage.Result">
<short>Bitmap created in the method with the image for the form.</short>
</element>
<element name="TCustomForm.GetRolesForControl">
<short>The role(s) for the control in a modal form (default or cancel button).</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.GetRolesForControl.Result">
<short/>
</element>
<element name="TCustomForm.GetRolesForControl.AControl">
<short/>
</element>
<element name="TCustomForm.GetRealPopupParent">
<short>
Gets the form that is the effective parent for the pop-up, dialog, or splash screen.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.GetRealPopupParent.Result">
<short>
Form instance that is the parent for the pop-up form, or Nil for a splash screen.
</short>
</element>
<element name="TCustomForm.Hide" link="#lcl.controls.TControl.Hide"/>
<element name="TCustomForm.IntfDropFiles">
<short>
Invokes the <link id="TCustomForm.OnDropFiles">OnDropFiles</link> handler of the form. This function is called by the LCL interface.
</short>
<descr>
<p>
The drop files event will be invoked when the user drops one or more dragged files onto one of forms in the application. First this event should be fired for the target form (or main form if drop target is unknown), and then for the application instance.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.IntfDropFiles.FileNames">
<short/>
</element>
<element name="TCustomForm.IntfHelp">
<short>
Show help for control or menu item. This function is called by the LCL interface.
</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.ShowHelp">TControl.ShowHelp</link>
</seealso>
</element>
<element name="TCustomForm.IntfHelp.AComponent">
<short/>
</element>
<element name="TCustomForm.IsShortcut">
<short>
Determines whether the specified message contains a shortcut or accelerator key.
</short>
<descr>
<p>
Checks form components to determine whether the specified message is a shortcut or accelerator key used on the form. This includes signalling the <var>OnShortcut</var> event handler (when assigned), calling <var>IsShortCut</var> for the form <var>Menu</var>, or calling IsShortcut for the <var>ActionLists</var> for the form instance.
</p>
<p>
Returns <b>True</b> when the specified <var>Message</var> is an active as a shortcut.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.IsShortcut.Result">
<short>True when the specified Key was handled as a shortcut.</short>
</element>
<element name="TCustomForm.IsShortcut.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomForm.MakeFullyVisible">
<short>Resizes the form for the specified monitor.</short>
<descr>
<p>
<var>MakeFullyVisible</var> is a method used to make the form instance fully visible on the specified monitor. This prevents the form from being partially visible on multiple monitors.
</p>
<p>
<var>AMonitor</var> is the <var>TMonitor</var> instance where the form is displayed. If AMonitor is not specified (contains <b>Nil</b>), the value in the <var>Monitor</var> property is used.
</p>
<p>
<var>UseWorkarea</var> indicates whether the work area for the target monitor is used. When set to <b>True</b>, the form uses the bounds established for the work area instead of the physical monitor. The default value for the parameter is <b>False</b>.
</p>
<p>
MakeFullyVisible ensures the form fits within the required bounds for the monitor or work area. If the form is too wide or too tall, the form bounds are adjusted so that the form fits within the required bounds.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.MakeFullyVisible.AMonitor">
<short>
The monitor where the form is displayed, or Nil to use the design-time monitor.
</short>
</element>
<element name="TCustomForm.MakeFullyVisible.UseWorkarea">
<short>
When True the form is adjusted to the bounds for the WorkArea for the monitor. Otherwise, the form is clipped to the monitor bounds.
</short>
</element>
<element name="TCustomForm.AutoSizeDelayedHandle">
<short>
Returns True if an auto-size action should be skipped when a form handle is not available.
</short>
<descr>
<p>
<var>AutoSizeDelayedHandle</var> is an overridden <var>Boolean</var> function used to determine if an <var>AutoSize</var> action must be deferred due to a missing form <var>Handle</var>.
</p>
<p>
When either <var>Parent</var> or <var>ParentWindow</var> has been assigned, the form is treated like a <var>TWinControl</var>; the return value is set to the value from the inherited method.
</p>
<p>
If one of the values is unassigned, the return value is always set to <b>False</b>. The form has its own handle, and the resize action does not need to be delayed.
</p>
<p>
Called from the <var>AutoSizeDelayed</var> method in an ancestor class.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.AutoSizeDelayedHandle.Result">
<short>
True if an auto-size action should be skipped when a form handle is not available.
</short>
</element>
<element name="TCustomForm.GetPreferredSize" link="#lcl.controls.TControl.GetPreferredSize"/>
<element name="TCustomForm.GetPreferredSize.PreferredWidth">
<short/>
</element>
<element name="TCustomForm.GetPreferredSize.PreferredHeight">
<short/>
</element>
<element name="TCustomForm.GetPreferredSize.Raw">
<short/>
</element>
<element name="TCustomForm.GetPreferredSize.WithThemeSpace">
<short/>
</element>
<element name="TCustomForm.Release">
<short>Marks the form for destruction.</short>
<descr>
<p>
<var>Release</var> is a procedure used to request destruction of the current form instance.
</p>
<p>
<var>Release</var> checks for a <var>TApplication</var> instance in the <var>Application</var> singleton. When it is assigned (contains a value other than <b>Nil</b>), its <var>ReleaseComponent</var> method is called to free the form instance by posting an asynchronous application message. When <var>Application</var> is not assigned, the <var>Free</var> method is called to destroy the form instance.
</p>
</descr>
<seealso>
<link id="TApplication.ReleaseComponent"/>
<link id="TCustomForm.Destroy"/>
<link id="Application"/>
</seealso>
</element>
<element name="TCustomForm.CanFocus">
<short>True when the form can receive focus.</short>
<descr>
<p>
<var>CanFocus</var> is an overridden <var>Boolean</var> function which indicates if the form instance can receive focus. The return value is <b>True</b> when the form is <var>Visible</var> and <var>Enabled</var>, or the inherited <var>CanFocus</var> method returns <b>True</b>.
</p>
<p>
<var>CanFocus</var> is used in the implementation of various methods in the class, including: <var>SetWindowFocus</var>, <var>UpdateShowing</var>, <var>SetActiveControl</var>, and <var>Loaded</var>.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TCustomForm.CanFocus.Result">
<short>True when the form can receive focus in the application.</short>
</element>
<element name="TCustomForm.SetFocus" link="#lcl.controls.TWinControl.SetFocus"/>
<element name="TCustomForm.SetFocusedControl">
<short>Handles a focus change for a control (enter/exit messages).</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.SetFocusedControl.Result">
<short>False when the focused control cannot be changed.</short>
</element>
<element name="TCustomForm.SetFocusedControl.Control">
<short>The control with focus on the form.</short>
</element>
<element name="TCustomForm.SetRestoredBounds">
<short>Sets the bounds for the restored control.</short>
<descr>
<p>
Ensures that the parameter values are used in the form instance. No actions are performed in the method when <var>ALeft</var>, <var>ATop</var>, <var>AWidth</var>, and <var>AHeight</var> are already assigned to the corresponding properties in the form instance.
</p>
<p>
Temporarily sets <var>WindowState</var> to <var>wsNormal</var>, and calls <var>SetBounds</var> to apply the parameter values to the form instance. Calls <var>MoveToDefaultPosition</var> when ADefaultPosition is <b>True</b>. Restores WindowState to its original value, and updates the values for the <var>RestoredLeft</var>, <var>RestoredRight</var>, <var>RestoredWidth</var>, and <var>RestoredHeight</var> properties.
</p>
<p>
Called from the <var>AfterConstruction</var> method prior to signalling the <var>OnCreate</var> event handler and applying the automatic layout policy for the form instance.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.SetRestoredBounds.ALeft">
<short>Value to restore to the Left property for the form.</short>
</element>
<element name="TCustomForm.SetRestoredBounds.ATop">
<short>Value to restore to the Top property for the form.</short>
</element>
<element name="TCustomForm.SetRestoredBounds.AWidth">
<short>Value to restore to the Width property for the form.</short>
</element>
<element name="TCustomForm.SetRestoredBounds.AHeight">
<short>Value to restore to the Height property for the form.</short>
</element>
<element name="TCustomForm.SetRestoredBounds.ADefaultPosition">
<short>
True if the form is moved to the monitor and location in the Position property.
</short>
</element>
<element name="TCustomForm.Show">
<short>Displays the form instance with support for High DPI scaling.</short>
<descr>
<p>
<var>Show</var> is a method used to display the form in an LCL application. It re-implements the method defined in an ancestor class, and does <b>not</b> call the inherited method.
</p>
<p>
Show ensures that scaling is performed using the automatic layout policy for the form instance. The <var>PixelsPerInch</var> setting for the <var>Monitor</var> is applied (when needed) by calling the <var>AutoAdjustLayout</var> method. This action is performed when both the <var>Application</var> and the form instance have their <var>Scaled</var> properties set to <b>True</b>.
</p>
<p>
Show sets the value in the <var>Visible</var> property to <b>True</b>, and calls the <var>ShowWindow</var> routine in the LCL interface at run-time using the <var>Handle</var> and <var>WindowState</var> for the form. The <var>BringToFront</var> method is called to apply the Z-Order for the form instance and its siblings.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Show">TControl.Show</link>
</seealso>
</element>
<element name="TCustomForm.ShowModal">
<short>Displays the form as a modal Dialog.</short>
<descr>
<p>
Shows the form in a modal state and waits until it is closed by the user or by the program. Modal state means that neither the user nor the program can switch to another form already made visible before calling <var>ShowModal</var>.
</p>
<p>
The form must have <var>Visible</var> set to <b>False</b> when calling <var>ShowModal</var>. The call does <b>not</b> return until the form is closed. The application switches to modal state until <var>ShowModal</var> has completed.
</p>
<p>
<var>ShowModal</var> creates its own event loop using <var>ProcessMessages</var>.
</p>
</descr>
<errors>
<p>
Raises an <var>EInvalidOperation</var> exception if the form cannot be displayed as a modal form.
</p>
</errors>
<seealso/>
</element>
<element name="TCustomForm.ShowModal.Result">
<short>The modal result for the dialog.</short>
</element>
<element name="TCustomForm.ShowOnTop">
<short>Displays the form in front of all other forms.</short>
<descr>
<p>
Makes the form <var>Visible</var> and moves it to the top of the Z-Order. <var>WindowState</var> is changed to <var>wsNormal</var> if the form is currently in a minimized state (<var>wsMinimized</var>). Sets the value in Visible to <b>True</b>, and calls <var>BringToFront</var> to move the form to the top of the Z-Order among its siblings.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.SmallIconHandle">
<short>
Returns (and optionally creates) the Handle for the small Icon used for the form.
</short>
<seealso>
<link id="TCustomForm.Icon"/>
</seealso>
</element>
<element name="TCustomForm.SmallIconHandle.Result">
<short>Handle for the small Icon for the form.</short>
</element>
<element name="TCustomForm.GetChildren">
<short>
Executes the specified callback for all child Controls, and Components with no Parent.
</short>
<descr>
<p>
<var>GetChildren</var> is an overridden method in <var>TCustomForm</var> which executes the callback method specified in <var>Proc</var> for child <var>Controls</var> owned by <var>Root</var>, or <var>Components</var> which do not have a <var>Parent</var>. It calls the inherited method in <var>TWinControl</var> to execute the callback for Child controls owned by Root. GetChildren iterates over the values in Component, and calls Proc when the <var>HasParent</var> method for a given component returns <b>False</b>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.GetChildren">TWinControl.GetChildren</link>
</seealso>
</element>
<element name="TCustomForm.GetChildren.Proc">
<short>The callback method.</short>
</element>
<element name="TCustomForm.GetChildren.Root">
<short>Components are enumerated only if Root is Self.</short>
</element>
<element name="TCustomForm.WantChildKey">
<short>
Indicates if key messages in a child control are handled in the message processing loop for the form.
</short>
<descr>
<p>
Always returns <b>False</b> in <var>TCustomForm</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.WantChildKey.Result">
<short>Returns False in TCustomForm.</short>
</element>
<element name="TCustomForm.WantChildKey.Child">
<short>Control with the key message for the method.</short>
</element>
<element name="TCustomForm.WantChildKey.Message">
<short>Key message from the child control.</short>
</element>
<element name="TCustomForm.RemoveAllHandlersOfObject" link="#lcl.lclclasses.TLCLComponent.RemoveAllHandlersOfObject"/>
<element name="TCustomForm.RemoveAllHandlersOfObject.AnObject">
<short/>
</element>
<element name="TCustomForm.AddHandlerFirstShow">
<short>
Adds a handler routine called the first time the form is shown.
</short>
<descr/>
<seealso>
<link id="TFormHandlerType"/>
</seealso>
<notes><note>Used in TAnchorDockHostSite.CreateNew.</note></notes>
</element>
<element name="TCustomForm.AddHandlerFirstShow.OnFirstShowHandler">
<short>
Handler routine added to the list of fhtFirstShow handlers in the class instance.
</short>
</element>
<element name="TCustomForm.AddHandlerFirstShow.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TCustomForm.RemoveHandlerFirstShow">
<short>
Removes the handler called the first time the form executes its Show method.
</short>
<descr/>
<seealso/>
<notes><note>Not used in the current LCL version.</note></notes>
</element>
<element name="TCustomForm.RemoveHandlerFirstShow.OnFirstShowHandler">
<short/>
</element>
<element name="TCustomForm.AddHandlerClose">
<short>
Adds a handler for a form close event.
</short>
<descr>
<p>
<var>AddHandlerClose</var> is a method used to add the <var>TCloseEvent</var> handler specified in <var>OnCloseHandler</var> to the list of form handlers for the type. It allows a form instance to have additional event handlers which behave just like the <var>OnClose</var> event handler.
</p>
<p>
AddHandlerClose calls the <var>AddHandler</var> method to create the TMethod entry used to represent the handler routine. When <var>AsFirst</var> is <b>True</b>, the routine in OnCloseHandler is inserted as the first item in the list of form close handlers.
</p>
<p>
Applications must implement and assign an object procedure using the signature in TCloseEvent to perform actions needed when the <var>Close</var> or <var>CloseModal</var> method is called for the form instance.
</p>
<p>
A handler added using AddHandlerClose is signalled after the <var>OnClose</var> event handler for the form instance.
</p>
<p>
Use <var>RemoveHandlerClose</var> to remove a form close handler added in the method.
</p>
</descr>
<seealso>
<link id="TCustomForm.Close"/>
<link id="TCustomForm.OnClose"/>
<link id="TCustomForm.RemoveHandlerClose"/>
<link id="TCloseEvent"/>
</seealso>
</element>
<element name="TCustomForm.AddHandlerClose.OnCloseHandler">
<short>
Form close handler routine added in the method.
</short>
</element>
<element name="TCustomForm.AddHandlerClose.AsFirst">
<short>
<b>True</b> if the handler is stored as the first entry in the list of form close handlers.
</short>
</element>
<element name="TCustomForm.RemoveHandlerClose">
<short>
Removes a form close handler added to the form instance.
</short>
<descr>
<p>
<var>RemoveHandlerClose</var> is a method used to remove the form close handler specified in <var>OnCloseHandler</var> from the list of handlers for the type. RemoveHandlerClose reverses the action performed in the AddHandlerClose method.
</p>
</descr>
<seealso>
<link id="TCustomForm.AddHandlerClose"/>
<link id="TCloseEvent"/>
</seealso>
</element>
<element name="TCustomForm.RemoveHandlerClose.OnCloseHandler">
<short>
Form close handler removed in the method.
</short>
</element>
<element name="TCustomForm.AddHandlerCreate">
<short>
Adds a handler for a form create event.
</short>
<descr>
<p>
<var>AddHandlerCreate</var> is a method used to add the <var>TNotifyEvent</var> handler specified in <var>OnCreateHandler</var> to the list of form handlers for the type. It allows a form instance to have additional event handlers which behave just like the <var>OnCreate</var> event handler.
</p>
<p>
AddHandlerCreate calls the <var>AddHandler</var> method to create the TMethod entry used to represent the handler routine. When <var>AsFirst</var> is <b>True</b>, the routine in OnCreateHandler is inserted as the first item in the list of form create handlers.
</p>
<p>
Applications must implement and assign an object procedure using the signature in TNotifyEvent to perform actions needed when the form instance has been created and its bounds have been assigned.
</p>
<p>
A handler added using AddHandlerCreate is signalled after the <var>OnCreate</var> event handler for the form instance.
</p>
<p>
Use <var>RemoveHandlerCreate</var> to remove a form create handler added in the method.
</p>
</descr>
<seealso>
<link id="TCustomForm.Create"/>
<link id="TCustomForm.OnCreate"/>
<link id="TCustomForm.AfterConstruction"/>
<link id="TCustomForm.Destroy"/>
<link id="TCustomForm.RemoveHandlerCreate"/>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomForm.AddHandlerCreate.OnCreateHandler">
<short>
Form create handler added in the method.
</short>
</element>
<element name="TCustomForm.AddHandlerCreate.AsFirst">
<short>
<b>True</b> if the handler is stored as the first entry in the list of form create handlers.
</short>
</element>
<element name="TCustomForm.RemoveHandlerCreate">
<short>
Removes a form create handler added to the form instance.
</short>
<descr>
<p>
<var>RemoveHandlerCreate</var> is a method used to remove the form create handler specified in <var>OnCreateHandler</var> from the list of handlers for the type. RemoveHandlerCreate reverses the action performed in the AddHandlerCreate method.
</p>
</descr>
<seealso>
<link id="TCustomForm.AddHandlerCreate"/>
<link id="#rtl.classes.TNotifyEvent"/>
</seealso>
</element>
<element name="TCustomForm.RemoveHandlerCreate.OnCreateHandler">
<short>
Form create handler removed in the method.
</short>
</element>
<element name="TCustomForm.ActiveMDIChild">
<short>Returns the currently active MDI child form.</short>
<descr>
<p>
A non-<b>Nil</b> result is returned only when FormStyle contains <var>fsMDIForm</var> or <var>fsMDIChild</var>; otherwise Result is <b>nil</b>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.ActiveMDIChild.Result">
<short>Nil if the form is neither an MDI host nor child.</short>
</element>
<element name="TCustomForm.GetMDIChildren" link="#lcl.forms.TCustomForm.MDIChildren"/>
<element name="TCustomForm.GetMDIChildren.Result">
<short>
Nil if the caller is not a MDI form type or a handle has not been allocated for the form.
</short>
</element>
<element name="TCustomForm.GetMDIChildren.AIndex">
<short/>
</element>
<element name="TCustomForm.MDIChildCount" link="#lcl.forms.TCustomForm.MDIChildren"/>
<element name="TCustomForm.MDIChildCount.Result">
<short>
-1 if caller isn't an MDI form or handle is not allocated.
</short>
</element>
<element name="TCustomForm.AutoScale">
<short>
Sets scaled to True and calls AutoAdjustLayout with the current PPI for the monitor.
</short>
<descr>
<p>
<var>AutoScale</var> is a method used to apply an automatic layout adjustment policy to scale the form and its controls when enabled and needed.
</p>
<p>
AutoScale sets the value in the <var>Scaled</var> property to <b>True</b> if it is not already enabled. This causes AutoScale to be called again, so no additional actions are performed in the current method call.
</p>
<p>
AutoScale uses the value in the <var>PixelsPerInch</var> property for the <var>Monitor</var> where the form is displayed to determine if the form and its controls need to be scaled. When Scaled is enabled for the <var>Application</var>, and the run-time PixelsPerInch setting differs from the design-time value, the <var>AutoAdjustLayout</var> method is called. The <var>lapAutoAdjustForDPI</var> policy is applied in the method using scaling factors for the Width and Height values on the form and its Controls.
</p>
<p>
AutoScale is called when a new value is assigned to the Scaled property.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.Dock">
<short>
Docks the form to the specified dock site.
</short>
<descr>
<p>
Calls the inherited method using the values in <var>NewDockSite</var> and <var>ARect</var> as arguments.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Dock">TControl.Dock</link>
</seealso>
</element>
<element name="TCustomForm.Dock.NewDockSite">
<short/>
</element>
<element name="TCustomForm.Dock.ARect">
<short/>
</element>
<element name="TCustomForm.UpdateDockCaption">
<short>
Gets the combined Caption for DockClients on the form.
</short>
<descr>
<p>
<var>UpdateDockCaption</var> is an overridden method used to get the combined Caption for all <var>DockClients</var> on the form. It does <b>not</b> call the inherited method.
</p>
<p>
<var>Exclude</var> contains a control which is omitted from the Caption values (when assigned). UpdateDockCaption iterates over the controls in <var>DockClients</var> to build the combined Caption for visible controls (other than the control in Exclude). Blank control captions are ignored. <var>UTF8FixBroken</var> is called to ensure that a given caption does not contain invalid UTF-8 characters. The caption for a <var>TMemo</var> control is truncated after 20 characters.
</p>
<p>
The Caption values for the controls are concatenated into a comma-delimited list of values which are assigned to the <var>Caption</var> property. An empty string is never assigned to the Caption property.
</p>
<p>
UpdateDockCaption is called when a new value is assigned to the <var>Text</var> property for a DockClient control with an assigned <var>HostDockSite</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.UpdateDockCaption">TWinControl.UpdateDockCaption</link>
</seealso>
</element>
<element name="TCustomForm.UpdateDockCaption.Exclude">
<short>Control to omit from the combined caption value.</short>
</element>
<element name="TCustomForm.Active">
<short>
Indicates if the form is enabled, visible, and has focus.
</short>
<descr>
<p>
<var>Active</var> is a read-only <var>Boolean</var> property which indicates if the form is enabled, visible, and has focus.
</p>
<p>
The <var>SetActive</var> method is used to update the value for the property, locate an <var>ActiveControl</var> for the form, and give focus to the form control. SetActive is called from the <var>WMActivate</var> method when the <var>LM_ACTIVATE</var> window control message is handled for the form.
</p>
<p>
The value in Active is used in the <var>FocusControl</var> method. It causes <var>SetFocus</var> to be called when its value is <b>False</b>. It is also used in the <var>SetActiveControl</var> method to determine if the window already has focus when the active control is changed.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.ActiveControl">
<short>Specifies the active control on the form.</short>
<descr>
<p>
<var>ActiveControl</var> is a <var>TWinControl</var> property which contains the control which has focus on the form. The property value can be <b>Nil</b> if the form is hidden, disabled, or has never been activated.
</p>
<p>
Setting a new value for the property causes validity checks to be performed to ensure that the specified control can receive focus when the form is <var>Visible</var>. An <var>EInvalidOperation</var> exception is raised when the new property value contains:
</p>
<ul>
<li>The current form instance.</li>
<li>A control not parented by the current form instance.</li>
<li>A control that returns False from its CanFocus method.</li>
</ul>
<p>
The <var>SetWindowFocus</var> method is called if the form is <var>Active</var>, and the <var>ActiveChanged</var> method is called.
</p>
<p>
The value in ActiveControl is updated in the <var>FocusControl</var> and <var>DefocusControl</var> methods.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.ActiveDefaultControl">
<short>Specifies the active default control on the form.</short>
<descr>
<p>
The active control which is the default control executed when the Enter key is pressed. When setting a new value for the property, a previous default control is notified of the change to the property value using the <var>ActiveDefaultControlChanged</var> method.
</p>
</descr>
<seealso>
<link id="TCustomForm.ActiveControl"/>
<link id="TCustomForm.DefaultControl"/>
</seealso>
</element>
<element name="TCustomForm.AllowDropFiles">
<short>Specifies whether files can be dropped onto this form.</short>
<descr>
<p>
<var>AllowDropFiles</var> is a <var>Boolean</var> property which indicates whether this form receives an <var>OnDropFiles</var> event when files are dropped on the form during a drag-and-drop operation.
</p>
</descr>
<seealso>
<link id="TCustomForm.OnDropFiles"/>
</seealso>
</element>
<element name="TCustomForm.AlphaBlend">
<short>Allows the form to be drawn with translucency.</short>
<descr>
<p>
<var>AlphaBlend</var> is a <var>Boolean</var> property which indicates if the form can be drawn with translucency. When set to <b>True</b>, the form is drawn with a degree of transparency and diffusion. This allows other forms (and their controls) which have a lower Z-Order value to be seen beneath the form. The default value for the property is <b>False</b>.
</p>
<p>
Use <var>AlphaBlendValue</var> to specify the degree of transparency and diffusion applied to the form content.
</p>
<p>
Changing the value in AlphaBlend causes the widgetset class to be notified of the change at run-time when a handle has been allocated for the form instance. A change to the property value is not rendered at design-time.
</p>
<p>
AlphaBlend and AlphaBlendValue are used in the implementation of the <var>InitializeWnd</var> method, and passed as arguments to methods in the widgetset class when either of the values are changed.
</p>
<remark>
AlphaBlend requires support from both the Desktop Environment (DE) and the hardware for the system; it may not work on all hardware, or platform / operating system combinations supported as Lazarus targets.
</remark>
</descr>
<seealso>
<link id="TCustomForm.AlphaBlendValue"/>
<link id="TCustomForm.InitializeWnd"/>
</seealso>
</element>
<element name="TCustomForm.AlphaBlendValue">
<short>
The translucence level for the form (0=transparent, 255=opaque).
</short>
<descr>
<p>
<var>AlphaBlendValue</var> is a <var>Byte</var> property which indicates the level of translucency for the form when <var>AlphaBlend</var> is set to <b>True</b>. AlphaBlendValue must be in the range 0..255 (for the Byte data type), where 0 represents 100% transparency and 255 is for full opacity.
</p>
<p>
Changing the value for the property causes the widgetset class to be notified of the change in the property value at run-time when a handle has been allocated for the form.
</p>
<p>
Set AlphaBlend to <b>True</b> to enable translucency for the form.
</p>
<p>
AlphaBlend and AlphaBlendValue are used in the implementation of the <var>InitializeWnd</var> method, and passed as arguments to methods in the widgetset class when either of the values are changed.
</p>
<remark>
AlphaBlend and AlphaBlendValue require support from both the Desktop Environment (DE) and the hardware for the system; it may not work on all hardware, or platform / operating system combinations supported as Lazarus targets.
</remark>
</descr>
<seealso>
<link id="TCustomForm.AlphaBlend"/>
<link id="TCustomForm.InitializeWnd"/>
</seealso>
</element>
<element name="TCustomForm.AutoScroll">
<short>Indicates if the form can automatically show or hide scroll bars.</short>
<descr>
<p>
<var>AutoScroll</var> is a <var>Boolean</var> property which indicates if the form can automatically show or hide its scroll bars. Set <var>AutoScroll</var> to <b>True</b> to enable scroll bars when the form size is too small to display its content in its entirety. AutoScroll can only be <b>True</b> when the <var>BorderStyle</var> for the form is <var>bsSizeable</var> or <var>bsSizeToolWin</var>, and may be changed to <b>False</b> at run-time when BorderStyle is changed to another value.
</p>
</descr>
<seealso>
<link id="TCustomForm.BorderStyle"/>
</seealso>
</element>
<element name="TCustomForm.BorderIcons">
<short>Specifies the icons which appear in the title bar for the form.</short>
<descr>
<p>
<var>BorderIcons</var> is a <var>TBorderIcons</var> property which contains valued from the <var>TBorderIcon</var> enumeration, and indicates the icons displayed in the title bar for the form instance. The default value for the property includes the following enumeration values:
</p>
<ul>
<li>biSystemMenu</li>
<li>biMinimize</li>
<li>biMaximize</li>
</ul>
<p>
See <link id="TBorderIcon">TBorderIcon</link> for more information about the enumeration values and their usage.
</p>
<p>
Changing the value in BorderIcons causes the <var>WidgetSetClass</var> for the form instance to be notified of the new values in the property.
</p>
<p>
Values in BorderIcons may be automatically changed at run-time when a new value is assigned to the <var>BorderStyle</var> property; see <link id="DefaultBorderIcons">DefaultBorderIcons</link> for the icons used for a specific border style.
</p>
</descr>
<seealso>
<link id="TBorderIcons"/>
<link id="TBorderIcon"/>
<link id="TCustomForm.BorderStyle"/>
<link id="DefaultBorderIcons"/>
</seealso>
</element>
<element name="TCustomForm.BorderStyle">
<short>
The border style affects the title bar, border and resize behavior of the form.
</short>
<descr>
<p>
Use BorderStyle to get or set the appearance of the form's border.
</p>
<p>
By default it is a sizeable window, but it could, for example, be a dialog form
or a tool window, or could be non-sizeable.
</p>
<p>
This property is slightly different (has a different base type) from the
<var>TCustomControl.BorderStyle</var> property. When the form is put into
another control the window borders depend on the widgetset. There are no
borders under GTK.
</p>
</descr>
<seealso>
<link id="TCustomForm.AutoScroll"/>
<link id="#lcl.controls.TFormBorderStyle">TFormBorderStyle</link>
<link id="#lcl.controls.TBorderStyle">TBorderStyle</link>
<link id="#lcl.controls.TCustomControl.BorderStyle">TCustomControl.BorderStyle</link>
</seealso>
</element>
<element name="TCustomForm.CancelControl">
<short>The control associated with the Cancel action.</short>
<descr>
<p>
Determines the control associated with the Cancel action (which exits from the modal form without changing anything). This is usually a button with the caption 'Cancel', but might be an 'Exit' button or anything else the application programmer decides. This control is selected either by explicitly clicking with the mouse, or by hitting the 'Esc' key.
</p>
</descr>
<seealso>
<link id="TCustomForm.DefaultControl"/>
</seealso>
</element>
<element name="TCustomForm.Caption">
<short>The text displayed in the title bar for the form.</short>
<descr>
<p>
Setting the value in <var>Caption</var> also causes the caption in <var>HostDockSite</var> to be updated.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
<link id="#lcl.controls.TControl.HostDockSite">TControl.HostDockSite</link>
</seealso>
</element>
<element name="TCustomForm.Color">
<short>The background color for the form.</short>
<descr>
<var>Color</var> is a <var>TColor</var> property with the background color used for the form. Color is re-declared in <var>TCustomForm</var> to use either <var>clDefault</var> or <var>clBtnFace</var> as the default value for the property. clDefault is used when the <var>UseCLDefault</var> compiler define exists, and indicates that the color is resolved to the value in a <var>Parent</var> control (when assigned).
</descr>
<seealso>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
<link id="#lcl.controls.TControl.GetDefaultColor">TControl.GetDefaultColor</link>
</seealso>
</element>
<element name="TCustomForm.DefaultControl">
<short>The control associated with the default action for this form.</short>
<descr>
<p>
This is typically a button such as 'Ok' or 'Accept' which is highlighted in some way on-screen to indicate that this is the default action. It is selected either by hitting 'Return' or 'Enter', or by clicking the control with the mouse.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.DefaultMonitor">
<short>The monitor on which the form is displayed.</short>
<descr>
<p>
Possible values:
</p>
<dl>
<dt>dmDesktop</dt>
<dd>No attempt to choose specific monitor.</dd>
<dt>dmPrimary</dt>
<dd>On the primary monitor.</dd>
<dt>dmMainForm </dt>
<dd>
On the same monitor as the main form. If there is no main form then use dmPrimary behavior.
</dd>
<dt>dmActiveForm</dt>
<dd>
On the same monitor as the currently active form. If there is no active form use dmMainForm behavior.
</dd>
</dl>
</descr>
<seealso/>
</element>
<element name="TCustomForm.Designer">
<short>The designer object when the form is in design mode.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.EffectiveShowInTaskBar">
<short>
Value from ShowInTaskBar adjusted for the default taskbar behavior in the application.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomForm.FormState">
<short>State flags for the form.</short>
<descr>
<p>
<var>FormState</var> is a read-only <var>TFormState</var> property which contains state flags enabled for the form instance. Values from the TFormStateType enumeration are included in, or excluded from, the set type when corresponding actions occur (or are resolved) for the form instance.
</p>
<p>
See <var>TFormStateType</var> for more information on the values and meanings in the enumeration.
</p>
<p>
FormState is updated when properties for the form instance are changed, and in methods which respond to window and control messages in the form instance.
</p>
</descr>
<seealso>
<link id="TFormState"/>
<link id="TFormStateType"/>
</seealso>
</element>
<element name="TCustomForm.FormStyle">
<short>Indicates the style for the form.</short>
<descr>
<p>
Possible values:
</p>
<dl>
<dt>fsNormal </dt>
<dd>Usual style.</dd>
<dt>fsStayOnTop</dt>
<dd>Form is positioned above all application's forms, except those which have
fsStayOnTop style.</dd>
<dt>fsSystemStayOnTop</dt>
<dd>Form is positioned above all OS windows, except other OS top-level windows.</dd>
<dt>fsSplash</dt>
<dd>Form is border-less.</dd>
<dt>fsMDIForm</dt>
<dd>MDI parent form.</dd>
<dt>fsMDIChild</dt>
<dd>MDI child form.</dd>
</dl>
</descr>
<seealso>
<link id="#lcl.controls.TFormStyle">TFormStyle</link>
</seealso>
</element>
<element name="TCustomForm.HelpFile">
<short>The name of the help file for the form.</short>
<descr>
<p>
<var>HelpFile</var> is a <var>String</var> property which contains the name of the help file for the form instance. HelpFile can use a fully-qualified path to the help file if it is not located in the same directory as the application which implements the form.
</p>
<p>
The value in HelpFile is used in <var>TApplication</var> when it retrieves the help file name from the active form in the application.
</p>
</descr>
<seealso>
<link id="TApplication"/>
<link id="TScreen.ActiveCustomForm"/>
</seealso>
</element>
<element name="TCustomForm.Icon">
<short>The Icon associated with this Form (in minimized state).</short>
<descr>
<p>
<var>Icon</var> is a <var>TIcon</var> property which contains the graphical icon for the form instance. Icon contains the image displayed on the task bar area when a form is minimized. If an Icon is not explicitly assigned for the form, the icon for the <var>Application</var> is used.
</p>
<p>
Assigning a new value to Icon causes existing icon handles to be freed, and the widgetset class is notified to re-create the icon handles.
</p>
</descr>
<seealso>
<link id="TCustomForm.BigIconHandle"/>
<link id="TCustomForm.SmallIconHandle"/>
<link id="#lcl.graphics.TIcon">TIcon</link>
</seealso>
</element>
<element name="TCustomForm.KeyPreview">
<short>Allows the form to intercept keystrokes in child controls.</short>
<descr>
<p>
<var>KeyPreview</var> is a <var>Boolean</var> property which controls whether the form can intercept key strokes from child controls.
</p>
<p>
When KeyPreview is set to <b>True</b>, the form is allowed to receive <var>KeyDown</var>, <var>KeyUp</var>, and <var>KeyPress</var> events before they are received / applied to the <var>ActiveControl</var> in the form. The default value for the property is <b>False</b>.
</p>
<p>
KeyPreview is used in the implementation of key handling methods in <var>TWinControl</var>. KeyPreview is often enabled for modal dialogs to allow the parent form to handle specific interactions with the user.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.MDIChildren">
<short>Provides indexed access to MDI child forms, when this is a MDI form.</short>
<descr>
<p>
<var>MDIChildren</var> is a read-only indexed <var>TCustomForm</var> property which provides access to the child forms in a Multi-Document Interface (MDI) application. In an MDI application, one of the forms acts as the main form for the application, and is the container for its MDI child forms. In addition, an MDI child form can be nested in another MDI child form.
</p>
<remark>
Historically, support for MDI is dependent on the underlying widgetset or platform. Some widgetsets provide better support for MDI than others. The consensus is that the QT/QT5 widgetsets offers the best level of support for MDI applications.
</remark>
<p>
The form role is determined by the value in the <var>FormStyle</var> property. <var>fsMDIForm</var> is used for the main form, and <var>fsMDIChild</var> for the child forms. <var>MDIChildren</var> is relevant when the current form instance uses one of these MDI form style values.
</p>
<p>
<var>Index</var> is an <var>Integer</var> value is used to access a MDI child form by its ordinal position in MDIChildren. The return value contains the <var>TCustomForm</var> instance at the specified position, as determined using the <var>GetMDIChildren</var> method in the widgetset class. The return value can be <b>Nil</b> when the current form does not use a FormStyle with the value fsMDIForm or fsMDIChild, or when a handle has not yet been allocated for the form instance. The return value is always <b>Nil</b> at design-time.
</p>
<p>
Use <var>MDIChildCount</var> to get the number MDI child forms for the form instance.
</p>
<p>
Use <var>ActiveMDIChild</var> to get the active MDI child form in the application.
</p>
<p>
Set the value in the <var>FormStyle</var> property to indicate that the class is used as a MDI form.
</p>
</descr>
<seealso>
<link id="TCustomForm.FormStyle"/>
<link id="TCustomForm.MDIChildCount"/>
<link id="TCustomForm.ActiveMDIChild"/>
</seealso>
</element>
<element name="TCustomForm.MDIChildren.I">
<short>Ordinal position for the MDI Child form requested.</short>
</element>
<element name="TCustomForm.Menu">
<short>The main menu for the form instance.</short>
<descr>
<p>
<var>Menu</var> is the <var>TMainMenu</var> instance assigned to the form.
</p>
<p>
Assigning a new value to Menu causes other forms on the <var>Screen</var> to be checked for a duplicate menu assignment. A singular TMainMenu instance cannot be assigned to more than one form. An <var>EInvalidOperation</var> is raised if another form already uses the menu instance. The <var>UpdateMenu</var> method is called when the new property value has been set.
</p>
</descr>
<seealso>
<link id="#lcl.menus.TMainMenu">TMainMenu</link>
<link id="Screen"/>
<link id="TScreen.Forms"/>
</seealso>
</element>
<element name="TCustomForm.ModalResult">
<short>Specifies the return value for a form (or dialog) displayed modally.</short>
<descr>
<p>
<var>ModalResult</var> is a <var>TModalResult</var> property which contains the value derived when the form is displayed modally. Setting a new value for the property causes the widgetset class to be notified when a handle has been allocated for the form.
</p>
<p>
The value in ModalResult is updated when the <var>ShowModal</var> method is called for the form instance. It may is updated in the <var>CloseModal</var> method when <var>CloseQuery</var> is <b>False</b> and <var>CloseAction</var> is <var>caNone</var>. Finally, it is set to <var>mrCancel</var> in the <var>Close</var> method when <var>FormState</var> contains the value <var>fsModal</var>.
</p>
<p>
See <link id="TModalResult">TModalResult</link> for more information about the enumeration values and their meanings.
</p>
</descr>
<seealso>
<link id="TModalResult"/>
<link id="TCustomForm.ShowModal"/>
<link id="TCustomForm.Close"/>
<link id="TCustomForm.FormState"/>
<link id="TCustomForm.CloseQuery"/>
</seealso>
</element>
<element name="TCustomForm.Monitor">
<short>The Monitor where the form is shown.</short>
<descr>
<p>
<var>Monitor</var> is a read-only <var>TMonitor</var> property which contains the monitor where the form was displayed. Monitor defaults to the <var>TMonitor</var> instance for the Parent form when it has been assigned.
</p>
<p>
When the parent form has not been assigned, and a handle exists for the form instance, the widgetset class is notified of the current coordinates for the form. The <var>MonitorFromWindow</var> method in the <var>Screen</var> singleton is called to locate the window closest to the the form (using its handle).
</p>
<p>
When neither a parent form nor a window handle are available, the <var>MonitorFromPoint</var> method in the <var>Screen</var> singleton is used to locate the form located at the <var>Top</var> and <var>Left</var> coordinates for the form instance.
</p>
</descr>
<seealso>
<link id="Screen"/>
<link id="TScreen"/>
<link id="TMonitor"/>
<link id="GetParentForm"/>
</seealso>
</element>
<element name="TCustomForm.LastActiveControl">
<short>
Tracks changes in the focus for the active form or the last active control for the current form.
</short>
<descr>
<p>
<var>LastActiveControl</var> is a read-only <var>TWinControl</var> property used to track a change in the focus for the active form or the control on the current form instance. It is updated when changes are made to the <var>ActiveControl</var> property, or in the <var>SetFocusedControl</var> method.
</p>
</descr>
<seealso>
<link id="TCustomForm.ActiveControl"/>
<link id="TCustomForm.SetFocusedControl"/>
</seealso>
</element>
<element name="TCustomForm.PopupMode">
<short>Defines where popup menus are shown.</short>
<descr>
<p>
<var>PopupMode</var> is a <var>TPopupMode</var> property which controls the display policy for pop-up forms. The default value for the property is <var>pmNone</var>. See <var>TPopupMode</var> for more information about the values and meanings in the enumeration.
</p>
<p>
Changing the value in PopupMode causes the value in <var>PopupParent</var> to be changed when the property is set to pmAuto or pmNone. At run-time, the widgetset class is notified of the change to the PopupParent property.
</p>
<p>
PopupMode is used in the implementation of the <var>GetRealPopupParent</var> and <var>ShowModal</var> methods.
</p>
</descr>
<seealso>
<link id="TCustomForm.PopupParent"/>
<link id="TCustomForm.GetRealPopupParent"/>
<link id="TCustomForm.ShowModal"/>
<link id="TPopupMode"/>
</seealso>
</element>
<element name="TCustomForm.PopupParent">
<short>
Parent form which owns the current form instance when displayed as a pop-up window.
</short>
<descr>
<p>
<var>PopupParent</var> is a <var>TCustomForm</var> property which contains the parent form which owns the current form instance when displayed as a pop-up window.
</p>
<p>
Setting a new value for the property causes the existing pop-up parent form to be removed from the free notifications for the application. A new non-Nil pop-up parent is added to the free notification list, and its <var>PopupMode</var> property is set to <var>pmExplicit</var>.
</p>
<p>
At run-time, the widgetset class is notified of the change in the <var>PopupParent</var> property. The notification is not performed at design-time.
</p>
</descr>
<seealso>
<link id="TCustomForm.PopupMode"/>
</seealso>
</element>
<element name="TCustomForm.OnActivate">
<short>Handler called when the form receives focus.</short>
<descr>
<p>
This handler is called when the form receives focus for the first time at application start up, and then subsequently each time focus is changed from another window for the same application to this window.
</p>
<p>
For focus changes between different applications, the <var>Application.OnActivate</var> event handler is called instead.
</p>
</descr>
<seealso>
<link id="#LCL.Forms.TApplication.OnActivate">TApplication.OnActivate</link>
</seealso>
</element>
<element name="TCustomForm.OnClose">
<short>
Handler called when the form is closed. It determines what happens to the form (destroy, hide...).
</short>
<descr>
<p>
<var>OnClose</var> is a <var>TCloseEvent</var> property which represents the event handler signalled when a form calls its <var>Close</var> or <var>CloseModal</var> method.
</p>
<p>
OnClose is triggered from the <var>DoClose</var> method immediately before calling any internal form handlers registered for the <var>fhtClose</var> form handler action type. OnClose can be used to determine the action performed in subsequent form handlers by setting the value in the <var>CloseAction</var> argument.
</p>
<p>
An application must implement and assign an object procedure using the signature for TCloseEvent to respond to the event notification.
</p>
</descr>
<seealso>
<link id="TCustomForm.Close"/>
<link id="TCustomForm.DoClose"/>
<link id="TCloseEvent"/>
</seealso>
</element>
<element name="TCustomForm.OnCloseQuery">
<short>
Event handler signalled when trying to close a form.
</short>
<descr>
<p>
<var>OnCloseQuery</var> is a <var>TCloseQueryEvent</var> property which contains the event handler signalled to determine whether the form can be closed. Set the value in the <var>CanClose</var> argument to <b>True</b> to allow the form instance to be closed. The default value for CanClose is <b>True</b>.
</p>
<p>
Use OnCloseQuery to perform any actions or dialogs needed to confirm that the form can in fact be closed.
</p>
<p>
An application must implement and assign an object procedure using the signature in TCloseQueryEvent to respond to the event notification.
</p>
<p>
OnCloseQuery is signalled from the <var>CloseQuery</var> method, and occurs immediately after MDI child forms have called their CloseQuery methods.
</p>
</descr>
<seealso>
<link id="TCustomForm.CloseQuery"/>
<link id="TCustomForm.MDIChildren"/>
<link id="TCloseQueryEvent"/>
</seealso>
</element>
<element name="TCustomForm.OnCreate">
<short>Handler called when the form has been created.</short>
<descr>
<p>
<var>OnCreate</var> is a <var>TNotifyEvent</var> property which implements an event handler signalled when a new form instance is created. OnCreate can be used to perform any action needed to configure the new form instance, or update the application where the form is used.
</p>
<p>
OnCreate is triggered from the <var>DoCreate</var> method (when assigned) before signalling any form handlers using the <var>fhtCreate</var> form handler action type. At this point, the initial coordinates for the form have been assigned, but are not realized until until DoCreate has been completed.
</p>
<p>
An application must implement and assign an object procedure using the signature for the handler to allow responding to the notification.
</p>
</descr>
<seealso>
<link id="TCustomForm.DoCreate"/>
<link id="TFormHandlerType"/>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomForm.OnDeactivate">
<short>Handler called when the form is deactivated (loses focus).</short>
<descr>
<p>
<var>OnDeactivate</var> is a <var>TNotifyEvent</var> property which contains an event handler signalled when form is deactivated (loses focus). OnDeactivate is signalled from the Deactivate method (when assigned).
</p>
</descr>
<seealso>
<link id="TApplication.OnDeactivate"/>
</seealso>
</element>
<element name="TCustomForm.OnDestroy">
<short>Handler called when the form is destroyed.</short>
<descr>
<p>
OnDestroy is a TNotifyEvent property signalled when the form instance is destroyed. OnDestroy is signalled from the DoDestroy method (when assigned) as one of the steps before destruction of the class instance. Before the event handler is triggered, the form has been hidden and the Menu from the main form in the Application has been unmerged.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TCustomForm.OnDropFiles">
<short>Handler called when files have been dropped.</short>
<descr>
<p>
<var>OnDropFiles</var> is a <var>TDropFilesEvent</var> event handler signalled when a File Drag notification is received from the LCL / widgetset interface.
</p>
<p>
The <var>Sender</var> argument contains the current form instance. The <var>FileName</var> argument contains an array with the file names for the drop operation.
</p>
<p>
Set <var>AllowDropFiles</var> to <b>True</b> to enable drag and drop operations, and execution of this event handler.
</p>
</descr>
<seealso>
<link id="TCustomForm.AllowDropFiles"/>
<link id="TDropFilesEvent"/>
</seealso>
</element>
<element name="TCustomForm.OnHelp">
<short>Handler called when Help is requested.</short>
<descr>
<p>
<var>OnHelp</var> is a <var>THelpEvent</var> property which contains the event handler signalled when a Help command is executed for the form instance. Arguments to the event handler identify the command and the context used in the help request.
</p>
<p>
<var>Command</var> contains the help request type, and corresponds to the values used in the Windows WinHelp API.
</p>
<p>
<var>Data</var> is a <var>PtrInt</var> type which points the context information for the help request.
</p>
<p>
The <var>CallHelp</var> argument indicates if handler(s) in the <var>Application</var> instance should be called when the event handler in the form is completed. Set CallHelp to <b>False</b> when the help request has been satisfied in the event handler.
</p>
<p>
An application must implement and assign an object function using the signature for the handler to respond to the event notification.
</p>
<p>
Set the return value to <b>True</b> if the Help request was successfully executed.
</p>
<p>
The OnHelp event handler for the active form is signalled when the <var>TApplication</var> instance executes its <var>DoOnHelp</var> method. The arguments to the event handler contain the values intercepted in the WMHelp message processing for the application. If the OnHelp event handler has not been assigned for the active form, the OnHelp event handler in the Application singleton is signalled (when assigned).
</p>
</descr>
<seealso>
<link id="THelpEvent"/>
<link id="Application"/>
<link id="TApplication.OnHelp"/>
<link id="TApplication.DoOnHelp"/>
</seealso>
</element>
<element name="TCustomForm.OnHide">
<short>Handler called when the form is being hidden.</short>
<descr>
<p>
<var>OnHide</var> is a <var>TNotifyEvent</var> property that represents the event handler signalled when the form instance is hidden. OnHide is triggered (when assigned) in the <var>DoHide</var> method, and occurs when the <var>CMShowingChanged</var> control message is applied to the <var>Showing</var> property for the form instance.
</p>
</descr>
<seealso>
<link id="TCustomForm.DoHide"/>
<link id="TCustomForm.Hide"/>
<link id="TCustomForm.Visible"/>
<link id="TCustomForm.CMShowingChanged"/>
<link id="#lcl.controls.TWinControl.Showing">TWinControl.Showing</link>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomForm.OnResize">
<short>Event handler signalled when the size for the form is changed.</short>
<descr>
<p>
<var>OnResize</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the dimensions for the form have been changed. It is signalled (when assigned) from the <var>DoOnResize</var> method, and occurs in the inherited DoOnResize method in the ancestor class.
</p>
<p>
Create and assign a procedure to the event handler to perform any actions needed after the form has been resized.
</p>
<p>
Use the <var>OnConstrainedResize</var> event handler to set the height and/or width for the form using minimum and maximum height and width values.
</p>
</descr>
<seealso>
<link id="TCustomForm.DoOnResize"/>
<link id="TScrollingWinControl.DoOnResize"/>
<link id="#lcl.controls.TControl.OnResize">TControl.OnResize</link>
</seealso>
</element>
<element name="TCustomForm.OnShortcut">
<short>
Event handler signalled when a key is pressed, before further handling of the key.
</short>
<descr>
<p>
OnShortcut is a TShortcutEvent property that represents the event handler signalled (when assigned) to detect and handle a shortcut key for the form instance. OnShortcut is called from the IsShortcut method used to examine keystroke events intercepted and forwarded by the Application.
</p>
<p>
The Msg argument contains the key event examined in the handler. Handled indicates that the key is handled by the event when set to True.
</p>
</descr>
<seealso>
<link id="TCustomForm.IsShortCut"/>
<link id="TApplication.IsShortCut"/>
<link id="TApplication.OnShortCut"/>
<link id="TShortCutEvent"/>
</seealso>
</element>
<element name="TCustomForm.OnShow">
<short>Handler called when the form becomes visible.</short>
<descr>
<p>
<var>OnShow</var> is a <var>TNotifyEvent</var> property with the event handler signalled (when assigned) when the form becomes visible. It is signalled from the <var>DoShow</var> method when the <b>CM_SHOWINGCHANGED</b> control messages is handled for the form, and when queued <var>OnResize</var> and <var>OnChangeBounds</var> events are executed for the form.
</p>
<p>
Create and assign a procedure to OnShow to perform any actions needed when the <var>Visible</var> property for the form is set to <b>True</b>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.OnShowModalFinished">
<short>
Event handler signalled when modal display of the form has been completed.
</short>
<descr>
<p>
<var>OnShowModalFinished</var> is a <var>TModalDialogFinished</var> property that implements the event handler signalled when modal display of the form has been completed. An application must implement an object procedure using the signature in <var>TModalDialogFinished</var>, and assign it to the property to respond to the event notification.
</p>
</descr>
<seealso>
<link id="TApplication.ModalFinished"/>
<link id="TApplication.OnModalEnd"/>
</seealso>
<notes>
<note>
Is this still needed? Not used in ShowModal or CloseModal. It does not appear to be signalled anywhere in the current LCL version.
</note>
</notes>
</element>
<element name="TCustomForm.OnWindowStateChange">
<short>Handler called when the form is minimized, maximized or restored.</short>
<descr>
<p>
<var>OnWindowStateChange</var> is a <var>TNotifyEvent</var> property which represents the event handler signalled when the value for the <var>WindowState</var> property is changed. OnWindowStateChange is triggered (when assigned) from the <var>Resizing</var> method, and occurs when the <b>WM_SIZE</b> window message for the action is handled.
</p>
<p>
See <var>TWindowState</var> for details about the values and meanings in the enumeration.
</p>
</descr>
<seealso>
<link id="TCustomForm.WindowState"/>
<link id="TCustomForm.Resizing"/>
<link id="TCustomForm.WMSize"/>
<link id="TWindowState"/>
</seealso>
</element>
<element name="TCustomForm.ParentFont">
<short>
Uses the font from the Parent when enabled.
</short>
<descr>
<p>
If true, the Font will be the same as the one from the Parent.
The default value for the property is <b>False</b> in <var>TCustomForm</var>.
</p>
<p>
While ParentFont is True, all changes to the font in the parent will also be applied to the font for the control. This synchronizes them, keeping them set to the same values. If changes are made directly to the Font property in the control, then ParentFont is automatically be set to False.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.ParentFont">TControl.ParentFont</link>
</seealso>
</element>
<element name="TCustomForm.Position">
<short>The initial placement for the form.</short>
<descr>
<p>
<var>Position</var> is a <var>TPosition</var> property which indicates the size and position policy used to display the form instance. The default value for the property is <var>poDesigned</var>, and indicates that the coordinates used in the form designer are used at run-time. See <link id="TPosition">TPosition</link> for the other values, and their meanings, available for the property.
</p>
<p>
Changing the value in Position causes the value in <var>AutoSize</var> to be updated when needed, and calls <var>UpdateControlState</var>. No additional actions are performed at design-time.
</p>
<p>
<var>MoveToDefaultPosition</var> is called when a handle exists for the form instance and the form has not been displayed.
</p>
</descr>
<seealso>
<link id="TForm.AutoSize"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
<link id="TPosition"/>
</seealso>
</element>
<element name="TCustomForm.RestoredLeft">
<short>
The Left coordinate for the form when it is restored (i.e. changes from minimized or maximized).
</short>
<descr>
<p>
<var>RestoredLeft</var> is a read-only <var>Integer</var> property which contains the left coordinate for the form when its size is altered in <var>WMSize</var> or <var>WMMove</var> message handlers. The property value is applied when the asynchronous queued event handler for the form is executed, and calls the <var>DoOnChangeBounds</var> method.
</p>
</descr>
<seealso>
<link id="TCustomForm.WMSize"/>
<link id="#lcl.controls.TControl.DoOnChangeBounds">TControl.DoOnChangeBounds</link>
<link id="#lcl.controls.TControl.Left">TControl.Left</link>
</seealso>
</element>
<element name="TCustomForm.RestoredTop">
<short>
The Top coordinate for the form when it is restored (i.e. changes from minimized or maximized).
</short>
<descr>
<p>
<var>RestoredTop</var> is a read-only <var>Integer</var> property which contains the top coordinate for the form when its size is altered in <var>WMSize</var> or <var>WMMove</var> message handlers. The property value is applied when the asynchronous queued event handler for the form is executed, and calls the <var>DoOnChangeBounds</var> method.
</p>
</descr>
<seealso>
<link id="TCustomForm.WMSize"/>
<link id="#lcl.controls.TControl.DoOnChangeBounds">TControl.DoOnChangeBounds</link>
<link id="#lcl.controls.TControl.Left">TControl.Left</link>
</seealso>
</element>
<element name="TCustomForm.RestoredWidth">
<short>The width of the form when it is resized.</short>
<descr>
<p>
<var>RestoredWidth</var> is a read-only <var>Integer</var> property which contains the Width for the form when its size is altered in <var>WMSize</var> or <var>WMMove</var> message handlers. The property value is applied when the asynchronous queued event handler for the form is executed and calls the <var>DoOnChangeBounds</var> method.
</p>
</descr>
<seealso>
<link id="TCustomForm.WMSize"/>
<link id="#lcl.controls.TControl.DoOnChangeBounds">TControl.DoOnChangeBounds</link>
<link id="#lcl.controls.TControl.Width">TControl.Width</link>
</seealso>
</element>
<element name="TCustomForm.RestoredHeight">
<short>The height of the form when it is resized.</short>
<descr>
<p>
<var>RestoredHeight</var> is a read-only <var>Integer</var> property which contains the height for the form when size is altered in <var>WMSize</var> or <var>WMMove</var> message handlers. The property value is applied when the asynchronous queued event handler for the form is executed and calls the <var>DoOnChangeBounds</var> method.
</p>
</descr>
<seealso>
<link id="TCustomForm.WMSize"/>
<link id="#lcl.controls.TControl.Height">TControl.Height</link>
<link id="#lcl.controls.TControl.DoOnChangeBounds">TControl.DoOnChangeBounds</link>
</seealso>
</element>
<element name="TCustomForm.ShowInTaskBar">
<short>How the form is represented in the system Task Bar.</short>
<descr>
<p>
<var>ShowInTaskBar</var> is a <var>TShowInTaskbar</var> property which indicates how the form is represented on the system task bar. The default value for the property is <var>stDefault</var>, and indicates the default behavior for the widgetset, platform, or operating system is used. See <link id="TShowInTaskbar">TShowInTaskbar</link> for more information about values in the enumeration and their meanings.
</p>
<p>
ShowInTaskBar is used in conjunction with the <var>TaskBarBehavior</var> property in the <var>Application</var> singleton to determine the effective visibility for the form on the system task bar. For example: The task bar behavior may require grouping related forms under a single form icon.
</p>
<p>
Changing the value for the property causes the effective visibility to be recalculated when the form is not hidden, or a MDI child form. The new effective task bar visibility is posted to the widgetset class.
</p>
</descr>
<seealso>
<link id="TShowInTaskbar"/>
<link id="Application"/>
<link id="TApplication.TaskBarBehavior"/>
</seealso>
</element>
<element name="TCustomForm.Visible">
<short>
Indicates if the control is visible on its parent.
</short>
<descr>
<p>
Re-declared in TCustomForm to use a different storage specifier than the ancestor class. In TCustomForm, visibility is not tied to an Action or an ActionLink; it uses the value in the Visible property.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Visible">TControl.Visible</link>
</seealso>
</element>
<element name="TCustomForm.WindowState">
<short>
Indicates whether the form is displayed in a minimized, maximized, full-screen or normal state.
</short>
<descr>
<p>
<var>WindowState</var> is a <var>TWindowState</var> property which indicates whether the form is currently displayed minimized, maximized, full-screen or normal (restored) state. The default value is <var>wsNormal</var> (i. e. neither minimized nor maximized).
</p>
<p>
Changing the value for the property at run-time causes the <var>ShowWindow</var> routine to be called with the Integer display command representing the new property value. The action is not performed at design-time, or when <var>Showing</var> is set to <b>False</b>.
</p>
<remark>
For the Windows platform, wsFullScreen is converted to wsMaximized when calling the ShowWindow API function; the Windows API does not provide a full-screen option.
</remark>
</descr>
<seealso>
<link id="TCustomForm.Show"/>
<link id="TWindowState"/>
<link id="#lcl.controls.TWinControl.Showing">TWinControl.Showing</link>
<link id="#lcl.lclintf.ShowWindow">ShowWindow</link>
</seealso>
</element>
<element name="TCustomFormClass">
<short>Class reference for the TCustomForm class.</short>
<descr>
<p>
Used primarily in the implementation of window classes for the Lazarus IDE.
</p>
</descr>
<seealso>
<link id="TCustomForm"/>
</seealso>
</element>
<element name="TForm">
<short>Implements a form used in an LCL application.</short>
<descr>
<p>
<var>TForm</var> is a <var>TCustomForm</var> descendant which implements a form displayed in an LCL application. It sets the visibility and default values for properties introduced in ancestor classes. It also adds methods needed for use as an MDI form in an application. LCL version information is available in the <var>LCLVersion</var> property, and is streamed to to the component resource file when a <var>Parent</var> is not assigned for the form.
</p>
<p>
Forms created at design-time using the Lazarus IDE are TForm descendants. A form can be used as the main form in an application, or it can be displayed as a MDI forms, dialog box, or tool window. Controls can added to the form, such as: TEdit, TLabel, TButton, TCheckBox, TComboBox, TListView, TTreeView, et. al.
</p>
</descr>
<seealso>
<link id="TCustomForm"/>
</seealso>
</element>
<element name="TForm.FLCLVersion" link="#lcl.forms.TForm.LCLVersion"/>
<element name="TForm.LCLVersionIsStored" link="#lcl.forms.TForm.LCLVersion"/>
<element name="TForm.LCLVersionIsStored.Result" link="#lcl.forms.TForm.LCLVersion.Result"/>
<element name="TForm.WSRegisterClass">
<short>
Creates an association between the class type and its widgetset class.
</short>
<descr>
WSRegisterClass is an overridden class procedure used to register the widgetset class used to create new instances of the form.
</descr>
<seealso>
<link id="#lcl.forms.TCustomForm.WSRegisterClass">TCustomForm.WSRegisterClass</link>
</seealso>
</element>
<element name="TForm.CreateWnd">
<short>
Creates the handle for the widgetset class and updates it menu and icons.
</short>
<descr>
<p>
<var>CreateWnd</var> is an overridden method in <var>TForm</var>. It makes the form instance the main form in the <var>Application</var> singleton if not already assigned and the form is not a MDI Child or a splash form.
</p>
<p>
CreateWnd calls the inherited method to create (or re-create) the Handle for the widgetset class, set the form state and auto-sizing behavior, and update its Menu and Icons.
</p>
</descr>
<seealso>
<link id="TCustomForm.CreateWnd"/>
<link id="TCustomForm.FormStyle"/>
<link id="TCustomForm.Menu"/>
<link id="TCustomForm.Icon"/>
<link id="TCustomForm.BorderIcons"/>
<link id="TApplication.MainForm"/>
</seealso>
</element>
<element name="TForm.Loaded">
<short>
Performs actions when LCL component streaming has been completed for the form instance.
</short>
<descr>
<p>
<var>Loaded</var> is an overridden method in <var>TForm</var>, and calls the inherited method on entry. It ensures that the value in the <var>LCLVersion</var> property is set to the <var>lcl_version</var> constant from the <file>LCLVersion</file> unit.
</p>
</descr>
<seealso>
<link id="TForm.LCLVersion"/>
<link id="TCustomForm.Loaded"/>
</seealso>
</element>
<element name="TForm.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is an overridden constructor for the class instance. Create ensures that the <var>LCLVersion</var> property is updated with the value from the <var>lcl_version</var> constant in the <file>LCLVersion</file> unit. Create calls the inherited constructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TCustomForm.Create"/>
<link id="TCustomForm.CreateNew"/>
<link id="#lcl.lclversion.lcl_version">lcl_version</link>
</seealso>
</element>
<element name="TForm.Create.TheOwner">
<short>Owner of the form instance.</short>
</element>
<element name="TForm.Cascade">
<short>Arranges MDI child forms so they overlap.</short>
<descr>
<p>
Cascade is a method used to arrange MDI Chid forms so that they overlap in a cascading fashion.
</p>
<p>
No actions are performed in the method when FormStyle has a value other than fsMDIForm. At run-time, the Cascade method in the widgetset class is called when its Handle has been allocated.
</p>
<p>
Use Tile to arrange MDI child forms in a grid format.
</p>
</descr>
<seealso/>
</element>
<element name="TForm.Next">
<short>Activates the next child MDI form (fsMDIChild) in the form sequence.</short>
<descr/>
<seealso/>
</element>
<element name="TForm.Previous">
<short>Activates the previous MDI child form in the form sequence.</short>
<descr/>
<seealso/>
</element>
<element name="TForm.Tile">
<short>Arranges MDI child forms side-by-side in a grid format.</short>
<descr/>
<seealso/>
</element>
<element name="TForm.ArrangeIcons">
<short>Arranges the icons for minimized forms in a MDI form.</short>
<descr>
<p>
<var>ArrangeIcons</var> is a method used to arrange the icons for minimized forms on a MDI form. No actions are performed in the method at design-time, or when <var>FormStyle</var> is set to a value other than <var>fsMDIForm</var>. ArrangeIcons calls the corresponding method in the widgetset class when its <var>Handle</var> has been allocated.
</p>
</descr>
<seealso>
<link id="TCustomForm.FormStyle"/>
<link id="#lcl.controls.TWinControl.Handle">TWinControl.Handle</link>
<link id="#lcl.controls.TWinControl.HandleAllocated">TWinControl.HandleAllocated</link>
</seealso>
</element>
<element name="TForm.ClientHandle" link="#lcl.forms.TCustomForm.ClientHandle"/>
<element name="TForm.DockManager" link="#lcl.controls.TWinControl.DockManager"/>
<element name="TForm.Action" link="#lcl.controls.TControl.Action"/>
<element name="TForm.ActiveControl" link="#lcl.forms.TCustomForm.ActiveControl"/>
<element name="TForm.Align" link="#lcl.controls.TControl.Align"/>
<element name="TForm.AllowDropFiles" link="#lcl.forms.TCustomForm.AllowDropFiles"/>
<element name="TForm.AlphaBlend" link="#lcl.forms.TCustomForm.AlphaBlend"/>
<element name="TForm.AlphaBlendValue" link="#lcl.forms.TCustomForm.AlphaBlendValue"/>
<element name="TForm.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TForm.AutoScroll" link="#lcl.forms.TScrollingWinControl.AutoScroll"/>
<element name="TForm.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TForm.BiDiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TForm.BorderIcons" link="#lcl.forms.TCustomForm.BorderIcons"/>
<element name="TForm.BorderStyle" link="#lcl.forms.TCustomForm.BorderStyle"/>
<element name="TForm.BorderWidth" link="#lcl.controls.TWinControl.BorderWidth"/>
<element name="TForm.Caption" link="#lcl.controls.TControl.Caption"/>
<element name="TForm.ChildSizing" link="#lcl.controls.TWinControl.ChildSizing"/>
<element name="TForm.ClientHeight" link="#lcl.controls.TControl.ClientHeight"/>
<element name="TForm.ClientWidth" link="#lcl.controls.TControl.ClientWidth"/>
<element name="TForm.Color" link="#lcl.forms.TCustomForm.Color"/>
<element name="TForm.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TForm.DefaultMonitor" link="#lcl.forms.TCustomForm.DefaultMonitor"/>
<element name="TForm.DesignTimePPI" link="#lcl.forms.TCustomDesignControl.DesignTimePPI"/>
<element name="TForm.DockSite" link="#lcl.controls.TWinControl.DockSite"/>
<element name="TForm.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TForm.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TForm.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TForm.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TForm.Font" link="#lcl.controls.TControl.Font"/>
<element name="TForm.FormStyle" link="#lcl.forms.TCustomForm.FormStyle"/>
<element name="TForm.HelpFile" link="#lcl.forms.TCustomForm.HelpFile"/>
<element name="TForm.Icon" link="#lcl.forms.TCustomForm.Icon"/>
<element name="TForm.KeyPreview" link="#lcl.forms.TCustomForm.KeyPreview"/>
<element name="TForm.Menu" link="#lcl.forms.TCustomForm.Menu"/>
<element name="TForm.OnActivate" link="#lcl.forms.TCustomForm.OnActivate"/>
<element name="TForm.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TForm.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TForm.OnClose" link="#lcl.forms.TCustomForm.OnClose"/>
<element name="TForm.OnCloseQuery" link="#lcl.forms.TCustomForm.OnCloseQuery"/>
<element name="TForm.OnConstrainedResize" link="#lcl.controls.TControl.OnConstrainedResize"/>
<element name="TForm.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TForm.OnCreate" link="#lcl.forms.TCustomForm.OnCreate"/>
<element name="TForm.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TForm.OnDeactivate" link="#lcl.forms.TCustomForm.OnDeactivate"/>
<element name="TForm.OnDestroy" link="#lcl.forms.TCustomForm.OnDestroy"/>
<element name="TForm.OnDockDrop" link="#lcl.controls.TWinControl.OnDockDrop"/>
<element name="TForm.OnDockOver" link="#lcl.controls.TWinControl.OnDockOver"/>
<element name="TForm.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TForm.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TForm.OnDropFiles" link="#lcl.forms.TCustomForm.OnDropFiles"/>
<element name="TForm.OnEndDock" link="#lcl.controls.TControl.OnEndDock"/>
<element name="TForm.OnGetSiteInfo" link="#lcl.controls.TWinControl.OnGetSiteInfo"/>
<element name="TForm.OnHelp" link="#lcl.forms.TCustomForm.OnHelp"/>
<element name="TForm.OnHide" link="#lcl.forms.TCustomForm.OnHide"/>
<element name="TForm.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TForm.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TForm.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TForm.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TForm.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TForm.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TForm.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TForm.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TForm.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TForm.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TForm.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TForm.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TForm.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TForm.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TForm.OnPaint" link="#lcl.controls.TCustomControl.OnPaint"/>
<element name="TForm.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TForm.OnShortCut" link="#lcl.forms.TCustomForm.OnShortcut"/>
<element name="TForm.OnShow" link="#lcl.forms.TCustomForm.OnShow"/>
<element name="TForm.OnShowHint" link="#lcl.controls.TControl.OnShowHint"/>
<element name="TForm.OnStartDock" link="#lcl.controls.TControl.OnStartDock"/>
<element name="TForm.OnUnDock" link="#lcl.controls.TWinControl.OnUnDock"/>
<element name="TForm.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TForm.OnWindowStateChange" link="#lcl.forms.TCustomForm.OnWindowStateChange"/>
<element name="TForm.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TForm.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TForm.ParentFont" link="#lcl.forms.TCustomForm.ParentFont"/>
<element name="TForm.PixelsPerInch" link="#lcl.forms.TCustomDesignControl.PixelsPerInch"/>
<element name="TForm.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TForm.PopupMode" link="#lcl.forms.TCustomForm.PopupMode"/>
<element name="TForm.PopupParent" link="#lcl.forms.TCustomForm.PopupParent"/>
<element name="TForm.Position" link="#lcl.forms.TCustomForm.Position"/>
<element name="TForm.SessionProperties" link="#lcl.controls.TControl.SessionProperties"/>
<element name="TForm.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TForm.ShowInTaskBar" link="#lcl.forms.TCustomForm.ShowInTaskBar"/>
<element name="TForm.UseDockManager" link="#lcl.controls.TWinControl.UseDockManager"/>
<element name="TForm.LCLVersion">
<short>
The LCL version number as a String type.
</short>
<descr>
<p>
Used to distinguish form streaming content for different versions of the LCL.
</p>
</descr>
</element>
<element name="TForm.Scaled" link="#lcl.forms.TCustomDesignControl.Scaled"/>
<element name="TForm.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TForm.WindowState" link="#lcl.forms.TCustomForm.WindowState"/>
<element name="TFormClass" link="#lcl.forms.TForm">
<short>Class of <var>TForm</var>.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomDockForm">
<short>A floating DockSite, usable to make TControls float.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomDockForm.DoAddDockClient">
<short>
Adds Client as a child control which fills the entire area for the docked form.
</short>
<descr>
<p>
DoAddDockClient is an overridden method used to add the control in Client to the docked form. It calls the inherited method on entry to set the Parent in Client to the current class instance. It sets the Align property in Client to alAlign to align the control to the bounds for the docked form. Values in the BorderSpacing property in Client are reset to 0; the current class instance provides the BorderSpacing values for the docked control. At run-time, the Visible property is set to True to display the docked form after the Client has been added.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.DoAddDockClient">TWinControl.DoAddDockClient</link>
</seealso>
</element>
<element name="TCustomDockForm.DoAddDockClient.Client">
<short>Control added to the docked form instance.</short>
</element>
<element name="TCustomDockForm.DoAddDockClient.ARect">
<short>Not used in the current implementation.</short>
</element>
<element name="TCustomDockForm.DoRemoveDockClient">
<short>Closes (releases) the form after the last client has been undocked.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TWinControl.DoRemoveDockClient">TWinControl.DoRemoveDockClient</link>
</seealso>
</element>
<element name="TCustomDockForm.DoRemoveDockClient.Client">
<short/>
</element>
<element name="TCustomDockForm.GetSiteInfo" link="#lcl.controls.TWinControl.GetSiteInfo">
<short>Disallows docking of an second client.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomDockForm.GetSiteInfo.Client">
<short/>
</element>
<element name="TCustomDockForm.GetSiteInfo.InfluenceRect">
<short/>
</element>
<element name="TCustomDockForm.GetSiteInfo.MousePos">
<short/>
</element>
<element name="TCustomDockForm.GetSiteInfo.CanDock">
<short/>
</element>
<element name="TCustomDockForm.Loaded">
<short>
Tries to make all child controls dockclients. This is of little use in practice,
a floating hostdocksite should have no child controls.
</short>
<descr/>
<seealso>
<link id="TCustomForm.Loaded"/>
</seealso>
</element>
<element name="TCustomDockForm.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overridden constructor for the class instance. It calls CreateNew to create a new form instance, and sets the default values for:
</p>
<ul>
<li>AutoScroll (False)</li>
<li>BorderStyle (bsSizeToolWin)</li>
<li>DockSite (True)</li>
<li>FormStyle (fsStayOnTop)</li>
</ul>
</descr>
<seealso>
<link id="TCustomForm.CreateNew"/>
</seealso>
</element>
<element name="TCustomDockForm.Create.TheOwner">
<short>Owner for the class instance.</short>
</element>
<element name="TCustomDockForm.AutoScroll">
<short>
Indicates if the form can automatically show or hide scroll bars.
</short>
<descr>
<p>
AutoScroll is a Boolean property which indicates if the form can automatically show or hide its scroll bars. The default valule for the property is False in TCustomDockForm.
</p>
<p>
AutoScroll can only be True when the BorderStyle for the form is bsSizeable or bsSizeToolWin , and may be changed to False at run-time when BorderStyle is changed to another value.
</p>
</descr>
<seealso>
<link id="#lcl.forms.TCustomDockForm.BorderStyle">TCustomDockForm.BorderStyle</link>
<link id="#lcl.forms.TCustomForm.AutoScroll">TCustomForm.AutoScroll</link>
</seealso>
</element>
<element name="TCustomDockForm.BorderStyle">
<short>
The border style affects the title bar, border and resize behavior of the form.
</short>
<descr>
<p>
Use BorderStyle to get or set the appearance of the form's border. The default value in TCustomDockForm is bsSizeToolWin.
</p>
<p>
This property is slightly different (has a different base type) from the TCustomControl.BorderStyle property. When the form is put into another control the window borders depend on the widgetset. There are no borders under GTK.
</p>
</descr>
<seealso>
<link id="#lcl.forms.TCustomForm.BorderStyle">TCustomForm.BorderStyle</link>
<link id="#lcl.controls.TFormBorderStyle">TFormBorderStyle</link>
</seealso>
</element>
<element name="TCustomDockForm.FormStyle">
<short>
Indicates the style for the form.
</short>
<descr>
<p>
The default value in TCustomDockForm is fsStayOnTop.
</p>
</descr>
<seealso>
<link id="#lcl.forms.TCustomForm.FormStyle">TCustomForm.FormStyle</link>
<link id="#lcl.controls.TFormStyle">TFormStyle</link>
</seealso>
</element>
<element name="TCustomDockForm.PixelsPerInch" link="#lcl.forms.TCustomDesignControl.PixelsPerInch"/>
<element name="THintWindow">
<short>
The pop-up box containing helpful information that appears when the mouse pointer hovers over an object.
</short>
<descr>
<p>
THintWindow is a TCustomForm descendant used to display text hints. It is not intended for use with child controls.
</p>
<p>
Usage:
</p>
<code>
HintWindow := THintWindow.Create(nil);
Rect := HintWindow.CalcHintRect(0, 'This is the hint',nil);
HintWindow.ActivateHint(Rect, 'This is the hint');
</code>
</descr>
<seealso/>
</element>
<element name="THintWindow.FActivating">
<short>True during ActivateHint.</short>
</element>
<element name="THintWindow.FAlignment"/>
<element name="THintWindow.FHintRect"/>
<element name="THintWindow.FHintData"/>
<element name="THintWindow.FAutoHide"/>
<element name="THintWindow.FAutoHideTimer">
<short>The timer used to make the hint disappear.</short>
</element>
<element name="THintWindow.FHideInterval"/>
<element name="THintWindow.AdjustBoundsForMonitor">
<short>Adjusts HintRect to fit on the current monitor.</short>
<descr>
<p>
Used in the implementation of the <var>OffsetHintRect</var> method.
</p>
</descr>
<seealso>
<link id="THintWindow.HintRect"/>
<link id="THintWindow.HintRectAdjust"/>
<link id="THintWindow.OffsetHintRect"/>
</seealso>
</element>
<element name="THintWindow.AdjustBoundsForMonitor.KeepWidth">
<short>Indicates that the width for HintRect should not be decreased.</short>
</element>
<element name="THintWindow.AdjustBoundsForMonitor.KeepHeight">
<short>Indicates that the height for HintRect should not be decreased.</short>
</element>
<element name="THintWindow.GetDrawTextFlags">
<short>Collects the flags for Draw Text formatting.</short>
<descr>
<p>
Returns a Cardinal value that contains the Draw Text flags needed for the Alignment and BiDiMode used in the hint window.
</p>
</descr>
<seealso>
<link id="THintWindow.Alignment"/>
<link id="THintWindow.BiDiMode"/>
</seealso>
</element>
<element name="THintWindow.GetDrawTextFlags.Result">
<short>Draw Text flags for the hint window.</short>
</element>
<element name="THintWindow.SetAutoHide">
<short>Sets the value for the AutoHide property.</short>
<descr/>
<seealso>
<link id="#lcl.forms.THintWindow.AutoHide">THintWindow.AutoHide</link>
</seealso>
</element>
<element name="THintWindow.SetAutoHide.Value">
<short>New value for the property.</short>
</element>
<element name="THintWindow.AutoHideHint">
<short>Hides the hint window when the hint timer has expired.</short>
<descr>
<p>
Called when the hint timer expires. Ensures that the internal hint timer is disabled. Hides the hint window by setting the <var>Visible</var> property to <b>False</b>.
</p>
</descr>
<seealso>
<link id="THintWindow.AutoHide"/>
<link id="THintWindow.HideInterval"/>
</seealso>
</element>
<element name="THintWindow.AutoHideHint.Sender">
<short>Not used in the method.</short>
</element>
<element name="THintWindow.SetHideInterval">
<short>Sets the value for the HideInterval property.</short>
<descr/>
<seealso>
<link id="THintWindow.HideInterval"/>
</seealso>
</element>
<element name="THintWindow.SetHideInterval.Value">
<short>New value for the property.</short>
</element>
<element name="THintWindow.SetHintRectAdjust">
<short>Sets the value for the HintRectAdjust property.</short>
<descr/>
<seealso>
<link id="THintWindow.HintRectAdjust"/>
</seealso>
</element>
<element name="THintWindow.SetHintRectAdjust.AValue">
<short>New value for the property.</short>
</element>
<element name="THintWindow.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="THintWindow.WMNCHitTest">
<short>Handles the WM_NCHITTEST window message for the hint window.</short>
<descr>
<p>
Sets the result in <var>Message</var> to <var>HTTRANSPARENT</var>. This forces the message to be forwarded to other windowed controls in the Z-Order until a value other than HTTRANSPARENT is returned.
</p>
</descr>
<seealso/>
</element>
<element name="THintWindow.WMNCHitTest.Message">
<short>Window message examined and updated in the method.</short>
</element>
<element name="THintWindow.ActivateSub">
<short>Sets the bounds for the hint window and configures the auto-hide timer.</short>
<descr>
<p>
Sets the bounds for the hint window to the values in the <var>HintRect</var> property, and makes the window <var>Visible</var>. The internal auto-hide timer is enabled when <var>AutoHide</var> contains <b>True</b>.
</p>
<p>
Called from the ActivateHint method.
</p>
</descr>
<seealso>
<link id="THintWindow.HintRect"/>
<link id="THintWindow.AutoHide"/>
<link id="THintWindow.ActivateHint"/>
<link id="#lcl.controls.TControl.Visible">TControl.Visible</link>
</seealso>
</element>
<element name="THintWindow.DoShowWindow" link="#lcl.forms.TCustomForm.DoShowWindow"/>
<element name="THintWindow.UpdateRegion">
<short>Updates the Window Region fir the hint window.</short>
<descr>
<p>
<var>UpdateRegion</var> calls the <var>SetWindowRgn</var> routine to set the window region for the hint window. The window region contains the area where the system can perform drawing operations; no area outside of the window region can be updated.
</p>
<remark>
<var>SetWindowRgn</var> requires access to the Handle for the hint window; no actions are performed in the method when <var>HandleAllocated</var> returns <b>False</b>.
</remark>
<p>
When <var>UseBGThemes</var> is enabled, <var>ThemeServices</var> are used to get the theme element details needed for the client rectangle in the hint window.
</p>
</descr>
<seealso>
<link id="THintWindow.UseBGThemes"/>
<link id="THintWindow.UseBGThemes"/>
</seealso>
</element>
<element name="THintWindow.SetColor">
<short>Sets the value for the Color property.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
</seealso>
</element>
<element name="THintWindow.SetColor.Value">
<short>New value for the property.</short>
</element>
<element name="THintWindow.UseBGThemes">
<short>
Indicates if a background from theme services is used when drawing the hint window.
</short>
<descr/>
<seealso/>
</element>
<element name="THintWindow.UseBGThemes.Result">
<short>True when ThemeServices are used for the background.</short>
</element>
<element name="THintWindow.UseFGThemes">
<short>
Indicates if theme services are used for the foreground rendered for the hint window.
</short>
<descr>
<p>
The return value is <b>True</b> when the <var>Font</var> used on the hint window is the stock system font for the platform.
</p>
</descr>
<seealso/>
</element>
<element name="THintWindow.UseFGThemes.Result">
<short>
True when ThemeServices are used to draw the foreground for the hint window.
</short>
</element>
<element name="THintWindow.Paint">
<short>Draws the content in the hint window.</short>
<descr>
<p>
<var>Paint</var> is an overridden method in <var>THintWindow</var>. It extends the inherited method to implement default drawing using the <var>Canvas</var> and the settings enabled for theme services. When <var>CountrolCount</var> is <b>0</b>, the internal routine is used to render the content.When CountrolCount indicates that child controls are present on the hint window, the inherited Paint method is called to render the content.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TCustomControl.Paint">TCustomControl.Paint</link>
</seealso>
</element>
<element name="THintWindow.FSysHintFont"/>
<element name="THintWindow.SysHintFont">
<short>System font used to draw text in the hint window.</short>
<descr/>
<seealso/>
</element>
<element name="THintWindow.SysHintFont.Result">
<short>TFont instance for the system font provided by the widgetset.</short>
</element>
<element name="THintWindow.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
Destroy is a class method used as the destructor for the class. Destroy ensures that the reference to the System Font used for hint windows is freed.
</p>
</descr>
<seealso>
<link id="THintWindow.SysHintFont"/>
</seealso>
</element>
<element name="THintWindow.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. Create calls the inherited <var>CreateNew</var> constructor, and allocates resources needed in the class instance. This includes an internal timer used when <var>AutoHide</var> is set to <b>True</b>.
</p>
<p>
Create sets the default values for the following properties:
</p>
<dl>
<dt>Parent</dt>
<dd>Set to Nil</dd>
<dt>Color</dt>
<dd>Set to clInfoBk</dd>
<dt>Font</dt>
<dd>Uses the Screen.HintFont</dd>
<dt>Canvas</dt>
<dd>Uses the brush style bsClear</dd>
<dt>Alignment</dt>
<dd>Set to taLeftJustify</dd>
<dt>BorderStyle</dt>
<dd>Set to bsNone</dd>
<dt>Caption</dt>
<dd>Set to an empty string ('')</dd>
<dt>HideInterval</dt>
<dd>Set to 3000 milliseconds (3 seconds)</dd>
<dt>AutoHide</dt>
<dd>Set to False</dd>
</dl>
<p>
Create uses the default size from the class type for the control to set the initial bounds for the hint window.
</p>
</descr>
<seealso/>
</element>
<element name="THintWindow.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="THintWindow.ActivateHint">
<short>Shows the specified hint.</short>
<descr>
<p>
<var>ActivateHint</var> is an overloaded procedure used to display the Hint text specified in <var>AHint</var>. An overloaded variant allows the display area for the hint window to be specified in the <var>ARect</var> argument.
</p>
<remark>
No actions are performed in the method if <var>ActivateHint</var> has been previously called with the same hint text and display area.
</remark>
</descr>
<seealso>
<link id="THintWindow.CalcHintRect"/>
</seealso>
</element>
<element name="THintWindow.ActivateHint.AHint">
<short>Text displayed in the hint window.</short>
</element>
<element name="THintWindow.ActivateHint.ARect">
<short>TRect with the display area for the hint window.</short>
</element>
<element name="THintWindow.ActivateWithBounds">
<short>Sets the bounds in HintRect and activates the hint window.</short>
<descr>
<p>
<var>ActivateWithBounds</var> is a procedure used to update the location and text for the hint window. ActivateWithBounds sets the value in <var>HintRect</var> to the value in the <var>ARect</var> argument. ActivateWithBounds calls <var>ActivateHint</var> using the value in <var>AHint</var> as the text displayed in the hint window.
</p>
</descr>
<seealso>
<link id="THintWindow.HintRect"/>
<link id="THintWindow.ActivateHint"/>
</seealso>
</element>
<element name="THintWindow.ActivateWithBounds.ARect">
<short>Rectangle with the bounds assigned to HintRect.</short>
</element>
<element name="THintWindow.ActivateWithBounds.AHint">
<short>Text displayed in the hint window.</short>
</element>
<element name="THintWindow.ActivateHintData">
<short>
An extended version of ActivateHint with additional data used for the hint display.
</short>
<descr>
<p>
<var>ActivateHintData</var> is an extended version of <var>ActivateHint</var>. It provides the additional <var>AData</var> argument which contains a pointer to values which can be used to construct the text displayed in the hint window.
</p>
<p>
The implementation in <var>THintWindow</var> does not use the values in <var>AData</var>. The method must be overridden in a descendent class to use the additional hint data in <var>AData</var>.
</p>
</descr>
<seealso>
<link id="THintWindow.ActivateHint"/>
</seealso>
</element>
<element name="THintWindow.ActivateHintData.ARect">
<short>Display rectangle for the hint text.</short>
</element>
<element name="THintWindow.ActivateHintData.AHint">
<short>Text displayed in the hint window.</short>
</element>
<element name="THintWindow.ActivateHintData.AData">
<short>Pointer to additional data used to construct the hint text.</short>
</element>
<element name="THintWindow.CalcHintRect">
<short>Determines the rectangle required for the hint display.</short>
<descr>
<p>
CalcHintRect determines the display rectangle required for the hint display. CalcHintRect uses the larger of the values in the length of the hint text, and the width of the hint window.
</p>
</descr>
<seealso/>
</element>
<element name="THintWindow.CalcHintRect.Result">
<short>Display area needed for the hint display.</short>
</element>
<element name="THintWindow.CalcHintRect.MaxWidth">
<short>Greater than zero, otherwise the full monitor width is used.</short>
</element>
<element name="THintWindow.CalcHintRect.AHint">
<short>Hint text used to derive the display area.</short>
</element>
<element name="THintWindow.CalcHintRect.AData">
<short>Pointer to additional data used to construct the hint text.</short>
</element>
<element name="THintWindow.OffsetHintRect">
<short>Moves the hint rectangle by the specified amounts.</short>
<descr/>
<seealso>
<link id="THintWindow.HintRect"/>
<link id="THintWindow.HintRectAdjust"/>
</seealso>
</element>
<element name="THintWindow.OffsetHintRect.Result">
<short>
True when the hint rectangle was successfully moved by the specified amounts.
</short>
</element>
<element name="THintWindow.OffsetHintRect.AOffset">
<short>TPoint with the horizontal and vertical offsets for the hint display.</short>
</element>
<element name="THintWindow.OffsetHintRect.dy">
<short>Additional vertical offset applied to the hint rectangle.</short>
</element>
<element name="THintWindow.OffsetHintRect.KeepWidth">
<short>Indicates the width for the hint rectangle must be maintained.</short>
</element>
<element name="THintWindow.OffsetHintRect.KeepHeight">
<short>Indicates the height for the hint rectangle must be maintained.</short>
</element>
<element name="THintWindow.InitializeWnd" link="#lcl.forms.TCustomForm.InitializeWnd"/>
<element name="THintWindow.IsHintMsg">
<short>Indicates if the specified message is relevant to a hint window display.</short>
<descr>
<p>
<var>IsHintMsg</var> is a <var>Boolean</var> function used to determine if the message instance in <var>Msg</var> is recognized in <var>THintWindow</var>.
</p>
<remark>
Not used in the current LCL implementation.
</remark>
</descr>
<seealso>
<link id="#lcl.lcltype.TMsg">TMsg</link>
</seealso>
</element>
<element name="THintWindow.IsHintMsg.Result">
<short>
True if the message is used for hint windows, False for all other messages.
</short>
</element>
<element name="THintWindow.IsHintMsg.Msg">
<short>TMsg instance with the message examined in the method.</short>
</element>
<element name="THintWindow.ReleaseHandle">
<short>Destroys an allocated handle for the widget.</short>
<descr>
<p>
ReleaseHandle is a method used to free the Handle allocated for the control in the widgetset class. It calls the DestroyHandle method if the Handle has been allocated for the class instance. ReleaseHandle is called by methods in the widgetset class to ensure that the Handle is set 0 (the un-initialized value).
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.DestroyHandle">TWinControl.DestroyHandle</link>
</seealso>
</element>
<element name="THintWindow.SetBounds">
<short>Applies the argument values to the bounds for the control.</short>
<descr>
<p>
<var>SetBounds</var> is an overridden method in <var>THintWindow</var>. It calls the inherited method on entry to apply the argument values to the bounds for the class instance. It calls the UpdateRegion method to set the window region, or apply a background theme when enabled.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
</seealso>
</element>
<element name="THintWindow.SetBounds.ALeft">
<short>Value for the Left property.</short>
</element>
<element name="THintWindow.SetBounds.ATop">
<short>Value for the Top property.</short>
</element>
<element name="THintWindow.SetBounds.AWidth">
<short>Value for the Width property.</short>
</element>
<element name="THintWindow.SetBounds.AHeight">
<short>Value for the Height property.</short>
</element>
<element name="THintWindow.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="THintWindow.GetControlClassDefaultSize.Result">
<short/>
</element>
<element name="THintWindow.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="THintWindow.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="THintWindow.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="THintWindow.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="THintWindow.Alignment">
<short>Text alignment used for the hint window.</short>
<descr>
<p>
<var>Alignment</var> is a <var>TAlignment</var> property that indicates the alignment used for the text displayed in the hint window.
</p>
<p>
The default value for the property is <var>taLeftJustify</var>, as assigned in the <var>Create</var> constructor. The value in Alignment is used to derive the draw text flags required for the <var>BidiMode</var> in the hint display, and passed to to <var>DrawText</var> routine in theme services or widgetset classes.
</p>
</descr>
<seealso>
<link id="THintWindow.BiDiMode"/>
<link id="TAlignment"/>
</seealso>
</element>
<element name="THintWindow.HintRect">
<short>Contains the bounds used to display the text for the hint.</short>
<descr>
<p>
<var>HintRect</var> is a <var>TRect</var> property which contains the bounds used to display the hint when it is activated. <var>HintRect</var> is adjusted using the values in <var>HintRectAdjust</var> (when assigned) and the borders drawn around the hint display.
</p>
</descr>
<seealso>
<link id="THintWindow.ActivateHint"/>
<link id="THintWindow.ActivateHintData"/>
<link id="THintWindow.ActivateWithBounds"/>
<link id="THintWindow.HintRectAdjust"/>
</seealso>
</element>
<element name="THintWindow.HintRectAdjust">
<short>Contains the bounds with additional space needed for the hint display.</short>
<descr/>
<seealso/>
</element>
<element name="THintWindow.HintData">
<short>Pointer to data used to formulate text displayed in the hint window.</short>
<descr/>
<seealso/>
</element>
<element name="THintWindow.AutoHide">
<short>Does the hint disappear (get hidden) after a while?</short>
<descr>
If <var>AutoHide</var> is TRUE, the hint disappears after an interval specified by
<link id="THintWindow.HideInterval">HideInterval</link>.
</descr>
<seealso/>
</element>
<element name="THintWindow.BiDiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="THintWindow.HideInterval">
<short>The time after which the displayed hint disappears.</short>
<descr/>
<seealso>
<link id="THintWindow.AutoHide"/>
</seealso>
</element>
<element name="THintWindowClass">
<short>Class of <var>THintWindow</var>.</short>
<descr/>
<seealso>
<link id="THintWindow"/>
</seealso>
</element>
<element name="THintWindowRendered">
<short>For a rendered hint with a child control added by an external provider.</short>
<descr/>
<seealso/>
</element>
<element name="THintWindowRendered.Create">
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="THintWindowRendered.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="THintWindowRendered.Destroy">
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="THintWindowRendered.ActivateRendered">
<short>Shows hint contents are rendered by a provider on child control.</short>
<descr/>
<seealso/>
</element>
<element name="TMonitor">
<short>Provides information about a physical monitor.</short>
<descr>
<p>
Monitor information is retrieved dynamically from the Operating System. This ensures that any changes to the installed hardware devices or their configuration are taken into account. <var>TMonitor</var> has properties that reflect its dimensions, use as the primary monitor, and its display density (or Pixels per Inch).
</p>
<p>
<var>TMonitor</var> is the type returned when reading the <var>TScreen.Monitors</var> property. <var>TMonitor</var> is the type used to implement the <var>TCustomForm.Monitor</var> property.
</p>
</descr>
<seealso>
<link id="TCustomForm.Monitor"/>
<link id="TScreen.Monitors"/>
</seealso>
</element>
<element name="TMonitor.FHandle" link="#lcl.forms.TMonitor.Handle"/>
<element name="TMonitor.FMonitorNum" link="#lcl.forms.TMonitor.MonitorNum"/>
<element name="TMonitor.GetInfo">
<short>Retrieves monitor information from the OS or platform.</short>
<descr>
<p>
<var>Getinfo</var> is a <var>Boolean</var> function used to get monitor information from the OS or platform hosting the LCL application. <var>Getinfo</var> initializes the <var>Info</var> output parameter to the size required for the <var>TMonitorInfo</var> type, and calls the <var>GetMonitorInfo</var> routine for the widgetset.
</p>
<p>
The return value is <b>True</b> when monitor information is successfully retrieved for the OS or platform. <var>Info</var> contains the size, display rectangle, work area, and flags for the monitor.
</p>
</descr>
<seealso>
<link id="#lcl.lcltype.TMonitorInfo">TMonitorInfo</link>
</seealso>
</element>
<element name="TMonitor.GetInfo.Result">
<short>True when monitor information was successfully retrieved.</short>
</element>
<element name="TMonitor.GetInfo.Info">
<short>TMonitorInfo with values retrieved for the OS or platform.</short>
</element>
<element name="TMonitor.GetLeft">
<short>Gets the value for the Left property.</short>
<descr/>
<seealso>
<link id="TMonitor.Left"/>
</seealso>
</element>
<element name="TMonitor.GetLeft.Result">
<short>Value for the property.</short>
</element>
<element name="TMonitor.GetHeight" link="#lcl.forms.TMonitor.Height"/>
<element name="TMonitor.GetHeight.Result">
<short/>
</element>
<element name="TMonitor.GetPixelsPerInch">
<short>Gets the value for the PixelsPerInch property.</short>
<descr/>
<seealso>
<link id="TMonitor.PixelsPerInch"/>
</seealso>
</element>
<element name="TMonitor.GetPixelsPerInch.Result">
<short>Value for the property.</short>
</element>
<element name="TMonitor.GetTop" link="#lcl.forms.TMonitor.Top"/>
<element name="TMonitor.GetTop.Result">
<short/>
</element>
<element name="TMonitor.GetWidth" link="#lcl.forms.TMonitor.Width"/>
<element name="TMonitor.GetWidth.Result">
<short/>
</element>
<element name="TMonitor.GetBoundsRect" link="#lcl.forms.TMonitor.BoundsRect"/>
<element name="TMonitor.GetBoundsRect.Result">
<short/>
</element>
<element name="TMonitor.GetWorkareaRect" link="#lcl.forms.TMonitor.WorkareaRect"/>
<element name="TMonitor.GetWorkareaRect.Result">
<short/>
</element>
<element name="TMonitor.GetPrimary" link="#lcl.forms.TMonitor.Primary"/>
<element name="TMonitor.GetPrimary.Result">
<short/>
</element>
<element name="TMonitor.Handle">
<short>Handle which identifies this monitor to the system.</short>
</element>
<element name="TMonitor.MonitorNum">
<short>Index of the monitor in the <link id="TScreen.Monitors"/> list.</short>
</element>
<element name="TMonitor.Left">
<short>The leftmost screen coordinate of the display.</short>
</element>
<element name="TMonitor.Height">
<short>The height of the display.</short>
</element>
<element name="TMonitor.Top">
<short>The top-most screen coordinate of the display.</short>
</element>
<element name="TMonitor.Width">
<short>The width of the display.</short>
</element>
<element name="TMonitor.BoundsRect">
<short>The logical dimensions of the monitor, within the desktop.
</short>
</element>
<element name="TMonitor.WorkareaRect">
<short>The usable display area, excluding a taskbar etc.</short>
</element>
<element name="TMonitor.Primary">
<short>True if this is the primary monitor of the system.</short>
</element>
<element name="TMonitor.PixelsPerInch">
<short>Contains the Pixels Per Inch or display density for the monitor.</short>
</element>
<element name="TMonitorList">
<short>A list of monitors available on the system.</short>
<descr>
<p>
<var>TMonitorList</var> is a <var>TList</var> descendant used to store <var>TMonitor</var> class instances representing the physical monitors attached to the system. It provides an indexed <var>Items</var> property that can be used to access monitor information by an ordinal position in the list. It also provides an overridden Notify method to free a TMonitor instance when the <var>lnDeleted</var> list notification is received.
</p>
<p>
TMonitorList is the type used to implement the <var>Monitors</var> property in <var>TScreen</var>.
</p>
</descr>
<seealso>
<link id="TMonitor"/>
<link id="TScreen.Monitors"/>
<link id="#rtl.classes.TList">TList</link>
</seealso>
</element>
<element name="TMonitorList.GetItem" link="#lcl.forms.TMonitorList.Items"/>
<element name="TMonitorList.GetItem.Result"/>
<element name="TMonitorList.GetItem.AIndex"/>
<element name="TMonitorList.SetItem" link="#lcl.forms.TMonitorList.Items"/>
<element name="TMonitorList.SetItem.AIndex"/>
<element name="TMonitorList.SetItem.AValue"/>
<element name="TMonitorList.Notify">
<short>
List notification handler which destroys the Monitor object on removal from the list.
</short>
<descr/>
<seealso/>
</element>
<element name="TMonitorList.Notify.Ptr">
<short>The monitor object.</short>
</element>
<element name="TMonitorList.Notify.Action">
<short>The list operation.</short>
</element>
<element name="TMonitorList.Items">
<short>The indexed list of all Monitors.</short>
<descr>
<p>
<var>Items</var> is a <var>TMonitor</var> property which provides indexed access to a monitor in the list by its ordinal position. Items is the default property for the list, and the target for a list enumerator for the class instance.
</p>
<p>
TMonitor instances in Items are create and added at run-time when the <var>UpdateMonitors</var> method in <var>TScreen</var> is called. This occurs in response to a <var>WM_DISPLAYCHANGE</var> message in the processing loop for an application.
</p>
</descr>
<seealso>
<link id="TMonitor"/>
<link id="TScreen.UpdateMonitors"/>
<link id="TApplication.HandleMessage"/>
</seealso>
</element>
<element name="TMonitorList.Items.AIndex">
<short>Ordinal position for a monitor in the list.</short>
</element>
<element name="PCursorRec" link="#lcl.forms.TCursorRec"/>
<element name="TCursorRec">
<short>Contains information about a cursor shape.</short>
<descr>
<p>
<var>TCursorRec</var> is a record type which contains information about a cursor shape used in an application. It contains members with the index position for the cursor, the Handle for the cursor resource, and a pointer to the next cursor record in the list.
</p>
</descr>
<seealso/>
</element>
<element name="TCursorRec.Next">
<short>Pointer to the next cursor record in the list.</short>
<descr/>
<seealso/>
</element>
<element name="TCursorRec.Index">
<short>Position of the cursor record in the list..</short>
<descr/>
<seealso/>
</element>
<element name="TCursorRec.Handle">
<short>The handle for the cursor resource.</short>
<descr/>
<seealso/>
</element>
<element name="TScreenFormEvent">
<short>Type used for a screen notification handler, for form related events.</short>
<descr/>
<seealso>
<link id="TScreenNotification"/>
<link id="TScreenControlEvent"/>
</seealso>
</element>
<element name="TScreenFormEvent.Sender">
<short>TObject for the event notification.</short>
</element>
<element name="TScreenFormEvent.Form">
<short>The affected form.</short>
</element>
<element name="TScreenControlEvent">
<short>Type for a screen notification handler used for control related events.</short>
<descr/>
<seealso>
<link id="TScreenFormEvent"/>
<link id="TScreenNotification"/>
</seealso>
</element>
<element name="TScreenControlEvent.Sender">
<short>TObject for the event notification.</short>
</element>
<element name="TScreenControlEvent.LastControl">
<short>The <b>new</b> active control.</short>
</element>
<element name="TScreenNotification">
<short>Screen notification events and handler types.</short>
<descr/>
<seealso>
<link id="TScreenFormEvent"/>
<link id="TScreenControlEvent"/>
</seealso>
</element>
<element name="TScreenNotification.snFormAdded">
<short>A form was added.</short>
</element>
<element name="TScreenNotification.snRemoveForm">
<short>A form was removed.</short>
</element>
<element name="TScreenNotification.snActiveControlChanged">
<short>The focus moved to another control.</short>
</element>
<element name="TScreenNotification.snActiveFormChanged">
<short>The focus moved to another form.</short>
</element>
<element name="TScreenNotification.snFormVisibleChanged">
<short>The visibility of a form changed.</short>
</element>
<element name="TMonitorDefaultTo">
<short>
The monitor to use when screen coordinates are outside of the physical bounds for the screens.
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TMonitorDefaultTo.mdNearest">
<short>Default to the nearest monitor.</short>
</element>
<element name="TMonitorDefaultTo.mdNull">
<short>Default to Nil (no suggested monitor).</short>
</element>
<element name="TMonitorDefaultTo.mdPrimary">
<short>Default to the primary monitor.</short>
</element>
<element name="TScreen">
<short>Provides information about the screen display in an application.</short>
<descr>
<p>
<var>TScreen</var> is a <var>TLCLComponent</var> descendant which provides information about multiple monitors in an LCL application. TScreen allows the GUI for an application to be managed on multiple monitors. It includes the size and resolution for a screen, and allows mapping the virtual Desktop and Workareas to the physical Monitors known to the application.
</p>
<p>
TScreen also provides access to objects displayed on a given screen, including: <var>Forms</var>, <var>Cursors</var>, and <var>Fonts</var>. For Delphi compatibility, non-visual <var>DataModules</var> are also included in the TScreen information. Properties are provided in the class with the currently active Form, Control and Cursor for a screen.
</p>
<p>
TScreen is the type used for the <var>Screen</var> singleton in an LCL application.
</p>
</descr>
<seealso>
<link id="TScreen.Cursors"/>
<link id="TScreen.DataModules"/>
<link id="TScreen.Fonts"/>
<link id="TScreen.Forms"/>
<link id="TScreen.CustomForms"/>
<link id="TScreen.Monitors"/>
<link id="TScreen.WorkareaRect"/>
<link id="TScreen.DesktopRect"/>
</seealso>
</element>
<element name="TScreen.crScreen"/>
<element name="TScreen.FActiveControl" link="#lcl.forms.TScreen.ActiveControl"/>
<element name="TScreen.FActiveCustomForm" link="#lcl.forms.TScreen.ActiveCustomForm"/>
<element name="TScreen.FActiveForm" link="#lcl.forms.TScreen.ActiveForm"/>
<element name="TScreen.FCursor" link="#lcl.forms.TScreen.Cursor"/>
<element name="TScreen.FTempCursors"/>
<element name="TScreen.FCursorMap" link="#lcl.forms.TScreen.Cursors"/>
<element name="TScreen.FCustomForms" link="#lcl.forms.TScreen.CustomForms"/>
<element name="TScreen.FCustomFormsZOrdered" link="#lcl.forms.TScreen.CustomFormsZOrdered"/>
<element name="TScreen.FDefaultCursor"/>
<element name="TScreen.FHintFont" link="#lcl.forms.TScreen.HintFont"/>
<element name="TScreen.FFocusedForm" link="#lcl.forms.TScreen.FocusedForm"/>
<element name="TScreen.FFonts" link="#lcl.forms.TScreen.Fonts"/>
<element name="TScreen.FFormList" link="#lcl.forms.TScreen.Forms"/>
<element name="TScreen.FDataModuleList" link="#lcl.forms.TScreen.DataModules"/>
<element name="TScreen.FIconFont" link="#lcl.forms.TScreen.IconFont"/>
<element name="TScreen.FMenuFont" link="#lcl.forms.TScreen.MenuFont"/>
<element name="TScreen.FScreenHandlers"/>
<element name="TScreen.FLastActiveControl">
<short>The last active control, used to detect focus changes.</short>
<seealso>
<link id="TScreen.RestoreLastActive"/>
</seealso>
</element>
<element name="TScreen.FLastActiveCustomForm">
<short>The last active form, used to detect focus changes.</short>
<descr/>
<seealso>
<link id="TScreen.RestoreLastActive"/>
</seealso>
</element>
<element name="TScreen.FMonitors" link="#lcl.forms.TScreen.Monitors"/>
<element name="TScreen.FOnActiveControlChange" link="#lcl.forms.TScreen.OnActiveControlChange"/>
<element name="TScreen.FOnActiveFormChange" link="#lcl.forms.TScreen.OnActiveFormChange"/>
<element name="TScreen.FPixelsPerInch" link="#lcl.forms.TScreen.PixelsPerInch"/>
<element name="TScreen.FSaveFocusedList"/>
<element name="TScreen.FSystemFont" link="#lcl.forms.TScreen.SystemFont"/>
<!-- private -->
<element name="TScreen.DeleteCursor">
<short>Removes the specified cursor from the Cursors property.</short>
<descr/>
<seealso>
<link id="TScreen.Cursors"/>
</seealso>
</element>
<element name="TScreen.DeleteCursor.AIndex">
<short>The logical cursor ID.</short>
</element>
<element name="TScreen.DestroyCursors">
<short>Deletes all TCursor instances in the Cursors property.</short>
<descr/>
<seealso>
<link id="TScreen.Cursors"/>
</seealso>
</element>
<element name="TScreen.DestroyMonitors">
<short>Clears the Monitors list.</short>
<descr/>
<seealso>
<link id="TScreen.Monitors"/>
</seealso>
</element>
<element name="TScreen.GetCursors">
<short>Gets the value for the indexed Cursors property.</short>
<descr/>
<seealso>
<link id="TScreen.Cursors"/>
</seealso>
</element>
<element name="TScreen.GetCursors.Result">
<short>Value for the indexed property.</short>
</element>
<element name="TScreen.GetCursors.AIndex">
<short>The logical cursor ID.</short>
</element>
<element name="TScreen.GetCustomFormCount">
<short>Gets the value for the CustomFormCount property.</short>
<descr/>
<seealso>
<link id="TScreen.CustomFormCount"/>
</seealso>
</element>
<element name="TScreen.GetCustomFormCount.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetCustomFormZOrderCount" link="#lcl.forms.TScreen.CustomFormZOrderCount"/>
<element name="TScreen.GetCustomFormZOrderCount.Result">
<short/>
</element>
<element name="TScreen.GetCustomForms">
<short>Gets the value for the indexed CustomForms property.</short>
<descr/>
<seealso>
<link id="TScreen.CustomForms"/>
</seealso>
</element>
<element name="TScreen.GetCustomForms.Result">
<short>Value for the indexed property.</short>
</element>
<element name="TScreen.GetCustomForms.Index">
<short>Ordinal position for the property value.</short>
</element>
<element name="TScreen.GetCustomFormsZOrdered">
<short>Gets the value for the indexed CustomFormsZOrdered property.</short>
<descr/>
<seealso>
<link id="TScreen.CustomFormsZOrdered"/>
</seealso>
</element>
<element name="TScreen.GetCustomFormsZOrdered.Result">
<short>TCustomForm instance at the specified position in the Z-Order.</short>
</element>
<element name="TScreen.GetCustomFormsZOrdered.Index">
<short>
Ordinal position for the property value; smaller values are higher in the Z-Order.
</short>
</element>
<element name="TScreen.GetDataModuleCount">
<short>Gets the value for the DataModuleCount property.</short>
<descr/>
<seealso>
<link id="TScreen.DataModuleCount"/>
</seealso>
</element>
<element name="TScreen.GetDataModuleCount.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetDataModules">
<short>Gets the value for the indexed DataModules property.</short>
<descr/>
<seealso>
<link id="TScreen.DataModules"/>
</seealso>
</element>
<element name="TScreen.GetDataModules.Result">
<short>Value for the indexed property.</short>
</element>
<element name="TScreen.GetDataModules.AIndex">
<short>Ordinal position for the property value.</short>
</element>
<element name="TScreen.GetDesktopLeft">
<short>Gets the value for the DesktopLeft property.</short>
<descr/>
<seealso>
<link id="TScreen.DesktopLeft"/>
</seealso>
</element>
<element name="TScreen.GetDesktopLeft.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetDesktopTop">
<short>Gets the value for the DesktopTop property.</short>
<descr/>
<seealso>
<link id="TScreen.DesktopTop"/>
</seealso>
</element>
<element name="TScreen.GetDesktopTop.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetDesktopHeight">
<short>Gets the value for the DesktopHeight property.</short>
<descr/>
<seealso>
<link id="TScreen.DesktopHeight"/>
</seealso>
</element>
<element name="TScreen.GetDesktopHeight.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetDesktopWidth">
<short>Gets the value for the DesktopWidth property.</short>
<descr/>
<seealso>
<link id="TScreen.DesktopWidth"/>
</seealso>
</element>
<element name="TScreen.GetDesktopWidth.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetDesktopRect">
<short>Gets the value for the DesktopRect property.</short>
<descr/>
<seealso>
<link id="TScreen.DesktopRect"/>
</seealso>
</element>
<element name="TScreen.GetDesktopRect.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetFonts">
<short>Gets the value for the Fonts property.</short>
<descr/>
<seealso>
<link id="TScreen.Fonts"/>
</seealso>
</element>
<element name="TScreen.GetFonts.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetFormCount">
<short>Gets the value for the GetFormCount property.</short>
<descr/>
<seealso>
<link id="TScreen.FormCount"/>
</seealso>
</element>
<element name="TScreen.GetFormCount.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetForms">
<short>Gets the value for the indexed Forms property.</short>
<descr/>
<seealso>
<link id="TScreen.Forms"/>
</seealso>
</element>
<element name="TScreen.GetForms.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetForms.Index">
<short>Ordinal position for the form instance in the property value.</short>
</element>
<element name="TScreen.GetHeight">
<short>Gets the value for the Height property.</short>
<descr>
<p>
Calls <var>GetSystemMetrics</var> to get the value for the property.
</p>
</descr>
<seealso>
<link id="TScreen.Height"/>
</seealso>
</element>
<element name="TScreen.GetHeight.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetMonitor" link="#lcl.forms.TScreen.Monitors"/>
<element name="TScreen.GetMonitor.Result">
<short/>
</element>
<element name="TScreen.GetMonitor.Index">
<short/>
</element>
<element name="TScreen.GetMonitorCount" link="#lcl.forms.TScreen.MonitorCount"/>
<element name="TScreen.GetMonitorCount.Result">
<short/>
</element>
<element name="TScreen.GetPrimaryMonitor" link="#lcl.forms.TScreen.PrimaryMonitor"/>
<element name="TScreen.GetPrimaryMonitor.Result">
<short/>
</element>
<element name="TScreen.GetWidth" link="#lcl.forms.TScreen.Width"/>
<element name="TScreen.GetWidth.Result">
<short/>
</element>
<element name="TScreen.AddForm">
<short>Internal notification handler, adds a new form to the lists.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.AddForm.AForm">
<short>Form instance added in the method.</short>
</element>
<element name="TScreen.RemoveForm">
<short>Internal notification handler, removes the form from the lists.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.RemoveForm.AForm">
<short>Form instance removed from the list.</short>
</element>
<element name="TScreen.SetFocusedForm" link="#lcl.forms.TScreen.FocusedForm"/>
<element name="TScreen.SetFocusedForm.Result">
<short/>
</element>
<element name="TScreen.SetFocusedForm.AForm">
<short/>
</element>
<element name="TScreen.SetCursor" link="#lcl.forms.TScreen.Cursor"/>
<element name="TScreen.SetCursor.AValue">
<short/>
</element>
<element name="TScreen.SetCursors" link="#lcl.forms.TScreen.Cursors"/>
<element name="TScreen.SetCursors.AIndex">
<short/>
</element>
<element name="TScreen.SetCursors.AValue">
<short/>
</element>
<element name="TScreen.SetHintFont" link="#lcl.forms.TScreen.HintFont"/>
<element name="TScreen.SetHintFont.AValue">
<short/>
</element>
<element name="TScreen.SetIconFont" link="#lcl.forms.TScreen.IconFont"/>
<element name="TScreen.SetIconFont.AValue">
<short/>
</element>
<element name="TScreen.SetMenuFont" link="#lcl.forms.TScreen.MenuFont"/>
<element name="TScreen.SetMenuFont.AValue">
<short/>
</element>
<element name="TScreen.SetSystemFont" link="#lcl.forms.TScreen.SystemFont"/>
<element name="TScreen.SetSystemFont.AValue">
<short/>
</element>
<element name="TScreen.UpdateLastActive">
<short>
Stores the currently active form and control in the last active members.
Notifies all registered handlers of eventual changes.
</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.RestoreLastActive">
<short>Moves the Focus back to the previously focused control.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.AddHandler">
<short>
Adds a handler routine to the list for the specified handler type.
</short>
<descr>
<p>
<var>AddHandler</var> is a procedure used to add a screen notification handler to the list of handlers in the TScreen instance.
</p>
<p>
<var>HandlerType</var> is a <var>TScreenNotification</var> enumeration value that defines the situation(s) where the screen handler can be executed. See TScreenNotification for more information about values in the enumeration.
</p>
<p>
<var>Handler</var> is a <var>TMethod</var> record with pointers to the code and optional data executed when the handler is invoked.
</p>
<p>
<var>AsFirst</var> indicates if the handler should be inserted as the initial handler in the method list (when <b>True</b>), or appended to the end of the list (when <b>False</b>).
</p>
<p>
AddHandler calls <var>RaiseGDBException</var> to raise an exception when the pointer to the Code in Handler has not been assigned.
</p>
<p>
AddHandler ensures that a <var>TMethodList</var> exists for handlers using the value in HandlerType, and calls the <var>Add</var> method in the <var>TMethodList</var> to store the Handler at the position needed for AsFirst.
</p>
<p>
AddHandler is called from the implementation of more specialized methods like AddHandlerFormAdded, AddHandlerRemoveForm, AddHandlerActiveControlChanged, AddHandlerActiveFormChanged, and AddHandlerFormVisibleChanged.
</p>
</descr>
<seealso>
<link id="TScreen.AddHandlerFormAdded"/>
<link id="TScreen.AddHandlerActiveControlChanged"/>
<link id="TScreen.AddHandlerActiveFormChanged"/>
<link id="TScreen.AddHandlerFormVisibleChanged"/>
<link id="TScreen.AddHandlerRemoveForm"/>
<link id="TScreenNotification"/>
</seealso>
</element>
<element name="TScreen.AddHandler.HandlerType">
<short>The handler type where the routine is stored.</short>
</element>
<element name="TScreen.AddHandler.Handler">
<short>The handler routine added in the method.</short>
</element>
<element name="TScreen.AddHandler.AsFirst">
<short>
Add the handler as the first (True) or last (False) handler in the internal list.
</short>
</element>
<element name="TScreen.RemoveHandler">
<short>
Removes a screen notification handler with the specified type.
</short>
<descr/>
<seealso>
<link id="TScreenNotificationAddHandler"/>
</seealso>
</element>
<element name="TScreen.RemoveHandler.HandlerType">
<short>The screen notification (event) type.</short>
</element>
<element name="TScreen.RemoveHandler.Handler">
<short>The screen notification handler removed in the method.</short>
</element>
<element name="TScreen.DoAddDataModule">
<short>
Adds the specified data module to the internal list for the screen.
</short>
<descr/>
<seealso>
<link id="TScreen.DataModules"/>
</seealso>
</element>
<element name="TScreen.DoAddDataModule.DataModule">
<short>Data module instance added in the method.</short>
</element>
<element name="TScreen.DoRemoveDataModule">
<short>Removes the specified data module from the internal list.</short>
<descr/>
<seealso>
<link id="TScreen.DataModules"/>
</seealso>
</element>
<element name="TScreen.DoRemoveDataModule.DataModule">
<short>Data module removed in the method.</short>
</element>
<element name="TScreen.NotifyScreenFormHandler">
<short>
Notifies all registered handlers for the given event type.
</short>
<descr>
<p>
<var>NotifyScreenFormHandler</var> retrieves the internal <var>TMethodList</var> instance used for handler routines with the type specified in <var>HandlerType</var>. Each of the <var>TScreenFormEvent</var> instances is signalled using the current class (Self) and Form as arguments.
</p>
<p>
NotifyScreenFormHandler is called from methods in TScreen like AddForm, RemoveForm, and UpdateLastActive. It is also called (via the Screen singleton) from the VisibleChanged method in TCustomForm.
</p>
</descr>
<seealso>
<link id="TScreen.AddForm"/>
<link id="TScreen.RemoveForm"/>
<link id="TScreen.UpdateLastActive"/>
<link id="TCustomForm.VisibleChanged"/>
<link id="TScreenFormEvent"/>
<link id="TScreenNotification"/>
<link id="#lazutils.lazmethodlist.TMethodList">TMethodList</link>
</seealso>
</element>
<element name="TScreen.NotifyScreenFormHandler.HandlerType">
<short>Form event type for the notification.</short>
</element>
<element name="TScreen.NotifyScreenFormHandler.Form">
<short>Form instance for the notification.</short>
</element>
<element name="TScreen.GetWorkAreaHeight" link="#lcl.forms.TScreen.WorkAreaHeight"/>
<element name="TScreen.GetWorkAreaHeight.Result">
<short/>
</element>
<element name="TScreen.GetWorkAreaLeft" link="#lcl.forms.TScreen.WorkAreaLeft"/>
<element name="TScreen.GetWorkAreaLeft.Result">
<short/>
</element>
<element name="TScreen.GetWorkAreaRect" link="#lcl.forms.TScreen.WorkAreaRect"/>
<element name="TScreen.GetWorkAreaRect.Result">
<short/>
</element>
<element name="TScreen.GetWorkAreaTop" link="#lcl.forms.TScreen.WorkAreaTop"/>
<element name="TScreen.GetWorkAreaTop.Result">
<short/>
</element>
<element name="TScreen.GetWorkAreaWidth" link="#lcl.forms.TScreen.WorkAreaWidth"/>
<element name="TScreen.GetWorkAreaWidth.Result">
<short/>
</element>
<element name="TScreen.GetHintFont">
<short>Gets the value for the HintFont property.</short>
<descr>
<p>
Ensures that a TFont instance exists for the member, that it has been initialized to the stock hint font for the WidgetSet class, or uses the default font and the color in clInfoText.
</p>
</descr>
<seealso>
<link id="TScreen.HintFont"/>
</seealso>
</element>
<element name="TScreen.GetHintFont.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetIconFont">
<short>Gets the value for the IconFont property.</short>
<descr>
<p>
Ensures that a TFont instance exists for the member, that it has been initialized to the stock icon font for the WidgetSet class, or uses the default font and the color in clDefault or clWindowText (depends on the UseCLDefault define for the platform).
</p>
</descr>
<seealso>
<link id="TScreen.IconFont"/>
</seealso>
</element>
<element name="TScreen.GetIconFont.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetMenuFont">
<short>Gets the value for the MenuFont property.</short>
<descr/>
<seealso>
<link id="TScreen.MenuFont"/>
</seealso>
</element>
<element name="TScreen.GetMenuFont.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.GetSystemFont">
<short>Gets the value for the SystemFont property.</short>
<descr/>
<seealso>
<link id="TScreen.SystemFont"/>
</seealso>
</element>
<element name="TScreen.GetSystemFont.Result">
<short>Value for the property.</short>
</element>
<element name="TScreen.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method on entry.
</p>
<p>
Create allocates resources needed for properties, including: <var>Fonts</var>, <var>Monitors</var>, <var>CustomForms</var>, <var>CustomFormsZOrdered</var>, and
<var>DataModules</var>. Resources for internal members are also allocated.
</p>
<p>
Create gets the default value used for the <var>PixelsPerInch</var> property from the <var>ScreenInfo</var> variable in the LCL interface.
</p>
<p>
Create assigns methods in the class instance as the routines used by the Lazarus IDE to provide support for data modules. Create assigns the routine used to get system fonts for the application.
</p>
</descr>
<seealso>
<link id="TScreen.Destroy"/>
</seealso>
</element>
<element name="TScreen.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TScreen.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy ensures that screen handlers registered using <var>AddHandler</var> are freed. Destroy also frees resource allocated for the class instance in the <var>Create</var> constructor. It calls the inherited method prior to exit.
</p>
</descr>
<seealso>
<link id="TScreen.Create"/>
</seealso>
</element>
<element name="TScreen.CustomFormIndex">
<short>Gets the ordinal position in CustomForms for the requested form.</short>
<descr>
<p>
<var>CustomFormIndex</var> is an <var>Integer</var> function used to get the position in <var>CustomForms</var> for the specified <var>TCustomForm</var> instance. It iterates over the values in CustomForms in reverse order. The return value contains the ordinal position in CustomForms where the TCustomForm instance in <var>AForm</var> was found, or -1 when AForm does not exist in CustomForms.
</p>
<p>
Use the <var>FormIndex</var> method to locate a form instance derived from <var>TForm</var> in the <var>Forms</var> property.
</p>
</descr>
<seealso>
<link id="TScreen.CustomForms"/>
<link id="TScreen.Forms"/>
<link id="TScreen.FormIndex"/>
</seealso>
</element>
<element name="TScreen.CustomFormIndex.Result">
<short>The ordinal position for the form in CustomForms, or -1 when not found.</short>
</element>
<element name="TScreen.CustomFormIndex.AForm">
<short>The form instance to locate in CustomForms.</short>
</element>
<element name="TScreen.FormIndex">
<short>Gets the ordinal position in Forms for the requested form.</short>
<descr>
<p>
<var>FormIndex</var> is an <var>Integer</var> function used to get the position in <var>Forms</var> where the specified <var>TForm</var> instance in located. It iterates over the values in Forms in reverse order. The return value contains the ordinal position in Forms where the TForm instance in <var>AForm</var> was found, or -1 when AForm does not exist in Forms.
</p>
<p>
Use the <var>CustomFormIndex</var> method to locate a form instance derived from <var>TCustomForm</var> in the <var>CustomForms</var> property.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.FormIndex.Result">
<short>
Ordinal position in Forms for the TForm instance, or -1 when not found.
</short>
</element>
<element name="TScreen.FormIndex.AForm">
<short>The TForm instance to locate in Forms.</short>
</element>
<element name="TScreen.CustomFormZIndex">
<short>
Gets the position in CustomFormsZOrdered for the specified form.
</short>
<descr>
<p>
The return value contains the z-order for the specified form, with the currently active form at index position zero (<b>0</b>).
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.CustomFormZIndex.Result">
<short/>
</element>
<element name="TScreen.CustomFormZIndex.AForm">
<short>Form instance to locate in CustomFormsZOrdered.</short>
</element>
<element name="TScreen.MoveFormToFocusFront">
<short>Moves the specified form to the front of all other forms.</short>
<descr>
<p>
<var>MoveFormToFocusFront</var> is a method used to move the form specified in <var>ACustomForm</var> to the top of the Z-order. This means that it appears on top of all other visible forms for the application.
</p>
<p>
MoveFormToFocusFront is called when the focused control is changed in the <var>TCustomForm</var> instance. It is also called from the <var>ShowModal</var> method in TCustomForm.
</p>
<p>
It ensures that ACustomForm is moved to the first position in <var>CustomForms</var> (the top of the Z-order). When ACustomForm is a <var>TForm</var> instance, it is also moved to the first position in the <var>Forms</var> property. Calls <var>MoveFormToZFront</var> to ensure that the form is moved to the first position in the <var>CustomFormsZOrdered</var> property.
</p>
</descr>
<errors>
Raises a catchable GDB exception if the form or screen classes are being destroyed, or when ACustomForm is not assigned or not present in the CustomForms property.
</errors>
<seealso/>
</element>
<element name="TScreen.MoveFormToFocusFront.ACustomForm">
<short>Form instance to move to the top of the Z-order.</short>
</element>
<element name="TScreen.MoveFormToZFront">
<short>
Moves the form to the front of the Z-order in the CustomFormsZOrdered property.
</short>
<descr>
<p>
<var>MoveFormToZFront</var> is a method used to ensure that the form in <var>ACustomForm</var> is at the top of the Z-order in the <var>CustomFormsZOrdered</var> property. MoveFormToZFront is called from the <var>MoveFormToFocusFront</var> method.
</p>
</descr>
<errors>
Raises a GDB exception when the form is being destroyed, or the application is shutting down.
</errors>
<seealso>
<link id="TScreen.MoveFormToFocusFront"/>
</seealso>
</element>
<element name="TScreen.MoveFormToZFront.ACustomForm">
<short>Form instance to move to the top of the Z-order.</short>
</element>
<element name="TScreen.GetCurrentModalForm">
<short>
Returns the Modal form at the top of the Z-order for the screen.
</short>
<descr>
<p>
Calls <var>GetCurrentModalFormZIndex</var> to find the first form instance in <var>CustomFormsZOrdered</var> with the value <var>fsModal</var> in its <var>FormState</var> property.
</p>
</descr>
<seealso>
<link id="TCustomForm.FormState"/>
<link id="TFormState"/>
</seealso>
</element>
<element name="TScreen.GetCurrentModalForm.Result">
<short>The modal form, or Nil if a modal form is not active.</short>
</element>
<element name="TScreen.GetCurrentModalFormZIndex">
<short>Returns the index of the top-most modal form in CustomFormsZOrdered.</short>
<descr>
<p>
Visits the form instances in <var>CustomFormsZOrdered</var> to find the first <var>TCustomForm</var> instance with the value <var>fsModal</var> in its <var>FormState</var> property.
</p>
<p>
Returns <b>-1</b> if a modal form is not found in the CustomFormsZOrdered property.
</p>
<p>
Called from the <var>GetCurrentModalForm</var> method.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.GetCurrentModalFormZIndex.Result">
<short>The index for the form, or -1 if no modal form is active.</short>
</element>
<element name="TScreen.CustomFormBelongsToActiveGroup">
<short>
Checks whether the specified form is present in the Z-ordered list of forms.
</short>
<descr>
<p>
The return value is <b>True</b> when <var>ACustomForm</var> is found in the <var>CustomFormsZOrdered</var> property and is not displayed as a modal form (<var>FormState</var> contains <var>fsModal</var>). The return value is <b>False</b> if ACustomForm is not found in CustomFormsZOrdered.
</p>
<p>
Used in widgetset classes to determine if a form is used and enabled on the screen.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.CustomFormBelongsToActiveGroup.Result">
<short>True if the form is used on the screen.</short>
</element>
<element name="TScreen.CustomFormBelongsToActiveGroup.AForm">
<short>Form instance to locate in the Z-ordered forms for the screen.</short>
</element>
<element name="TScreen.FindNonDesignerForm">
<short>Finds the form with the specified name, excluding designer forms.</short>
<descr>
<p>
Used when an Application loads its components using the LCL streaming mechanism. Ignores the designer forms and data modules (where ComponentState contains csDesigning) handled by the Lazarus IDE.
</p>
</descr>
<seealso>
<link id="TScreen.FindForm"/>
</seealso>
</element>
<element name="TScreen.FindNonDesignerForm.Result">
<short>Application form instance in CustomForms with the specified name, or Nil.</short>
</element>
<element name="TScreen.FindNonDesignerForm.FormName">
<short>Name of the form to locate in the method.</short>
</element>
<element name="TScreen.FindForm">
<short>Finds a form on the screen by its name.</short>
<descr>
<p>
Visits the form instances in the CustomForms property, and compares the text in the Name properties to the value in FormName. CompareText is called to perform a case-insensitive comparison for the values.
</p>
<p>
The return value is the TCustomForm instance which matches the name in FormName, or Nil when CustomFormCount is 0 or FormName is not found in CustomForms.
</p>
</descr>
<seealso>
<link id="TScreen.FindNonDesignerForm"/>
</seealso>
</element>
<element name="TScreen.FindForm.Result">
<short>Form instance with the specified name, or Nil.</short>
</element>
<element name="TScreen.FindForm.FormName">
<short>Name for the form to locate in the method.</short>
</element>
<element name="TScreen.FindNonDesignerDataModule">
<short>
Finds a data module with the specified name, excluding designer data modules.
</short>
<descr>
<p>
Visits the data module instances in the internal list, and compares the Name property for the TDataModule instances to the value in DataModuleName. CompareText text is called to perform a case-insensitive comparison for the values. TDataModule instances with csDesigning in the ComponentState property are ignored; these are design-time data modules used by the Lazarus IDE.
</p>
<p>
The return value contains the TDataModule instance with the name in DataModuleName, or Nil when the data module list is empty or the name in DataModuleName is not found in the list.
</p>
<p>
Used when an Application loads its components using the LCL streaming mechanism. Ignores the designer forms and data modules (where ComponentState contains csDesigning) handled by the Lazarus IDE.
</p>
</descr>
<seealso>
<link id="TScreen.FindDataModule"/>
</seealso>
</element>
<element name="TScreen.FindNonDesignerDataModule.Result">
<short>Data module with the specified name, or Nil.</short>
</element>
<element name="TScreen.FindNonDesignerDataModule.DataModuleName">
<short>Name of the data module to locate in the method.</short>
</element>
<element name="TScreen.FindDataModule">
<short>Finds the data module with the specified name.</short>
<descr>
<p>
<var>FindDataModule</var> is a <var>TDataModule</var> function used to get the data module with the name specified in <var>DataModuleName</var>.
</p>
<p>
FindDataModule visits each of the data modules in the internal list to find the TDataModule instance with the specified name in its <var>Name</var> property. <var>CompareText</var> is called to perform a case-insensitive comparison for the values.
</p>
<p>
The return value is the TDataModule instance with the name in DataModuleName, or <b>Nil</b> when the internal list is empty or DataModuleName is not found in the list.
</p>
</descr>
<seealso>
<link id="TScreen.FindNonDesignerDataModule"/>
</seealso>
</element>
<element name="TScreen.FindDataModule.Result">
<short>TDataModule instance with the specified name, or Nil.</short>
</element>
<element name="TScreen.FindDataModule.DataModuleName">
<short>Name for the data module to locate in the method.</short>
</element>
<element name="TScreen.UpdateMonitors">
<short>Rebuilds the list of available monitors.</short>
<descr>
<p>
Calls <var>DestroyMonitors</var> to clear existing <var>TMonitor</var> instances in the <var>Monitors</var> property. Calls <var>EnumDisplayMonitors</var> in the LCL interface to create and store TMonitor instances in the Monitors property.
</p>
<p>
UpdateMonitors is called when the private <var>UpdatedMonitor</var> function needs to access information for a monitor using its <var>Handle</var>. It is also called when the value for the <var>Monitor</var> or <var>MonitorCount</var> property is read.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.UpdateScreen">
<short>Updates the value for the PixelsPerInch property.</short>
<descr>
<p>
Updates the value for the <var>PixelsPerInch</var> property from the ScreenInfo in the LCL interface.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.RemoveAllHandlersOfObject">
<short>
Removes all handler routines for the specified object regardless of notification type.
</short>
<descr>
<p>
<var>RemoveAllHandlersOfObject</var> is a method used to remove all handler routines for the specified object, regardless of the <var>TScreenNotification</var> type. RemoveAllHandlersOfObject iterates over the method lists in the internal array, and calls the <var>RemoveAllMethodsOfObject</var> method for the object instance specified in <var>AnObject</var>. It calls the virtual inherited method prior to exit.
</p>
<p>
Called when the Lazarus IDE is terminated.
</p>
</descr>
<seealso>
<link id="TScreenNotification"/>
<link id="#lazutils.lazmethodlist.TMethodList.RemoveAllMethodsOfObject">TMethodList.RemoveAllMethodsOfObject</link>
<link id="#lcl.lclclasses.TLCLComponent.RemoveAllHandlersOfObject">TLCLComponent.RemoveAllHandlersOfObject</link>
</seealso>
</element>
<element name="TScreen.RemoveAllHandlersOfObject.AnObject">
<short>
Object instance with the handlers removed in the method.
</short>
</element>
<element name="TScreen.AddHandlerFormAdded">
<short>
Adds a form added notification handler to the class instance.
</short>
<descr/>
<seealso>
<link id="TScreen.RemoveHandlerFormAdded"/>
<link id="TScreenFormEvent"/>
</seealso>
</element>
<element name="TScreen.AddHandlerFormAdded.OnFormAdded">
<short>Routine added as the form added notification handler.</short>
</element>
<element name="TScreen.AddHandlerFormAdded.AsFirst">
<short>
True when OnFormAdded should be the first entry in the list of handlers for the type.
</short>
</element>
<element name="TScreen.RemoveHandlerFormAdded">
<short>Removes a form added notification handler.</short>
<descr/>
<seealso>
<link id="TScreen.AddHandlerFormAdded"/>
<link id="TScreenFormEvent"/>
</seealso>
</element>
<element name="TScreen.RemoveHandlerFormAdded.OnFormAdded">
<short>Form added handler removed in the method.</short>
</element>
<element name="TScreen.AddHandlerRemoveForm">
<short>Adds a form removed notification handler.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.AddHandlerRemoveForm.OnRemoveForm">
<short>Form remove handler added in the method.</short>
</element>
<element name="TScreen.AddHandlerRemoveForm.AsFirst">
<short>True if the handler should be stored as the first routine for the type.</short>
</element>
<element name="TScreen.RemoveHandlerRemoveForm">
<short>Removes a from removed notification handler.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.RemoveHandlerRemoveForm.OnRemoveForm">
<short>Form remove handler routine removed in the method.</short>
</element>
<element name="TScreen.AddHandlerActiveControlChanged">
<short>Adds a control changed notification handler.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.AddHandlerActiveControlChanged.OnActiveControlChanged">
<short>Active control changed notification handler added in the method.</short>
</element>
<element name="TScreen.AddHandlerActiveControlChanged.AsFirst">
<short>True if the handler should be the first in the list for the type.</short>
</element>
<element name="TScreen.RemoveHandlerActiveControlChanged">
<short>Removes a control changed notification handler.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.RemoveHandlerActiveControlChanged.OnActiveControlChanged">
<short>Active control changed handler removed in the method.</short>
</element>
<element name="TScreen.AddHandlerActiveFormChanged">
<short>Adds a form changed notification handler.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.AddHandlerActiveFormChanged.OnActiveFormChanged">
<short>Active form changed handler added in the method.</short>
</element>
<element name="TScreen.AddHandlerActiveFormChanged.AsFirst">
<short>True if the handler should be the first in the list for the type.</short>
</element>
<element name="TScreen.RemoveHandlerActiveFormChanged">
<short>Removes a form changed notification handler.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.RemoveHandlerActiveFormChanged.OnActiveFormChanged">
<short>Active form changed handler removed in the method.</short>
</element>
<element name="TScreen.AddHandlerFormVisibleChanged">
<short>Adds a visible changed notification handler.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.AddHandlerFormVisibleChanged.OnFormVisibleChanged">
<short>Form visible changed handler added in the method.</short>
</element>
<element name="TScreen.AddHandlerFormVisibleChanged.AsFirst">
<short>True if the handler should be the first in the list for the type.</short>
</element>
<element name="TScreen.RemoveHandlerFormVisibleChanged">
<short>Removes a visible changed notification handler.</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.RemoveHandlerFormVisibleChanged.OnFormVisibleChanged">
<short>From visible changed handler removed in the method.</short>
</element>
<element name="TScreen.DisableForms">
<short>
Disables all forms except for <var>SkipForm</var>.
</short>
<descr>
<p>
Used to disable forms when a modal form or dialog is displayed.
</p>
<p>
The enabled state for forms is determined by the widgetset class, and not from LCL properties. If <var>DisabledList</var> is Nil, a new list is created. All forms disabled in the method are added to the list. When the modal form returns, EnableForms is called to restore the list of forms disabled in the method.
</p>
</descr>
<seealso>
<link id="TScreen.EnableForms"/>
</seealso>
</element>
<element name="TScreen.DisableForms.Result">
<short>The list containing all disabled forms.</short>
</element>
<element name="TScreen.DisableForms.SkipForm">
<short>Don't disable this form (ignored if Nil).</short>
</element>
<element name="TScreen.DisableForms.DisabledList">
<short>The list to update. If Nil, a new list is created and returned.</short>
</element>
<element name="TScreen.EnableForms">
<short>
Re-enables forms disabled in the DisableForms method.
</short>
<descr>
<p>
Use this method to restore all <link id="TScreen.DisableForms">previously disabled</link> forms.
</p>
</descr>
<seealso>
<link id="TScreen.DisableForms"/>
</seealso>
</element>
<element name="TScreen.EnableForms.AFormList">
<short>
The list containing the forms to enable. The list is destroyed on exit.
</short>
</element>
<element name="TScreen.MonitorFromPoint">
<short>
Finds the monitor containing the given screen coordinates.
</short>
<descr>
<p>
<var>MonitorFromPoint</var> is a <var>TMonitor</var> function used to get the monitor with the coordinates in the <var>Point</var> argument.
</p>
<p>
<var>MonitorDefault</var> is a <var>TMonitorDefaultTo</var> enumeration value which indicates which monitor to use when the coordinates in Point cannot be located on a screen. See TMonitorDefaultTo for more information about the enumeration values and their meanings.
</p>
<p>
MonitorFromPoint calls the corresponding method in the widgetset class to get the <var>Handle</var> for the monitor. Values in the <var>Monitors</var> property are checked for the Handle, and the return value is set to the TMonitor instance with the given Handle.
</p>
<p>
If the Handle is <b>-1</b> (<var>MONITOR_UNIMPL</var>), the <var>MonitorFromRect</var> method is called to locate a monitor with the origin in Point. Otherwise, the values in Monitors are refreshed to ensure that existing monitors and their handles are up-to-date in the class instance.
</p>
<p>
MonitorFromPoint is called from the <var>GetMonitor</var> method in <var>TCustomForm</var>, and the <var>AdjustBoundsForMonitor</var> method in <var>THintWindow</var>.
</p>
</descr>
<seealso>
<link id="TScreen.MonitorFromRect"/>
</seealso>
</element>
<element name="TScreen.MonitorFromPoint.Result">
<short>The monitor where the coordinates are located.</short>
</element>
<element name="TScreen.MonitorFromPoint.Point">
<short>The screen coordinates used to find a monitor.</short>
</element>
<element name="TScreen.MonitorFromPoint.MonitorDefault">
<short>Monitor returned when the coordinates are not found on a monitor.</short>
</element>
<element name="TScreen.MonitorFromRect">
<short>Finds the monitor where the specified rectangle is located.</short>
<descr>
<p>
<var>MonitorFromRect</var> is a <var>TMonitor</var> function used to get the monitor where the coordinates in the specified rectangle are located.
</p>
<p>
<var>MonitorDefault</var> is a <var>TMonitorDefaultTo</var> enumeration value which indicates the monitor used when the coordinates in Rect are not found on a monitor. See TMonitorDefaultTo for more information about the values in the enumeration and their meanings.
</p>
<p>
MonitorFromRect calls the corresponding method in the widgetset class to get the <var>Handle</var> for the monitor where <var>Rect</var> is located. It searches <var>Monitors</var> for the <var>TMonitor</var> instance with the Handle value, and uses the TMonitor instance when the Handle is found. The <var>UpdatedMonitor</var> method is called to ensure that the value in Monitors are up-to-date.
</p>
<p>
When the Handle contains <b>-1</b> (<var>MONITOR_UNIMPL</var>), the value in MonitorDefault us used to locate a monitor which intersects the coordinates in Rect. The return value is set to the TMonitor instance in Monitors which corresponds to the value in MonitorDefault. If a monitor is not found, the return value is set to PrimaryMonitor or the closest match as needed for MonitorDefault.
</p>
</descr>
<seealso>
<link id="TScreen.MonitorFromPoint"/>
</seealso>
</element>
<element name="TScreen.MonitorFromRect.Result">
<short>The TMonitor instance where the rectangle is located.</short>
</element>
<element name="TScreen.MonitorFromRect.Rect">
<short>Rectangle with the screen coordinates to locate in the method.</short>
</element>
<element name="TScreen.MonitorFromRect.MonitorDefault">
<short>Monitor use when the specified rectangle is not found on a monitor.</short>
</element>
<element name="TScreen.MonitorFromWindow">
<short>
Finds the monitor containing the form with the given window handle.
</short>
<descr>
<p>
MonitorFromWindow is a TMonitor function used to locate monitor where the form represented by the specified window Handle is displayed.
</p>
<p>
<var>MonitorDefault</var> is a <var>TMonitorDefaultTo</var> enumeration value which indicates the monitor used when the display area for the form is not found on a monitor. See TMonitorDefaultTo for more information about the values in the enumeration and their meanings.
</p>
<p>
MonitorFromWindow calls MonitorFromWindow in the widgetset class to get a monitor handle used to locate the monitor in the Monitors property. The UpdatedMonitor method is called to ensure that Monitors contains up-to-date values for the available monitors.
</p>
<p>
If a monitor with the Handle is not found, GetWindowRect is called to get the display areas for the monitor Handle. MonitorFromRect is called to locate the monitor which contains the rectangle.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.MonitorFromWindow.Result">
<short>The monitor found.</short>
</element>
<element name="TScreen.MonitorFromWindow.Handle">
<short>The window handle to use.</short>
</element>
<element name="TScreen.MonitorFromWindow.MonitorDefault">
<short>What to return when no monitor was found.</short>
</element>
<element name="TScreen.BeginTempCursor">
<short>
Sets the Cursor property to a temporary shape. Use EndTempCursor to release it.
</short>
<descr>
<p>
<var>BeginTempCursor</var> is a method used to change the mouse cursor shape to the temporary cursor in the <var>ACursor</var> argument. It adds the value in ACursor to an internal list of temporary cursors. The cursor shape is removed when the <var>EndTempCursor</var> method is called.
</p>
<p>
BeginTempCursor calls <var>SetCursor</var> in the widgetset class to change the mouse cursor shape to the value in <var>Cursors</var> stored at the index in ACursor.
</p>
<p>
Use EndTempCursor to remove a given cursor shape, and restore the mouse cursor to a previous value.
</p>
</descr>
<seealso>
<link id="TScreen.EndTempCursor"/>
<link id="TScreen.BeginScreenCursor"/>
<link id="TScreen.EndScreenCursor"/>
<link id="TScreen.BeginWaitCursor"/>
<link id="TScreen.EndWaitCursor"/>
<link id="TScreen.Cursors"/>
<link id="#lcl.controls.TCursor">TCursor</link>
</seealso>
</element>
<element name="TScreen.BeginTempCursor.aCursor">
<short>Identifies the temporary mouse cursor shape to apply to the screen.</short>
</element>
<element name="TScreen.EndTempCursor">
<short>Releases a temporary mouse cursor set with BeginTempCursor.</short>
<descr>
<p>
<var>EndTempCursor</var> is a method used to release the temporary cursor shape in <var>ACursor</var>. It removes the value from the internal list of temporary cursors updated in the <var>BeginTempCursor</var> method. Only the cursor shape in ACursor is removed from the list; other values are left intact.
</p>
<p>
EndTempCursor calls <var>SetCursor</var> in the widgetset class to apply the cursor shape in <var>RealCursor</var>.
</p>
<p>
An <var>Exception</var> is raised with the message 'Unbalanced BeginTempCursor/EndTempCursor calls for cursor' if ACursor is not found in the list of temporary cursors.
</p>
<p>
Use BeginTempCursor to display and store a temporary mouse cursor shape.
</p>
</descr>
<errors>
Raises an Exception with the message 'Unbalanced BeginTempCursor/EndTempCursor calls for cursor' if ACursor is not found in the list of temporary cursors.
</errors>
<seealso>
<link id="TScreen.RealCursor"/>
<link id="TScreen.Cursors"/>
<link id="TScreen.BeginTempCursor"/>
<link id="TScreen.BeginScreenCursor"/>
<link id="TScreen.EndScreenCursor"/>
<link id="TScreen.BeginWaitCursor"/>
<link id="TScreen.EndWaitCursor"/>
<link id="#lcl.controls.TCursor">TCursor</link>
</seealso>
</element>
<element name="TScreen.EndTempCursor.aCursor">
<short>Identifies the cursor shape released in the method.</short>
</element>
<element name="TScreen.BeginWaitCursor">
<short>Sets the cursor to the shape in crHourGlass.</short>
<descr>
<p>
Calls <var>BeginTempCursor</var> using the cursor shape in <var>crHourGlass</var>.
</p>
</descr>
<seealso>
<link id="TScreen.BeginTempCursor"/>
<link id="TScreen.BeginScreenCursor"/>
<link id="#lcl.controls.crHourGlass">crHourGlass</link>
<link id="#lcl.controls.TCursor">TCursor</link>
</seealso>
</element>
<element name="TScreen.EndWaitCursor">
<short>Removes the crHourGlass mouse cursor shape.</short>
<descr>
<p>
Calls <var>EndTempCursor</var> to remove the <var>crHourGlass</var> mouse cursor shape.
</p>
</descr>
<seealso>
<link id="TScreen.EndTempCursor"/>
<link id="#lcl.controls.crHourGlass">crHourGlass</link>
<link id="#lcl.controls.TCursor">TCursor</link>
</seealso>
</element>
<element name="TScreen.BeginScreenCursor">
<short>Changes the active cursor to the most recent shape in the internal list of cursors.</short>
<descr>
<p>
Calls the BeginTempCursor method using the mouse cursor shape currently assigned to the internal member for the screen.
</p>
<p>
Use EndScreenCursor to revert the mouse cursor shape to the value on entry to the method.
</p>
</descr>
<seealso>
<link id="TScreen.EndScreenCursor"/>
<link id="TScreen.BeginTempCursor"/>
<link id="TScreen.EndTempCursor"/>
</seealso>
</element>
<element name="TScreen.EndScreenCursor">
<short>
Removes the current mouse cursor shape from the internal list, and restores the previous cursor shape.
</short>
<descr>
<p>
Calls the EndTempCursor method to remove the current mouse cursor shape from the internal list of cursors. The most recent cursor shape in the internal list is restored when it differs from the value assigned to Cursor.
</p>
<p>
Use BeginScreenCursor to make the value in Cursor the current cursor shape for the screen.
</p>
</descr>
<seealso>
<link id="TScreen.BeginScreenCursor"/>
<link id="TScreen.BeginTempCursor"/>
<link id="TScreen.EndTempCursor"/>
</seealso>
</element>
<element name="TScreen.ActiveControl">
<short>The control which has the focus on the active form for the screen.</short>
<descr>
<p>
<var>ActiveControl</var> is a read-only <var>TWinControl</var> property which indicates the form or control that has focus on the screen, and gets input entered using the keyboard. The property value is updated when the <var>SetFocusedControl</var> method in <var>TCustomForm</var> sets the active control for the form and calls the <var>UpdateLastActive</var> method for the screen.
</p>
</descr>
<seealso>
<link id="TScreen.ActiveForm"/>
<link id="TScreen.ActiveCustomForm"/>
<link id="#lcl.forms.TCustomForm.SetFocusedControl">TCustomForm.SetFocusedControl</link>
</seealso>
</element>
<element name="TScreen.ActiveCustomForm">
<short>The TCustomForm instance which has the focus.</short>
<descr>
<p>
<var>ActiveCustomForm</var> is a read-only <var>TCustomForm</var> property which contains the active custom form instance which has focus on the screen. The property value is updated in TCustomForm methods like <var>SetFocusedControl</var> and <var>MoveToDefaultPosition</var>. It is also updated in <var>TApplication</var> methods like <var>ControlDestroyed</var>.
</p>
<p>
Use <var>ActiveForm</var> to get the <var>TForm</var> instance that has focus on the screen.
</p>
</descr>
<seealso>
<link id="TScreen.ActiveForm"/>
<link id="TScreen.ActiveControl"/>
<link id="TCustomForm.SetFocusedControl"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
<link id="TApplication.ControlDestroyed"/>
</seealso>
</element>
<element name="TScreen.ActiveForm">
<short>The TForm instance which has the focus.</short>
<descr>
<p>
<var>ActiveForm</var> is a read-only <var>TForm</var> property which contains the form instance in the application which has focus on the screen. The property value is updated from methods in <var>TCustomForm</var> like <var>SetFocusedControl</var> and <var>MoveToDefaultPosition</var>. It is also updated from methods in TApplication like <var>ControlDestroyed</var>.
</p>
<p>
Use <var>ActiveCustomForm</var> to get a form instance derived from <var>TCustomForm</var>, including: <var>THintWindow</var>, <var>TCustomDockForm</var>, and <var>TLazDockForm</var>. These class types are not available in ActiveForm.
</p>
</descr>
<seealso>
<link id="TScreen.ActiveControl"/>
<link id="TScreen.ActiveCustomForm"/>
<link id="TCustomForm.SetFocusedControl"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
<link id="TApplication.ControlDestroyed"/>
</seealso>
</element>
<element name="TScreen.Cursor">
<short>Indicates the current mouse cursor shape.</short>
<descr>
<p>
<var>Cursor</var> is a <var>TCursor</var> property which identifies the current mouse cursor shape drawn on the screen. The numeric value is the <var>HCURSOR</var> handle for the image drawn as the cursor shape. Cursor constants (like <var>crHourGlass</var>) defined in the <file>controls.pp</file> unit can be used instead of the numeric value.
</p>
<p>
Cursor is used as an index into the values in the <var>Cursors</var> property where the handle for the <var>TCursorImage</var> resources are stored. Changing the value for the property causes the <var>SetCursor</var> method in the widgetset class to be called to apply the handle in Cursors at the position in Cursor.
</p>
</descr>
<seealso>
<link id="TScreen.Cursors"/>
<link id="TScreen.RealCursor"/>
<link id="Controls.crDefault"/>
</seealso>
</element>
<element name="TScreen.RealCursor">
<short>
Gets the value for the Cursor property taking temporary cursors into account.
</short>
<descr>
<p>
<var>RealCursor</var> is a read-only <var>TCursor</var> property which provides the current shape for the cursor taking temporary cursors into account.
</p>
<p>
Temporary cursors are added and removed using the <var>BeginTempCursor</var> and <var>EndTempCursor</var> methods. When a temporary cursor exists, RealCursor returns the most recent cursor shape added to the internal list using BeginTempCursor. If the internal list is empty, the value in Cursor is returned as the property value.
</p>
<p>
The value from RealCursor is used in the <var>SetCursor</var> method to determine the value stored in the <var>Cursor</var> property, and passed as an argument to SetCursor in the widgetset class.
</p>
</descr>
</element>
<element name="TScreen.Cursors">
<short>Provides indexed access to the available mouse cursor shapes for the screen.</short>
<descr>
<p>
<var>Cursors</var> is an indexed <var>HCURSOR</var> property which provides access to the handle for a mouse cursor shape by its numeric value. The cursor constants (like <var>crHourGlass</var>) defined in the <file>controls.pp</file> unit can be used instead of the numeric value.
</p>
<p>
Cursors uses an internal <var>TMap</var> instance to store the handle values and provides access using the index values. When the value for the property is read, <var>CreateStandardCursor</var> in the widgetset class is called to retrieve the handle. If it has not been assigned, a temporary <var>TCursorImage</var> is created for the cursor resource and its handle is added to the internal map.
</p>
<p>
Setting a new value for the indexed property causes an existing handle in the internal map to be re-created.
</p>
</descr>
<seealso>
<link id="TScreen.Cursor"/>
<link id="TScreen.RealCursor"/>
<link id="TScreen.Cursors"/>
</seealso>
</element>
<element name="TScreen.Cursors.Index">
<short>Ordinal position for the requested cursor shape.</short>
</element>
<element name="TScreen.CustomFormCount">
<short>Number of TCustomForm form instances in the CustomForms property.</short>
<descr>
<p>
<var>CustomFormCount</var> is a read-only <var>Integer</var> property which contains the number of <var>TCustomForm</var> instances stored in the <var>CustomForms</var> property. Read access for the property value is redirected to the <var>Count</var> property in CustomForms.
</p>
</descr>
<seealso>
<link id="TScreen.CustomForms"/>
<link id="TCustomForm"/>
</seealso>
</element>
<element name="TScreen.CustomForms">
<short>
Provides indexed access to the TCustomForm instances on the screen.
</short>
<descr>
<p>
<var>CustomForms</var> is a read-only indexed <var>TCustomForm</var> property which provides access to a custom form instance in the list by its ordinal position.
</p>
<p>
Values in the CustomForms property are added and removed when the <var>CreateNew</var> and <var>Destroy</var> methods in TCustomForm are executed.
</p>
<p>
Use <var>CustomFormsZOrdered</var> to access a custom form instance by its Z-order on the screen.
</p>
<p>
Use the <var>Forms</var> property to access a <var>TForm</var> instance on the screen by its ordinal position.
</p>
</descr>
<seealso>
<link id="TScreen.CustomFormCount"/>
<link id="TScreen.CustomFormsZOrdered"/>
<link id="TScreen.Forms"/>
</seealso>
</element>
<element name="TScreen.CustomForms.Index">
<short>Ordinal position for the requested form.</short>
</element>
<element name="TScreen.CustomFormsZOrdered">
<short>The list of Custom Forms, indexed by Z-order (zero is top-most).</short>
<descr>
<p>
<var>CustomFormsZOrdered</var> is a read-only indexed <var>TCustomForm</var> property which provides access to a custom form by its ordinal position in the Z-Order for the screen. The form at position <b>0</b> (<b>zero</b>) is displayed at the top of the Z-Order, and overlaps any form with a higher Z-Order value.
</p>
<p>
Values in the property are added and removed in the <var>AddForm</var> and <var>RemoveForm</var> methods.
</p>
<p>
CustomFormsZOrdered is used in widgetset classes when an application on the screen is minimized or maximized, or when a form is hidden or displayed using the <var>ShowHide</var> method in its widgetset class.
</p>
<p>
Use <var>CustomFormZOrderCount</var> to get the number of custom form instances in CustomFormsZOrdered.
</p>
<p>
Use <var>CustomForms</var> or <var>Forms</var> to access a form instance by its ordinal position in the list of forms on the screen.
</p>
</descr>
<seealso>
<link id="TScreen.CustomFormZOrderCount"/>
<link id="TScreen.CustomForms"/>
<link id="TScreen.Forms"/>
<link id="TCustomForm.Visible"/>
<link id="TCustomForm.Show"/>
<link id="TCustomForm.Hide"/>
<link id="#lcl.controls.TWinControl.Showing">TWinControl.Showing</link>
</seealso>
</element>
<element name="TScreen.CustomFormsZOrdered.Index">
<short>Ordinal position in the Z-Order (0 is top-most).</short>
</element>
<element name="TScreen.CustomFormZOrderCount">
<short>
Number of custom forms instances in the CustomFormsZOrdered property.
</short>
<descr>
<p>
<var>CustomFormZOrderCount</var> is a read-only <var>Integer</var> property which contains the number of <var>TCustomForm</var> instances stored in the <var>CustomFormsZOrdered</var> property. Read access for the property value is re-directed to the <var>Count</var> property in the list used for CustomFormsZOrdered.
</p>
<p>
Use <var>CustomForms</var> and <var>CustomFormCount</var> to access TCustomForm instances on the screen regardless of their Z-Order.
</p>
<p>
Use <var>Forms</var> and <var>FormCount</var> to access <var>TForm</var> instances on the screen regardless of their Z-Order.
</p>
</descr>
<seealso>
<link id="TScreen.CustomFormsZOrdered"/>
<link id="TScreen.CustomForms"/>
<link id="TScreen.CustomFormCount"/>
<link id="TScreen.Forms"/>
<link id="TScreen.FormCount"/>
</seealso>
</element>
<element name="TScreen.DesktopLeft">
<short>The left-most coordinate of the desktop.</short>
<descr>
<p>
<var>DesktopLeft</var> is a read-only <var>Integer</var> property with the left coordinate for the desktop. The property value contains the virtual screen size returned from <var>GetSystemMetrics</var> for the <var>SM_XVIRTUALSCREEN</var> parameter.
</p>
<p>
DesktopLeft is used in the <var>MoveToDefaultPosition</var> method in <var>TCustomForm</var>. The values in <var>DesktopLeft</var>, <var>DesktopTop</var>, <var>DesktopWidth</var> and <var>DesktopHeight</var> are also assigned to members in the <var>DesktopRect</var> property.
</p>
</descr>
<seealso>
<link id="TScreen.DesktopRect"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
</seealso>
</element>
<element name="TScreen.DesktopTop">
<short>The top-most coordinate for the desktop.</short>
<descr>
<p>
<var>DesktopTop</var> is a read-only <var>Integer</var> property with the top coordinate for the desktop. The property value contains the virtual screen size returned from <var>GetSystemMetrics</var> for the <var>SM_YVIRTUALSCREEN</var> parameter.
</p>
<p>
DesktopTop is used in the <var>MoveToDefaultPosition</var> method in <var>TCustomForm</var>. The values in <var>DesktopLeft</var>, <var>DesktopTop</var>, <var>DesktopWidth</var> and <var>DesktopHeight</var> are also assigned to members in the <var>DesktopRect</var> property.
</p>
</descr>
<seealso>
<link id="TScreen.DesktopRect"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
</seealso>
</element>
<element name="TScreen.DesktopHeight">
<short>The total vertical size for the desktop.</short>
<descr>
<p>
<var>DesktopHeight</var> is a read-only <var>Integer</var> property with the total height for the desktop. The property values is the result from <var>GetSystemMetrics</var> using the <var>SM_CYVIRTUALSCREEN</var> parameter.
</p>
<p>
DesktopHeight is used in the <var>MoveToDefaultPosition</var> method in <var>TCustomForm</var>. The values in <var>DesktopLeft</var>, <var>DesktopTop</var>, <var>DesktopWidth</var> and <var>DesktopHeight</var> are also assigned to members in the <var>DesktopRect</var> property.
</p>
</descr>
<seealso>
<link id="TScreen.DesktopRect"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
</seealso>
</element>
<element name="TScreen.DesktopWidth">
<short>The total horizontal size for the desktop.</short>
<descr>
<p>
<var>DesktopWidth</var> is a read-only <var>Integer</var> property with the total width for the desktop. The property values is the result from <var>GetSystemMetrics</var> using the <var>SM_CXVIRTUALSCREEN</var> parameter.
</p>
<p>
DesktopWidth is used in the <var>MoveToDefaultPosition</var> method in <var>TCustomForm</var>. The values in <var>DesktopLeft</var>, <var>DesktopTop</var>, <var>DesktopWidth</var> and <var>DesktopHeight</var> are also assigned to members in the <var>DesktopRect</var> property.
</p>
</descr>
<seealso>
<link id="TScreen.DesktopRect"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
</seealso>
</element>
<element name="TScreen.DesktopRect">
<short>Bounds rectangle for the desktop spanning all monitors.</short>
<descr>
<p>
<var>DesktopRect</var> is a read-only <var>TRect</var> property with the bounds for the desktop spanning all monitors. Member values in the property are derived from the <var>DesktopLeft</var>, <var>DesktopTop</var>, <var>DesktopWidth</var>, and <var>DesktopHeight</var> properties.
</p>
<p>
DesktopRect is provided as a convenience property; it is not used directly in the LCL.
</p>
</descr>
<seealso>
<link id="TScreen.DesktopLeft"/>
<link id="TScreen.DesktopTop"/>
<link id="TScreen.DesktopHeight"/>
<link id="TScreen.DesktopWidth"/>
</seealso>
</element>
<element name="TScreen.FocusedForm">
<short>The form that has Focus on the screen.</short>
<descr>
<p>
<var>FocusedForm</var> is a read-only <var>TCustomForm</var> property which contains the form which has focus on the screen. The value for the property is maintained in the <var>SetFocusedForm</var> method, which ensures that the previously focused form is deactivated before setting the value in the property. It is also updated in the <var>RemoveForm</var> method when the freed form instance is the current value for the property.
</p>
<p>
FocusedForm is updated in the <var>ShowModal</var> method in <var>TCustomForm</var> when the focus is changed to a modal form. It is also updated in the <var>ControlDestroyed</var> method in <var>TApplication</var> when the freed control is also the current value for the property.
</p>
<p>
The value in the property is used to prevent hint windows from being displayed for other forms when a modal form is active.
</p>
</descr>
<seealso>
<link id="TScreen.ActiveForm"/>
<link id="TScreen.ActiveCustomForm"/>
</seealso>
</element>
<element name="TScreen.FormCount">
<short>The number of Forms on the screen.</short>
<descr>
<p>
<var>FormCount</var> is a read-only <var>Integer</var> property with the number of <var>TForm</var> instances stored in the <var>Forms</var> property. Read access to the property value is redirected to the <var>Count</var> property in Forms.
</p>
<p>
Use <var>CustomFormCount</var> to get the number of <var>TCustomForm</var> instances in the <var>CustomForms</var> property.
</p>
</descr>
<seealso>
<link id="TScreen.Forms"/>
<link id="TScreen.CustomFormCount"/>
<link id="TScreen.CustomForms"/>
</seealso>
</element>
<element name="TScreen.Forms">
<short>Provides indexed access to TForm instances on the screen.</short>
<descr>
<p>
<var>Forms</var> is a read-only indexed <var>TForm</var> property which provides access to the TForm instances on the screen by their ordinal position in the list of forms. <var>Index</var> values must be in the range <b>0..<var>FormCount</var>-1</b>. An <var>EListError</var> exception is raised when Index contains an invalid position for the list.
</p>
<p>
Values are added to and removed from Forms in the <var>AddForm</var> and <var>RemoveForm</var> methods. These methods are called when the <var>CreateNew</var> or <var>Destroy</var> method in TForm is executed. Forms is used in widgetset classes to get the form instance with a given <var>Handle</var> in the widgetset.
</p>
<p>
Use <var>CustomForms</var> and <var>CustomFormCount</var> to access the <var>TCustomForm</var> instances on the screen.
</p>
</descr>
<errors>
Raises an EListError exception when Index contains an invalid position for the list.
</errors>
<seealso>
<link id="TScreen.FormCount"/>
<link id="TScreen.CustomForms"/>
<link id="TScreen.CustomFormCount"/>
<link id="TCustomForm.CreateNew"/>
<link id="TCustomForm.Destroy"/>
</seealso>
</element>
<element name="TScreen.Forms.Index">
<short>Ordinal position for the form in the property value.</short>
</element>
<element name="TScreen.DataModuleCount">
<short>The number of data modules for the screen.</short>
<descr>
<p>
<var>DataModuleCount</var> is a read-only <var>Integer</var> property with the number of <var>TDataModule</var> instances stored in the <var>DataModules</var> property. Read access for the property value is redirected to the <var>Count</var> property in DataModules.
</p>
<p>
Use DataModules to access a TDataModule instance by its ordinal position in the list of data modules.
</p>
</descr>
<seealso>
<link id="TScreen.DataModules"/>
</seealso>
</element>
<element name="TScreen.DataModules">
<short>Provides indexed access to data modules on the screen.</short>
<descr>
<p>
<var>DataModules</var> is a read-only indexed <var>TDataModule</var> property which provides access to a data module by its ordinal position in the list. Data modules are a non-visual component at run-time, and are provided to maintain compatibility with the Delphi VCL equivalent.
</p>
<p>
<var>Index</var> contains the ordinal position in the list for the property value, and must be in the range <b>0..<var>DataModuleCount</var>-1</b>. An <var>EListError</var> exception is raised if Index has an invalid position for the list.
</p>
<p>
Use <var>DataModuleCount</var> to get the number of data module instances in the property.
</p>
</descr>
<seealso>
<link id="TScreen.DataModuleCount"/>
<link id="#rtl.classes.TDataModule">TDataModule</link>
</seealso>
</element>
<element name="TScreen.DataModules.Index">
<short>Ordinal position for the TDataModule instance in the property value.</short>
</element>
<element name="TScreen.HintFont">
<short>The font used to display Hints.</short>
<descr>
<p>
<var>HintFont</var> is a <var>TFont</var> property with the font used to display hint text for forms and controls. Reading the property value causes the <var>InitStockFont</var> method in the widgetset class to be called. If the hint font is not initialized in the widgetset class, default font attributes are assigned to the font instance using the color in <var>clInfoText</var>.
</p>
<p>
The value in HintFont is used to set the default font for <var>THintWindow</var> instances, It can be used in controls which display their own custom hint windows and hint text should be displayed in the default font for the platform.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.IconFont">
<short>The font used for desktop icons.</short>
<descr>
<p>
IconFont is passed to the InitStockFont method in the widgetset to initialize the font.
</p>
<remark>
Not used in the current LCL implementation.
</remark>
</descr>
<seealso>
</seealso>
</element>
<element name="TScreen.MenuFont">
<short>The font used in menus.</short>
<descr/>
<seealso/>
<notes>
<note>Currently used only in FindFontName in the TurboPower IPro package.</note>
</notes>
</element>
<element name="TScreen.SystemFont">
<short>
The default font used for system task dialogs and controls like TSpeedButton.
</short>
<descr/>
<seealso/>
</element>
<element name="TScreen.Fonts">
<short>The names for the available (installed) fonts.</short>
<descr>
<p>
<var>Fonts</var> is a read-only <var>TStrings</var> property which contains the names for the fonts available using the <var>EnumFontFamiliesEx</var> routine for the widgetset. Values in Fonts are sorted alphabetically in ascending order.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.Height">
<short>The height of the primary monitor.</short>
<descr>
<p>
<var>Height</var> is a read-only <var>Integer</var> property with the height of the primary monitor for the system. The property value contains the result from <var>GetSystemMetrics</var> using the <var>SM_CYSCREEN</var> parameter.
</p>
<p>
Values in <var>Height</var> and <var>Width</var> are used when setting the position for forms or other dialogs to ensure that they are visible on the monitor. They are also used when LCL coordinates are converted to screen coordinates to ensure that the positions are valid for the monitor.
</p>
</descr>
<seealso>
<link id="TScreen.PrimaryMonitor"/>
</seealso>
</element>
<element name="TScreen.MonitorCount">
<short>The number of available Monitors.</short>
<descr>
<p>
<var>MonitorCount</var> is a read-only <var>Integer</var> property with the number of <var>TMonitor</var> instances stored in the <var>Monitors</var> property. Reading value for the property causes the <var>UpdateMonitors</var> method to be called when Monitors is empty. The property value is redirected to the <var>Count</var> property in Monitors.
</p>
<p>
Use <var>Monitors</var> to access a <var>TMonitor</var> instance by its ordinal position in the list.
</p>
</descr>
<seealso>
<link id="TScreen.Monitors"/>
</seealso>
</element>
<element name="TScreen.Monitors">
<short>
Provides indexed access to the available monitors in the class instance.
</short>
<descr>
<p>
<var>Monitors</var> is a read-only indexed <var>TMonitor</var> property which provides access to the available monitors in the class instance by their ordinal position in the list.
</p>
<p>
Reading a value for the property causes the <var>UpdateMonitors</var> method to be called when the number of monitors in the <var>TMonitorList</var> instance is <b>0</b> (<b>zero</b>). The property value is the TMonitor instance in the list at the specified ordinal position.
</p>
<p>
Use <var>MonitorCount</var> to get the number of entries stored in the Monitors property.
</p>
</descr>
<seealso>
<link id="TScreen.MonitorCount"/>
<link id="TMonitor"/>
<link id="TMonitorList"/>
</seealso>
</element>
<element name="TScreen.Monitors.Index">
<short>Ordinal position for the TMonitor instance in the property value.</short>
</element>
<element name="TScreen.PixelsPerInch">
<short>
The number of screen pixels per virtual inch (DPI) for the screen.
</short>
<descr>
<p>
PixelsPerInch is a read-only Integer property which contains the number of screen pixels per inch for the display device. The display uses virtual inches, which typically are bigger than physical inches. This requires that text appear bigger on a screen than on a printer.
</p>
<p>
The default value for the property is set in the constructor for the class instance using the horizontal pixels per inch from the <var>ScreenInfo</var> variable in the <file>graphics</file> unit. The value is updated (from the same source) when the <var>UpdateScreen</var> method is called.
</p>
<p>
The property value is used at run-time to detected when scaling is needed in forms, controls, and fonts to adjust for different design-time PPI settings.
</p>
</descr>
<seealso/>
</element>
<element name="TScreen.PrimaryMonitor">
<short>The primary monitor which typically includes the task bar area.</short>
<descr>
<p>
<var>PrimaryMonitor</var> is a read-only <var>TMonitor</var> property with the primary monitor for the system. The property value is determined by checking for the <var>TMonitor</var> instance in <var>Monitors</var> with its <var>Primary</var> property set to <b>True</b>. The property value is <b>Nil</b> if a monitor is not found with its Primary property set to <b>True</b>.
</p>
<p>
The property value is used in the <var>MoveToDefaultPosition</var> method in <var>TCustomForm</var>. It is also used in widgetset classes to select the monitor for a dialog when the main form for an application has not been assigned.
</p>
</descr>
<seealso>
<link id="TScreen.Monitors"/>
<link id="TCustomForm.MoveToDefaultPosition"/>
<link id="TMonitor"/>
</seealso>
</element>
<element name="TScreen.Width">
<short>The width of the primary monitor.</short>
<descr>
<p>
<var>Width</var> is a read-only <var>Integer</var> property with the width for the primary monitor. The property value is the result from <var>GetSystemMetrics</var> using the <var>SM_CXSCREEN</var> parameter.
</p>
<p>
Use <var>Height</var> to get height for the primary monitor.
</p>
<p>
Use <var>DesktopWidth</var> to get the usable width for the desktop minus the area reserved for a task bar.
</p>
</descr>
<seealso>
<link id="TScreen.Height"/>
<link id="TScreen.DesktopWidth"/>
</seealso>
</element>
<element name="TScreen.WorkAreaRect">
<short>The usable display area on the primary monitor excluding the task bar.</short>
<descr>
</descr>
<seealso>
<link id="TScreen.DesktopRect"/>
</seealso>
</element>
<element name="TScreen.WorkAreaHeight">
<short>The usable height of the primary monitor excluding the task bar.</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TScreen.WorkAreaLeft">
<short>The usable left coordinate on the primary monitor.</short>
<descr>
</descr>
<seealso>
<link id="TScreen.WorkareaRect"/>
</seealso>
</element>
<element name="TScreen.WorkAreaTop">
<short>The usable top coordinate on the primary monitor.</short>
<descr>
<p>
Returns the value for the <var>Top</var> member in <var>WorkAreaRect</var>, which omits the task bar area if aligned to the top of the screen.
</p>
<p>
Use the <var>DesktopTop</var> property to get the coordinate for the top of the primary monitor.
</p>
</descr>
<seealso>
<link id="TScreen.WorkAreaRect"/>
<link id="TScreen.DesktopTop"/>
</seealso>
</element>
<element name="TScreen.WorkAreaWidth">
<short>The usable width for the WorkAreaRect.</short>
<descr>
<p>
Returns the difference between the <var>Right</var> and <var>Left</var> members in <var>WorkAreaRect</var>.
</p>
<p>
Use <var>DesktopWidth</var> to get the width for the primary monitor including the task bar area.
</p>
</descr>
<seealso>
<link id="TScreen.WorkAreaRect"/>
<link id="TScreen.DesktopWidth"/>
</seealso>
</element>
<element name="TScreen.OnActiveControlChange">
<short>
Event handler signalled when the active form control for the screen has been changed.
</short>
<descr>
<p>
<var>OnActiveControlChange</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the active control on the screen has been changed. The <var>Sender</var> argument contains the <var>TScreen</var> instance for the change notification.
</p>
<p>
OnActiveControlChange is signalled (when assigned) from the <var>UpdateLastActive</var> method, and occurs after the <var>OnActiveFormChange</var> event has been signalled (when assigned).
</p>
</descr>
<seealso>
<link id="TScreen.AddHandlerActiveControlChanged"/>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TScreen.OnActiveFormChange">
<short>
Event handler signalled when the active form on the screen has been changed.
</short>
<descr>
<p>
<var>OnActiveFormChange</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the active form on the screen has been changed. <var>Sender</var> contains the <var>TScreen</var> instance for the change notification.
</p>
<p>
OnActiveFormChange is signalled (when assigned) from the <var>UpdateLastActive</var> method, and occurs before the <var>OnActiveControlChange</var> event handler.
</p>
</descr>
<seealso>
<link id="TScreen.AddHandlerActiveFormChanged"/>
<link id="TScreen.AddHandlerActiveFormChanged"/>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TQueryEndSessionEvent">
<short>
Specifies an event type used to handle a WM_QUERYENDSESSION window message in an application.
</short>
<descr/>
<seealso>
<link id="TApplication.OnQueryEndSession"/>
</seealso>
</element>
<element name="TQueryEndSessionEvent.Cancel">
<short>Set Cancel to True to prevent the session from ending.</short>
</element>
<element name="TExceptionEvent">
<short>
Defines an event handler signalled to perform exception handling in an application.
</short>
<descr>
<p>
<var>TExceptionEvent</var> is an object procedure type that defines an event handler signalled to perform exception handling in an application. Arguments passed to the event handler identify the application generating the notification, and the exception class instance. Applications must implement an object procedure using the signature for the event, and assign it to an event handler to respond to the notification.
</p>
<p>
<var>TExceptionEvent</var> is the type used to implement exception handlers in <var>TApplication</var> and <var>TApplicationProperties</var>.
</p>
</descr>
<seealso>
<link id="TApplication.HandleException"/>
<link id="TApplicationProperties.OnException"/>
</seealso>
</element>
<element name="TExceptionEvent.Sender">
<short>Object instance for the notification.</short>
</element>
<element name="TExceptionEvent.E">
<short>Exception instance for the notification.</short>
</element>
<element name="TGetHandleEvent">
<short>
Specifies an event handler used to get the handle for the main form in an application.
</short>
<descr>
<p>
<var>TGetHandleEvent</var> is an object procedure type which defines an event handler signalled to get the handle for the main form in an application. <var>TGetHandleEvent</var> is the type used to implement the <var>OnGetMainFormHandle</var> event handler in <var>TApplication</var> and <var>TApplicationProperties</var>.
</p>
</descr>
<seealso>
<link id="TApplication.OnGetMainFormHandle"/>
<link id="TApplicationProperties.OnGetMainFormHandle"/>
<link id="TApplication.AddOnGetMainFormHandleHandler"/>
<link id="TApplication.RemoveOnGetMainFormHandleHandler"/>
</seealso>
</element>
<element name="TGetHandleEvent.Handle">
<short>Handle for the form instance used as the main form.</short>
</element>
<element name="TIdleEvent">
<short>Specifies an event handler signalled when an application becomes idle.</short>
<descr>
<p>
<var>TIdleEvent</var> is an object procedure type which specifies an event handler signalled when an application becomes idle.
</p>
<p>
<var>Sender</var> is the object for the event notification and normally contains the <var>Application</var> singleton.
</p>
<p>
<var>Done</var> is a variable <var>Boolean</var> parameter which indicates if the event handler has finished processing. When set to <b>False</b>, subsequent idle event handlers can be called. When set to <b>True</b>, the idle state processing has been completed.
</p>
<p>
TIdleEvent is the type used for the <var>OnIdle</var> event handler in <var>TApplication</var>. The event handler is signalled when the application becomes idle. The event handler can return False in Done to allow other idle event handlers to be signalled. The idle event handlers are called repeatedly until Done is set to True.
</p>
<p>
Use the TIdleEvent event handler type to provide short duration event handlers which ensure that the application remains responsive.
</p>
</descr>
<seealso/>
</element>
<element name="TIdleEvent.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TIdleEvent.Done">
<short>Set to True when processing is done.</short>
</element>
<element name="TOnUserInputEvent">
<short>
Specifies an event handler signalled to respond to user input messages in an application.
</short>
<descr>
<p>
<var>TOnUserInputEvent</var> is an object procedure type which defines an event handler signalled to respond to user input messages in an application. It is used as a callback which forwards input messages from widgetset classes to the current application.
</p>
<p>
<var>TOnUserInputEvent</var> is the type used for the <var>OnUserInput</var> event handler in <var>TApplication</var> and <var>TApplicationProperties</var>.
</p>
</descr>
<seealso>
<link id="TApplication.OnUserInput"/>
<link id="TApplicationProperties.OnUserInput"/>
<link id="TApplication.AddOnUserInputHandler"/>
<link id="TApplication.RemoveOnUserInputHandler"/>
</seealso>
</element>
<element name="TOnUserInputEvent.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TOnUserInputEvent.Msg">
<short>Message with the user input for the event.</short>
</element>
<element name="TDataEvent">
<short>Specifies the type used for an asynchronous callback method.</short>
<descr/>
<seealso>
<link id="TApplication.QueueAsyncCall"/>
</seealso>
</element>
<element name="TDataEvent.Data">
<short>PtrInt type with the argument passed to the method.</short>
</element>
<element name="TCMHintShow">
<short>Provides access to members in a CM_HINTSHOW control message.</short>
<descr>
<p>
TCMHintShow is a record type used to represent a CM_HINTSHOW control message passed as an argument to methods in a control.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.CMHintShow">TControl.CMHintShow</link>
</seealso>
</element>
<element name="TCMHintShow.Msg">
<short>Cardinal value representing the control message.</short>
</element>
<element name="TCMHintShow.Reserved">
<short>Reserved parameter values for the message.</short>
</element>
<element name="TCMHintShow.HintInfo">
<short>Pointer to the hint information for the control message.</short>
</element>
<element name="TCMHintShow.Result">
<short>Result returned for the control message.</short>
</element>
<element name="TCMHintShowPause">
<short>Not used in the current LCL implementation.</short>
<descr>
<p>
TCMHintShowPause is not used in the current LCL implementation.
</p>
</descr>
<seealso/>
</element>
<element name="TCMHintShowPause.Msg">
<short/>
</element>
<element name="TCMHintShowPause.WasActive">
<short/>
</element>
<element name="TCMHintShowPause.Pause">
<short/>
</element>
<element name="TCMHintShowPause.Result">
<short/>
</element>
<element name="TAppHintTimerType">
<short>Represents TApplication hint timer states.</short>
<descr>
<p>
<var>TAppHintTimerType</var> is used in the implementation of the <var>TApplication</var> class, and passed as an argument to its <var>StartHintTime</var> method.
</p>
</descr>
<seealso/>
</element>
<element name="TAppHintTimerType.ahttNone">
<short>The hint timer is off.</short>
</element>
<element name="TAppHintTimerType.ahttShowHint">
<short>Waiting to show a hint; used when a hint timer is started.</short>
</element>
<element name="TAppHintTimerType.ahttHideHint">
<short>Waiting to hide an hint; used when the hint control is changed or the mouse leaves a hint rectangle.</short>
</element>
<element name="TAppHintTimerType.ahttReshowHint">
<short>Waiting to show the next hint; used when the hide hint timer is started.</short>
</element>
<element name="TShowHintEvent">
<short>Defines an event handler signalled to perform hint display.</short>
<descr>
<p>
<var>TShowHintEvent</var> is an object procedure type which defines an event handler signalled to perform hint display. It is the type used for the <var>TApplication.OnShowHint</var> event handler property.
</p>
</descr>
<seealso>
<link id="TApplication.OnShowHint"/>
<link id="TApplication.ShowHintWindow"/>
<link id="TApplication.AddOnShowHintHandler"/>
<link id="TApplication.RemoveOnShowHintHandler"/>
<link id="TApplicationProperties.OnShowHint"/>
</seealso>
</element>
<element name="TShowHintEvent.HintStr">
<short>Text for hint display event.</short>
</element>
<element name="TShowHintEvent.CanShow">
<short>True if the hint can be displayed.</short>
</element>
<element name="TShowHintEvent.HintInfo">
<short>Hint info structure for the hint.</short>
</element>
<element name="THintInfoAtMouse">
<short>
Stores control and mouse position information for a hint display.
</short>
<descr>
<p>
<var>THintInfoAtMouse</var> is a record type used to store Control and Mouse position information for a hint display.
</p>
<p>
THintInfoAtMouse is passed as an argument to the <var>ShowHintWindow</var> method in <var>TApplication</var>. It is also used in the implementation of TApplication methods like <var>ActivateHint</var> and <var>OnHintTimer</var>.
</p>
</descr>
<seealso>
<link id="TApplication.ShowHintWindow"/>
<link id="TApplication.ActivateHint"/>
<link id="TApplication.OnHintTimer"/>
</seealso>
</element>
<element name="THintInfoAtMouse.MousePos">
<short>Position of the mouse cursor for the hint display.</short>
</element>
<element name="THintInfoAtMouse.Control">
<short>Control for the hint display.</short>
</element>
<element name="THintInfoAtMouse.ControlHasHint">
<short>Indicates if hint text is available for form or control.</short>
</element>
<element name="TApplicationFlag">
<short>Application state flags.</short>
<descr>
<p>
<var>TApplicationFlag</var> is an enumeration type with values that represent activity or state in an application. <var>TApplicationFlag</var> values are stored in the <var>TApplicationFlags</var> type used to implement the <var>Flags</var> property in <var>TApplication</var>.
</p>
</descr>
<seealso>
<link id="TApplicationFlags"/>
<link id="TApplication.Flags"/>
</seealso>
</element>
<element name="TApplicationFlag.AppWaiting">
<short>Application is in an Idle state and waiting for a message.</short>
</element>
<element name="TApplicationFlag.AppIdleEndSent">
<short>
IdleEnd handlers have been notified of message arrival; end the idle state for the application.
</short>
</element>
<element name="TApplicationFlag.AppHandlingException">
<short>In exception handling.</short>
<notes><note>Not used in the current LCL version.</note></notes>
</element>
<element name="TApplicationFlag.AppNoExceptionMessages">
<short>
Suppresses exception display for the application; set when an exception is aborted in the application.
</short>
</element>
<element name="TApplicationFlag.AppActive">
<short>The application has focus; prevents recursive application activation.</short>
</element>
<element name="TApplicationFlag.AppDestroying">
<short>Shutting down; set when the application instance is freed.</short>
</element>
<element name="TApplicationFlag.AppDoNotCallAsyncQueue">
<short>Skip asynchronous callbacks between handled messages.</short>
<notes>
<note>
Included in Flags when the application is being destroyed. Causes an exception to be raised in QueueAsyncCall.
</note>
</notes>
</element>
<element name="TApplicationFlag.AppInitialized">
<short>Application has been initialized.</short>
</element>
<element name="TApplicationFlags">
<short>Set type used to store values from the TApplicationFlag enumeration.</short>
<descr>
<p>
<var>TApplicationFlags</var> is the type used for the <var>Flags</var> property in <var>TApplication</var>.
</p>
</descr>
<seealso>
<link id="TApplicationFlag"/>
<link id="TApplication.Flags"/>
</seealso>
</element>
<element name="TApplicationNavigationOption">
<short>Which keys can be used for the navigation within a form.</short>
<descr>
<p>
<var>TApplicationNavigationOption</var> is an enumerated type with values that control the behaviors enabled for navigation in an application. Values from TApplicationNavigationOption are stored in the <var>TApplicationNavigationOptions</var> set type used to implement the <var>Navigation</var> property in <var>TApplication</var>.
</p>
</descr>
<seealso>
<link id="TApplicationNavigationOptions"/>
<link id="TApplication.Navigation"/>
</seealso>
</element>
<element name="TApplicationNavigationOption.anoTabToSelectNext">
<short>The Tab key moves the Focus to the next (or previous) control in TabOrder.
</short>
</element>
<element name="TApplicationNavigationOption.anoReturnForDefaultControl">
<short>The Enter key triggers the default action.
</short>
</element>
<element name="TApplicationNavigationOption.anoEscapeForCancelControl">
<short>The Escape key triggers the Cancel action.</short>
</element>
<element name="TApplicationNavigationOption.anoF1ForHelp">
<short>The F1 key brings up context sensitive help.</short>
</element>
<element name="TApplicationNavigationOption.anoArrowToSelectNextInParent">
<short>The Arrow keys move the focus.</short>
</element>
<element name="TApplicationNavigationOptions" link="#lcl.forms.TApplicationNavigationOption"/>
<element name="TApplicationHandlerType">
<short>Types of Application notification handlers.</short>
<descr>
<p>
<var>TApplicationHandlerType</var> is an enumerated type with values that identify handler categories used in <var>TApplication</var>.
</p>
<p>
TApplicationHandlerType is used as an index value for the internal array of <var>TMethodList</var> instances used in TApplication. It is passed as an argument to the <var>AddHandler</var> and <var>RemoveHandler</var> methods in TApplication to identify the method list where the handler is stored. It is also used in the implementation of TApplication methods used to retrieve, execute, or maintain handlers such as: <var>Destroy</var> and <var>RemoveAllHandlersOfObject</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TApplicationHandlerType.ahtIdle">
<short>Application becoming idle.</short>
</element>
<element name="TApplicationHandlerType.ahtIdleEnd">
<short>Application idle state is ending.</short>
</element>
<element name="TApplicationHandlerType.ahtKeyDownBefore">
<short>Handler for KeyDown events, invoked before interface and LCL handlers.</short>
</element>
<element name="TApplicationHandlerType.ahtKeyDownAfter">
<short>
Default handler for KeyDown events, invoked after interface and LCL handlers.
</short>
</element>
<element name="TApplicationHandlerType.ahtActivate">
<short>Handler invoked on application activated.</short>
</element>
<element name="TApplicationHandlerType.ahtDeactivate">
<short>Handler invoked on application deactivated.</short>
</element>
<element name="TApplicationHandlerType.ahtUserInput">
<short>Handler invoked on user input.</short>
<notes>
<note>Used in NotifyUserInputHandler; implemented in Sparta MDI package</note>
</notes>
</element>
<element name="TApplicationHandlerType.ahtException">
<short>Handler invoked on handled exception.</short>
</element>
<element name="TApplicationHandlerType.ahtEndSession">
<short>Handler invoked on session end.</short>
<notes><note>Used in IntfEndSession.</note></notes>
</element>
<element name="TApplicationHandlerType.ahtQueryEndSession">
<short>Handler invoked before session ends.</short>
</element>
<element name="TApplicationHandlerType.ahtMinimize">
<short>Handler invoked when the application is minimized.</short>
</element>
<element name="TApplicationHandlerType.ahtModalBegin">
<short>Handler invoked when a form is shown modally.</short>
</element>
<element name="TApplicationHandlerType.ahtModalEnd">
<short>Handler invoked when the last modal form is closed.</short>
</element>
<element name="TApplicationHandlerType.ahtRestore">
<short>Handler invoked on application restored (from minimized state).</short>
</element>
<element name="TApplicationHandlerType.ahtDropFiles">
<short>Handler invoked on files dropped.</short>
<notes><note>Used in IntfDropFiles.</note></notes>
</element>
<element name="TApplicationHandlerType.ahtHelp">
<short>Handler invoked on F1 key (help request).</short>
<notes><note>Used when OnHelp is not assigned in the application.</note></notes>
</element>
<element name="TApplicationHandlerType.ahtHint">
<short>Handler invoked on Hint request.</short>
</element>
<element name="TApplicationHandlerType.ahtShowHint">
<short>Handler invoked on Hint becoming visible.</short>
</element>
<element name="TApplicationHandlerType.ahtGetMainFormHandle">
<short>Handler provides the Handle for the main form.</short>
</element>
<element name="PAsyncCallQueueItem">
<short>A queued asynchronous callback request node.</short>
<descr/>
<seealso>
<link id="TAsyncCallQueueItem"/>
</seealso>
</element>
<element name="TAsyncCallQueueItem">
<short>Record used for a queued asynchronous callback request.</short>
<descr/>
<seealso>
<link id="TApplication.QueueAsyncCall"/>
</seealso>
</element>
<element name="TAsyncCallQueueItem.Method">
<short>Object procedure with the callback method.</short>
<descr/>
</element>
<element name="TAsyncCallQueueItem.Data">
<short>Pointer to the callback method argument.</short>
<descr/>
</element>
<element name="TAsyncCallQueueItem.NextItem">
<short>Pointer to the next item in the callback queue.</short>
<descr/>
</element>
<element name="TAsyncCallQueueItem.PrevItem">
<short>Pointer to the previous item in the callback queue.</short>
<descr/>
</element>
<element name="TAsyncCallQueue">
<short>Represents an asynchronous callback queue.</short>
<descr>
</descr>
<seealso>
<link id="TApplication.QueueAsyncCall"/>
</seealso>
</element>
<element name="TAsyncCallQueue.Top">
<short>The first queued callback request.</short>
</element>
<element name="TAsyncCallQueue.Last">
<short>The last queued callback request.</short>
</element>
<element name="TAsyncCallQueues">
<short>Management information for asynchronous callbacks.</short>
<descr>
<p>
Two queues are used in TAsyncCallQueues. New calls are added to the Next queue. Cur contains the callbacks currently being processed in the queue.
</p>
<p>
When the application starts processing the calls, the Next queue becomes the Cur queue, and a new Next queue is created. This simplifies thread-safe addition in subsequent calls.
</p>
</descr>
<seealso>
<link id="TApplication.QueueAsyncCall"/>
</seealso>
</element>
<element name="TAsyncCallQueues.CritSec">
<short>The critical section for adding and removing queue elements.</short>
<descr/>
</element>
<element name="TAsyncCallQueues.Cur">
<short>The currently processed queue. Processed entries are removed.</short>
<descr/>
</element>
<element name="TAsyncCallQueues.Next">
<short>New calls are added to this queue.</short>
<descr/>
</element>
<element name="TApplicationType">
<short>
Identifies the kind of device where the application currently runs.
</short>
<descr>
<p>
<var>TApplicationType</var> identifies the kind of device where the application currently runs. Note that the same application can run on differing device types if it has a flexible user interface.
</p>
<p>
TApplicationType is the type used to implement the <var>ApplicationType</var> property in <var>TApplication</var>, and returned from widgetset methods that identify the platform for the interface.
</p>
</descr>
<seealso/>
</element>
<element name="TApplicationType.atDefault">
<short>The widgetset will attempt to auto-detect the device type.</short>
</element>
<element name="TApplicationType.atDesktop">
<short>For common desktops and notebooks.</short>
</element>
<element name="TApplicationType.atPDA">
<short>For smartphones and other devices with a smallish touchscreen.</short>
</element>
<element name="TApplicationType.atKeyPadDevice">
<short>Devices without any pointing device, such as keypad feature phones or kiosk machines.</short>
</element>
<element name="TApplicationExceptionDlg">
<short>Enumeration with dialog types for an application.</short>
<descr>
<p>
<var>TApplicationExceptionDlg</var> is an enumerated type with values that indicates the type of dialog displayed for an application exception. <var>TApplicationExceptionDlg</var> is the type used to implement the <var>ExceptionDialog</var> property in <var>TApplication</var> and <var>TApplicationProperties</var>.
</p>
</descr>
<seealso>
<link id="TApplication.ExceptionDialog"/>
<link id="TApplicationProperties.ExceptionDialog"/>
</seealso>
</element>
<element name="TApplicationExceptionDlg.aedOkCancelDialog">
<short>Exception handler window will be a dialog with Ok/Cancel buttons.</short>
</element>
<element name="TApplicationExceptionDlg.aedOkMessageBox">
<short>Exception handler window will be a simple message box.</short>
</element>
<element name="TApplicationShowGlyphs">
<short>Describes the policy for the application of how to show menu and button glyphs.</short>
<descr>
<p>
<var>TApplicationShowGlyphs</var> is an enumerated type with values that indicate the policy for displaying glyphs on menus and buttons. TApplicationShowGlyphs is the type used to implement the <var>ShowButtonGlyphs</var> and <var>ShowMenuGlyphs</var> properties in both <var>TApplication</var> and <var>TApplicationProperties</var>.
</p>
</descr>
<seealso>
<link id="TApplication.ShowButtonGlyphs"/>
<link id="TApplication.ShowMenuGlyphs"/>
<link id="TApplicationProperties.ShowButtonGlyphs"/>
<link id="TApplicationProperties.ShowMenuGlyphs"/>
<link id="#lcl.menus.TGlyphShowMode">TGlyphShowMode</link>
</seealso>
</element>
<element name="TApplicationShowGlyphs.sbgAlways">
<short>Show glyphs always (disregards system preferences).</short>
</element>
<element name="TApplicationShowGlyphs.sbgNever">
<short>Show glyphs never (disregards system preferences).</short>
</element>
<element name="TApplicationShowGlyphs.sbgSystem">
<short>Show glyphs according to the platform or OS preferences.</short>
</element>
<element name="TTaskBarBehavior">
<short>How forms are represented in the TaskBar.</short>
<descr>
<p>
<var>TTaskBarBehavior</var> is an enumerated type with values that define how forms are displayed in the task bar. TTaskBarBehavior is the type used to implement the <var>TaskBarBehavior</var> property in <var>TApplication</var>.
</p>
<remark>
Some Linux window managers do not support task bar behaviors. For example: Cinnamon.
</remark>
</descr>
<seealso>
<link id="TApplication.TaskBarBehavior"/>
</seealso>
</element>
<element name="TTaskBarBehavior.tbDefault">
<short>Show TaskBar buttons according to the platform default.</short>
</element>
<element name="TTaskBarBehavior.tbMultiButton">
<short>Show buttons for Forms with ShowInTaskBar=stDefault.</short>
</element>
<element name="TTaskBarBehavior.tbSingleButton">
<short>Hide buttons for Forms with ShowInTaskBar=stDefault.</short>
</element>
<element name="TApplicationDoubleBuffered">
<short>
Enumeration with values used in the DoubleBuffered property in TApplication.
</short>
<descr/>
<seealso>
<link id="TApplication.DoubleBuffered"/>
</seealso>
</element>
<element name="TApplicationDoubleBuffered.adbDefault">
<short>
Widgetset dependent. For Windows, it is True unless in a remote desktop connection. For other widgetsets it is False.
</short>
</element>
<element name="TApplicationDoubleBuffered.adbFalse">
<short>DoubleBuffered is not used on the platform.</short>
</element>
<element name="TApplicationDoubleBuffered.adbTrue">
<short>DoubleBuffered is used on the platform.</short>
</element>
<element name="TApplication">
<short>Application management and configuration for a GUI application.</short>
<descr>
<p>
<var>TApplication</var> is a <var>TCustomApplication</var> descendant which provides facilities used to manage and configure a GUI application. Properties, methods, and event handlers are provided which allow a program to create, execute, monitor, maintain and destroy an application and its forms. Every GUI application contains an Application variable that represents the TApplication or descendent class instance.
</p>
<p>
TApplication provides a message processing loop that includes hooks for event handlers and exception handling, and supports dispatching messages for <var>TCustomAction</var> instances used in application forms. TApplication provides support for hints and content-sensitive help for forms and controls used in the application. Convenience methods, like <var>MessageBox</var>, are provided to simplify access to dialogs and error messages in the application.
</p>
</descr>
<seealso>
<link id="TScreen"/>
</seealso>
</element>
<element name="TApplication.FApplicationHandlers">
<short>Holds the registered handler routines for the application.</short>
</element>
<element name="TApplication.FApplicationType" link="#lcl.forms.TApplication.ApplicationType"/>
<element name="TApplication.FCaptureExceptions" link="#lcl.forms.TApplication.CaptureExceptions"/>
<element name="TApplication.FComponentsToRelease">
<short>The list of components marked for release.</short>
<descr/>
<seealso>
<link id="TApplication.Release"/>
</seealso>
</element>
<element name="TApplication.FComponentsReleasing">
<short>
The list of components which currently are released (destroyed).
</short>
<descr/>
<seealso>
<link id="TApplication.Release"/>
</seealso>
</element>
<element name="TApplication.FCreatingForm"/>
<element name="TApplication.FDoubleBuffered"/>
<element name="TApplication.FExceptionDialog"/>
<element name="TApplication.FExtendedKeysSupport"/>
<element name="TApplication.FFindGlobalComponentEnabled" link="#lcl.forms.TApplication.FindGlobalComponentEnabled"/>
<element name="TApplication.FFlags" link="#lcl.forms.TApplication.Flags"/>
<element name="TApplication.FHint" link="#lcl.forms.TApplication.Hint"/>
<element name="TApplication.FHintColor" link="#lcl.forms.TApplication.HintColor"/>
<element name="TApplication.FHintControl" link="#lcl.forms.TApplication.HintControl"/>
<element name="TApplication.FHintHidePause" link="#lcl.forms.TApplication.HintHidePause"/>
<element name="TApplication.FHintHidePausePerChar" link="#lcl.forms.TApplication.HintHidePausePerChar"/>
<element name="TApplication.FHintPause" link="#lcl.forms.TApplication.HintPause"/>
<element name="TApplication.FHintRect">
<short>The screen area of the current Hint window.</short>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.FHintShortCuts" link="#lcl.forms.TApplication.HintShortCuts"/>
<element name="TApplication.FHintShortPause" link="#lcl.forms.TApplication.HintShortPause"/>
<element name="TApplication.FHintTimer">
<short>The timer for showing and hiding Hints.</short>
</element>
<element name="TApplication.FHintTimerType">
<short>The Hint time mode.</short>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.FHintWindow">
<short>The current Hint window.</short>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.FIcon" link="#lcl.forms.TApplication.Icon"/>
<element name="TApplication.FBigIconHandle">
<short>The Handle for the big application icon.</short>
</element>
<element name="TApplication.FLayoutAdjustmentPolicy"/>
<element name="TApplication.FMainFormOnTaskBar" link="#lcl.forms.TApplication.MainFormOnTaskBar"/>
<element name="TApplication.FModalLevel" link="#lcl.forms.TApplication.ModalLevel"/>
<element name="TApplication.FLayoutAdjustmentPolicy"/>
<element name="TApplication.FMoveFormFocusToChildren"/>
<element name="TApplication.FOnCircularException"/>
<element name="TApplication.FOnGetMainFormHandle" link="#lcl.forms.TApplication.OnGetMainFormHandle"/>
<element name="TApplication.FOnMessageDialogFinished"/>
<element name="TApplication.FOnModalBegin" link="#lcl.forms.TApplication.OnModalBegin"/>
<element name="TApplication.FOnModalEnd" link="#lcl.forms.TApplication.OnModalEnd"/>
<element name="TApplication.FScaled"/>
<element name="TApplication.FShowButtonGlyphs" link="#lcl.forms.TApplication.ShowButtonGlyphs"/>
<element name="TApplication.FShowMenuGlyphs" link="#lcl.forms.TApplication.ShowMenuGlyphs"/>
<element name="TApplication.FSmallIconHandle">
<short>The Handle for the small application icon.</short>
</element>
<element name="TApplication.FIdleLockCount">
<short>Counter for nested Idle locks, preventing execution of OnIdle handlers.</short>
</element>
<element name="TApplication.FLastKeyDownSender">
<short>Cached key event parameter.</short>
</element>
<element name="TApplication.FLastKeyDownKeys">
<short>List of key values for the last KeyDown sender.</short>
</element>
<element name="TApplication.FLastKeyDownShift">
<short>Cached key event parameter.</short>
</element>
<element name="TApplication.FMainForm" link="#lcl.forms.TApplication.MainForm"/>
<element name="TApplication.FMouseControl" link="#lcl.forms.TApplication.MouseControl"/>
<element name="TApplication.FNavigation" link="#lcl.forms.TApplication.Navigation"/>
<element name="TApplication.FOldExceptProc">
<short>The previously installed exception handler.</short>
</element>
<element name="TApplication.FOnActionExecute" link="#lcl.forms.TApplication.OnActionExecute"/>
<element name="TApplication.FOnActionUpdate" link="#lcl.forms.TApplication.OnActionUpdate"/>
<element name="TApplication.FOnActivate" link="#lcl.forms.TApplication.OnActivate"/>
<element name="TApplication.FOnDeactivate" link="#lcl.forms.TApplication.OnDeactivate"/>
<element name="TApplication.FOnDestroy" link="#lcl.forms.TApplication.OnDestroy"/>
<element name="TApplication.FOnDropFiles" link="#lcl.forms.TApplication.OnDropFiles"/>
<element name="TApplication.FOnHelp" link="#lcl.forms.TApplication.OnHelp"/>
<element name="TApplication.FOnHint" link="#lcl.forms.TApplication.OnHint"/>
<element name="TApplication.FOnIdle" link="#lcl.forms.TApplication.OnIdle"/>
<element name="TApplication.FOnIdleEnd" link="#lcl.forms.TApplication.OnIdleEnd"/>
<element name="TApplication.FOnEndSession" link="#lcl.forms.TApplication.OnEndSession"/>
<element name="TApplication.FOnQueryEndSession" link="#lcl.forms.TApplication.OnQueryEndSession"/>
<element name="TApplication.FOnMinimize" link="#lcl.forms.TApplication.OnMinimize"/>
<element name="TApplication.FOnRestore" link="#lcl.forms.TApplication.OnRestore"/>
<element name="TApplication.FOnShortcut" link="#lcl.forms.TApplication.OnShortcut"/>
<element name="TApplication.FOnShowHint" link="#lcl.forms.TApplication.OnShowHint"/>
<element name="TApplication.FOnUserInput" link="#lcl.forms.TApplication.OnUserInput"/>
<element name="TApplication.FAsyncCall" link="#lcl.forms.TApplication.QueueAsyncCall">
<short>Queues for asynchronous calls.</short>
</element>
<element name="TApplication.FShowHint" link="#lcl.forms.TApplication.ShowHint"/>
<element name="TApplication.FShowMainForm" link="#lcl.forms.TApplication.ShowMainForm"/>
<element name="TApplication.FLastMousePos">
<short>Cached mouse event parameter.</short>
</element>
<element name="TApplication.FLastMouseControl">
<short>Cached mouse event parameter.</short>
</element>
<element name="TApplication.FLastMouseControlValid">
<short>Cached mouse event parameter.</short>
</element>
<element name="TApplication.FBidiMode" link="#lcl.forms.TApplication.BiDiMode"/>
<element name="TApplication.FRestoreStayOnTop">
<short>The list of all forms that should be restored to StayOnTop.</short>
<descr>The list is created in RemoveStayOnTop, processed in RestoreStayOnTop.</descr>
</element>
<element name="TApplication.FTaskBarBehavior" link="#lcl.forms.TApplication.TaskBarBehavior"/>
<element name="TApplication.FUpdateFormatSettings"/>
<element name="TApplication.FRemoveStayOnTopCounter"/>
<element name="TApplication.FExceptionCounter"/>
<element name="TApplication.DoOnIdleEnd">
<short>
Notifies the OnIdleEnd handlers when the application exits Idle state.
</short>
</element>
<element name="TApplication.GetActive"/>
<element name="TApplication.GetActive.Result"/>
<element name="TApplication.GetCurrentHelpFile">
<short>
Gets the HelpFile name for the active form, or the Application.
</short>
<descr>
<p>
<var>GetCurrentHelpFile</var> is a <var>String</var> function used to get the help file name for the active form or application.
</p>
<p>
<var>GetCurrentHelpFile</var> checks for an active form in the <var>Screen</var> singleton. If a form is active, the file name in its <var>HelpFile</var> property is used as the return value. If a form is not active, the <var>HelpFile</var> in the <var>Application</var> instance is used.
</p>
</descr>
<seealso>
<link id="TScreen.ActiveCustomForm"/>
<link id="TCustomForm.HelpFile"/>
<link id="TApplication.HelpFile"/>
</seealso>
</element>
<element name="TApplication.GetCurrentHelpFile.Result">
<short>Help file name located in the method.</short>
</element>
<element name="TApplication.GetExename">
<short>Gets the name of the executable for the application.</short>
<descr>
<p>
<var>GetExename</var> is a <var>String</var> function used to get the name of the executable file which started the application. The return value contains the first command line parameter (ordinal position 0) returned from the <var>ParamStrUTF8</var> routine in <file>LazUtils</file>.
</p>
</descr>
<seealso>
<link id="#LazUtils.LazUTF8.ParamStrUTF8"/>
</seealso>
</element>
<element name="TApplication.GetExename.Result">
<short>Name of the executable file used to start the application.</short>
</element>
<element name="TApplication.GetHandle">
<short>Gets the value for the Handle property.</short>
<descr>
<p>
Returns the AppHandle property from the WidgetSet singleton.
</p>
</descr>
<seealso>
<link id="TApplication.Handle"/>
</seealso>
</element>
<element name="TApplication.GetHandle.Result">
<short>The Handle for the application.</short>
</element>
<element name="TApplication.GetMainFormHandle">
<short>
Determines the main form handle, using all available handlers.
</short>
<descr/>
<seealso>
<link id="TApplication.OnGetMainFormHandle"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.GetMainFormHandle.Result">
<short>Handle value for the main form.</short>
</element>
<element name="TApplication.GetTitle">
<short>
Gets the value for the Title when it is not already stored in the property.
</short>
<descr>
<p>
Extracts the program name from the command line arguments when Title is unassigned.
</p>
</descr>
</element>
<element name="TApplication.GetTitle.Result">
<short>Value for the Title property.</short>
</element>
<element name="TApplication.FreeIconHandles">
<short>Destroys the application icons.</short>
<descr>
<p>
<var>FreeIconHandles</var> is a procedure used to free icon handles used in the application. FreeIconHandles ensures that the internal members for the small and large icon handles are destroyed (when assigned). The <var>DestroyIcon</var> routine is called to destroy each of the icon handles using the correct routine for the widgetset implementation.
</p>
<p>
FreeIconHandles is called from the destructor for the class instance, and when an icon for the application has been changed.
</p>
</descr>
<seealso>
<link id="TApplication.Destroy"/>
<link id="TApplication.IconChanged"/>
<link id="TApplication.SmallIconHandle"/>
<link id="TApplication.BigIconHandle"/>
</seealso>
</element>
<element name="TApplication.IconChanged">
<short>
Implements the OnChange event handler used for the Icon in the application.
</short>
<descr>
<p>
<var>IconChanged</var> is a method used to load the new application icon, and to notify the widgetset and all forms of the change. It implements the <var>OnChange</var> event handler assigned to the <var>Icon</var> for the application.
</p>
<p>
It frees existing handles both the small and large versions of the Icon for the application, and calls the <var>AppSetIcon</var> method in the widgetset class to re-create the handles.
</p>
<p>
IconChanged posts a <var>CM_ICONCHANGED</var> control message to each of the <var>TCustomForm</var> instances in the <var>Screen</var> singleton. Unassigned handle values are provided for both the small and large icons on the form.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.IconChanged.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TApplication.SetBidiMode">
<short>Sets the value for the BiDiMode property.</short>
<descr>
<p>
<var>SetBidiMode</var> is a method used to set value for the <var>BiDiMode</var> property. It updates the property value, and calls <var>NotifyCustomForms</var> to post a <var>CM_PARENTBIDIMODECHANGED</var> control message to all <var>TCustomForm</var> instances on the <var>Screen</var>.
</p>
</descr>
<seealso>
<link id="TApplication.BiDiMode"/>
<link id="TApplication.NotifyCustomForms"/>
</seealso>
</element>
<element name="TApplication.SetBidiMode.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplication.SetFlags">
<short>Sets the value for the Flags property.</short>
<descr>
<p>
SetFlags allows the value AppNoExceptionMessages to be added to or removed from the values in the TApplicationFlags set type. All other existing values in Flags are not modified.
</p>
</descr>
<seealso>
<link id="TApplication.Flags"/>
<link id="TApplicationFlags"/>
</seealso>
</element>
<element name="TApplication.SetFlags.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplication.SetMainFormOnTaskBar">
<short>Sets the value for the MainFormOnTaskBar property.</short>
<descr>
<p>
Calls the <var>AppSetMainFormOnTaskBar</var> method in the widgetset class to apply the new value for the property.
</p>
</descr>
<seealso>
<link id="TApplication.MainFormOnTaskBar"/>
</seealso>
</element>
<element name="TApplication.SetMainFormOnTaskBar.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplication.SetNavigation">
<short>Sets the value for the Navigation property.</short>
<descr/>
<seealso>
<link id="TApplication.Navigation"/>
</seealso>
</element>
<element name="TApplication.SetNavigation.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplication.SetShowButtonGlyphs">
<short>Sets the value for the ShowButtonGlyphs property.</short>
<descr>
<p>
Updates the property value, and calls the <var>NotifyCustomForms</var> method to post a <var>CM_APPSHOWBTNGLYPHCHANGED</var> control message to <var>TCustomForm</var> instances for the application.
</p>
</descr>
<seealso>
<link id="TApplication.ShowButtonGlyphs"/>
</seealso>
</element>
<element name="TApplication.SetShowButtonGlyphs.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplication.SetShowMenuGlyphs" link="#lcl.forms.TApplication.ShowMenuGlyphs"/>
<element name="TApplication.SetShowMenuGlyphs.AValue">
<short/>
</element>
<element name="TApplication.SetTaskBarBehavior" link="#lcl.forms.TApplication.TaskBarBehavior"/>
<element name="TApplication.SetTaskBarBehavior.AValue">
<short/>
</element>
<element name="TApplication.UpdateMouseControl">
<short>Handles mouse movement to a new control.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.UpdateMouseControl.NewMouseControl">
<short/>
</element>
<element name="TApplication.UpdateMouseHint">
<short>Sets Hint to the (new) hint that applies to CurrentControl.</short>
<descr>
</descr>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.UpdateMouseHint.CurrentControl">
<short>The control under the mouse.</short>
</element>
<element name="TApplication.SetCaptureExceptions" link="#lcl.forms.TApplication.CaptureExceptions"/>
<element name="TApplication.SetCaptureExceptions.AValue">
<short/>
</element>
<element name="TApplication.SetHint" link="#lcl.forms.TApplication.Hint"/>
<element name="TApplication.SetHint.AValue">
<short/>
</element>
<element name="TApplication.SetHintColor" link="#lcl.forms.TApplication.HintControl"/>
<element name="TApplication.SetHintColor.AValue">
<short/>
</element>
<element name="TApplication.SetIcon" link="#lcl.forms.TApplication.Icon"/>
<element name="TApplication.SetIcon.AValue">
<short/>
</element>
<element name="TApplication.SetShowHint" link="#lcl.forms.TApplication.ShowHint"/>
<element name="TApplication.SetShowHint.AValue">
<short/>
</element>
<element name="TApplication.StopHintTimer">
<short>Disables the Hint timer.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.ValidateHelpSystem">
<short>
Checks for an installed <link id="#lcl.HelpIntfs.HelpManager">HelpManager</link>.
</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.ValidateHelpSystem.Result">
<short>True when HelpManager is not Nil.</short>
</element>
<element name="TApplication.WndProc" link="#lcl.controls.TControl.WndProc"/>
<element name="TApplication.WndProc.AMessage">
<short/>
</element>
<element name="TApplication.DispatchAction">
<short>Asks the active form and MainForm to handle the action.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.DispatchAction.Result">
<short>True when the action was handled.</short>
</element>
<element name="TApplication.DispatchAction.Msg">
<short/>
</element>
<element name="TApplication.DispatchAction.Action">
<short/>
</element>
<element name="TApplication.AddHandler">
<short>
Adds an application notification handler to the list of handlers for the specified type.
</short>
<descr>
<p>
<var>AddHandler</var> is a procedure used to add an application notification handler to the list of handlers in the TApplication instance.
</p>
<p>
<var>HandlerType</var> is a <var>TApplicationHandlerType</var> enumeration value that defines the situation(s) where the handler can be executed. See TApplicationHandlerType for more information about values in the enumeration.
</p>
<p>
<var>Handler</var> is a <var>TMethod</var> record with pointers to the code and optional data executed when the handler is invoked.
</p>
<p>
<var>AsFirst</var> indicates if the handler should be inserted as the initial handler in the method list (when <b>True</b>), or appended to the end of the list (when <b>False</b>).
</p>
<p>
AddHandler calls <var>RaiseGDBException</var> to raise an exception when the pointer to the Code in Handler has not been assigned.
</p>
<p>
AddHandler ensures that a <var>TMethodList</var> exists for handlers using the value in HandlerType, and calls the <var>Add</var> method in the <var>TMethodList</var> to store the Handler at the position needed for AsFirst.
</p>
<p>
AddHandler is called from the implementation of methods specialized for a specific application handler type, like:
</p>
<ul>
<li>AddOnIdleHandler</li>
<li>AddOnIdleEndHandler</li>
<li>AddOnUserInputHandler</li>
<li>AddOnKeyDownBeforeHandler</li>
<li>AddOnKeyDownHandler</li>
<li>AddOnActivateHandler</li>
<li>AddOnDeactivateHandler</li>
<li>AddOnExceptionHandler</li>
<li>AddOnEndSessionHandler</li>
<li>AddOnQueryEndSessionHandler</li>
<li>AddOnMinimizeHandler</li>
<li>AddOnModalBeginHandler</li>
<li>AddOnModalEndHandler</li>
<li>AddOnRestoreHandler</li>
<li>AddOnDropFilesHandler</li>
<li>AddOnHelpHandler</li>
<li>AddOnHintHandler</li>
<li>AddOnShowHintHandler</li>
<li>AddOnGetMainFormHandleHandler</li>
</ul>
</descr>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
<seealso>
</seealso>
</element>
<element name="TApplication.AddHandler.HandlerType">
<short>
Application handler type for the handler routine.
</short>
</element>
<element name="TApplication.AddHandler.Handler">
<short>
Handler routine added in the method.
</short>
</element>
<element name="TApplication.AddHandler.AsFirst">
<short>
<b>True</b> if the handler is stored as the first entry in the list of handlers for the type. <b>False</b> to append the handler to the end of the list.
</short>
</element>
<element name="TApplication.RemoveHandler">
<short>
Removes an application notification handler from the list for the specified handler type.
</short>
<descr>
<p>
Calls the Remove method in the TMethodList for the application handler type in the HandlerType argument. Handler contains the TMethod instance to locate and remove from the application handlers for the type.
</p>
<p>
RemoveHandler is called from other methods which operate on a specific TApplicationHandlerType, like:
</p>
<ul>
<li>RemoveOnIdleHandler</li>
<li>RemoveOnIdleEndHandler</li>
<li>RemoveOnUserInputHandler</li>
<li>RemoveOnKeyDownBeforeHandler</li>
<li>RemoveOnKeyDownHandler</li>
<li>RemoveOnActivateHandler</li>
<li>RemoveOnDeactivateHandler</li>
<li>RemoveOnExceptionHandler</li>
<li>RemoveOnEndSessionHandler</li>
<li>RemoveOnQueryEndSessionHandler</li>
<li>RemoveOnMinimizeHandler</li>
<li>RemoveOnModalBeginHandler</li>
<li>RemoveOnModalEndHandler</li>
<li>RemoveOnRestoreHandler</li>
<li>RemoveOnDropFilesHandler</li>
<li>RemoveOnHelpHandler</li>
<li>RemoveOnHintHandler</li>
<li>RemoveOnShowHintHandler</li>
<li>RemoveOnGetMainFormHandleHandler</li>
</ul>
</descr>
<seealso>
<link id="TApplication.AddHandler"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveHandler.HandlerType">
<short>
Application notification type for the handler removed in the method.
</short>
</element>
<element name="TApplication.RemoveHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.RunLoop">
<short>Encapsulates the application message loop (HandleMessage).</short>
</element>
<element name="TApplication.Activate">
<short>
Handler for application activation, notifies all activation handlers.
</short>
</element>
<element name="TApplication.Deactivate">
<short>
Handler for application deactivation, notifies all deactivation handlers.
</short>
<descr/>
</element>
<element name="TApplication.Deactivate.Force">
<short>True when called from the widgetset.</short>
</element>
<element name="TApplication.GetConsoleApplication">
<short>Always returns False for a GUI application.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.GetConsoleApplication.Result">
<short>False for a GUI application.</short>
</element>
<element name="TApplication.NotifyIdleHandler">
<short>Signals all idle handlers for the application.</short>
<descr>
<p>
<var>NotifyIdleHandler</var> is a method used to signal event handlers using the <var>ahtIdle</var> application handler type.
</p>
<p>
The internal array of handlers is checked for a <var>TMethodList</var> which uses the application handler type. If it exists, each of the methods in the list are signalled, in reverse order, using the value in <var>Done</var> as a control flag. While Done is <b>True</b>, the handlers are continuously called in the loop. If any handler in the list sets Done to <b>False</b>, the method is exited.
</p>
<p>
NotifyIdleHandler is called from the <var>Idle</var> method. It occurs after the <var>ReleaseComponents</var> and <var>ProcessAsyncCallQueue</var> methods have been called. It is also called after the <var>OnIdle</var> event handler in the TApplication has been signalled (when assigned) and when the Done argument to the event handler is <b>True</b>.
</p>
</descr>
<seealso>
<link id="TApplication.OnIdle"/>
<link id="TApplication.Idle"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.NotifyIdleHandler.Done">
<short>
<b>True</b> when all handlers are done, meaning: wait for the next message.
</short>
</element>
<element name="TApplication.NotifyIdleEndHandler">
<short>
Notifies all Idle End handlers when a new message has arrived.
</short>
<descr>
<p>
Executes the <var>CallNotifyEvents</var> method in the TMethodList for the handler type. Te application instance is passed as an argument to the method.
</p>
<p>
NotifyIdleEndHandler is called when AppIdleEndSent is included in the Flags for the TApplication instance. It occurs after the OnIdleEnd event handler has been signalled (when assigned).
</p>
</descr>
<seealso>
<link id="TApplication.OnIdleEnd"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.NotifyActivateHandler">
<short>Notifies all Activate handlers for the application.</short>
<descr>
<p>
<var>NotifyActivateHandler</var> signals the <var>OnActivate</var> event handler (when assigned) using the <var>TApplication</var> instance as the Sender for the notification event. The <var>CallNotifyEvents</var> method in the TMethodList is called to signal each of the routines for the handler type.
</p>
<p>
NotifyActivateHandler is called when an application is initially executed, and when focus is acquired from a different application.
</p>
</descr>
<seealso>
<link id="TApplication.OnActivate"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.NotifyDeactivateHandler">
<short>Notifies all Deactivate handlers for the application.</short>
<descr>
<p>
<var>NotifyDeactivateHandler</var> is a method used to signal all of the deactivate handlers for the application. OnDeactivate is signalled (when assigned) using the application instance as an argument.
</p>
<p>
CallNotifyEvents is executed for each of the handlers in the TMethodList for the ahtDeactivate notification type. Use AddOnDeactivateHandler and RemoveOnDeactivateHandler to maintain an additional handler for the notification type.
</p>
<p>
NotifyDeactivateHandler is called from the Deactivate method, and occurs when focus is changed to another application or the application is closed.
</p>
</descr>
<seealso>
<link id="TApplication.OnDeactivate"/>
<link id="TApplication.AddOnDeactivateHandler"/>
<link id="TApplication.RemoveOnDeactivateHandler"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.NotifyCustomForms">
<short>
Performs the specified message for all custom forms in the application.
</short>
<descr>
<p>
Calls the <var>Perform</var> method for custom forms in the application using <var>Msg</var> as an argument.
</p>
<p>
NotifyCustomForms is called when theme options for button or menu glyphs are changed to sbgSystem in the application instance.
</p>
</descr>
<seealso>
<link id="TScreen.CustomForms"/>
<link id="Screen"/>
<link id="TApplication.IntfThemeOptionChange"/>
<link id="#lcl.controls.TControl.Perform">TControl.Perform</link>
</seealso>
</element>
<element name="TApplication.NotifyCustomForms.Msg">
<short>The message sent to the forms.</short>
</element>
<element name="TApplication.IsHintMsg">
<short>Exists for Delphi compatibility only.</short>
<descr>
<p>
Always returns <var>False</var> in <var>TApplication</var>. Provided for Delphi code compatibility only.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.IsHintMsg.Result">
<short>Always returns False.</short>
</element>
<element name="TApplication.IsHintMsg.Msg">
<short>Not used in the implementation.</short>
</element>
<element name="TApplication.DoOnHelp">
<short>
Signals an OnHelp event handler.
</short>
<descr>
<p>
Signals the OnHelp message handler. DoOnHelp tries the OnHelp handlers for the active form and the Application, as well as handler routines added for the ahtHelp handler type.
</p>
<p>
DoOnHelp is called from the HelpCommand method.
</p>
</descr>
<seealso>
<link id="TApplication.OnHelp"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.DoOnHelp.Result">
<short>True when the message was handled.</short>
</element>
<element name="TApplication.DoOnHelp.Command">
<short>
Help command to handle in the event handler(s).
</short>
</element>
<element name="TApplication.DoOnHelp.Data">
<short>
Pointer to the help data used in the event handler(s).
</short>
</element>
<element name="TApplication.DoOnHelp.CallHelp">
<short/>
</element>
<element name="TApplication.DoOnMouseMove">
<short>
OnMouseMove message handler, updates the Hint.
</short>
<descr>
<p>
<var>DoOnMouseMove</var> performs actions needed when a mouse move message is received and applied for the application. It retrieves the current position for the mouse pointer, and calls the ActivateHint method to build / display a hint for the active form / control in the application.
</p>
<p>
DoOnMouseMove is called from the NotifyUserInputHandler method.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.ShowHintWindow">
<short>Shows or hides the Hint window for the application.</short>
<descr>
<p>
When a parented HintControl has been assigned, handler routines are signalled to check whether the hint can be display in the event handler. The OnShowHint event handler is signalled first (when assigned). Additional application handlers assigned using AddOnShowHintHandler are signalled next.
</p>
<p>
If the hint text is not empty, it is displayed and its timer is started. Otherwise the HideHint method is called to hide the hint window.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.ShowHintWindow.Info">
<short>
Updated with the Hint-related information for a parent control or form.
</short>
</element>
<element name="TApplication.OnHintTimer">
<short>
Implements an event handler signalled when the timer for a hint display has elapsed.
</short>
<descr>
<p>
<var>OnHintTimer</var> is an implementation of the event handler assigned to the OnTimer event handler in the internal timer for the application instance.
</p>
<p>
It calls StopHintTimer to ensure that the timer is disabled. If the mouse pointer is not within the client area for the current form or control, HideHint is called to hide the hint window. Otherwise, hint information for the control under the mouse pointer is retrieved and ShowHintWindow is called to start a new hint display.
</p>
<p>
OnHintTimer is called directly from the StartHintTimer method when Internal is set to 0 (or a negative value).
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.OnHintTimer.Sender">
<short/>
</element>
<element name="TApplication.SetTitle">
<short>Sets the value for the Title property.</short>
<descr>
<p>
Calls the inherited method on entry. Calls the <var>AppSetTitle</var> method in the widgetset class to apply the new value for the property.
</p>
</descr>
<seealso>
<link id="TApplication.Title"/>
</seealso>
</element>
<element name="TApplication.SetTitle.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplication.StartHintTimer">
<short>Starts the timer for display of a hint message.</short>
<descr/>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.StartHintTimer.Interval">
<short/>
</element>
<element name="TApplication.StartHintTimer.TimerType">
<short/>
</element>
<element name="TApplication.UpdateVisible">
<short>Asks the widgetset to update the task bar entries.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.DoIdleActions">
<short>Updates all Actions and hides splash screens.</short>
<descr>
<p>
<var>DoIdleActions</var> ensures that the UpdateActions method is called for visible and enabled forms in the application. This allows the TBasicAction instances in menus and controls on each form to be updated as well.
</p>
<p>
DoIdleActions hides any form instance in Screen which uses fsSplash in its FormStyle property.
</p>
<p>
DoIdleActions is called from the Idle method after OnIdle and other idle event handlers have been signalled and indicated that they have been completed successfully.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.MenuPopupHandler">
<short>Implements the OnMenuPopupHandler for the application.</short>
<descr>
<p>
Assigned as the handler routine for the OnMenuPopupHandler variable in the LCL when the application instance is created.
</p>
<p>
Calls the <var>HideHint</var> method to manage values in <var>HintWindow</var>, <var>HintControl</var>, and <var>HintRect</var> (when needed).
</p>
</descr>
<seealso>
<link id="#lcl.menus.OnMenuPopupHandler">OnMenuPopupHandler</link>
</seealso>
</element>
<element name="TApplication.MenuPopupHandler.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TApplication.ProcessAsyncCallQueue">
<short>Calls all methods queued in QueueAsyncCall.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.FreeComponent" link="#lcl.forms.TApplication.ReleaseComponents"/>
<element name="TApplication.FreeComponent.Data">
<short>Ignored, should be zero.</short>
</element>
<element name="TApplication.ReleaseComponents">
<short>Destroys all components marked for release.</short>
<descr>
<p>
ReleaseComponents ensures that any component in the internal list calls ReleaseComponent to handle the free notification for a reference-counted LCL component.
</p>
<p>
ReleaseComponents is called from the Idle and FreeComponent methods.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.DoBeforeFinalization">
<short>Destroys all components.</short>
<descr>
<p>
Called from the <var>BeforeFinalization</var> routine which is used as the <var>ExitProc</var> handler in the application instance.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.GetParams">
<short>Returns the command line argument at the specified position.</short>
<descr>
<p>
<var>GetParams</var> is an overridden <var>String</var> function in <var>TApplication</var> used to get the argument at the specified position in the command line. It re-implements the read access specifier for the property from the ancestor class, and does not call the inherited method.
</p>
<p>
<var>Index</var> is the ordinal position for the requested parameter value. Index must be in the range <b>0..<var>ParamCount</var>-1</b> or an <var>EListError</var> exception is raised. Position <b>0</b> contains the name of the executable file for the application.
</p>
<p>
The return value contains the UTF-8-encoded <var>String</var> with the value for the parameter at the specified position. It is retrieved using the <var>ParamStrUTF8</var> routine for the position in Index.
</p>
</descr>
<seealso>
<link id="#lazutils.lazutf8.ParamStrUTF8">ParamStrUTF8</link>
<link id="#fcl.custapp.TCustomApplication.Params">TCustomApplication.Params</link>
<link id="#fcl.custapp.TCustomApplication.ParamCount">TCustomApplication.ParamCount</link>
</seealso>
</element>
<element name="TApplication.GetParams.Result">
<short>String with the parameter value, or an empty string.</short>
</element>
<element name="TApplication.GetParams.Index">
<short>Ordinal position for the requested parameter value.</short>
</element>
<element name="TApplication.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance.
</p>
<p>
It ensures that the LCL is configured to use the private <var>WndProc</var> method to handle messages dispatched for the application instance.
</p>
<p>
Create allocates resources needed in the class instance, and sets the default values for properties. Event handler routines implemented in <var>TApplication</var> are assigned as needed.
</p>
<p>
Create calls the inherited constructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<element name="TApplication.Create.AOwner">
<short>The Owner object that invoked this instance of TApplication.</short>
</element>
<element name="TApplication.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
Destroy is the overridden destructor for the class instance.
</p>
<p>
<var>Destroy</var> ensures that the value <var>AppDestroying</var> is included in the <var>Flags</var> for the application, and signals the <var>OnDestroy</var> event handler (when assigned). Destroy calls the <var>ProcessAsyncCallQueue</var> method to process / handle queued asynchronous method calls pending for the application instance.
</p>
<p>
Hint display is cancelled and suppressed while the application is shutting down. The action component for the application is set to <b>Nil</b> to prevent execution of associated actions during shutdown.
</p>
<p>
Destroy frees resources allocated in the application instance, including the Icon and any Icon handles currently in use. Handlers added to application instance are also freed.
</p>
<p>
Destroy calls the inherited destructor, and discards any pending asynchronous calls not previously handled for the application instance. Exception handling is restored to the state on entry to the Create constructor. Finally, the Application class instance is set to <b>Nil</b>.
</p>
</descr>
<errors>
<p>
Destroy calls <var>RaiseGDBException</var> to raise an exception if the current class instance is unassigned (contains <b>Nil</b>). Uses the exception message 'TApplication.Destroy Self=nil'.
</p>
<p>
Raises an <var>EAssertFalied</var> exception if the CustomApplication and Application variables do not contain the same TCustomApplication instance.
</p>
</errors>
<seealso/>
</element>
<element name="TApplication.ActivateHint">
<short>Configures a hint window for the specified mouse position.</short>
<descr>
<p>
<var>ActivateHint</var> is a procedure used to configure a hint window display at the coordinates specified in <var>CursorPos</var>.
</p>
<p>
ActivateHint retrieves the hint information at the mouse position. If the control for the hint differs from the current hint control, the existing hint is deactivated. The new hint window sets its hint timer and calculates the rectangle for the hint window.
</p>
<p>
If a hint is not available for the specified mouse position, the <var>CancelHint</var> method is called.
</p>
<p>
ActivateHint is used in the implementation of the <var>DoOnMouseMove</var> and <var>ShowHintWindow</var> methods.
</p>
</descr>
<seealso>
<link id="TApplication.ShowHintWindow"/>
<link id="TApplication.DoOnMouseMove"/>
<link id="TApplication.CancelHint"/>
<link id="TApplication.HideHint"/>
<link id="TApplication.Hint"/>
<link id="TApplication.HintPause"/>
<link id="TApplication.OnHint"/>
</seealso>
</element>
<element name="TApplication.ActivateHint.CursorPos">
<short>Mouse cursor position used to retrieve the hint information.</short>
</element>
<element name="TApplication.ActivateHint.CheckHintControlChange">
<short>Indicates if hint controls are used to compared existing and new hint windows.</short>
</element>
<element name="TApplication.GetControlAtMouse">
<short>Gets the control under the mouse pointer.</short>
<descr>
<p>
<var>GetControlAtMouse</var> is a <var>TControl</var> function used to get the control under the mouse pointer. The return value contains the form or control at the position where the mouse pointer is located. The return value is <b>Nil</b> at design-time.
</p>
<p>
GetControlAtMouse updates internal members used to track the control and its position.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.GetControlAtMouse.Result">
<short>The control under the mouse pointer, or Nil at design-time.</short>
</element>
<element name="TApplication.ControlDestroyed">
<short>Clears all references to the destroyed control.</short>
<descr>
<p>
<var>ControlDestroyed</var> is a method used to update the application when the control in <var>AControl</var> is freed. ControlDestroyed ensures that any property in the application that contains a reference to AControl is set to <b>Nil</b>, including:
</p>
<ul>
<li>MainForm</li>
<li>MouseControl</li>
<li>HintControl</li>
<li>CreatingForm (internal)</li>
</ul>
<p>
Properties in the <var>Screen</var> singleton are also updated to remove any references to AControl, including:
</p>
<ul>
<li>ActiveControl</li>
<li>ActiveCustomForm</li>
<li>ActiveForm</li>
<li>FocusedForm</li>
</ul>
<p>
The <var>UpdateLastActive</var> method in Screen is called to perform change notification for the forms and / or controls.
</p>
<p>
ControlDestroyed is called from the <var>Destroy</var> method in <var>TControl</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Destroy">TControl.Destroy</link>
</seealso>
</element>
<element name="TApplication.ControlDestroyed.AControl">
<short>Control instance which is being freed.</short>
</element>
<element name="TApplication.BigIconHandle">
<short>The Handle for the large application Icon.</short>
<seealso>
<link id="TApplication.Icon"/>
</seealso>
</element>
<element name="TApplication.BigIconHandle.Result">
<short/>
</element>
<element name="TApplication.SmallIconHandle">
<short>The Handle for the small application Icon.</short>
<seealso>
<link id="TApplication.Icon"/>
</seealso>
</element>
<element name="TApplication.SmallIconHandle.Result">
<short/>
</element>
<element name="TApplication.BringToFront">
<short>
Asks the widgetset to bring the last form for the application in front of all other programs.
</short>
<descr>
<p>
Calls the AppBringToFront method in the widgetset class.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.CreateForm">
<short>Creates a Form or component, owned by Application.</short>
<descr>
<remark>
The method name is slightly misleading, and kept only for Delphi compatibility. The method can actually create any kind of component.
</remark>
<p>
CreateForm creates a Component instance of the given class, and sets the pointer to the component variable. If it is a form, it will be added to the list of forms in the application.
</p>
<p>
A splash form is shown immediately.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.CreateForm.InstanceClass">
<short>The class type used to create the new instance.</short>
</element>
<element name="TApplication.CreateForm.Reference">
<short>The variable for the new component reference.</short>
</element>
<element name="TApplication.UpdateMainForm">
<short>
Makes the specified form the MainForm in the Application.
</short>
<descr>
<p>
UpdateMainForm is a method used to make the form instance in AForm the main form for the application. It stores the value in AForm to the MainForm property. No actions are performed in the method for the following conditions:
</p>
<ul>
<li>MainForm is already assigned.</li>
<li>AForm is marked for release.</li>
<li>The Handle for AForm has not yet been allocated.</li>
<li>
AForm is a MDI Child form (FormStyle contains fsMDIChild) or a splash screen form (FormStyle contains fsSplash).
</li>
</ul>
<p>
UpdateMainForm is called from the CreateForm method, and occurs before the form calls its HandleNeeded method. It is also called when the Handle for a form is created (or re-created) in the CreateWnd method in TForm.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.UpdateMainForm.AForm">
<short>The form to use as the MainForm in the Application.</short>
</element>
<element name="TApplication.QueueAsyncCall">
<short>Inserts an asynchronous call into the queue.</short>
<descr>This is thread safe.</descr>
<errors>
Exceptions on various inconsistencies of the queue.
</errors>
<seealso/>
<example file="forms/tapplication_queueasynccall.pas"/>
</element>
<element name="TApplication.QueueAsyncCall.AMethod">
<short>The method to call asynchronously.</short>
</element>
<element name="TApplication.QueueAsyncCall.Data">
<short>The argument passed to the method.</short>
</element>
<element name="TApplication.RemoveAsyncCalls">
<short>Removes all calls added via QueueAsyncCall.</short>
<descr>This is thread safe.</descr>
<errors>
Exceptions on various inconsistencies of the queue.
</errors>
</element>
<element name="TApplication.RemoveAsyncCalls.AnObject">
<short/>
</element>
<element name="TApplication.ReleaseComponent">
<short>
Safely destroys a component used in the application.
</short>
<descr>
<p>
<var>ReleaseComponent</var> is a method used to ensure that the component in AComponent is freed in the application. During normal processing, ReleaseComponent adds the <var>TComponent</var> instance to a list and queues an asynchronously call to <var>FreeComponent</var>. This allows the component to be freed when the application enters an idle state.
</p>
<p>
If the Application <var>Flags</var> contains <var>AppDestroying</var>, the <var>Free</var> method for AComponent is called immediately.
</p>
<p>
No actions are performed in the method if <var>Destroy</var> has already been called for AComponent (<var>ComponentState</var> contains <var>csDestroying</var>).
</p>
<p>
ReleaseComponent is called from the <var>ReleaseComponents</var> method in <var>TApplication</var>, and from the <var>Release</var> method in <var>TCustomForm</var>. It may also be used in the implementation of controls to ensure that its resources are freed as needed.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.ReleaseComponent.AComponent">
<short>The component to destroy.</short>
</element>
<element name="TApplication.ExecuteAction">
<short>Signals the OnActionExecute handler (when assigned).</short>
<descr>
<p>
<var>ExecuteAction</var> is an overridden <var>Boolean</var> function used to signal the <var>OnActionExecute</var> (when assigned) using <var>ExeAction</var> as the action executed in the event handler. It sets the default value for the <var>Handled</var> argument to the event handler to <b>False</b>. The argument can be updated in the event handler, and is used as the return value for the method.
</p>
<p>
ExecuteAction re-implements the method defined in the ancestor, and does <b>not</b> call the inherited method.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TComponent.ExecuteAction">TComponent.ExecuteAction</link>
</seealso>
</element>
<element name="TApplication.ExecuteAction.Result">
<short>True when the Action was handled in the event handler.</short>
</element>
<element name="TApplication.ExecuteAction.ExeAction">
<short>The Action to execute in the event handler.</short>
</element>
<element name="TApplication.UpdateAction">
<short>Signals the OnActionUpdate handler (when assigned).</short>
<descr>
<p>
<var>UpdateAction</var> is an overridden <var>Boolean</var> function used to signal the <var>OnActionUpdate</var> event handler (when assigned) to update the settings for the action in <var>TheAction</var>. It sets the default value for the <var>Handled</var> argument to the event handler to <b>False</b>. The argument can be updated in the event handler, and is used as the return value for the method.
</p>
<p>
UpdateAction re-implements the method defined in the ancestor, and does <b>not</b> call the inherited method.
</p>
</descr>
<seealso>
<link id="#rtl.Classes.TComponent.UpdateAction">TComponent.UpdateAction</link>
</seealso>
</element>
<element name="TApplication.UpdateAction.Result">
<short>True if the action was updated in the event handler.</short>
</element>
<element name="TApplication.UpdateAction.TheAction">
<short>The action updated in the event handler.</short>
</element>
<element name="TApplication.HandleException">
<short>
<var>HandleException</var> method for handling an exception;
attempts to maintain program execution if possible, otherwise exits gracefully.
</short>
<descr>
<p>
Individual exception handler methods should be supplied by the application programmer, to override place-holder entries declared in ancestor classes. This method checks whether the application is halted when an exception occurs, or invokes the appropriate handler. It also writes details about the exception to the appropriate place for debugging.
</p>
</descr>
<seealso>
<link id="#fcl.custapp.TCustomApplication.HandleException">TCustomApplication.HandleException</link>
</seealso>
</element>
<element name="TApplication.HandleException.Sender">
<short/>
</element>
<element name="TApplication.HandleMessage">
<short>Handles pending messages, and enters the Idle state.</short>
<descr>
<p>
<var>HandleMessage</var> is a method used to process pending window or control messages in the application. It calls the <var>AppProcessMessages</var> method in the widgetset class to handle pending messages. It calls the <var>Idle</var> method to enter the idle state where queued asynchronous callbacks can be handled and idle handlers can be signalled.
</p>
<p>
It is very similar to the <var>ProcessMessages</var> method, which does not signal idle handlers for the application or wait for a new message before exit.
</p>
<p>
HandleMessage is called from the <var>RunLoop</var> method in <var>TApplication</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.HelpCommand">
<short>Show help.</short>
<descr>
<p>
Currently relies on OnHelp handlers. CallHelp is not implemented.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TApplication.HelpCommand.Result">
<short/>
</element>
<element name="TApplication.HelpCommand.Command">
<short/>
</element>
<element name="TApplication.HelpCommand.Data">
<short/>
</element>
<element name="TApplication.HelpContext">
<short>Shows context-sensitive help for the application.</short>
<descr>
<p>
HelpContext is a Boolean function used to display context-sensitive help for the specified help context. It calls the DoOnHelp method to select and execute a help handler routine for the specified help context. The routine may be one of the OnHelp event handlers found in the active form or in TApplication. If neither are assigned, the application handlers are checked for a routine using the ahtHelp handler type.
</p>
<p>
If the help context was handled in DoOnHelp, not additional actions are performed in the method. Otherwise, the ShowHelpOrErrorForContext is called to handle the help request.
</p>
<p>
The return value is False if the help context could not be handled using any of these options.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.HelpContext.Result">
<short>True if the help request was handled in the method.</short>
</element>
<element name="TApplication.HelpContext.Context">
<short>Help context displayed in the method.</short>
</element>
<element name="TApplication.HelpKeyword">
<short>Shows help for the specified keyword.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.HelpKeyword.Result">
<short/>
</element>
<element name="TApplication.HelpKeyword.Keyword">
<short/>
</element>
<element name="TApplication.HelpShowTableOfContents">
<short>
Displays the Help Table of Contents using the Help Manager for the application.
</short>
<descr>
<p>
<var>HelpShowTableOfContents</var> is a method used to display the Help Table of Contents for the application. It uses the global <var>HelpManager</var> variable (when assigned) to call its <var>ShowTableOfContents</var> method. This method must be re-implemented in a descendent class; the default implementation simply returns the <var>shrHelpNotFound</var> result.
</p>
<p>
The return value is <b>True</b> when the HelpManager successfully displays the Table of Contents, and returns the <var>shrSuccess</var> result code. If HelpManager has not been assigned, the return value is always <b>False</b>.
</p>
</descr>
<seealso>
<link id="#lcl.helpintfs.HelpManager">HelpManager</link>
<link id="#lcl.helpintfs.THelpManager.ShowTableOfContents">THelpManager.ShowTableOfContents</link>
<link id="#lcl.helpintfs.TShowHelpResult">TShowHelpResult</link>
</seealso>
<version>
Added in LCL version 2.2.0. This method is Delphi compatible.
</version>
</element>
<element name="TApplication.HelpShowTableOfContents.Result">
<short>
True if the Help Table of Contents was successfully displayed by the application.
</short>
</element>
<element name="TApplication.ShowHelpForObject">
<short>When Sender is a TControl, invoke its ShowHelp method.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.ShowHelpForObject.Sender">
<short>Should be a TControl, otherwise no help is displayed.</short>
</element>
<element name="TApplication.RemoveStayOnTop">
<short>
Removes the StayOnTop attribute from all forms in the application.
</short>
<descr>
Builds a list of forms for use in the RestoreStayOnTop method.
</descr>
<seealso>
<link id="TApplication.RestoreStayOnTop"/>
</seealso>
</element>
<element name="TApplication.RemoveStayOnTop.ASystemTopAlso">
<short/>
</element>
<element name="TApplication.RestoreStayOnTop">
<short>
Restores StayOnTop for all forms changed by RemoveStayOnTop.
</short>
<descr>
</descr>
<seealso>
<link id="TApplication.RemoveStayOnTop"/>
</seealso>
</element>
<element name="TApplication.RestoreStayOnTop.ASystemTopAlso">
<short/>
</element>
<element name="TApplication.IsWaiting">
<short>True if the application is waiting for a message event.</short>
<descr>
<p>
The return value is <b>True</b> when <var>AppWaiting</var> has been included in the <var>Flags</var> for the application.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.IsWaiting.Result">
<short>True if the application is in AppWaiting state.</short>
</element>
<element name="TApplication.CancelHint">
<short>
Called when the Hint timer has expired to stop showing the Hint.
</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.HideHint">
<short>Hides the Hint window.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.HintMouseMessage">
<short>Called when the the mouse is over a control with a Hint.</short>
<descr>Does nothing.</descr>
<seealso/>
</element>
<element name="TApplication.HintMouseMessage.Control">
<short/>
</element>
<element name="TApplication.HintMouseMessage.AMessage">
<short/>
</element>
<element name="TApplication.Initialize">
<short>Initializes the widgetset (and more).</short>
<descr>
<p>
<var>Initialize</var> is an overridden procedure in TApplication used to perform initialization tasks for the application. Initialize calls the inherited method to provide support for instance counting in the custom application. Initialize ensures that the <var>WidgetSet</var> class type is assigned for the application, and that the Screen singleton is initialized and updated.
</p>
<p>
Initialize raises an <var>Exception</var> if WidgetSet has not been assigned, or contains a class type other than <var>TWidgetSet</var>, for the application.
</p>
<p>
Initialize updates the <var>Flags</var> property to include the value <b>AppInitialized</b> when both the LCL interface (Widgetset) and the Screen singleton have been configured.
</p>
<p>
Initialize loads the graphic image used in the <var>Icon</var> property. If a resource with the name <b>MAINICON</b> is included in the Lazarus Resource, it is loaded and used as the application icon. Otherwise, <var>FindResource</var> is called to locate and load the named icon from the resource handle.
</p>
</descr>
<errors>
Raises an Exception if the WidgetSet class is invalid or not assigned.
</errors>
<seealso>
<link id="Screen"/>
<link id="TApplication.Icon"/>
<link id="TApplication.Flags"/>
<link id="#lcl.interfacebase.WidgetSet">WidgetSet</link>
<link id="#fcl.custapp.TCustomApplication.Initialize">TCustomApplication.Initialize</link>
</seealso>
</element>
<element name="TApplication.MessageBox">
<short>Display an message dialog with response buttons.</short>
<descr>
<p>
The function is used internally to display messages during the handling of <var>Exceptions</var>, but is also available to application programmers as an alternative to some of the message dialogs found in the <file>Dialogs</file> unit.
</p>
<p>
The function returns an integer value corresponding to the button that was pressed; its value can be determined by reference to the constants [IDOK..IDHELP].
</p>
</descr>
<seealso>
<link id="#lcl.Dialogs.MessageDlg">MessageDlg</link>
</seealso>
<example file="dialogs/displaymessagebox.pas"/>
</element>
<element name="TApplication.MessageBox.Result">
<short>Indicates the pressed button.</short>
<descr>
<p>Can be one of the following values:</p>
<ul>
<li>IDOK</li>
<li>IDCANCEL</li>
<li>IDABORT</li>
<li>IDRETRY</li>
<li>IDIGNORE</li>
<li>IDYES</li>
<li>IDNO</li>
<li>IDCLOSE</li>
<li>IDHELP</li>
</ul>
</descr>
</element>
<element name="TApplication.MessageBox.Text">
<short>The text in the MessageBox.</short>
<descr/>
</element>
<element name="TApplication.MessageBox.Caption">
<short>The Caption of the MessageBox.</short>
<descr/>
</element>
<element name="TApplication.MessageBox.Flags">
<short>
The icon and buttons appearing in the message box.
</short>
<descr>
<p>
Several constants are declared in the LCLType unit.
</p>
<p>Add (better: OR) an icon constant and a buttons constant. For example:</p>
<code>MB_ABORTRETRYIGNORE + MB_ICONQUESTION</code>
<p>Causes the application to display a query (?) icon in a box with three buttons: ABORT RETRY IGNORE.</p>
<p>Buttons can be one of:</p>
<ul>
<li>MB_OK</li>
<li>MB_OKCANCEL</li>
<li>MB_ABORTRETRYIGNORE</li>
<li>MB_YESNOCANCEL</li>
<li>MB_YESNO</li>
<li>MB_RETRYCANCEL</li>
</ul>
<p>The icon can be one of:</p>
<ul>
<li>MB_ICONHAND</li>
<li>MB_ICONQUESTION</li>
<li>MB_ICONEXCLAMATION</li>
<li>MB_ICONASTERISK</li>
<li>MB_ICONWARNING (same as MB_ICONEXCLAMATION)</li>
<li>MB_ICONERROR (same as MB_ICONHAND)</li>
<li>MB_ICONSTOP (same as MB_ICONHAND)</li>
<li>MB_ICONINFORMATION (same as MB_ICONASTERISK)</li>
</ul>
</descr>
</element>
<element name="TApplication.Minimize">
<short>
Asks the widgetset to minimize the application.
</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.ModalStarted">
<short>Called when a modal form display is started.</short>
<descr>
Invokes all OnModalBegin handlers when entering Modal state.
</descr>
<seealso>
<link id="TApplication.ModalFinished"/>
</seealso>
</element>
<element name="TApplication.ModalFinished">
<short>Called when a modal form is closed.</short>
<descr>
Invokes all OnModalEnd handlers when exiting Modal state.
</descr>
<seealso>
<link id="TApplication.ModalStarted"/>
</seealso>
</element>
<element name="TApplication.Restore">
<short>Restores a previously minimized application.</short>
<descr>
<p>
Calls the <var>AppRestore</var> method in the widgetset class, which generally restores the main form for the application and re-focuses its active control. It will also restore an active modal dialog.
</p>
</descr>
<seealso>
<link id="TApplication.Minimize"/>
</seealso>
</element>
<element name="TApplication.Notification">
<short>
Performs actions when a component is added to or removed from the application.
</short>
<descr>
<p>
<var>Notification</var> is an overridden method in <var>TApplication</var> used to perform actions needed when a component is added to or removed from the application. Notification provides special handling when component references are removed. It ensures that the internal member for a given component is set to <var>Nil</var> when the reference is freed. If the freed component is the MainForm for the application, the Terminate method is called to shut down the application and update the OS-level ExitCode.
</p>
</descr>
<seealso>
<link id="#rtl.Classes.TComponent.Notification">TComponent.Notification</link>
</seealso>
</element>
<element name="TApplication.Notification.AComponent">
<short>Component for the notification.</short>
</element>
<element name="TApplication.Notification.Operation">
<short>Operation performed for the component reference.</short>
</element>
<element name="TApplication.ProcessMessages">
<short>
Call this method during lengthy operations to ensure the GUI remains responsive.
</short>
<descr>
<p>
Calls <var>AppProcessMessages</var> in the widgetset class to processes pending messages, and calls <var>ProcessAsyncCallQueue</var> to handle any queued asynchronous callbacks.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.Idle">
<short>Called when the application enters the idle state.</short>
<descr>
<p>
Idle is a method used to perform actions when the application enters an idle state. It allows the application to free components pending release, and handle any queued asynchronous requests.
</p>
<p>
In addition, Idle calls event and application handlers assigned in the class instance. OnIdle is signalled (when assigned). NotifyIdleHandler is called to signal any application handler(s) using the ahtIdle handler type.
</p>
<p>
The DoIdleActions method is called to update the actions for Visible and Enabled forms, and to hide visible splash screen forms (FormStyle is fsSplash).
</p>
<p>
When the Wait argument is set to True, the AppWaitMessage method in the widgetset class is called to capture an message on the handles for the application. This action is not performed when Wait is False.
</p>
<p>
Idle calls the DoOnIdleEnd method to signal the OnIdleEnd event handler and any application handlers using the ahtIdleEnd handler type.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.Idle.Wait">
<short>Indicates if the method waits for the next message.</short>
</element>
<element name="TApplication.Run">
<short>
Loads the MainForm and passes control to the event loop for the application.
</short>
<descr>
</descr>
<seealso>
<link id="#fcl.CustApp.TCustomApplication.Run">TCustomApplication.Run</link>
</seealso>
</element>
<element name="TApplication.ShowException">
<short>
Shows the message for the specified exception and asks the user to abort or continue.
</short>
<descr>
<p>
<var>E</var> is the Exception instance with the message displayed in the method. If the message contains an invalid UTF-8 codepoint, AnsiToUtf8 is called to get a valid UTF-8 value for the exception message.
</p>
<p>
ShowException creates a dialog to display the exception message. If the exception occurred before the application was fully initialized, the inherited ShowException method is called.
</p>
<p>
The value in the ExceptionDialog property determines the type of dialog displayed for the message, and the buttons available on the dialog. While the dialog is active, the OnIdle event handlers in the application are disabled. They are re-enabled when the dialog is closed. The modal result from the dialog determines whether the application is terminated by calling Halt, or allowed to continue.
</p>
<remark>
No actions are performed in the method when AppNoExceptionMessages has been included in the Flags for the application. The exception message is not displayed and control is returned to the calling routine.
</remark>
</descr>
<seealso>
<link id="TApplication.ExceptionDialog"/>
<link id="TApplication.Flags"/>
<link id="TApplicationFlags"/>
<link id="TApplicationFlag"/>
<link id="#fcl.CustApp.TCustomApplication.ShowException">TCustomApplication.ShowException</link>
<link id="#rtl.system.Halt">Halt</link>
<link id="#rtl.sysutils.Exception">Exception</link>
</seealso>
</element>
<element name="TApplication.ShowException.E">
<short>
The exception with the message to display in the method.
</short>
</element>
<element name="TApplication.Terminate">
<short>
The application is terminated and the component engine is shutdown.
</short>
<descr>
<p>
<var>Terminate</var> is an overridden method in <var>TApplication</var>, and calls the inherited method on entry to set the values in Terminated and ExitCode. It calls the AppTerminate method the widgetset class instance to perform actions needed to halt the application using the mechanism(s) for the operating system or platform.
</p>
<p>
Use Terminated to determine if the method has already been called and has not yet been completed in the widgetset class.
</p>
</descr>
<seealso>
<link id="#fcl.custapp.TCustomApplication.Terminate">TCustomApplication.Terminate</link>
<link id="#fcl.custapp.TCustomApplication.Terminated">TCustomApplication.Terminated</link>
</seealso>
</element>
<element name="TApplication.DisableIdleHandler">
<short>Disables Idle handling.</short>
<descr>
<p>
Blocks Idle handling by incrementing the internal idle lock counter. Can be called multiple times, but each call must be followed by EnableIdleHandler.
</p>
<p>
Used in the ShowException method while an exception dialog is active.
</p>
</descr>
<seealso>
<link id="TApplication.EnableIdleHandler"/>
<link id="TApplication.ShowException"/>
</seealso>
</element>
<element name="TApplication.EnableIdleHandler">
<short>Resumes Idle handling.</short>
<descr>
<p>
Attempts to re-enable idle handling by decrementing the internal idle lock counter. Idle handling is enabled when the internal idle lock counter is 0.
</p>
<p>
Called from the ShowException method when the exception dialog is exited.
</p>
</descr>
<errors>
Raises a catchable GDB Exception if the idle handler has not already been disabled.
</errors>
<seealso>
<link id="TApplication.DisableIdleHandler"/>
</seealso>
</element>
<element name="TApplication.NotifyUserInputHandler">
<short>Notifies all user input handlers of the specified message.</short>
<descr>
<p>
Ensures that ActivateHint or CancelHint is called for a mouse message in the Msg argument.
</p>
<p>
Signals the OnUserInput event handler when assigned to allow filtering messages at the application level. Signals each of the user input handlers for the application using the Sender object instance and Msg as arguments. Sender defaults to the application instance when unassigned.
</p>
<p>
<var>NotifyUserInputHandler</var> is used to pass mouse and character events between a widgetset class instance and the forms and controls in an application. It is called from the message processing mechanism that is part of the LCL interface.
</p>
</descr>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.NotifyUserInputHandler.Msg">
<short>
Message examined in the method for mouse or character events.
</short>
</element>
<element name="TApplication.NotifyKeyDownBeforeHandler">
<short>Notifies all ahtKeyDownBefore handlers.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.NotifyKeyDownBeforeHandler.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TApplication.NotifyKeyDownBeforeHandler.Key">
<short>Key code examined in the event handler.</short>
</element>
<element name="TApplication.NotifyKeyDownBeforeHandler.Shift">
<short>Ctrl, Alt, Shift modifier for the key code.</short>
</element>
<element name="TApplication.NotifyKeyDownHandler">
<short>
Notifies all ahtKeyDownAfter handlers, and eventually reacts to F1 (Help).
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.NotifyKeyDownHandler.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TApplication.NotifyKeyDownHandler.Key">
<short>Key code examined in the event handler.</short>
</element>
<element name="TApplication.NotifyKeyDownHandler.Shift">
<short>Ctrl, Alt, Shift modifier for the key code.</short>
</element>
<element name="TApplication.ControlKeyDown">
<short>
Handles KeyDown events in a Control, e.g. handles navigation keys.
</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.ControlKeyDown.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TApplication.ControlKeyDown.Key">
<short>Key code examined in the event handler.</short>
</element>
<element name="TApplication.ControlKeyDown.Shift">
<short>Ctrl, Alt, Shift modifier for the key code.</short>
</element>
<element name="TApplication.ControlKeyUp">
<short>
Handles KeyUp events in a Control, e.g. handles Enter and Esc keys.
</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.ControlKeyUp.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TApplication.ControlKeyUp.Key">
<short>Key code examined in the event handler.</short>
</element>
<element name="TApplication.ControlKeyUp.Shift">
<short>Ctrl, Alt, Shift modifier for the key code.</short>
</element>
<element name="TApplication.AddOnIdleHandler">
<short>
Adds an application Idle handler to the list of handlers for the type.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnIdleHandler.Handler">
<short>Idle handler Routine added to the handlers for the type.</short>
</element>
<element name="TApplication.AddOnIdleHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first item in the list. <b>False</b> if the handler is appended to the list.
</short>
</element>
<element name="TApplication.RemoveOnIdleHandler">
<short>
Removes an application Idle handler for the list of handlers for the type.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnIdleHandler.Handler">
<short>
Handler routine removed from the list of idle handlers.
</short>
</element>
<element name="TApplication.AddOnIdleEndHandler">
<short>
Adds an application IdleEnd handler to the list of handlers for the type.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnIdleEndHandler.Handler">
<short>
Idle end handler routine added to the list of handlers.
</short>
</element>
<element name="TApplication.AddOnIdleEndHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first item in the list. <b>False</b> if the handler is appended to the list.
</short>
</element>
<element name="TApplication.RemoveOnIdleEndHandler">
<short>Removes an application IdleEnd handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnIdleEndHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnUserInputHandler">
<short>
Adds an application user input handler to the list of handlers for the type.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnUserInputHandler.Handler">
<short>
Handler routine added in the method to the list of handlers.
</short>
</element>
<element name="TApplication.AddOnUserInputHandler.AsFirst">
<short>
<b>True</b> if the handler routine is inserted as the first entry in the list. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnUserInputHandler">
<short>
Removes an application user input handler from the list of handlers for the type.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnUserInputHandler.Handler">
<short>Handler routine removed from the list of handlers.</short>
</element>
<element name="TApplication.AddOnKeyDownBeforeHandler">
<short>Adds an application key down before interface handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnKeyDownBeforeHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnKeyDownBeforeHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnKeyDownBeforeHandler">
<short>Removes an application key down before interface handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnKeyDownBeforeHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnKeyDownHandler">
<short>
Adds an application key down handler to the list for the type.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnKeyDownHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnKeyDownHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnKeyDownHandler">
<short>Removes an application key down after interface handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnKeyDownHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnActivateHandler">
<short>Adds an application activation handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnActivateHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnActivateHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnActivateHandler">
<short>Removes an application activation handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnActivateHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnDeactivateHandler">
<short>Adds an application deactivation handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnDeactivateHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnDeactivateHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnDeactivateHandler">
<short>Removes an application deactivation handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnDeactivateHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnExceptionHandler">
<short>Adds an application exception handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnExceptionHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnExceptionHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnExceptionHandler">
<short>Removes an application exception handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnExceptionHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnEndSessionHandler">
<short>Adds an application logoff handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnEndSessionHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnEndSessionHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnEndSessionHandler">
<short>Removes an application logoff handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnEndSessionHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnQueryEndSessionHandler">
<short>Adds an application logoff query handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnQueryEndSessionHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnQueryEndSessionHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnQueryEndSessionHandler">
<short>Removes an application logoff query handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnQueryEndSessionHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnMinimizeHandler">
<short>Adds an application minimizing handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnMinimizeHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnMinimizeHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnMinimizeHandler">
<short>Removes an application minimizing handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnMinimizeHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnModalBeginHandler">
<short>Adds an application becoming modal handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnModalBeginHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnModalBeginHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnModalBeginHandler">
<short>Removes an application becoming modal handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnModalBeginHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnModalEndHandler">
<short>Adds an application exiting modal state handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnModalEndHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnModalEndHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnModalEndHandler">
<short>Removes an application exiting modal state handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnModalEndHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnRestoreHandler">
<short>Adds an application exiting minimized state handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnRestoreHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnRestoreHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnRestoreHandler">
<short>Removes an application exiting minimized state handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnRestoreHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnDropFilesHandler">
<short>Adds an application dropped files handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnDropFilesHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnDropFilesHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnDropFilesHandler">
<short>Removes an application dropped files handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnDropFilesHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnHelpHandler">
<short>Adds an application Help handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnHelpHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnHelpHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnHelpHandler">
<short>Removes an application Help handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnHelpHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnHintHandler">
<short>Adds an application Hint handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnHintHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnHintHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnHintHandler">
<short>Removes an application Hint handler.</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnHintHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnShowHintHandler">
<short>
Adds an application Hint show handler to the list for the handler type.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnShowHintHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnShowHintHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnShowHintHandler">
<short>
Removes an application Hint show handler from the list for the handler type.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnShowHintHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.AddOnGetMainFormHandleHandler">
<short>
Adds a handler signalled when the application MainForm handle is retrieved.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.AddOnGetMainFormHandleHandler.Handler">
<short>
Handler routine added in the method to the list of handlers for the type.
</short>
</element>
<element name="TApplication.AddOnGetMainFormHandleHandler.AsFirst">
<short>
<b>True</b> if the handler is inserted as the first routine in the list of handlers. <b>False</b> if it is appended to the end of the list.
</short>
</element>
<element name="TApplication.RemoveOnGetMainFormHandleHandler">
<short>
Removes a handler used to get the handle for the main form in the application.
</short>
<descr/>
<seealso>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.RemoveOnGetMainFormHandleHandler.Handler">
<short>
Handler routine removed in the method.
</short>
</element>
<element name="TApplication.RemoveAllHandlersOfObject">
<short>
Removes all handlers implemented for the specified object.
</short>
<descr>
<p>
<var>RemoveAllHandlersOfObject</var> ensures that all handler routines for the object specified in AnObject are removed from the method lists for each of the TApplicationHandlerType values. The RemoveAllMethodsOfObject method in each of the TMethodList instances is called to remove the handlers for the specified object.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.RemoveAllHandlersOfObject.AnObject">
<short/>
</element>
<element name="TApplication.DoBeforeMouseMessage">
<short>
Performs actions needed before a mouse message is processed in the application.
</short>
<descr>
<p>
DoBeforeMouseMessage ensures that the value in MouseControl is updated before the mouse message is handled in the application. It calls UpdateMouseControl to assign the control under the mouse pointer to the CurMouseControl argument.
</p>
<p>
DoBeforeMouseMessage is called when messages are exchanged between a widgetset class instance and the LCL application.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.DoBeforeMouseMessage.CurMouseControl">
<short>
Current value for the MouseControl property. May be updated with the new control under the mouse pointer in the method.
</short>
</element>
<element name="TApplication.IsShortcut">
<short>
Checks whether a handler is available for the shortcut key in the message.
</short>
<descr>
<p>
The return value is set to True if the key code in the message is handled by the application or one of the enabled forms or controls in the application.
</p>
<p>
IsShortCut signals the OnShortcut event handler (when assigned) to determine if the accelerator is handled at the application level. If it is handled in OnShortcut, no additional actions are performed in the method.
</p>
<p>
Next, an enabled modal form on the screen calls its IsShortCut method to examine the accelerator.
</p>
<p>
The active form for the Screen is checked when it is enabled by calling its IsShortCut method.
</p>
<p>
Finally, the main form for the application is checked by calling its IsShortCut method.
</p>
<p>
The return value is False when the shortcut is not handled in any of the preceding calls to IsShortCut.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.IsShortcut.Result">
<short>True when the shortcut is handled.</short>
</element>
<element name="TApplication.IsShortcut.Message">
<short>
Message with the key code for the accelerator.
</short>
</element>
<element name="TApplication.IntfQueryEndSession">
<short>Called by the interface to confirm the end of a session.</short>
<descr>
<p>
Asks all QueryEndSession handlers to confirm termination of the application.
</p>
</descr>
<seealso>
<link id="TApplication.OnQueryEndSession"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.IntfQueryEndSession.Cancel">
<short/>
</element>
<element name="TApplication.IntfEndSession">
<short>Called by the interface when the session ends.</short>
<descr>Notifies all OnEndSession handlers.</descr>
<seealso>
<link id="TApplication.OnEndSession"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.IntfAppActivate">
<short>Called by the interface on application activation.</short>
<descr>
Notifies all activation handlers.
</descr>
<seealso>
<link id="TApplication.OnActivate"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.IntfAppDeactivate">
<short>Called by the interface on application deactivation.</short>
<descr/>
<seealso>
<link id="TApplication.OnDeactivate"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.IntfAppMinimize">
<short>Called by the interface when the application is minimized.</short>
<descr/>
<seealso>
<link id="TApplication.OnMinimize"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.IntfAppRestore">
<short>Called by the interface when the application is restored.</short>
<descr/>
<seealso>
<link id="TApplication.OnRestore"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.IntfDropFiles">
<short>Called by the interface when files have been dropped.</short>
<descr/>
<seealso>
<link id="TApplication.OnDropFiles"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.IntfDropFiles.FileNames">
<short/>
</element>
<element name="TApplication.IntfSettingsChange">
<short>
Called when the WM_SETTINGCHANGE message is handled for the application.
</short>
<descr>
<p>
Calls <var>GetFormatSettingsUTF8</var> or <var>GetFormatSettings</var>, depending on use of UTF-8 in the RTL, when UpdateFormatSettings is set to True. This applies to Windows platforms only.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.IntfThemeOptionChange">
<short>Called by the interface when a theme option has changed.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.IntfThemeOptionChange.AThemeServices">
<short/>
</element>
<element name="TApplication.IntfThemeOptionChange.AOption">
<short/>
</element>
<element name="TApplication.IsRightToLeft">
<short>Indicates if BiDiMode contains a value other than bdLeftToRight.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.IsRightToLeft.Result">
<short/>
</element>
<element name="TApplication.IsRTLLang">
<short>Checks the given language name for use of right-to-left reading.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.IsRTLLang.Result">
<short>True when the language code uses right-to-left reading.</short>
</element>
<element name="TApplication.IsRTLLang.ALang">
<short>ISO language code examined in the method.</short>
</element>
<element name="TApplication.Direction">
<short>
Gets the TBidiMode value with the direction for the specified language name.
</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.Direction.Result">
<short>TBiDiMode value for the specified language.</short>
</element>
<element name="TApplication.Direction.ALang">
<short>ISO language name examined in the method.</short>
</element>
<element name="TApplication.DoArrowKey">
<short>Uses arrow keys for navigation, if enabled.</short>
</element>
<element name="TApplication.DoArrowKey.AControl">
<short>The control receiving the key.</short>
</element>
<element name="TApplication.DoArrowKey.Key">
<short>The virtual key; becomes VK_UNKNOWN when handled.</short>
</element>
<element name="TApplication.DoArrowKey.Shift">
<short>The active modifier keys.</short>
</element>
<element name="TApplication.DoTabKey">
<short>Uses the Tab key for navigation, if enabled.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.DoTabKey.AControl">
<short>The control receiving the key.</short>
</element>
<element name="TApplication.DoTabKey.Key">
<short>The virtual key; becomes VK_UNKNOWN when handled.</short>
</element>
<element name="TApplication.DoTabKey.Shift">
<short>Shift, Ctrl or Alt modifier for the virtual key.</short>
</element>
<element name="TApplication.DoEscapeKey">
<short>Interprets Esc as Cancel action, if applicable.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.DoEscapeKey.AControl">
<short>The control receiving the key.</short>
</element>
<element name="TApplication.DoEscapeKey.Key">
<short>The virtual key; becomes VK_UNKNOWN when handled.</short>
</element>
<element name="TApplication.DoEscapeKey.Shift">
<short>The active modifier keys.</short>
</element>
<element name="TApplication.DoReturnKey">
<short>Interprets Enter as the default action, if applicable.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.DoReturnKey.AControl">
<short>The control receiving the key.</short>
</element>
<element name="TApplication.DoReturnKey.Key">
<short>The virtual key; becomes VK_UNKNOWN when handled.</short>
</element>
<element name="TApplication.DoReturnKey.Shift">
<short>The active modifier keys.</short>
</element>
<element name="TApplication.Active">
<short>True if the application is focused.</short>
<descr>
<p>
<var>Active</var> is a read-only <var>Boolean</var> property which indicates if the application is focused. Returns <b>True</b> if the <var>AppActive</var> flag has been included in the <var>Flags</var> for the application.
</p>
<p>
The value in Active (and Flags) is updated when the private <var>Activate</var> or <var>Deactivate</var> methods are called.
</p>
</descr>
<seealso>
<link id="TApplication.Flags"/>
<link id="TApplicationFlags"/>
<link id="TApplicationFlag"/>
</seealso>
</element>
<element name="TApplication.ApplicationType">
<short>
The type of the application (i.e. the sort of device for which it is intended).
</short>
<descr>
<p>The type of the application:</p>
<p>Default, Desktop, Handheld, PDA, Smartphone</p>
</descr>
<seealso/>
</element>
<element name="TApplication.BidiMode">
<short>The bidirectional mode to use.</short>
</element>
<element name="TApplication.CaptureExceptions">
<short>Enables exception handling in the Application.</short>
<descr/>
<seealso/>
</element>
<element name="TApplication.DoubleBuffered">
<short>Indicates if the application uses double buffering.</short>
<descr>
<p>
Double buffering is a technique used to reduce screen flickering when form and controls are (re)drawn. When enabled, an off-screen buffer is used to accelerate drawing operations.
</p>
<p>
The default value for the property is adbDefault and indicates that the application uses the default capabilities provided by the widgetset.
</p>
<remark>
DoubleBuffered is a platform-specific property. Only the Windows platform implements double buffering (at the widgetset level) in the current LCL version. Changing the value for the property to True has no effect if double buffering is not implemented for the widgetset used in the Application.
</remark>
</descr>
<seealso/>
</element>
<element name="TApplication.ExtendedKeysSupport">
<short>
Controls whether extended key codes are available in key down and key up messages.
</short>
<descr>
<p>
When enabled, ExtendedKeysSupport causes Shift, Ctrl, and Alt (Menu) (Options or Mac OS) to generate distinct values for the left and right keys. The values can then be handled in OnKeyDown and OnKeyUp event handlers, or in overridden KeyDown and KeyUp methods.
</p>
<p>
See VK_LSHIFT in LCLType for more details.
</p>
</descr>
<seealso>
<link id="#lcl.lcltype.VK_LSHIFT"/>
</seealso>
</element>
<element name="TApplication.ExceptionDialog">
<short>
Indicates the dialog type used for an exception in the application.
</short>
<descr>
<p>
<var>ExceptionDialog</var> is a <var>TApplicationExceptionDlg</var> property which indicates the dialog type displayed for an exception handled by the application instance. The default value for the property is <var>aedOkCancelDialog</var>, as assigned in the <var>Create</var> constructor.
</p>
<p>
See TApplicationExceptionDlg for more information about values in the enumeration and their meanings.
</p>
</descr>
<seealso>
<link id="TApplicationExceptionDlg"/>
<link id="TApplication.Create"/>
<link id="TApplicationProperties.ExceptionDialog"/>
</seealso>
</element>
<element name="TApplication.FindGlobalComponentEnabled">
<short>Enables searching for global components by name.</short>
<descr>
<p>
This property is used by TReader to auto rename forms in the application to unique names.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.Flags">
<short>Contains state flags for the application.</short>
<descr>
<p>
<var>Flags</var> is a <var>TApplicationFlags</var> property which contains flag values currently enabled for the application. It is a set type, and may contain zero or more values from the <var>TApplicationFlag</var> enumeration.
</p>
<p>
Values in Flags are updated when methods are executed in the class instance. A value may be transient in nature, and exist only while a particular method is running. They may also be more permanent, and indicate actions which have been performed and/or completed.
</p>
<p>
Values are added to and removed from Flags in methods like:
</p>
<ul>
<li>Create</li>
<li>Destroy</li>
<li>Initialize</li>
<li>Activate</li>
<li>Deactivate</li>
<li>Idle</li>
<li>ShowException</li>
</ul>
</descr>
<seealso>
<link id="TApplicationFlags"/>
<link id="TApplicationFlag"/>
</seealso>
</element>
<element name="TApplication.Handle">
<short>Provides access to the widgetset handle for the application instance.</short>
<descr>
<p>
<var>Handle</var> is a <var>THandle</var> property which provides access to the widgetset handle used for the application instance. Reading the value for the property is redirected to the AppHandle allocated in the widgetset class. Setting the value for the property causes the AppHandle in the widgetset class to be updated with the new value.
</p>
<p>
Handle is used to send and receive window messages and state change notifications for the application instance using the <b>LCL</b> interface.
</p>
</descr>
<seealso>
<link id="TWidgetSet.AppHandle"/>
</seealso>
</element>
<element name="TApplication.Hint">
<short>The current Hint text.</short>
<descr>
<p>
A hint is a pop-up message that appears briefly while the mouse hovers over a control. It usually displays useful information about how to use the UI element, or the type of data that should be entered, etc.
</p>
<p>
Other properties can be used to customize the delay before a Hint is shown, after the mouse is moved away from the control or form, and how long it will remain visible.
</p>
</descr>
<seealso>
<link id="TApplication.HintPause"/>
<link id="TApplication.HintHidePause"/>
<link id="TApplication.HintHidePausePerChar"/>
</seealso>
</element>
<element name="TApplication.HintColor">
<short>The background color for a Hint window.</short>
<descr>
<p>
<var>HintColor</var> is a <var>TColor</var> property with the color for the background in a <var>Hint</var> window.
</p>
<p>
The default value for the property is defined in the <var>DefHintColor</var> constant and assigned in the constructor for the application instance. Changing the value for the property causes the color in the internal <var>THintWindow</var> instance to be updated with the new property value.
</p>
<p>
HintColor is used in the <var>ShowHintWindow</var> method to configure the hint information displayed using a CM_HINTSHOW control message. It may be updated in the same method to use the value returned when the message is handled for the application.
</p>
</descr>
<seealso>
<link id="TApplication.Hint"/>
<link id="TApplication.ShowHint"/>
<link id="TApplication.ShowHintWindow"/>
<link id="THintWindow"/>
</seealso>
</element>
<element name="TApplication.HintHidePause">
<short>
Indicates how long a Hint remains visible after the mouse pointer is moved.
</short>
<descr>
<p>
<var>HintHidePause</var> is an <var>Integer</var> property with the number of milliseconds (or ticks) that a Hint display remains visible after the mouse pointer leaves the control or form. The default value is defined in the DefHintHidePause constant and assigned to the property in the constructor for the application instance.
</p>
<p>
HintHidePause is used in the ShowHintWindow method to configure the hint information displayed using a CM_HINTSHOW control message.
</p>
</descr>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.HintHidePausePerChar">
<short>
Indicates how long a keystroke extends the time a Hint remains visible (added to HintHidePause).
</short>
<descr/>
<seealso>
<link id="TApplication.HintHidePause"/>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.HintPause">
<short>The delay before a Hint is shown for a form or control.</short>
<descr>
<p>
HintPause is an Integer property with the number of milliseconds to wait before a Hint window is displayed for a form or control.
</p>
<p>
The default value is defines in the DefHintPause constant and assigned to the property in the constructor for the application instance.
</p>
<p>
HintPause is used in the ActivateHint method, and provides the interval for the internal timer instance used for hints in the application.
</p>
</descr>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.HintShortCuts">
<short>
Enables or disables display of keyboard shortcuts (e. g. on menu items).
</short>
<descr>
<p>
HintShortCuts is a Boolean property controls display of shortcut characters for action-enabled items in the application. This applies to controls which utilize the TControlActionLink class. The default value for the property is <b>True</b>, and enables display of keyboard shortcuts or accelerators.
</p>
</descr>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.HintShortPause">
<short>The pause before a different Hint is displayed.</short>
<descr/>
<seealso>
<link id="TApplication.Hint"/>
</seealso>
</element>
<element name="TApplication.Icon">
<short>The icon associated with this application.</short>
<descr>
<p>
Icon is TIcon property with the image used to represent the application on the desktop, task bar, and system menus.
</p>
<p>
The image can be assigned to TIcon at design-time using the Lazarus object inspector, or by setting values in the Project options dialog. The image can also be assigned at run-time using properties and methods in the TIcon instance.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.LayoutAdjustmentPolicy">
<short>
Indicates the layout and sizing policy used for forms and controls in the application.
</short>
<descr/>
<seealso>
<link id="TLayoutAdjustmentPolicy"/>
</seealso>
</element>
<element name="TApplication.Navigation">
<short>Allows switching between controls using keyboard navigation.</short>
<descr>
<p>
By default, the following keys can be used for keyboard navigation in an LCL application:
</p>
<dl>
<dt>Tab, Shift+Tab</dt>
<dd>Moves the Focus to the next (or previous) control in TabOrder.</dd>
<dt>Enter</dt>
<dd>Triggers the default action for the form or control.</dd>
<dt>Escape</dt>
<dd>Triggers the Cancel action for the form or control.</dd>
<dt>F1</dt>
<dd>Displays context sensitive help (when available).</dd>
<dt>Cursor or arrow keys</dt>
<dd>Moves the focus or cursor.</dd>
</dl>
</descr>
<seealso>
<link id="TApplicationNavigationOptions"/>
</seealso>
</element>
<element name="TApplication.MainForm">
<short>Contains the main form for the application.</short>
<descr>
<p>
<var>MainForm</var> is a read-only <var>TForm</var> property which contains the form that is the main or primary form for the application.
</p>
<p>
The value in MainForm is assigned when the first form is created using the <var>CreateForm</var> method and the <var>FormStyle</var> for the form contains a value other than <var>fsSplash</var>.
</p>
<p>
The form instance in MainForm is displayed when the <var>Run</var> method is called to start the message processing loop for the application.
</p>
<p>
The application is terminated when this form is closed.
</p>
</descr>
<seealso>
<link id="TApplication.CreateForm"/>
<link id="TApplication.Run"/>
<link id="TCustomForm.FormStyle"/>
<link id="TForm"/>
</seealso>
</element>
<element name="TApplication.MainFormHandle">
<short>Window handle for the MainForm in the application.</short>
<descr>
<p>
<var>MainFormHandle</var> is a read-only <var>HWND</var> property which contains the handle for the form instance used as the main form in the application.
</p>
<p>
The value for the property is derived using the <var>OnGetMainFormHandle</var> event handler (when assigned) or a <var>TGetHandleEvent</var> handler assigned in the application. When neither of these mechanisms provides a value other than zero (0), the window handle assigned in the <var>MainForm</var> property is used.
</p>
<p>
MainFormHandle is used in the implementation of methods in WidgetSet classes, primarily for the Windows platform, and in custom-drawn controls.
</p>
</descr>
<seealso>
<link id="TApplication.MainForm"/>
<link id="TApplication.OnGetMainFormHandle"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.MainFormOnTaskBar">
<short>
Controls whether a button is displayed on the task bar for the main form in the application.
</short>
<descr>
<p>
<var>MainFormOnTaskBar</var> is a <var>Boolean</var> property which determines whether the icon for the main form in the application is displayed on the task bar. When MainFormOnTaskBar is set to <b>True</b>, a button representing the main form is displayed on the task bar area in the window manager. When set to <b>False</b>, the button is not displayed in the task bar area.
</p>
<p>
Changing the value in the property causes the Widgetset class to be notified of the new property value.
</p>
<p>
MainFormOnTaskBar is a platform-dependent property. It may not be implemented for all platforms supported for the Lazarus application. In addition, some platforms which display task bar thumbnails (like Windows Vista) may require the property to be set to True.
</p>
<p>
The default value for the property is normally set in the Lazarus project file (<b>.lpr</b>) used to compile the application.
</p>
</descr>
<seealso>
<link id="TApplication.MainForm"/>
<link id="TApplication.Icon"/>
<link id="TApplication.Title"/>
</seealso>
</element>
<element name="TApplication.ModalLevel">
<short>The number of modal forms shown.</short>
<descr>
<p>
<var>ModalLevel</var> is a read-only <var>Integer</var> property with the number of forms displayed modally in the application.
</p>
<p>
The value in ModalLevel is incremented in the <var>ModalStarted</var> method. It causes the <var>OnModalBegin</var> event handler and application handlers for the <var>ahtModalBegin</var> handler type to be signalled (when assigned) when its value is <b>1</b> following the increment.
</p>
<p>
The value in ModalLevel is decremented in the <var>ModalFinished</var> method. It causes the <var>OnModalEnd</var> event handler and application handlers for the <var>ahtModalEnd</var> handler type to be signalled (when assigned) when its value is <b>0</b> following the decrement.
</p>
</descr>
<seealso>
<link id="TApplication.ModalStarted"/>
<link id="TApplication.ModalFinished"/>
<link id="TApplication.OnModalBegin"/>
<link id="TApplication.OnModalEnd"/>
<link id="#lazutils.lazmethodlist.TMethodList.CallNotifyEvents">
TMethodList.CallNotifyEvents</link>
</seealso>
</element>
<element name="TApplication.MoveFormFocusToChildren">
<short>Indicates if an active control is focused when a form receives focus.</short>
<descr>
<p>
<var>MoveFormFocusToChildren</var> is a <var>Boolean</var> property which indicates if an active control is focused when a form receives focus in the application.
</p>
<p>
The default value is <b>True</b>. When set to <b>False</b>, the window or form will still receive focus, but a child control is not selected.
</p>
<p>
Used in the <var>SetActive</var> method in <var>TCustomForm</var>.
</p>
</descr>
<seealso>
<link id="TCustomForm.Active"/>
</seealso>
</element>
<element name="TApplication.MouseControl">
<short>Contains the control currently under the mouse pointer.</short>
<descr>
<p>
Used to detect when the mouse enters and leaves a control. MouseControl is updated and used in methods like GetControlAtMouse and UpdateMouseControl.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TApplication.TaskBarBehavior">
<short>Indicates how forms are represented in the task bar.</short>
<descr>
<p>
<var>TaskBarBehavior</var> is a <var>TTaskBarBehavior</var> property which indicates how forms in the application are represented in the task bar. The property value is used in conjunction with the <var>ShowInTaskBar</var> property for the TCustomForm instances in the application. For example:
</p>
<dl>
<dt>tbDefault</dt>
<dd>
Shows task bar buttons according to the default behavior for the platform.
</dd>
<dt>tbMultiButton</dt>
<dd>
Shows a task bar button for each form with stDefault in its ShowInTaskBar property.
</dd>
<dt>tbSingleButton</dt>
<dd>
Hide buttons for Forms with stDefault in its ShowInTaskBar property.
</dd>
</dl>
<p>
When the property value is changed, the <var>UpdateShowInTaskBar</var> for each TCustomForm instance is called when its ShowInTaskBar property is <var>stDefault</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.UpdateFormatSettings">
<short>
Indicates if application format settings are updated when changed in a widgetset class.
</short>
<descr>
<p>
<var>UpdateFormatSettings</var> is a platform-specific <var>Boolean</var> property which indicates if application format settings are updated when changed in a widgetset class. The default value for the property is <b>True</b>, as assigned in the <var>Create</var> constructor.
</p>
<p>
The property value is used in the <var>IntfSettingsChange</var> method to determine if the <var>GetFormatSettings</var> or <var>GetFormatSettingsUTF8</var> method is called for the Windows platform. GetFormatSettings is called when <b>DisableUTF8RTL</b> is defined for the compiler. Other platforms are not affected, and do not call either method.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.OnActionExecute">
<short>Default handler for unhandled Actions.</short>
<descr>
<p>
<var>OnActionExecute</var> is a <var>TActionEvent</var> property with the event handler signalled (when assigned) from the <var>ExecuteAction</var> method.
</p>
<p>
The <var>AAction</var> argument contains the <var>TBasicAction</var> instance executed in the event handler. <var>Handled</var> indicates whether the action was executed in the event handler. Set Handled to <b>False</b> if the action was not executed.
</p>
</descr>
<seealso>
<link id="TApplication.ExecuteAction"/>
<link id="#lcl.actnlist.TActionEvent">TActionEvent</link>
<link id="#rtl.classes.TBasicAction">TBasicAction</link>
</seealso>
</element>
<element name="TApplication.OnActionUpdate">
<short>Event handler signalled to update actions used in the application.</short>
<descr>
<p>
<var>OnActionUpdate</var> is a <var>TActionEvent</var> property with the event handler signalled to update actions used in the application. OnActionUpdate is signalled from the <var>UpdateAction</var> method called when the <var>CM_UPDATEACTIONS</var> control message is handled in the application.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.OnActivate">
<short>
Event handler signalled when an Activate message is handled in the application.
</short>
<descr>
<p>
<var>OnActivate</var> is a <var>TNotifyEvent</var> property with the event handler signalled when an <var>Activate</var> message is handled for the application.
</p>
<p>
OnActivate is signalled from the <var>NotifyActivateHandler</var> method, which occurs when the Activate method is called for the application. The event handler is also signalled (via Activate) from the <var>WMActivate</var> method in <var>TCustomForm</var> to ensure that the application is activated before one of its forms is updated in the task bar.
</p>
<p>
Use the <var>OnDeactivate</var> event handler to perform actions needed when the main form in an application is de-activated.
</p>
<p>
Use the <var>TApplicationProperties</var> class to assign properties and event handlers at design-time that are applied to the application instance at run-time.
</p>
</descr>
<seealso>
<link id="TApplication.NotifyActivateHandler"/>
<link id="TApplication.AddOnActivateHandler"/>
<link id="TApplication.RemoveOnActivateHandler"/>
<link id="TApplication.OnDeactivate"/>
<link id="TApplicationHandlerType"/>
<link id="TApplicationProperties"/>
</seealso>
</element>
<element name="TApplication.OnDeactivate">
<short>
Event handler signalled when a Deactivate message is handled in the application.
</short>
<descr>
<p>
<var>OnDeactivate</var> is a <var>TNotifyEvent</var> property with the event handler signalled when a <var>Deactivate</var> message is handled in the application.
</p>
<p>
It is signalled from the <var>NotifyDeactivateHandler</var> method, and occurs when the Deactivate method is called for the application. The event handler is also signalled (via Deactivate) from the <var>WMActivate</var> method in <var>TCustomForm</var> to ensure that the application is de-activated when its main form is de-activated.
</p>
<p>
Use the <var>OnActivate</var> event handler to perform actions needed when the application is activated.
</p>
<p>
Use the <var>TApplicationProperties</var> class to assign properties and event handlers at design-time that are applied to the application instance at run-time.
</p>
</descr>
<seealso>
<link id="TApplication.NotifyDeactivateHandler"/>
<link id="TApplication.AddOnDeactivateHandler"/>
<link id="TApplication.RemoveOnDeactivateHandler"/>
<link id="TApplicationHandlerType"/>
<link id="TApplicationProperties"/>
</seealso>
</element>
<element name="TApplication.OnGetMainFormHandle">
<short>
Event handler used to provide a value for the MainFormHandle property.
</short>
<descr>
<p>
Used in the implementation of the <var>GetMainFormHandle</var> method. Provides the first opportunity to set the value for <var>MainFormHandle</var> before calling the other handlers added to the application.
</p>
</descr>
<seealso>
<link id="TApplication.MainFormHandle"/>
<link id="TApplication.MainForm"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnIdle">
<short>Event handler signalled when the application enters the idle state.</short>
<descr>
<p>
<var>OnIdle</var> is a <var>TIdleEvent</var> property with the event handler signalled when the application enters the idle state. Assign an object procedure to the event handler to perform actions needed when other window or control messages are not present.
</p>
<p>
It is signalled from the <var>Idle</var> method, and occurs after released components and asynchronous callbacks have been processed for the application. It occurs before the <var>NotifyIdleHandler</var> method is called to process other application handlers using the <var>ahtIdle</var> type.
</p>
<p>
Any actions performed in the event handler should have a short duration, and relatively low resource requirements. This will ensure that system performance is not adversely affected, and the application is responsive.
</p>
<p>
Use <var>OnIdleEnd</var> to perform actions needed when the application leaves the idle state.
</p>
<p>
Use the <var>TApplicationProperties</var> class to assign properties and event handlers for an application instance at design-time that are applied at run-time.
</p>
</descr>
<seealso>
<link id="TApplication.Idle"/>
<link id="TApplication.NotifyIdleHandler"/>
<link id="TApplication.OnIdleEnd"/>
<link id="TApplicationHandlerType"/>
<link id="TApplicationProperties"/>
</seealso>
</element>
<element name="TApplication.OnIdleEnd">
<short>Event handler signalled when the application leaves the Idle state.</short>
<descr>
<p>
<var>OnIdleEnd</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the application leaves the <var>Idle</var> state.
</p>
<p>
It is signalled from the <var>DoOnIdleEnd</var> method, and occurs after the <var>AppWaitMessage</var> method in the widgetset class has been completed. It occurs before the <var>NotifyIdleEndHandler</var> method is called to process other application handlers using the <var>ahtIdleEnd</var> type.
</p>
<p>
Use <var>OnIdle</var> to perform actions needed when the application enters the idle state.
</p>
<p>
Use the <var>TApplicationProperties</var> class to assign properties and event handlers for an application instance at design-time that are applied at run-time.
</p>
</descr>
<seealso>
<link id="TApplication.Idle"/>
<link id="TApplication.NotifyIdleEndHandler"/>
<link id="TApplication.OnIdle"/>
<link id="TApplicationHandlerType"/>
<link id="TApplicationProperties"/>
</seealso>
</element>
<element name="TApplication.OnEndSession">
<short>Event handler signalled when a session is ended in the application.</short>
<descr>
<p>
<var>OnEndSession</var> is a <var>TNotifyEvent</var> property with the event handler signalled when a session is ended in the application. It is called from the <var>IntfEndSession</var> method, and occurs when the <var>WM_ENDSESSION</var> message is handled in the widget class. It is signalled before other application handlers using the <var>ahtEndSession</var> type.
</p>
<remark>
OnEndSession may not work reliably on all platforms supported supported for Lazarus. Some environments / window managers do not post a WM_ENDSESSION message when the process is killed.
</remark>
</descr>
<seealso>
<link id="TApplication.IntfEndSession"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnQueryEndSession">
<short>This event handler can deny to end the session.</short>
<descr/>
<seealso>
<link id="TApplication.IntfQueryEndSession"/>
<link id="TQueryEndSessionEvent"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnMinimize">
<short>Event handler signalled when the application is minimized.</short>
<descr>
<p>
<var>OnMinimize</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the application has been minimized (iconified in GTK terminology). The application is minimized when its main form is also minimized.
</p>
<p>
OnMinimize is signalled when the <var>IntfAppMinimize</var> method is called by the widgetset class, and occurs before other application handlers using the <var>ahtMinimize</var> type are notified.
</p>
<p>
Use <var>OnRestore</var> to perform actions when the main form is restored from its minimized state.
</p>
</descr>
<seealso>
<link id="TApplication.IntfAppMinimize"/>
<link id="TApplication.OnRestore"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnMessageDialogFinished">
<short>
Event handler signalled when a message dialog in the application has been completed.
</short>
<descr>
Used in the CustomDraw interface.
</descr>
<seealso/>
</element>
<element name="TApplication.OnModalBegin">
<short>
Event handler signalled when a form in the application is displayed as a modal form.
</short>
<descr>
<p>
<var>OnModalBegin</var> is a <var>TNotifyEvent</var> property with the event handler signalled when a form in the application is displayed as a modal form.
</p>
<p>
OnModalBegin is signalled from the <var>ModalStarted</var> method, which is called when the form instance calls its <var>ShowModal</var> method. It occurs only once - when the first modal form is displayed. Subsequent events are ignored in ModalStarted when a modal form is already active.
</p>
<p>
Use <var>OnModalEnd</var> to perform actions needed when the number of modal forms for the application reaches <b>0</b> (<b>zero</b>).
</p>
</descr>
<seealso>
<link id="TApplication.ModalStarted"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnModalEnd">
<short>
Event handler signalled when the last modal form for the application has been exited.
</short>
<descr>
<p>
<var>OnModalEnd</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the last modal form or dialog in the application has been exited.
</p>
<p>
It is signalled from the <var>ModalFinished</var> method if the number of modal forms in the application is <b>0</b> (<b>zero</b>). It is signalled prior to other application handlers using the <var>ahtModalEnd</var> handler type.
</p>
<p>
Use <var>OnModalBegin</var> to perform actions needed when the first modal form is displayed for the application.
</p>
</descr>
<seealso>
<link id="TApplication.ModalFinished"/>
<link id="TCustomForm.ShowModal"/>
<link id="#lcl.dialogs.TCommonDialog.Execute">TCommonDialog.Execute</link>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnRestore">
<short>
Event handler signalled when the application is restored from a minimized / maximized state.
</short>
<descr>
<p>
<var>OnRestore</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the application is restored from a minimized / maximized state. It is signalled from the <var>IntfAppRestore</var> method, and occurs before other application handlers using the <var>ahtRestore</var> type are notified.
</p>
<p>
Use OnMinimize to respond to the notification when the application is minimized.
</p>
</descr>
<seealso>
<link id="TApplication.IntfAppRestore"/>
<link id="TApplication.AddOnRestoreHandler"/>
<link id="TApplication.RemoveOnRestoreHandler"/>
<link id="TApplication.OnMinimize"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnDropFiles">
<short>
Event handler signalled when file(s) are dropped into the application.
</short>
<descr>
<p>
<var>OnDropFiles</var> is a <var>TDropFilesEvent</var> property with the event handler signalled when one or more files are dropped onto a form in the application. It is signalled from the <var>IntfDropFiles</var> method, and occurs after the corresponding method for the form that is the drop target has been notified from the window processing loop.
</p>
</descr>
<seealso>
<link id="TApplication.IntfDropFiles"/>
<link id="TCustomForm.IntfDropFiles"/>
<link id="TCustomForm.AllowDropFiles"/>
</seealso>
</element>
<element name="TApplication.OnHelp">
<short>
Event handler signalled when help is requested in the application.
</short>
<descr>
<p>
<var>OnHelp</var> is a <var>THelpEvent</var> property with the event handler signalled (if assigned) when help is requested in the application. It is signalled from the <var>DoOnHelp</var> method when the <var>ActiveForm</var> does not have an assigned <var>OnHelp</var> event handler or does not respond the specified help command. It occurs before other application handlers using the <var>ahtHelp</var> handler type are notified.
</p>
</descr>
<seealso>
<link id="TApplication.DoOnHelp"/>
<link id="TApplication.HelpContext"/>
<link id="TApplication.HelpKeyword"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnHint">
<short>Event handler signalled when a hint is requested in the application.</short>
<descr>
<p>
<var>OnHint</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the value for the <var>Hint</var> property has been changed in the application. It is signalled (when assigned) from the <var>SetHint</var> method, and occurs before other application handlers using the <var>ahtHint</var> handler type are notified.
</p>
</descr>
<seealso>
<link id="TApplication.Hint"/>
<link id="TApplication.AddOnHintHandler"/>
<link id="TApplication.RemoveOnHintHandler"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnShortcut">
<short>
Event handler signalled to determine if a keystroke message is a shortcut key in the application.
</short>
<descr>
<p>
<var>OnShortcut</var> is a <var>TShortcutEvent</var> property with the event handler signalled to determine if a keystroke message is a shortcut (or accelerator) key in the application. It is signalled (when assigned) from the <var>IsShortcut</var> method, and occurs before the OnShortcut event handlers for other forms are checked.
</p>
<p>
This event handler can interpret keystrokes as shortcuts, before the normal target handles the key. The event handler can set its <var>Handled</var> argument to <b>True</b> when the <var>Msg</var> argument contains a shortcut keystroke specific to the application. This prevents the OnShortcut event handlers in the application forms from being notified.
</p>
</descr>
<seealso>
<link id="TApplication.IsShortcut"/>
<link id="TShortCutEvent"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnShowHint">
<short>
Event handler signalled prior to displaying a hint window.
</short>
<descr>
<p>
<var>OnShowHint</var> is a <var>TShowHintEvent</var> property with the event handler signalled prior to displaying a hint window for the application.
</p>
<p>
It is signalled (when assigned) from the <var>ShowHintWindow</var> method when <var>ShowHint</var> has been enabled in the application. It occurs after <var>HintControl</var> has been assigned to the hint window, and the position for the hint window relative to HintControl has been calculated. It occurs before other application handlers using the ahtShowHint type are notified, and the hint window is made visible and activated.
</p>
</descr>
<seealso>
<link id="TApplication.ShowHintWindow"/>
<link id="TApplication.AddOnShowHintHandler"/>
<link id="TApplication.RemoveOnShowHintHandler"/>
<link id="TShowHintEvent"/>
<link id="TApplicationHandlerType"/>
</seealso>
</element>
<element name="TApplication.OnUserInput">
<short>
Event handler signalled to handle user input messages.
</short>
<descr>
<p>
<var>OnUserInput</var> is a <var>TOnUserInputEvent</var> property with the event handler signalled when an input message is available in the processing loop for the widgetset class. It is signalled (when assigned) from the <var>NotifyUserInputHandler</var> method, and occurs before other application handlers using the <var>ahtUserInput</var> type are notififed.
</p>
</descr>
<seealso>
<link id="TApplicationHandlerType"/>
<link id="TApplication.NotifyUserInputHandler"/>
<link id="TOnUserInputEvent"/>
</seealso>
</element>
<element name="TApplication.OnDestroy">
<short>Event handler signalled when the application is freed.</short>
<descr>
<p>
<var>OnDestroy</var> is signalled from the <var>Destroy</var> destructor prior to freeing resources allocated in the application class instance. It provides the first opportunity to respond to application shutdown after <var>Flags</var> has been updated to include the <var>AppDestroying</var> enumeration value.
</p>
</descr>
<seealso>
<link id="TApplication.Destroy"/>
<link id="TApplication.Flags"/>
<link id="TApplicationFlags"/>
</seealso>
</element>
<element name="TApplication.OnCircularException">
<short>
Event handler signalled when a circular exception occurs before the application is halted.
</short>
<descr>
<p>
<var>OnCircularException</var> is a <var>TExceptionEvent</var> property with the event handler signalled when a circular exception occurs in an application. It is signalled from the <var>HandleException</var> method when another Exception occurs within the exception handler.
</p>
</descr>
<seealso>
<link id="TApplication.HandleException"/>
<link id="TExceptionEvent"/>
</seealso>
</element>
<element name="TApplication.ShowButtonGlyphs">
<short>
Allows the platform defaults for glyphs on buttons to be overridden.
</short>
<descr>
<p>
Some platforms always show glyphs on buttons, while others do not.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TApplication.ShowMenuGlyphs">
<short>Sets the default policy for showing or hiding glyph images in menus.</short>
<descr/>
<seealso>
<link id="#lcl.menus.TGlyphShowMode">TGlyphShowMode</link>
</seealso>
</element>
<element name="TApplication.ShowHint">
<short>Indicates if Hints are displayed for the application.</short>
<descr>
<p>
<var>ShowHint</var> is a <var>Boolean</var> property which indicates if <var>Hints</var> are displayed for the application. It is used when tracking the position of the mouse cursor over controls and forms, and determines if the items require a hint display.
</p>
<p>
Setting the value in <var>ShowHints</var> to <b>False</b> causes an existing <var>THintWindow</var> instance in the application to be freed.
</p>
</descr>
<seealso>
<link id="TApplicationProperties.ShowHint"/>
<link id="TForm.ShowHint"/>
<link id="TControl.ParentShowHint"/>
<link id="THintWindow"/>
</seealso>
</element>
<element name="TApplication.ShowMainForm">
<short>
Allows the main form to be shown or hidden when an application is started.
</short>
<descr>
<p>
Allows the main form to be shown or hidden when an application is started. The default value for the property is <b>True</b> as assigned in the <var>Create</var> constructor.
</p>
<p>
The property value is updated at run-time when a new value is assigned to the <var>ShowMainFrom</var> property in <var>TApplicationProperties</var>.
</p>
<p>
ShowMainForm is used in the <var>Run</var> method to determine if the <var>Show</var> method is called for an assigned <var>MainForm</var> instance. The form is displayed prior to calling the <var>AppRun</var> method in the widgetset class.
</p>
</descr>
<seealso/>
</element>
<element name="TApplication.Title">
<short>Contains the title for the application.</short>
<descr>
<p>
The read and write access specifiers for the property are overridden in <var>TApplication</var>. Read access ensures that an empty title defaults to the file name (without path information) for the application executable file. Write access ensures that a new value for the property is applied to the widgetset class using its <var>AppSetTitle</var> method.
</p>
</descr>
<seealso>
<link id="#fcl.CustApp.TCustomApplication.Title">TCustomApplication.Title</link>
</seealso>
</element>
<element name="TApplication.Scaled">
<short>
Indicates if forms and controls in the application can be scaled to different display densities (Pixels per Inch).
</short>
<descr>
<p>
<var>Scaled</var> is a <var>Boolean</var> property which indicates if the application can be scaled between differing display densities (Pixels per Inch) at run-time. The default value for the property is normally set in the project file used to compile the application and its forms and controls.
</p>
<p>
When Scaled is set to <b>True</b>, the application allows the design-time PixelsPerInch value to be adjusted to reflect the run-time value. Forms, frames, image lists, and other controls also have a Scaled property which determines if the feature is enabled for that particular class type. If Scaled is set to <b>False</b> in TApplication, the feature is disabled for all of the other class types. Scaled (at the application-level) is normally checked before the component- or control-level setting.
</p>
</descr>
<seealso/>
</element>
<element name="DefaultApplicationBiDiMode">
<short>Contains the default BiDiMode value used for the current LCL version.</short>
<descr>
<p>
The default value is <var>bdLeftToRight</var>.
</p>
</descr>
<seealso/>
</element>
<element name="DefHintColor">
<short>The default hint window background color.</short>
<descr/>
<seealso/>
</element>
<element name="DefHintPause">
<short>
The default pause before the hint window is displayed (in milliseconds).
</short>
<descr/>
<seealso/>
</element>
<element name="DefHintShortPause">
<short>
The default pause (in milliseconds) before a Hint is re-displayed.
</short>
<descr/>
<seealso/>
</element>
<element name="DefHintHidePause">
<short>
The default pause before a hint is hidden (in milliseconds).
</short>
<descr/>
<seealso/>
</element>
<element name="DefHintHidePausePerChar">
<short>The default pause added to DefHintHidePause (in milliseconds).</short>
<descr/>
<seealso/>
</element>
<element name="TApplicationProperties">
<short>
A component that provides access to the properties for the current application.
</short>
<descr>
<p>
<var>TApplicationProperties</var> is a non-visual component used to provide design-time settings that are applied at run-time to an application, including:
</p>
<ul>
<li>CaptureExceptions</li>
<li>HelpFile</li>
<li>Hint</li>
<li>HintColor</li>
<li>HintHidePause</li>
<li>HintPause</li>
<li>HintShortCuts</li>
<li>HintShortPause</li>
<li>ShowButtonGlyphs</li>
<li>ShowMenuGlyphs</li>
<li>ShowHint</li>
<li>ShowMainForm</li>
<li>Title</li>
<li>OnException</li>
<li>OnGetMainFormHandle</li>
<li>OnIdle</li>
<li>OnIdleEnd</li>
<li>OnEndSession</li>
<li>OnQueryEndSession</li>
<li>OnMinimize</li>
<li>OnModalBegin</li>
<li>OnModalEnd</li>
<li>OnRestore</li>
<li>OnDropFiles</li>
<li>OnHelp</li>
<li>OnHint</li>
<li>OnShowHint</li>
<li>OnUserInput</li>
</ul>
<p>
Values for the properties are assigned in the constructor using the currently assigned values in the <var>Application</var> singleton. The assignments can be maintained at design-time.
</p>
<p>
At run-time, changes to the properties are also assigned to the <var>Application</var> singleton. For event handler properties, the previous routine is removed as a handler and the new handler is added to the <var>Application</var> singleton. When the component is freed, the event handlers are removed from the <var>Application</var> singleton. The changed properties are not assigned to the <var>Application</var> singleton at design-time.
</p>
<p>
<var>TApplicationProperties</var> is available on the <b>Additional</b> tab in the Lazarus IDE Component Palette. <var>TApplicationProperties</var> is similar to the TApplicationEvents class in Delphi.
</p>
</descr>
<seealso>
<link id="TApplicationProperties.Create"/>
<link id="TApplication"/>
<link id="Application"/>
</seealso>
</element>
<element name="TApplicationProperties.FCaptureExceptions" link="#lcl.forms.TApplicationProperties.CaptureExceptions"/>
<element name="TApplicationProperties.FExceptionDialogType"/>
<element name="TApplicationProperties.FHelpFile" link="#lcl.forms.TApplicationProperties.HelpFile"/>
<element name="TApplicationProperties.FHint" link="#lcl.forms.TApplicationProperties.Hint"/>
<element name="TApplicationProperties.FHintColor" link="#lcl.forms.TApplicationProperties.HintColor"/>
<element name="TApplicationProperties.FHintHidePause" link="#lcl.forms.TApplicationProperties.HintHidePause"/>
<element name="TApplicationProperties.FHintPause" link="#lcl.forms.TApplicationProperties.HintPause"/>
<element name="TApplicationProperties.FHintShortCuts" link="#lcl.forms.TApplicationProperties.HintShortCuts"/>
<element name="TApplicationProperties.FHintShortPause" link="#lcl.forms.TApplicationProperties.HintShortPause"/>
<element name="TApplicationProperties.FOnActivate"/>
<element name="TApplicationProperties.FOnDeactivate"/>
<element name="TApplicationProperties.FOnDropFiles" link="#lcl.forms.TApplicationProperties.OnDropFiles"/>
<element name="TApplicationProperties.FOnGetMainFormHandle" link="#lcl.forms.TApplicationProperties.OnGetMainFormHandle"/>
<element name="TApplicationProperties.FOnModalBegin" link="#lcl.forms.TApplicationProperties.OnModalBegin"/>
<element name="TApplicationProperties.FOnModalEnd" link="#lcl.forms.TApplicationProperties.OnModalEnd"/>
<element name="TApplicationProperties.FShowButtonGlyphs" link="#lcl.forms.TApplicationProperties.ShowButtonGlyphs"/>
<element name="TApplicationProperties.FShowHint" link="#lcl.forms.TApplicationProperties.ShowHint"/>
<element name="TApplicationProperties.FShowMainForm" link="#lcl.forms.TApplicationProperties.ShowMainForm"/>
<element name="TApplicationProperties.FShowMenuGlyphs" link="#lcl.forms.TApplicationProperties.ShowMenuGlyphs"/>
<element name="TApplicationProperties.FTitle" link="#lcl.forms.TApplicationProperties.Title"/>
<element name="TApplicationProperties.FOnException" link="#lcl.forms.TApplicationProperties.OnException"/>
<element name="TApplicationProperties.FOnIdle" link="#lcl.forms.TApplicationProperties.OnIdle"/>
<element name="TApplicationProperties.FOnIdleEnd" link="#lcl.forms.TApplicationProperties.OnIdleEnd"/>
<element name="TApplicationProperties.FOnHelp" link="#lcl.forms.TApplicationProperties.OnHelp"/>
<element name="TApplicationProperties.FOnHint" link="#lcl.forms.TApplicationProperties.OnHint"/>
<element name="TApplicationProperties.FOnShowHint" link="#lcl.forms.TApplicationProperties.OnShowHint"/>
<element name="TApplicationProperties.FOnUserInput" link="#lcl.forms.TApplicationProperties.OnUserInput"/>
<element name="TApplicationProperties.FOnEndSession" link="#lcl.forms.TApplicationProperties.OnEndSession"/>
<element name="TApplicationProperties.FOnQueryEndSession" link="#lcl.forms.TApplicationProperties.OnQueryEndSession"/>
<element name="TApplicationProperties.FOnMinimize" link="#lcl.forms.TApplicationProperties.OnMinimize"/>
<element name="TApplicationProperties.FOnRestore" link="#lcl.forms.TApplicationProperties.OnRestore"/>
<element name="TApplicationProperties.SetExceptionDialog">
<short>Sets the value for the ExceptionDialog property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.ExceptionDialog"/>
</seealso>
</element>
<element name="TApplicationProperties.SetExceptionDialog.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetCaptureExceptions">
<short>Sets the value for the CaptureExceptions property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.CaptureExceptions"/>
</seealso>
</element>
<element name="TApplicationProperties.SetCaptureExceptions.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetHelpFile">
<short>Sets the value for the HelpFile property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.HelpFile"/>
</seealso>
</element>
<element name="TApplicationProperties.SetHelpFile.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetHint">
<short>Sets the value for the Hint property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.Hint"/>
</seealso>
</element>
<element name="TApplicationProperties.SetHint.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetHintColor">
<short>Sets the value for the HintColor property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.HintColor"/>
</seealso>
</element>
<element name="TApplicationProperties.SetHintColor.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetHintHidePause">
<short>Sets the value for the HintHidePause property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.HintHidePause"/>
</seealso>
</element>
<element name="TApplicationProperties.SetHintHidePause.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetHintPause">
<short>Sets the value for the HintPause property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.HintPause"/>
</seealso>
</element>
<element name="TApplicationProperties.SetHintPause.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetHintShortCuts">
<short>Sets the value for the HintShortCuts property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.HintShortCuts"/>
</seealso>
</element>
<element name="TApplicationProperties.SetHintShortCuts.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetHintShortPause">
<short>Sets the value for the HintShortPause property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.HintShortPause"/>
</seealso>
</element>
<element name="TApplicationProperties.SetHintShortPause.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetShowButtonGlyphs">
<short>Sets the value for the ShowButtonGlyphs property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.ShowButtonGlyphs"/>
</seealso>
</element>
<element name="TApplicationProperties.SetShowButtonGlyphs.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetShowMenuGlyphs">
<short>Sets the value for the ShowMenuGlyphs property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.ShowMenuGlyphs"/>
</seealso>
</element>
<element name="TApplicationProperties.SetShowMenuGlyphs.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetShowHint">
<short>Sets the value for the ShowHint property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.ShowHint"/>
</seealso>
</element>
<element name="TApplicationProperties.SetShowHint.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetShowMainForm">
<short>Sets the value for the ShowMainForm property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.ShowMainForm"/>
</seealso>
</element>
<element name="TApplicationProperties.SetShowMainForm.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetTitle">
<short>Sets the value for the Title property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.Title"/>
</seealso>
</element>
<element name="TApplicationProperties.SetTitle.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnActivate">
<short>Sets the value for the OnActivate property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnActivate"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnActivate.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnDeactivate">
<short>Sets the value for the OnDeactivate property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnDeactivate"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnDeactivate.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnException">
<short>Sets the value for the OnException property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnException"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnException.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnGetMainFormHandle">
<short>Sets the value for the OnGetMainFormHandle property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnGetMainFormHandle"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnGetMainFormHandle.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnIdle">
<short>Sets the value for the OnIdle property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnIdle"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnIdle.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnIdleEnd">
<short>Sets the value for the OnIdleEnd property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnIdleEnd"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnIdleEnd.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnEndSession">
<short>Sets the value for the OnEndSession property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnEndSession"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnEndSession.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnQueryEndSession">
<short>Sets the value for the OnQueryEndSession property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnQueryEndSession"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnQueryEndSession.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnMinimize">
<short>Sets the value for the OnMinimize property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnMinimize"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnMinimize.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnModalBegin">
<short>Sets the value for the OnModalBegin property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnModalBegin"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnModalBegin.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnModalEnd">
<short>Sets the value for the OnModalEnd property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnModalEnd"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnModalEnd.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnRestore">
<short>Sets the value for the OnRestore property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnRestore"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnRestore.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnDropFiles">
<short>Sets the value for the OnDropFiles property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnDropFiles"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnDropFiles.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnHelp">
<short>Sets the value for the OnHelp property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnHelp"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnHelp.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnHint">
<short>Sets the value for the OnHint property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnHint"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnHint.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnShowHint">
<short>Sets the value for the OnShowHint property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnShowHint"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnShowHint.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.SetOnUserInput">
<short>Sets the value for the OnUserInput property.</short>
<descr/>
<seealso>
<link id="TApplicationProperties.OnUserInput"/>
</seealso>
</element>
<element name="TApplicationProperties.SetOnUserInput.AValue">
<short>New value for the property.</short>
</element>
<element name="TApplicationProperties.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for TApplicationProperties. Create calls the inherited <var>Create</var> method, and sets the defaults values when a new application is being designed, or loads local values for an existing application.
</p>
</descr>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<element name="TApplicationProperties.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TApplicationProperties.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. <var>Destroy</var> ensures that event handlers in the class instance are removed from the handlers registered in the global <var>TApplication</var> instance.
</p>
<remark>
Event handlers are not removed from the Application variable at design-time; they were not added at design-time either.
</remark>
<p>
<var>Destroy</var> calls the inherited destructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TApplicationProperties.OnActivate"/>
<link id="TApplicationProperties.OnDeactivate"/>
<link id="TApplicationProperties.OnException"/>
<link id="TApplicationProperties.OnGetMainFormHandle"/>
<link id="TApplicationProperties.OnIdle"/>
<link id="TApplicationProperties.OnIdleEnd"/>
<link id="TApplicationProperties.OnEndSession"/>
<link id="TApplicationProperties.OnQueryEndSession"/>
<link id="TApplicationProperties.OnMinimize"/>
<link id="TApplicationProperties.OnModalBegin"/>
<link id="TApplicationProperties.OnModalEnd"/>
<link id="TApplicationProperties.OnRestore"/>
<link id="TApplicationProperties.OnDropFiles"/>
<link id="TApplicationProperties.OnHelp"/>
<link id="TApplicationProperties.OnHint"/>
<link id="TApplicationProperties.OnShowHint"/>
<link id="TApplicationProperties.OnUserInput"/>
</seealso>
</element>
<element name="TApplicationProperties.CaptureExceptions" link="#lcl.forms.TApplication.CaptureExceptions"/>
<element name="TApplicationProperties.ExceptionDialog">
<short>Indicates the dialog type displayed for an exception.</short>
<descr>The default value is aedOkCancelDialog.</descr>
<seealso/>
</element>
<element name="TApplicationProperties.HelpFile">
<short>Contains the name for the help file in an application.</short>
<descr>
<p>
<var>HelpFile</var> is a <var>String</var> property with the name of the help file for an application. It is read from or written to the HelpFile property in the Application singleton. Changing the value for the property at run-time causes the Application instance to be updated.
</p>
</descr>
<seealso>
<link id="TCustomForm.HelpFile"/>
<link id="Application"/>
</seealso>
</element>
<element name="TApplicationProperties.Hint" link="#lcl.forms.TApplication.Hint"/>
<element name="TApplicationProperties.HintColor" link="#lcl.forms.TApplication.HintColor"/>
<element name="TApplicationProperties.HintHidePause" link="#lcl.forms.TApplication.HintHidePause"/>
<element name="TApplicationProperties.HintPause" link="#lcl.forms.TApplication.HintPause"/>
<element name="TApplicationProperties.HintShortCuts" link="#lcl.forms.TApplication.HintShortCuts"/>
<element name="TApplicationProperties.HintShortPause" link="#lcl.forms.TApplication.HintShortPause"/>
<element name="TApplicationProperties.ShowButtonGlyphs" link="#lcl.forms.TApplication.ShowButtonGlyphs"/>
<element name="TApplicationProperties.ShowMenuGlyphs" link="#lcl.forms.TApplication.ShowMenuGlyphs"/>
<element name="TApplicationProperties.ShowHint" link="#lcl.forms.TApplication.ShowHint"/>
<element name="TApplicationProperties.ShowMainForm" link="#lcl.forms.TApplication.ShowMainForm"/>
<element name="TApplicationProperties.Title" link="#lcl.forms.TApplication.Title"/>
<element name="TApplicationProperties.OnActivate" link="#lcl.forms.TApplication.OnActivate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TApplicationProperties.OnDeactivate" link="#lcl.forms.TApplication.OnDeactivate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TApplicationProperties.OnException">
<short>Event handler signalled to handle an exception in an application.</short>
<descr>
<p>
OnException is a TExceptionEvent property with an event handler signalled to handle an exception in an application. Its value is assigned to the OnException property in the Application singleton at run-time.
</p>
<p>
Changing the value for the property at run-time causes the Application singleton to be updated.
</p>
</descr>
<seealso>
<link id="Application"/>
<link id="TApplication.HandleException"/>
<link id="#fcl.custapp.TCustomApplication.OnException">TCustomApplication.OnException</link>
</seealso>
</element>
<element name="TApplicationProperties.OnGetMainFormHandle" link="#lcl.forms.TApplication.OnGetMainFormHandle"/>
<element name="TApplicationProperties.OnIdle" link="#lcl.forms.TApplication.OnIdle"/>
<element name="TApplicationProperties.OnIdleEnd" link="#lcl.forms.TApplication.OnIdleEnd"/>
<element name="TApplicationProperties.OnEndSession" link="#lcl.forms.TApplication.OnEndSession"/>
<element name="TApplicationProperties.OnQueryEndSession" link="#lcl.forms.TApplication.OnQueryEndSession"/>
<element name="TApplicationProperties.OnMinimize" link="#lcl.forms.TApplication.OnMinimize"/>
<element name="TApplicationProperties.OnModalBegin" link="#lcl.forms.TApplication.OnModalBegin"/>
<element name="TApplicationProperties.OnModalEnd" link="#lcl.forms.TApplication.OnModalEnd"/>
<element name="TApplicationProperties.OnRestore" link="#lcl.forms.TApplication.OnRestore"/>
<element name="TApplicationProperties.OnDropFiles" link="#lcl.forms.TApplication.OnDropFiles"/>
<element name="TApplicationProperties.OnHelp" link="#lcl.forms.TApplication.OnHelp"/>
<element name="TApplicationProperties.OnHint" link="#lcl.forms.TApplication.OnHint"/>
<element name="TApplicationProperties.OnShowHint" link="#lcl.forms.TApplication.OnShowHint"/>
<element name="TApplicationProperties.OnUserInput" link="#lcl.forms.TApplication.OnUserInput"/>
<element name="TIDesigner">
<short>The abstract base class for visual Form designers.</short>
<descr>
<p>
<var>TIDesigner</var> is a <var>TObject</var> descendant which specifies the interface used for visual Form designers . TIDesigner is the type used for the <var>TCustomForm.Designer</var> property.
</p>
<p>
It is used as the ancestor for <var>TComponentEditorDesigner</var>, and the type expected in the RootDesigner for the Object Inspector and Property editors used in the Lazarus IDE.
</p>
</descr>
<seealso>
<link id="TCustomForm.Designer"/>
<link id="FindRootDesigner"/>
</seealso>
</element>
<element name="TIDesigner.FLookupRoot">
<short>Member with the value for the LookupRoot property.</short>
</element>
<element name="TIDesigner.FDefaultFormBoundsValid">
<short>Member with the value for the DefaultFormBoundsValid property.</short>
</element>
<element name="TIDesigner.IsDesignMsg">
<short>
<var>IsDesignMsg</var> - receives a message from Sender, and returns True if it is a design message.</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.IsDesignMsg.Result">
<short/>
</element>
<element name="TIDesigner.IsDesignMsg.Sender">
<short/>
</element>
<element name="TIDesigner.IsDesignMsg.Message">
<short/>
</element>
<element name="TIDesigner.UTF8KeyPress">
<short>
Defines the method used to handle a key press event for a UTF-8-encoded character.
</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.UTF8KeyPress.UTF8Key">
<short>UTF-8-encoded character for the key press event.</short>
</element>
<element name="TIDesigner.Modified">
<short>Method when design is <var>Modified</var>.</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.Notification">
<short>
<var>Notification</var> that the supplied Operation has been applied to the
specified Component.
</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.Notification.AComponent">
<short/>
</element>
<element name="TIDesigner.Notification.Operation">
<short/>
</element>
<element name="TIDesigner.PaintGrid">
<short>
<var>PaintGrid</var> - method for painting the grid in the designer.</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.ValidateRename">
<short>
<var>ValidateRename</var> - method to validate the Rename process.</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.ValidateRename.AComponent">
<short/>
</element>
<element name="TIDesigner.ValidateRename.CurName">
<short/>
</element>
<element name="TIDesigner.ValidateRename.NewName">
<short/>
</element>
<element name="TIDesigner.GetShiftState">
<short>
Gets the value for the shift state (whether Shift, Ctrl, or Alt key).
</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.GetShiftState.Result">
<short>Shift, Ctrl, Alt modifier for the designer.</short>
</element>
<element name="TIDesigner.SelectOnlyThisComponent">
<short>
Method to select only the current component in the designer.
</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.SelectOnlyThisComponent.AComponent">
<short/>
</element>
<element name="TIDesigner.UniqueName">
<short>
Returns a Unique name for the designer, using the BaseName as a starting point.
</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.UniqueName.Result">
<short/>
</element>
<element name="TIDesigner.UniqueName.BaseName">
<short/>
</element>
<element name="TIDesigner.PrepareFreeDesigner">
<short>Prepares the design surface and frees the root control.</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.PrepareFreeDesigner.AFreeComponent">
<short/>
</element>
<element name="TIDesigner.LookupRoot">
<short>Component that is the root control in the form design surface.</short>
<descr/>
<seealso/>
</element>
<element name="TIDesigner.DefaultFormBoundsValid">
<short>
Indicates whether the bounds are valid after moving or sizing the form on the design surface.
</short>
<descr/>
<seealso/>
</element>
<element name="TFormPropertyStorage">
<short>
<var>TFormPropertyStorage</var> - class for storage of a Form's properties.
</short>
<descr>
<p>
<var>TFormPropertyStorage</var> is a <var>TControlPropertyStorage</var> descendant which extends the ancestor class to read and write form values. It provides additional methods called when a form is created, closed, or freed. TFormPropertyStorage is the base class for descendants like <var>TCustomIniPropStorage</var>, <var>TCustomJSONPropStorage</var>, and <var>TCustomXMLPropStorage</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TFormPropertyStorage.FormCreate">
<short>
Handler routine used as an OnCreate handler in the Owner of the class instance.
</short>
<descr>
Calls the Restore method.
</descr>
<seealso/>
</element>
<element name="TFormPropertyStorage.FormCreate.Sender">
<short>Form which owns the class instance.</short>
</element>
<element name="TFormPropertyStorage.FormClose">
<short>
Handler routine used as an OnClose handler in the Owner of the class instance.
</short>
<descr/>
<seealso/>
</element>
<element name="TFormPropertyStorage.FormClose.Sender">
<short>Form which owns the class instance.</short>
</element>
<element name="TFormPropertyStorage.FormClose.CloseAction">
<short>Close action performed in the method.</short>
</element>
<element name="TFormPropertyStorage.FormDestroy">
<short>
Handler routine used as an OnDestroy handler in the Owner of the class instance.
</short>
<descr/>
<seealso/>
</element>
<element name="TFormPropertyStorage.FormDestroy.Sender">
<short>Form which owns the class instance.</short>
</element>
<element name="TFormPropertyStorage.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overridden constructor for the class instance. It calls the inherited method on entry, using the value in TheOwner as the Owner for the class instance. Create ensures that private methods in the class instance are assigned as event handler routines for the TCustomForm instance in TheOwner.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<element name="TFormPropertyStorage.Create.TheOwner">
<short>TCustomForm instance which owns th class instance.</short>
</element>
<element name="TFormPropertyStorage.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
Destroy is the overridden destructor for the class instance. It ensures that event handler routines, assigned in the constructor to the form which owns the class instance, are removed before the class instance is freed. It calls the inherited destructor prior to exit.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TComponent.Destroy">TComponent.Destroy</link>
</seealso>
</element>
<element name="KeysToShiftState">
<short>
Converts modifier keys in the LParam of a mouse message to a TShiftState value.
</short>
<descr/>
<seealso>
<link id="ShiftStateToKeys"/>
<link id="KeyDataToShiftState"/>
<link id="#rtl.classes.TShiftState">TShiftState</link>
<link id="#lcl.lcltype.MK_SHIFT">MK_SHIFT</link>
<link id="#lcl.lcltype.MK_CONTROL">MK_CONTROL</link>
<link id="#lcl.lcltype.MK_LBUTTON">MK_LBUTTON</link>
<link id="#lcl.lcltype.MK_RBUTTON">MK_RBUTTON</link>
<link id="#lcl.lcltype.MK_MBUTTON">MK_MBUTTON</link>
<link id="#lcl.lcltype.MK_XBUTTON1">MK_XBUTTON1</link>
<link id="#lcl.lcltype.MK_XBUTTON2">MK_XBUTTON2</link>
</seealso>
</element>
<element name="KeysToShiftState.Result">
<short/>
</element>
<element name="KeysToShiftState.Keys">
<short>The asynchronous keyboard state.</short>
</element>
<element name="KeyDataToShiftState">
<short>
Converts modifier keys from the LParam keyboard message (WM_KEYUP for
example) to a TShiftState.
</short>
<descr/>
<seealso>
<link id="#rtl.classes.TShiftState">TShiftState</link>
<link id="KeysToShiftState"/>
<link id="ShiftStateToKeys"/>
<link id="#lcl.lcltype.MK_SHIFT">MK_SHIFT</link>
<link id="#lcl.lcltype.MK_CONTROL">MK_CONTROL</link>
<link id="#lcl.lcltype.MK_LBUTTON">MK_LBUTTON</link>
<link id="#lcl.lcltype.MK_RBUTTON">MK_RBUTTON</link>
<link id="#lcl.lcltype.MK_MBUTTON">MK_MBUTTON</link>
<link id="#lcl.lcltype.MK_XBUTTON1">MK_XBUTTON1</link>
<link id="#lcl.lcltype.MK_XBUTTON2">MK_XBUTTON2</link>
</seealso>
</element>
<element name="KeyDataToShiftState.Result">
<short/>
</element>
<element name="KeyDataToShiftState.KeyData">
<short/>
</element>
<element name="KeyboardStateToShiftState">
<short>
Converts virtual key state codes to TShiftState values.
</short>
<descr>
<p>
Calls GetKeyState to get the virtual key codes for the following:
</p>
<ul>
<li>VK_SHIFT</li>
<li>VK_CONTROL</li>
<li>VK_MENU</li>
<li>VK_LWIN</li>
<li>VK_RWIN</li>
</ul>
<p>
The return value is a set type with the TShiftState values corresponding to the virtual key codes. It may be an empty set when none of the virtual keys are detected.
</p>
</descr>
<seealso/>
</element>
<element name="KeyboardStateToShiftState.Result">
<short/>
</element>
<element name="ShiftStateToKeys">
<short>
Converts a shift state into a key state value compatible with the key state of a Windows API LParam.
</short>
<descr>
<p>
The return value is a PtrUInt type and contains an OR'ed combination of the following constants:
</p>
<ul>
<li>MK_Shift</li>
<li>MK_Control</li>
<li>MK_LButton</li>
<li>MK_RButton</li>
<li>MK_MButton</li>
<li>MK_XBUTTON1</li>
<li>MK_XBUTTON2</li>
</ul>
</descr>
<seealso>
<link id="#rtl.classes.TShiftState">TShiftState</link>
<link id="KeysToShiftState"/>
<link id="KeyDataToShiftState"/>
<link id="#lcl.lcltype.MK_SHIFT">MK_SHIFT</link>
<link id="#lcl.lcltype.MK_CONTROL">MK_CONTROL</link>
<link id="#lcl.lcltype.MK_LBUTTON">MK_LBUTTON</link>
<link id="#lcl.lcltype.MK_RBUTTON">MK_RBUTTON</link>
<link id="#lcl.lcltype.MK_MBUTTON">MK_MBUTTON</link>
<link id="#lcl.lcltype.MK_XBUTTON1">MK_XBUTTON1</link>
<link id="#lcl.lcltype.MK_XBUTTON2">MK_XBUTTON2</link>
</seealso>
</element>
<element name="ShiftStateToKeys.Result">
<short/>
</element>
<element name="ShiftStateToKeys.ShiftState">
<short/>
</element>
<element name="WindowStateToStr">
<short>Converts a TWindowState enumeration value to its String representation.</short>
<descr>
<p>
<var>WindowStateToStr</var> is a <var>String</var> function used to get the string representation for the <var>TWindowState</var> enumeration value in the <var>State</var> argument. Calls <var>GetEnumName</var> in <file>lazutilities</file> to get the String representation for the value in <var>State</var>.
</p>
</descr>
<seealso>
<link id="#rtl.typinfo.GetEnumName">GetEnumName</link>
</seealso>
</element>
<element name="WindowStateToStr.Result">
<short>String representing the specified enumeration value.</short>
</element>
<element name="WindowStateToStr.State">
<short>TWindowState enumeration value converted in the routine.</short>
</element>
<element name="StrToWindowState">
<short>Converts a string to a TWindowState enumeration value.</short>
<descr>
<p>
<var>StrToWindowState</var> is a <var>TWindowState</var> function used to get the value from the TWindowState enumeration for the specified string. StrToWindowState calls the <var>GetEnumValueDef</var> routine in <file>lazutilities</file> to convert the string to its value in the TWindowState enumeration. The return value defaults to <var>wsNormal</var> when <var>Name</var> does not represent a value in the TWindowState enumeration.
</p>
</descr>
<seealso>
<link id="#lazutils.lazutilities.GetEnumValueDef">GetEnumValueDef</link>
</seealso>
</element>
<element name="StrToWindowState.Result">
<short>TWindowState value for the specified string, or wsNormal by default.</short>
</element>
<element name="StrToWindowState.Name">
<short>String representation for the window state enumeration value.</short>
</element>
<element name="dbgs">
<short>Formats various typed values into readable text.</short>
<descr/>
<seealso/>
</element>
<element name="dbgs.Result">
<short>The formatted value.</short>
</element>
<element name="dbgs.State">
<short/>
</element>
<element name="dbgs.Action">
<short/>
</element>
<element name="dbgs.Kind">
<short/>
</element>
<element name="TFocusState">
<short>
Pointer to focus state information for the last active control in an application.
</short>
<descr>
<p>
Alias for the Pointer type. Used as the return value for the SaveFocusState function.
</p>
</descr>
<seealso>
<link id="SaveFocusState"/>
</seealso>
</element>
<element name="SaveFocusState">
<short>Returns the last focused control (focus state) in an application.</short>
<descr>
<p>
Returns the value from the LastFocusedControl variable in the implementation for the unit. The type used for the return value is TFocusState.
</p>
</descr>
<seealso>
<link id="RestoreFocusState"/>
</seealso>
</element>
<element name="SaveFocusState.Result">
<short>Last control which had focus in the application.</short>
</element>
<element name="RestoreFocusState">
<short>Restores the last focused control in an application to specified value.</short>
<descr/>
<seealso>
<link id="SaveFocusState"/>
</seealso>
</element>
<element name="RestoreFocusState.FocusState">
<short/>
</element>
<element name="TGetDesignerFormEvent">
<short>
Specifies an event handler signalled to get the form with the designer for a persistent object.
</short>
<descr>
<p>
<var>TGetDesignerFormEvent</var> is an object function type which specifies an event handler signalled to get the form instance with the designer object for <var>APersistent</var>. The return value contains the <var>TCustomForm</var> instance which contains the designer object for the persistent object, and may be unassigned (<b>Nil</b>) if a form hosting APersistent cannot be located.
</p>
<p>
TGetDesignerFormEvent is the type used for the <var>OnGetDesignerForm</var> variable in the <file>forms</file> unit.
</p>
</descr>
<seealso>
<link id="OnGetDesignerForm"/>
<link id="GetDesignerForm"/>
</seealso>
</element>
<element name="TGetDesignerFormEvent.Result">
<short/>
</element>
<element name="TGetDesignerFormEvent.APersistent">
<short/>
</element>
<element name="TIsFormDesignFunction">
<short>
Specifies a Boolean function type used to implement the routine assigned to the IsFormDesign variable.
</short>
<descr>
TIsFormDesignFunction is a Boolean function type used in the IsFormDesign variable.
</descr>
<seealso>
<link id="IsFormDesign"/>
</seealso>
</element>
<element name="TIsFormDesignFunction.Result">
<short>Returns True when the form has csDesignInstance in its component state.</short>
</element>
<element name="TIsFormDesignFunction.AForm">
<short/>
</element>
<element name="OnGetDesignerForm">
<short>
Event handler signalled to get the designer form for the specified form or control.
</short>
<descr>
<p>
OnGetDesignerForm is a TGetDesignerFormEvent variable that contains the event handler signalled to get a form with a design surface for the specified form or control.
</p>
</descr>
<seealso/>
</element>
<element name="IsFormDesign">
<short>
Address of the function used to determine if specified control is a form designer.
</short>
<descr/>
<seealso/>
</element>
<element name="GetParentForm">
<short>Gets the form instance for the specified Control.</short>
<descr>
<p>
<var>GetParentForm</var> is a <var>TCustomForm</var> function used to the form instance for the control specified in the <var>Control</var> argument.
</p>
<p>
Control is the <var>TControl</var> instance examined in the method. The <var>Parent</var> property is used to navigate to preceding parent controls until a <var>TCustomForm</var> instance is found.
</p>
<p>
<var>TopForm</var> indicates if the top-most form instance in the hierarchy is needed. When set to <b>False</b>, the first TCustomForm instance found in the control hierarchy is used. Otherwise, all Parent controls in the hierarchy are examined until a Parent control has not been assigned.
</p>
<p>
The return value can contain the value in Control if it is a TCustomForm descendant and no other form instances are used in the control hierarchy. This is Delphi compatible.
</p>
</descr>
<seealso/>
</element>
<element name="GetParentForm.Result">
<short>Form instance that is the parent for the specified control.</short>
</element>
<element name="GetParentForm.Control">
<short>Control used to locate the parent form in the control hierarchy.</short>
</element>
<element name="GetParentForm.TopForm">
<short>True if the top-most form instance in the control hierarchy is needed.</short>
</element>
<element name="GetDesignerForm">
<short>
Gets the Form with the designer object for the specified control or persistent object.
</short>
<descr>
<p>
GetDesignerForm is a TCustomForm function used to get the form instance with the designer object for the specified control or persistent object instance. The function is overloaded to allow use of a TControl or a TPersistent instance to locate the form.
</p>
<p>
The return value contains the top-most TCustomForm instance with a TIDesigner instance for the value in Control or APersistent. The return value is Nil when a form is not found which hosts the specified argument.
</p>
</descr>
<seealso/>
</element>
<element name="GetDesignerForm.Result">
<short>Form instance with the designer for the specified argument.</short>
</element>
<element name="GetDesignerForm.Control">
<short>TControl instance used to locate the owner form.</short>
</element>
<element name="GetDesignerForm.APersistent">
<short>TPersistent instance used to locate the owner form.</short>
</element>
<element name="GetFirstParentForm">
<short>Does a recursive search for the first Parent of type TCustomForm.</short>
<descr>
<p>
<var>GetFirstParentForm</var> is a <var>TCustomForm</var> function used to find the first form instance in the Parents for the specified <var>Control</var>. GetFirstParentForm calls the <var>GetParentForm</var> routine to get the form instance used as the return value. The return value is <b>Nil</b> when Control has not been assigned, or a form is not found in GetParentForm.
</p>
<p>
GetFirstParentForm is called from the <var>IntfGetDropFilesTarget</var> method in <var>TWinControl</var>, and from routines which handle accelerator keys for widgetset classes.
</p>
</descr>
<seealso>
<link id="GetParentForm"/>
</seealso>
</element>
<element name="GetFirstParentForm.Result">
<short>The first custom form instance found by ascending the control hierarchy.</short>
</element>
<element name="GetFirstParentForm.Control">
<short>TControl instance where the search for a parent form is started.</short>
</element>
<element name="GetTopFormSkipNonDocked">
<short>
Gets the top-most form which hosts the specified control docksite form instances.
</short>
<descr/>
<seealso/>
</element>
<element name="GetTopFormSkipNonDocked.Result">
<short/>
</element>
<element name="GetTopFormSkipNonDocked.Control">
<short/>
</element>
<element name="ValidParentForm">
<short>Gets a valid parent form for the specified control.</short>
<descr>
<p>
<var>ValidParentForm</var> is a <var>TCustomForm</var> function used to get a valid parent form for the control specified in the <var>Control</var> argument. <var>TopForm</var> indicates if the return value should contain the absolute root ancestor in the ancestry tree. ValidParentForm calls <var>GetParentForm</var> to get the return value for the routine.
</p>
<p>
ValidParentForm raises an <var>EInvalidOperation</var> exception with the message in <var>sParentRequired</var> when a valid parent form is not found for the specified control.
</p>
</descr>
<errors>
Raises an EInvalidOperation exception with the message in sParentRequired when a valid parent form is not found for the specified control.
</errors>
<seealso/>
</element>
<element name="ValidParentForm.Result">
<short>Form instance that is the parent form for the control.</short>
</element>
<element name="ValidParentForm.Control">
<short>Control examined in the routine.</short>
</element>
<element name="ValidParentForm.TopForm">
<short>True if all parent forms are located in the routine.</short>
</element>
<element name="FindRootDesigner">
<short>
Gets the designer object for the specified persistent object (or its parent).
</short>
<descr>
<p>
<var>FindRootDesigner</var> is a <var>TIDesigner</var> function used to get the root designer object for the specified persistent object instance. The TIDesigner instance is found on the Form where the object (or its parent) is hosted in the Lazarus IDE. The return value is <b>Nil</b> when a parent form for <var>APersistent</var> is not found.
</p>
</descr>
<seealso/>
</element>
<element name="FindRootDesigner.Result">
<short>
TIDesigner instance for the object, or Nil when a parent form is not found.
</short>
</element>
<element name="FindRootDesigner.APersistent">
<short>Persistent object examined for a designer instance in the routine.</short>
</element>
<element name="GetParentDesignControl">
<short>
Gets the control which is the top-most TCustomDesignControl instance for the specified control, or Nil when not a TCustomDesignControl instance.
</short>
<descr/>
<seealso/>
</element>
<element name="GetParentDesignControl.Result">
<short/>
</element>
<element name="GetParentDesignControl.Control">
<short/>
</element>
<element name="NeedParentDesignControl">
<short>
Ensures that a TCustomDesignControl instance is found for the specified control.
</short>
<descr>
<p>
Calls <var>GetParentDesignControl</var> to get the return value for the function. Raises an <var>EInvalidOperation</var> exception if a <var>TCustomDesignControl</var> instance is not found for the specififed control.
</p>
<p>
Used in methods which perform scaling operations for <var>TCustomForm</var> or <var>TControl</var> instances.
</p>
</descr>
<seealso/>
</element>
<element name="NeedParentDesignControl.Result">
<short/>
</element>
<element name="NeedParentDesignControl.Control">
<short/>
</element>
<element name="IsAccel">
<short>Searches for the given virtual key, used as an accelerator.</short>
<descr>
<p>
An accelerator consists of an ampersand followed by the accelerator key. Duplicate ampersands are ignored; they denote a literal (displayed) ampersand character (<b>&</b>).
</p>
</descr>
<seealso/>
</element>
<element name="IsAccel.Result">
<short>True when the key is used as an accelerator.</short>
</element>
<element name="IsAccel.VK">
<short>The virtual key (uppercase ASCII) to find.</short>
</element>
<element name="IsAccel.Str">
<short>The string to scan.</short>
</element>
<element name="NotifyApplicationUserInput">
<short>Invokes all application user input handlers.</short>
<descr/>
<seealso/>
</element>
<element name="NotifyApplicationUserInput.Msg">
<short>The message to process.</short>
</element>
<element name="GetShortHint">
<short>Returns the short version of a Hint string.</short>
<descr>
<p>
A short Hint is separated from the long Hint by a '|' character. When no such character is found, the whole Hint is returned.
</p>
</descr>
<seealso/>
</element>
<element name="GetShortHint.Result">
<short>The short (or complete) Hint.</short>
</element>
<element name="GetShortHint.Hint">
<short>The string containing both a short and long Hint.</short>
</element>
<element name="GetLongHint">
<short>Returns the long version of a Hint string.</short>
<descr/>
<seealso>
<link id="GetShortHint"/>
</seealso>
</element>
<element name="GetLongHint.Result">
<short/>
</element>
<element name="GetLongHint.Hint">
<short/>
</element>
<element name="Application">
<short>The TApplication singleton.</short>
<descr>
<p>
<var>Application</var> is a unit global variable with the <var>TApplication</var> instance representing the currently executing application. The value for the variable is assigned in the initialization section for the unit when the application is started. It is freed in the finalization section when the application is terminated.
</p>
<p>
Use the <var>TApplicationProperties</var> component to provide design-time configuration settings for properties (including event handlers) which are automatically applied to Application at run-time.
</p>
</descr>
<seealso>
<link id="TApplication"/>
<link id="TApplicationProperties"/>
</seealso>
</element>
<element name="Screen">
<short>The TScreen singleton for the application.</short>
<descr/>
<seealso>
<link id="TScreen"/>
</seealso>
</element>
<element name="ExceptionObject">
<short>Variable representing the current exception object in an application.</short>
<descr>
<p>
Used in the implementation of the TApplication.HandleException method.
</p>
</descr>
<seealso>
<link id="TApplication.HandleException"/>
</seealso>
</element>
<element name="HintWindowClass">
<short>The class type used to create hint window instances for an application.</short>
<descr/>
<seealso/>
</element>
<element name="RequireDerivedFormResource">
<short>
When True every form must have a resource (e.g. a .res file). An exception is raised if the resource is missing when creating a form.
</short>
<descr>
<p>
The form resource is the <file>.lfm</file> file compiled into the executable of your application. For this flag, it does not matter if it was compiled via an <file>.lrs</file> file or via <file>fpcres</file>. The resource is automatically loaded by <var>TForm</var> and its descendants when created using the <var>Create(Owner)</var> method.
</p>
<p>
If the resource file is missing, there is something wrong with either a resource or the unit which contains the faulty form. If the flag is False, you will see a blank form and probably search a long time what is wrong. If you set this flag to True, you get an exception.
</p>
<p>
For creating forms without resources, you have 3 options:
</p>
<ul>
<li>Create a TForm class (not a descendant).</li>
<li>Construct your form using the CreateNew() constructor.</li>
<li>It is also possible to disable the exception by setting the global
variable RequireDerivedFormResource to False.</li>
</ul>
<p>
History:
Before 0.9.31 there was no exception. Therefore some resource-less forms
might use the standard constructor Create(Owner) and will now get
exceptions. This change is Delphi compatible and compatible with
TFrame and TDataModule components.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TMessageBoxFunction">
<short>The type used for the MessageBox variable.</short>
<descr>
<p>
TMessageBoxFunction is an Integer function type which specifies the routine used to perform a message box or dialog.
</p>
<p>
Arguments passed to the function identify the content for the message dialog, including:
</p>
<ul>
<li>Text displayed in the message dialog</li>
<li>Title used on dialog form</li>
<li>Flag values that control the buttons and icon for the dialog</li>
</ul>
<p>
The return value contains the modal result returned from the message dialog.
</p>
</descr>
<seealso>
<link id="MessageBoxFunction"/>
</seealso>
</element>
<element name="TMessageBoxFunction.Result">
<short/>
</element>
<element name="TMessageBoxFunction.Text">
</element>
<element name="TMessageBoxFunction.Caption">
<short/>
</element>
<element name="TMessageBoxFunction.Flags">
<short/>
</element>
<element name="MessageBoxFunction">
<short>
Provides the routine used to display a message dialog in widgetset implementations.
</short>
<descr>
<p>
Normally contains a reference to the <var>DefaultMessageBox</var> function. It may have another function reference assigned to the variable in specific widgetset implementations (such as CustomDraw controls).
</p>
</descr>
<seealso>
<link id="#lcl.dialogs.DefaultMessageBox">DefaultMessageBox</link>
</seealso>
</element>
<element name="DefaultBorderIcons">
<short>Maps form border styles to their border icons.</short>
<descr>
<p>
<var>DefaultBorderIcons</var> is an array constant with <var>TBorderIcons</var> values indicating the icons available for the various form border styles. Values in the array are indexed by the enumeration values in TFormBorderStyle. Each element in the array contains zero (0) or more values from the TBorderIcon enumeration, and indicates that the icon is used for the form border style.
</p>
<p>
DefaultBorderIcons contains the following values for the corresponding TFormBorderStyle values:
</p>
<dl>
<dt>bsNone</dt>
<dd>An empty set ([])</dd>
<dt>bsSingle</dt>
<dd>[biSystemMenu, biMinimize]</dd>
<dt>bsSizeable</dt>
<dd>[biSystemMenu, biMinimize, biMaximize]</dd>
<dt>bsDialog</dt>
<dd>[biSystemMenu]</dd>
<dt>bsToolWindow</dt>
<dd>[biSystemMenu, biMinimize]</dd>
<dt>bsSizeToolWin</dt>
<dd>[biSystemMenu, biMinimize, biMaximize]</dd>
</dl>
<p>
DefaultBorderIcons is used in the implementation of the SetFormBorderStyle method in TCustomForm.
</p>
</descr>
<seealso/>
</element>
<element name="CreateWidgetset">
<short>Creates the widgetset singleton.</short>
<descr>
<p>
<var>CreateWidgetset</var> is a procedure used to create the <var>WidgetSet</var> singleton. CreateWidgetset executes the initialization handlers for the LCL interface.
</p>
<p>
<var>AWidgetsetClass</var> is the <var>TWidgetsetClass</var> class type used to create the <var>WidgetSet</var> singleton. CreateWidgetset is called from the <file>interfaces.pp</file> unit for a specific widgetset implementation (win32, gtk, gtk2, gtk3, qt, qt5, et. al.).
</p>
</descr>
<seealso/>
</element>
<element name="CreateWidgetset.AWidgetsetClass">
<short>TWidgetsetClass class type for the desired widgetset implementation.</short>
</element>
<!-- procedure Visibility: default -->
<element name="FreeWidgetSet">
<short>Destroys singletons for the Screen, Application, and WidgetSet.</short>
<descr>
<p>
<var>FreeWidgetSet</var> is a procedure used to free resources allocated to the <var>Screen</var>, <var>Application</var>, <var>Clipboards</var>, and <var>WidgetSet</var> singletons.
</p>
<p>
For Screen, allocated cursors and monitors are destroyed. Application is freed, and set to Nil. All clipboard formats are freed as well. The WidgetSet singleton is freed, and set to Nil.
</p>
<p>
FreeWidgetSet executes the <var>CallInterfaceFinalizationHandlers</var> routine to perform any finalization handlers installed for the <b>LCL</b> interface.
</p>
</descr>
<seealso>
<link id="Application"/>
<link id="Screen"/>
<link id="WidgetSet"/>
<link id="#lcl.lclproc.CallInterfaceFinalizationHandlers">CallInterfaceFinalizationHandlers</link>
</seealso>
</element>
<element name="Register">
<short>Registers components declared in this unit.</short>
<descr>
<p>
<var>Register</var> is a procedure used to register components declared in the <file>forms.pp</file> unit for use in the Lazarus IDE. The following components are added to the component palette in the Lazarus IDE:
</p>
<p>
<b>Standard</b> Tab
</p>
<ul>
<li>TFrame</li>
</ul>
<p>
<b>Additional</b> Tab
</p>
<ul>
<li>TScrollBox</li>
<li>TApplicationProperties</li>
</ul>
</descr>
<seealso/>
</element>
</module>
<!-- Forms -->
</package>
</fpdoc-descriptions>
|