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
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
StdCtrls
====================================================================
-->
<module name="StdCtrls">
<short>Standard controls used in the Lazarus Component Library (LCL).</short>
<descr>
<p>
<file>stdctrls.pp</file> contains standard controls used in Lazarus Component Library (LCL) applications. Most of the controls are found on the <b>Standard</b> tab in the Lazarus IDE component palette, including:
</p>
<ul>
<li>TButton</li>
<li>TLabel</li>
<li>TEdit</li>
<li>TMemo</li>
<li>TToggleBox</li>
<li>TCheckBox</li>
<li>TRadioButton</li>
<li>TListBox</li>
<li>TComboBox</li>
<li>TScrollBar</li>
<li>TGroupBox</li>
</ul>
<p>
The following controls are added to the <b>Additional</b> tab in the Lazarus IDE component palette:
</p>
<ul>
<li>TStaticText</li>
</ul>
</descr>
<!-- unresolved external references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Types"/>
<element name="LCLStrConsts"/>
<element name="LCLType"/>
<element name="LCLProc"/>
<element name="LCLIntf"/>
<element name="LMessages"/>
<element name="LResources"/>
<element name="Graphics"/>
<element name="ActnList"/>
<element name="Controls"/>
<element name="Forms"/>
<element name="Menus"/>
<element name="Themes"/>
<element name="TextStrings"/>
<element name="ExtendedStrings"/>
<element name="LazUTF8"/>
<element name="LazMethodList"/>
<element name="LazLoggerBase"/>
<element name="LazUtilities"/>
<element name="TEditCharCase">
<short>Determines the case for text in an edit box or a combo-box control.</short>
<descr>
<p>
<var>TEditCharCase</var> is an enumerated type with values that determine the case used for text in controls like <var>TCustomComboBox</var> and <var>TCustomEdit</var>. TEditCharCase is the type used to implement the <var>CharCase</var> property in both TCustomComboBox and TCustomEdit.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.CharCase"/>
<link id="TCustomEdit.CharCase"/>
</seealso>
</element>
<element name="TEditCharCase.ecNormal">
<short>Normal mode (no case conversion).</short>
</element>
<element name="TEditCharCase.ecUppercase">
<short>Converts every character entered to upper case.</short>
</element>
<element name="TEditCharCase.ecLowerCase">
<short>Converts every character entered to lower case.</short>
</element>
<element name="TEchoMode">
<short>How text in the edit box is displayed.</short>
<descr>
<p>
<var>TEchoMode</var> is an enumerated type with values that control whether text in a control is displayed with or without obfuscation. TEchoMode is the type used to implement the <var>EchoMode</var> property in <var>TCustomEdit</var>.
</p>
</descr>
<seealso>
<link id="TCustomEdit.EchoMode"/>
</seealso>
</element>
<element name="TEchoMode.emNormal">
<short>Characters are shown unmodified.</short>
</element>
<element name="TEchoMode.emNone">
<short>All characters are shown as spaces.</short>
<descr/>
</element>
<element name="TEchoMode.emPassword">
<short>All characters shown as the value in PasswordChar.</short>
</element>
<element name="TScrollStyle">
<short>Indicates the visibility for scrollbars on a control.</short>
<descr>
<p>
<var>TScrollStyle</var> is an enumerated type with values that indicates the visibility for one or more scrollbars displayed for an associated edit control. TScrollStyle is the type used to implement the <var>ScrollBars</var> property in <var>TCustomMemo</var>.
</p>
</descr>
<seealso>
<link id="TCustomMemo.ScrollBars"/>
</seealso>
</element>
<element name="TScrollStyle.ssNone">
<short>No scrollbars are displayed.</short>
</element>
<element name="TScrollStyle.ssHorizontal">
<short>A horizontal scrollbar is shown.</short>
</element>
<element name="TScrollStyle.ssVertical">
<short>A vertical scrollbar is shown.</short>
</element>
<element name="TScrollStyle.ssBoth">
<short>Both horizontal and vertical scrollbars are shown.</short>
</element>
<element name="TScrollStyle.ssAutoHorizontal">
<short>A horizontal scrollbar is shown only when needed.</short>
</element>
<element name="TScrollStyle.ssAutoVertical">
<short>A vertical scrollbar is shown only when needed.</short>
</element>
<element name="TScrollStyle.ssAutoBoth">
<short>Both scrollbars are shown only when needed.</short>
</element>
<element name="TScrollCode">
<short>The scroll action type, as reported by the widget.</short>
<descr>
<p>
<var>TScrollCode</var> is an enumerated type with values that represent scroll actions received from the widgetset class for a scrollbar. The positions and values in the enumeration correspond to the constants defined in the <file>LCLType</file> unit, and include:
</p>
<ul>
<li>SB_LINEUP</li>
<li>SB_LINEDOWN</li>
<li>SB_PAGEUP</li>
<li>SB_PAGEDOWN</li>
<li>SB_THUMBPOSITION</li>
<li>SB_THUMBTRACK</li>
<li>SB_TOP</li>
<li>SB_BOTTOM</li>
<li>SB_ENDSCROLL</li>
</ul>
<p>
Values in TScrollCode are passed as an argument to the <var>Scroll</var> method in <var>TCustomScrollBar</var>, and subsequently to the <var>TScrollEvent</var> event handler in the <var>OnScroll</var> property.
</p>
</descr>
<seealso>
<link id="TScrollEvent"/>
<link id="TCustomScrollBar.Scroll"/>
<link id="TCustomScrollBar.OnScroll"/>
</seealso>
</element>
<element name="TScrollCode.scLineUp">
<short>Scroll one line up (column left).</short>
</element>
<element name="TScrollCode.scLineDown">
<short>Scroll one line down (column right).</short>
</element>
<element name="TScrollCode.scPageUp">
<short>Scroll one page up (left).</short>
</element>
<element name="TScrollCode.scPageDown">
<short>Scroll one page down (right).</short>
</element>
<element name="TScrollCode.scPosition">
<short>Scroll to the specified position.</short>
</element>
<element name="TScrollCode.scTrack">
<short>Scroll tracking to the specified position.</short>
</element>
<element name="TScrollCode.scTop">
<short>Scroll to the top (left) end.</short>
</element>
<element name="TScrollCode.scBottom">
<short>Scroll to the bottom (right) end.</short>
</element>
<element name="TScrollCode.scEndScroll">
<short>Scrolling finished.</short>
</element>
<element name="TScrollEvent">
<short>Defines an event handler type for scrollbar events.</short>
<descr>
<p>
<var>TScrollEvent</var> is an object procedure which defines an event handler signalled when a scroll event occurs in the scrollbar widgetset class. The event handler is called before the new <var>Position</var> is set for the control. The value in Position can be adjusted to implement custom scrollbar behavior.
</p>
<p>
TScrollEvent is the type used to implement the <var>OnScroll</var> event handler in <var>TCustomScrollBar</var>.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.OnScroll"/>
<link id="TCustomScrollBar.Scroll"/>
</seealso>
</element>
<element name="TScrollEvent.Sender">
<short>The scrollbar for the event notification.</short>
</element>
<element name="TScrollEvent.ScrollCode">
<short>The scroll action for the notification.</short>
</element>
<element name="TScrollEvent.ScrollPos">
<short>New position for the scrollbar.</short>
<descr>
<p>
The suggested new scroll position. Change this value to implement custom scroll behavior.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomScrollBar">
<short>The base class for <var>TScrollBar</var>.</short>
<descr>
<p>
<var>TCustomScrollBar</var> is a <var>TWinControl</var> descendant which defines the base class for a scrollbar, such as <var>TScrollBar</var>. TCustomScrollBar can be used for horizontal or vertical scrollbars displayed on a form or scrolling window control.
</p>
<p>
A scrollbar allows the content in a client area to be scrolled when it extends beyond the window bounds. TCustomScrollBar provides the properties, methods, and events needed to interface with the widgetset class for the platform or operating system.
</p>
<p>
Use the <var>Kind</var> property to specify the orientation for the scrollbar.
</p>
<p>
Use <var>Min</var>, <var>Max</var>, <var>SmallChange</var>, <var>LargeChange</var>, <var>PageSize</var> and <var>Position</var> properties to control the scrolling behavior for the scrollbar.
</p>
<p>
Use the <var>OnChange</var> and <var>OnScroll</var> event handlers to respond to programmatic changes to the scrollbar, or messages received from the widgetset class.
</p>
<p>
See <link id="#lcl.forms.TControlScrollBar">TControlScrollBar</link> for information about scrollbars used for windowed controls.
</p>
</descr>
<seealso>
<link id="TScrollBar"/>
<link id="#lcl.forms.TScrollingWinControl">TScrollingWinControl</link>
<link id="#lcl.forms.TControlScrollBar">TControlScrollBar</link>
<link id="#lcl.controls.TWinControl">TWinControl</link>
</seealso>
</element>
<element name="TCustomScrollBar.FKind"/>
<element name="TCustomScrollBar.FPosition"/>
<element name="TCustomScrollBar.FMin"/>
<element name="TCustomScrollBar.FMax"/>
<element name="TCustomScrollBar.FPageSize"/>
<element name="TCustomScrollBar.FRTLFactor"/>
<element name="TCustomScrollBar.FSmallChange"/>
<element name="TCustomScrollBar.FLargeChange"/>
<element name="TCustomScrollBar.FOnChange"/>
<element name="TCustomScrollBar.FOnScroll"/>
<element name="TCustomScrollBar.DoScroll">
<short>Performs actions needed to translate and apply scrollbar notification messages.</short>
</element>
<element name="TCustomScrollBar.DoScroll.Message">
<short>Message examined and applied in the method.</short>
</element>
<element name="TCustomScrollBar.NotRightToLeft">
<short>Always returns </short>
</element>
<element name="TCustomScrollBar.NotRightToLeft.Result">
<short>Always returns True.</short>
</element>
<element name="TCustomScrollBar.SetKind">
<short>Sets the value for the Kind property.</short>
<descr/>
<seealso>
<link id="TCustomScrollBar.Kind"/>
</seealso>
</element>
<element name="TCustomScrollBar.SetKind.Value">
<short>New value for the Kind property.</short>
</element>
<element name="TCustomScrollBar.SetMax">
<short>Sets the value for the Max property.</short>
<descr/>
<seealso>
<link id="TCustomScrollBar.Max"/>
</seealso>
</element>
<element name="TCustomScrollBar.SetMax.Value">
<short>New value for the Max property.</short>
</element>
<element name="TCustomScrollBar.SetMin">
<short>Sets the value for the Min property.</short>
<descr/>
<seealso>
<link id="TCustomScrollBar.Min"/>
</seealso>
</element>
<element name="TCustomScrollBar.SetMin.Value">
<short>New value for the Min property.</short>
</element>
<element name="TCustomScrollBar.SetPosition">
<short>Sets the value for the Position property.</short>
<descr/>
<seealso>
<link id="TCustomScrollBar.Position"/>
</seealso>
</element>
<element name="TCustomScrollBar.SetPosition.Value">
<short>New value for the Position property.</short>
</element>
<element name="TCustomScrollBar.SetPageSize">
<short>Sets the value for the PageSize property.</short>
<descr/>
<seealso>
<link id="TCustomScrollBar.PageSize"/>
</seealso>
</element>
<element name="TCustomScrollBar.SetPageSize.Value">
<short>New value for the PageSize property.</short>
</element>
<element name="TCustomScrollBar.CNHScroll">
<short>Handles the LM_HSCROLL message for the control.</short>
</element>
<element name="TCustomScrollBar.CNHScroll.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomScrollBar.CNVScroll">
<short>Handles the LM_VSCROLL message for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomScrollBar.CNVScroll.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomScrollBar.CNCtlColorScrollBar">
<short>Handles the CN_CTLCOLORSCROLLBAR message for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomScrollBar.CNCtlColorScrollBar.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomScrollBar.WMEraseBkgnd">
<short>Handles the LM_ERASEBKGND message for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomScrollBar.WMEraseBkgnd.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomScrollBar.WSRegisterClass">
<short>Registers the widgetset class created for new instances of the control.</short>
<descr>
<p>
<var>WSRegisterClass</var> is an overridden procedure used to register the widgetset class instance created for new instances of the control. WSRegisterClass calls the inherited method, and calls <var>RegisterCustomScrollBar</var> for the widgetset.
</p>
</descr>
<seealso>
<link id="#lcl.lclclasses.TLCLComponent.WSRegisterClass">TLCLComponent.WSRegisterClass</link>
</seealso>
</element>
<element name="TCustomScrollBar.GetControlClassDefaultSize">
<short>Gets the default size for new instances of the class.</short>
<descr>
<p>
<var>GetControlClassDefaultSize</var> is an overridden <var>TSize</var> class function used to get the default size for new instances of the class.
</p>
<p>
GetControlClassDefaultSize sets the values in members in the return value. The <var>CX</var> member contains the width for the new instance, and is set 121 (pixels). The <var>CY</var> member contains the height for the new instance, and is set to the number of pixels returned from <var>GetSystemMetrics</var> for the <var>SM_CYHSCROLL</var> constant.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
</seealso>
</element>
<element name="TCustomScrollBar.GetControlClassDefaultSize.Result">
<short>TSize instance with the default width and height for the control.</short>
</element>
<element name="TCustomScrollBar.CreateParams">
<short>Initializes the creation parameters for the class instance.</short>
<descr>
<p>
<var>CreateParams</var> is an overridden method used initialize the creation parameters for the class instance. CreateParams calls the inherited method, and ensures that the <var>Params</var> argument is updated to include the value from the <var>Kind</var> property in the style information for the <var>TCreateParams</var> instance. This ensures that the correct orientation for the scrollbar is used in the creation parameters.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.Kind"/>
<link id="TScrollBarKind"/>
<link id="TCustomScrollBar.CreateWnd"/>
<link id="#lcl.lcltype.TCreateParams">TCreateParams</link>
<link id="#lcl.controls.TWinControl.CreateParams">TWinControl.CreateParams</link>
</seealso>
</element>
<element name="TCustomScrollBar.CreateParams.Params">
<short>The creation parameters and flags for the instance.</short>
</element>
<element name="TCustomScrollBar.CreateWnd">
<short>
<var>CreateWnd</var> - calls inherited <var>CreateWnd</var> then initializes various Scroll Info properties.
</short>
<descr>
<p>
The inherited method creates the interface object, sets parameters and assigns the handle. Then the size of scrollbar, maximum and minimum values, page size and position of scrollbar are set.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
</seealso>
</element>
<element name="TCustomScrollBar.Change">
<short>Invokes the OnChange event handler for the control.</short>
<descr>
<p>
<var>Change</var> is a procedure used to perform the <var>Changed</var> method in the ancestor class, and to signal the <var>OnChange</var> event handler (when assigned) for the control. Change is called when <var>SetParams</var> is used to update the <var>Position</var>, <var>Min</var>, <var>Max</var>, or <var>PageSize</var> values in the scrollbar.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.OnChange"/>
<link id="TCustomScrollBar.SetParams"/>
<link id="TCustomScrollBar.Position"/>
<link id="TCustomScrollBar.Min"/>
<link id="TCustomScrollBar.Max"/>
<link id="TCustomScrollBar.PageSize"/>
<link id="#lcl.controls.TControl.Changed">TControl.Changed</link>
</seealso>
</element>
<element name="TCustomScrollBar.Scroll">
<short>Signals the OnScroll event handler.</short>
<descr>
<p>
<var>Scroll</var> is a method used to signal the <var>OnScroll</var> event handler (when assigned) for the control.
</p>
<p>
<var>ScrollCode</var> contains the scrollbar command constant for the scroll operation. <var>ScrollPos</var> contains the new position for the scrollbar when the operation is completed.
</p>
<p>
Scroll is called from the implementation of the private DoScroll method, which handles scrollbar control messages and sets the values for the arguments to the method.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.OnScroll"/>
</seealso>
</element>
<element name="TCustomScrollBar.Scroll.ScrollCode">
<short>
Scroll command code for the operation; up or down a line, a page, to the top or bottom, etc.
</short>
</element>
<element name="TCustomScrollBar.Scroll.ScrollPos">
<short>The new position for the scrollbar.</short>
</element>
<element name="TCustomScrollBar.CalculatePreferredSize">
<short>Gets the preferred size for new instances of the class.</short>
<descr>
<p>
<var>CalculatePreferredSize</var> is overridden in TCustomScrollBar. The inherited method is called, and the value in PreferredHeight or PreferredWidth is updated, based on the value in <var>Kind</var>, to use the corresponding value from <var>GetSystemMetrics</var>.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.Kind"/>
<link id="#lcl.controls.TWinControl.CalculatePreferredSize">TWinControl.CalculatePreferredSize</link>
<link id="#lcl.lclintf.GetSystemMetrics">GetSystemMetrics</link>
</seealso>
</element>
<element name="TCustomScrollBar.CalculatePreferredSize.PreferredWidth">
<short>Preferred width calculated for the control.</short>
</element>
<element name="TCustomScrollBar.CalculatePreferredSize.PreferredHeight">
<short>Preferred height calculated for the control.</short>
</element>
<element name="TCustomScrollBar.CalculatePreferredSize.WithThemeSpace">
<short>True when space is reserved for theme element details in the calculated dimensions.</short>
</element>
<element name="TCustomScrollBar.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 constructor on entry.
</p>
<p>
Create ensures that the component style is updated to <var>csScrollBar</var> and sets the initial bounds for the control to the values returned from <var>GetControlClassDefaultSize</var>. Create sets the default values for properties, like:
</p>
<dl>
<dt>TabStop</dt>
<dd>Set to True.</dd>
<dt>ControlStyle </dt>
<dd>
Includes the values: [csFramed, csDoubleClicks, csOpaque]. Excludes the values: [csAcceptsControls, csDoubleClicks, csCaptureMouse, csSetCaption].
</dd>
<dt>Kind</dt>
<dd>Set to sbHorizontal.</dd>
<dt>Position</dt>
<dd>Set to 0.</dd>
<dt>Min</dt>
<dd>Set to 0.</dd>
<dt>Max</dt>
<dd>Set to 100.</dd>
<dt>SmallChange</dt>
<dd>Set to 1.</dd>
<dt>LargeChange</dt>
<dd>Set to 1.</dd>
</dl>
</descr>
<seealso/>
</element>
<element name="TCustomScrollBar.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomScrollBar.SetParams">
<short>Updates the Min and Max values, the size of the page, and the position in the scrollbar.</short>
<descr>
<p>
<var>SetParams</var> is an overloaded procedure used to update the values in the <var>TScrollInfo</var> structure passed to the widgetset class. Values passed in parameters are stored in the TScrollInfo instance, and used to validate the new settings for the scrollbar.
</p>
<p>
SetParams raises an <var>EInvalidOperation</var> exception if the value in AMax is smaller than the value in AMin.
</p>
<p>
The value in <var>APosition</var> is normalized to ensure that it is in the range specified by <var>AMin</var> and <var>AMax</var>.
</p>
<p>
<var>APageSize</var> is set to 0 (zero) if it contains a negative value.
</p>
<p>
When any of the parameter values differ from the current values in the class instance, the class instance is updated. <var>SetScrollInfo</var> is called to apply the changed values when a handle has been allocated for the control. <var>SetScrollPos</var> is called when APosition contains a value different than the one in the class instance. The <var>Change</var> method is called to process the updated values in the control and signal the <var>OnChange</var> event handler (when assigned). The <var>SetParams</var> method in the widgetset class is called to synchronize the changes.
</p>
<p>
SetParams is called when a new value is assigned to the <var>Position</var>, <var>Min</var>, <var>Max</var>, or <var>PageSize</var> property.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.Position"/>
<link id="TCustomScrollBar.Min"/>
<link id="TCustomScrollBar.Max"/>
<link id="TCustomScrollBar.PageSize"/>
<link id="TCustomScrollBar.Change"/>
<link id="TCustomScrollBar.OnChange"/>
<link id="TScrollInfo"/>
</seealso>
</element>
<element name="TCustomScrollBar.SetParams.APosition">
<short>Value applied to the scrollbar position.</short>
</element>
<element name="TCustomScrollBar.SetParams.AMin">
<short>Value applied to the scrollbar minimum value.</short>
</element>
<element name="TCustomScrollBar.SetParams.AMax">
<short>Value applied to the scrollbar maximum value.</short>
</element>
<element name="TCustomScrollBar.SetParams.APageSize">
<short>Value applied to the scrollbar page size.</short>
</element>
<element name="TCustomScrollBar.Kind">
<short>Contains the scrollbar orientation, horizontal or vertical.</short>
<descr>
<p>
<var>Kind</var> is a <var>TScrollBarKind</var> property which indicates the orientation for the scrollbar.
</p>
<p>
Setting a new value for the property causes the <var>Constraints</var> for the control to be updated with values from the widgetset class. The widgetset class is also notified of the new value for the property. <var>SetBounds</var> is called to refresh the <var>Width</var> and <var>Height</var> for the control.
</p>
<p>
The default value for the property is <var>sbHorizontal</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Constraints">TControl.Constraints</link>
<link id="#lcl.controls.TControl.Width">TControl.Width</link>
<link id="#lcl.controls.TControl.Height">TControl.Height</link>
<link id="#lcl.controls.TWinControl.SetBounds">TWinControl.SetBounds</link>
<link id="TScrollBarKind"/>
</seealso>
</element>
<element name="TCustomScrollBar.LargeChange">
<short>The distance to scroll on an click beneath the slider.</short>
<descr>
<p>
A large change is produced by clicks on the blank area above or below the slider; it is rather analogous to the Page Down or Page Up functions of the Keyboard, and is typically set up to move the slider and the control contents by a full page (window size).
</p>
<p>
Use SmallChange for the value applied when the Up or Down arrows are clicked, or when one of the cursor keys is pressed to navigate in the associated control.
</p>
</descr>
</element>
<element name="TCustomScrollBar.Max">
<short>The maximum value for the bottom or right position depending on orientation.</short>
<descr>
<p>
The default value for the property is <b>100</b>. Changing the value for the property cause SetParams to be called to apply the values in Position, Min, Max, and PageSize to the scrollbar information stored in the widgetset class instance.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.Min"/>
<link id="TCustomScrollBar.Position"/>
<link id="TCustomScrollBar.PageSize"/>
<link id="TCustomScrollBar.SetParams"/>
<link id="#lcl.lcltype.TScrollInfo">TScrollInfo</link>
</seealso>
</element>
<element name="TCustomScrollBar.Min">
<short>The minimum value for the top or left position depending on orientation.</short>
<descr>
<p>
The default value for the property is <b>0</b>. Changing the value for the property cause SetParams to be called to apply the values in Position, Min, Max, and PageSize to the scrollbar information stored in the widgetset class instance.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.Max"/>
<link id="TCustomScrollBar.Position"/>
<link id="TCustomScrollBar.PageSize"/>
<link id="TCustomScrollBar.SetParams"/>
<link id="#lcl.lcltype.TScrollInfo">TScrollInfo</link>
</seealso>
</element>
<element name="TCustomScrollBar.PageSize">
<short>The size of the slider relative to the total scroll range.</short>
<descr>
<p>
PageSize contains the size for the proportionally-sized slider for the control.
</p>
<p>
PageSize is used in the CreateWnd method when the inital scrollbar information is assigned for the control. It is also one of the arguments passed to the SetParams method to update the scrollbar information in the widgetset class instance.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomScrollBar.Position">
<short>The position of the slider in the scrollbar.</short>
<descr>
<p>
Position contains a value in the range specified by the Min and Max properties. The default value for the property is 0. Changing the value for the property causes the SetParams method to be called to apply the values in Position, Min, Max, and PageSize to the scrollbar information stored in the widgetset class instance.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.Max"/>
<link id="TCustomScrollBar.Min"/>
<link id="TCustomScrollBar.PageSize"/>
<link id="TCustomScrollBar.SetParams"/>
</seealso>
</element>
<element name="TCustomScrollBar.SmallChange">
<short>
The distance to scroll when the up or down button is clicked.
</short>
<descr>
<p>
A small change occurs when the up or down buttons are clicked, or by up/down keyboard commands. It is typically used for scrolling by a few pixels, or by a single row or column of text.
</p>
<p>
Use LargeChange for the value applied when clicking the thumb in the scrollbar, or when using the Home or End keys to navigate in the associated control.
</p>
</descr>
</element>
<element name="TCustomScrollBar.TabStop">
<short>Enables navigation using the Tab key.</short>
<descr>
<p>
Allows the user to navigate to this control by pressing the Tab or Shift+Tab keys. The default value for the property is True in TCustomScrollBar.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.TabStop">TWinControl.TabStop</link>
</seealso>
</element>
<element name="TCustomScrollBar.OnChange">
<short>Event handler signalled when the value in Position, Min, Max, or PageSize is changed.</short>
<descr>
<p>
<var>OnChange</var> is a <var>TNotifyEvent</var> property which contains an event handler signalled when scroll information is updated in the control. OnChange is signalled (when assigned) from the Change method, and occurs when the value in Position, Min, Max, or PageSize is changed using SetParams.
</p>
<p>
Use the OnScroll event handler to respond to events signalled for control messages dispatched to the Scroll method.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.Position"/>
<link id="TCustomScrollBar.Min"/>
<link id="TCustomScrollBar.Max"/>
<link id="TCustomScrollBar.PageSize"/>
<link id="TCustomScrollBar.Change"/>
<link id="TCustomScrollBar.SetParams"/>
<link id="TCustomScrollBar.OnScroll"/>
</seealso>
</element>
<element name="TCustomScrollBar.OnScroll">
<short>Event handler signalled when scrollbar messages are applied.</short>
<descr>
<p>
<var>OnScroll</var> is a <var>TScrollEvent</var> property which provides an event handler signalled when the position for the scrollbar has been changed.
</p>
<p>
<var>Sender</var> contains the scrollbar for the event.
</p>
<p>
<var>ScrollCode</var> contains the scroll command constant for the operation.
</p>
<p>
<var>ScrollPos</var> contains the new position for the scrollbar when the operation is completed. The event handler can be used to override the value in ScrollPos before it is applied to the Position property in the class instance.
</p>
<p>
OnScroll is signalled (when assigned) from the <var>Scroll</var> method, and occurs when control messages, like CNHScroll and CNVScroll, are processed and applied.
</p>
<p>
Use the <var>OnChange</var> event to respond to programmatic changes to property values in the scrollbar.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.Position"/>
<link id="TCustomScrollBar.Scroll"/>
<link id="TCustomScrollBar.OnChange"/>
<link id="TScrollEvent"/>
</seealso>
</element>
<element name="TScrollBar">
<short>
A control that allows the user to scroll the content in an associated control by moving a slider.
</short>
<descr>
<p>
A control that allows the user to scroll the content in a windowed control, by moving a slider.
</p>
<p>
TScrollBar appears as a long rectangular track bar, within which a smaller contrasting block or slider can move up and down (or from side to side in a horizontal ScrollBar). It has small triangular indicators or pointers on one or both ends of the bar, depending on the widgetset.
</p>
<p>
Clicking with the mouse on one of the pointers moves the slider a small distance (<var>SmallChange</var>) in the specified direction. Clicking with the mouse in the blank area of the scrollbar above or below the slider makes the slider move by a larger increment (<var>LargeChange</var>).
</p>
<p>
The slider can also be moved by clicking on it with the mouse, and holding down the button while moving the mouse. The slider then follows the mouse until the button is released.
</p>
<p>
If the mouse has a scrollwheel, the slider also can be moved by rotating the wheel.
</p>
<p>
The arrow keys or the Page Up/Page Down keys on the keyboard can be used to move the slider, too.
</p>
<p>
The location of the slider along the track is held in the <var>Position</var> property. It's the programmer's responsibility to ensure that the content of the window is scrolled to the new Position of the scrollbar.
</p>
</descr>
<seealso>
<link id="TCustomScrollBar.OnChange"/>
<link id="HowToUseStdCtrls"/>
</seealso>
</element>
<element name="TScrollBar.Align" link="#lcl.controls.TControl.Align"/>
<element name="TScrollBar.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TScrollBar.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TScrollBar.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TScrollBar.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TScrollBar.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TScrollBar.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TScrollBar.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TScrollBar.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TScrollBar.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TScrollBar.Kind" link="#lcl.stdctrls.TCustomScrollBar.Kind"/>
<element name="TScrollBar.LargeChange" link="#lcl.stdctrls.TCustomScrollBar.LargeChange"/>
<element name="TScrollBar.Max" link="#lcl.stdctrls.TCustomScrollBar.Max"/>
<element name="TScrollBar.Min" link="#lcl.stdctrls.TCustomScrollBar.Min"/>
<element name="TScrollBar.OnChange" link="#lcl.stdctrls.TCustomScrollBar.OnChange"/>
<element name="TScrollBar.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TScrollBar.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TScrollBar.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TScrollBar.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TScrollBar.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TScrollBar.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TScrollBar.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TScrollBar.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TScrollBar.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TScrollBar.OnScroll" link="#lcl.stdctrls.TCustomScrollBar.OnScroll"/>
<element name="TScrollBar.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TScrollBar.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TScrollBar.PageSize" link="#lcl.stdctrls.TCustomScrollBar.PageSize"/>
<element name="TScrollBar.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TScrollBar.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TScrollBar.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TScrollBar.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TScrollBar.Position" link="#lcl.stdctrls.TCustomScrollBar.Position"/>
<element name="TScrollBar.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TScrollBar.SmallChange" link="#lcl.stdctrls.TCustomScrollBar.SmallChange"/>
<element name="TScrollBar.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TScrollBar.TabStop" link="#lcl.stdctrls.TCustomScrollBar.TabStop"/>
<element name="TScrollBar.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TCustomGroupBox">
<short>
The base class for <var>TGroupBox</var>, <var>TRadioGroup</var> and <var>TCheckGroup</var>.
</short>
<descr>
<p>
<var>TCustomGroupBox</var> is a visual component used to organize related controls into a group. It acts a container. TCustomGroupBox is the base class for <var>TGroupBox</var>, <var>TRadioGroup</var> and <var>TCheckGroup</var>. Do not create instances of TCustomGroupBox; use one of the descendent classes.
</p>
</descr>
<seealso>
<link id="TGroupBox"/>
<link id="#lcl.extctrls.TRadioGroup">TRadioGroup</link>
<link id="#lcl.extctrls.TCheckGroup">TCheckGroup</link>
</seealso>
</element>
<element name="TCustomGroupBox.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomGroupBox.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomGroupBox.GetControlClassDefaultSize.Result">
<short>Default size for new instances of the class.</short>
</element>
<element name="TCustomGroupBox.UpdateOpaque">
<short>Updates the control style when the parent background is used.</short>
<descr>
<p>
<var>UpdateOpaque</var> is a method used to update the control style flags when the parent background is used for the control. When the <var>ParentBackground</var> property is set to <b>True</b>, <var>ControlStyle</var> is updated to remove the <var>csOpaque</var> flag. If ParentBackground is not enabled, ControlStyle is updated to include the csOpaque flag.
</p>
</descr>
<seealso>
<link id="TCustomGroupBox.ParentBackground"/>
</seealso>
</element>
<element name="TCustomGroupBox.CreateParams">
<short>Ensures that creation parameters are updated for the control.</short>
<descr>
<p>
<var>CreateParams</var> is overridden in <var>TCustomGroupBox</var> to ensure that the <var>Style</var> information in <var>Params</var> is updated to include the value <var>BS_GROUPBOX</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.CreateParams">TWinControl.CreateParams</link>
<link id="#lcl.lcltype.TCreateParams">TCreateParams</link>
<link id="#lcl.lcltype.BS_GROUPBOX">BS_GROUPBOX</link>
</seealso>
</element>
<element name="TCustomGroupBox.CreateParams.Params">
<short>Creation parameters updated in the method.</short>
</element>
<element name="TCustomGroupBox.SetColor">
<short>Sets the value for the Color property.</short>
<descr>
<p>
<var>SetColor</var> is a method used to set the value in 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="TCustomGroupBox.ParentBackground"/>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
</seealso>
</element>
<element name="TCustomGroupBox.SetColor.Value">
<short>New value for the Color property.</short>
</element>
<element name="TCustomGroupBox.SetParentBackground">
<short>Sets the value for the ParentBackground property.</short>
<descr>
<p>
<var>SetParentBackground</var> is an overridden method in <var>TCustomGroupBox</var> used to set the value for the <var>ParentBackground</var> property. It calls the inherited method on entry.
</p>
<p>
When the property value is set to <b>True</b> and <var>ParentColor</var> is enabled, the Color property in the <var>Parent</var> control is assigned to the Color property for the group box. Otherwise, <var>clDefault</var> is assigned to the <var>Color</var> property.
</p>
<p>
SetParentBackground calls the <var>UpdateOpaque</var> method to ensure that the ControlStyle flags for the control reflect the transparency needed to draw the parent background.
</p>
</descr>
<seealso>
<link id="TCustomGroupBox.SetParentBackground"/>
<link id="TCustomGroupBox.UpdateOpaque"/>
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
<link id="#lcl.graphics.clDefault">clDefault</link>
</seealso>
</element>
<element name="TCustomGroupBox.SetParentBackground.AParentBackground">
<short>New value for the ParentBackground property.</short>
</element>
<element name="TCustomGroupBox.CMParentColorChanged">
<short>Handles the CM_PARENTCOLORCHANGED message for the control.</short>
<descr>
<p>
Calls the inherited method on entry to update the value in the <var>Color</var> property. Calls <var>UpdateOpaque</var> to adjust the control style flags when the parent color is applied.
</p>
</descr>
<seealso>
<link id="TCustomGroupBox.UpdateOpaque"/>
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
<link id="#lcl.controls.TControl.CMParentColorChanged">TControl.CMParentColorChanged</link>
</seealso>
</element>
<element name="TCustomGroupBox.CMParentColorChanged.Message">
<short>Control message handled in the method.</short>
</element>
<element name="TCustomGroupBox.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 constructor on entry to the method. Create ensures that the component style is set to the value <var>csGroupBox</var>, and includes the value <var>csAcceptsControls</var> in the <var>ControlStyle</var> property. Create calls <var>SetInitialBounds</var> to resize the control using the values returned from <var>GetControlClassDefaultSize</var>.
</p>
</descr>
<seealso>
<link id="TCustomGroupBox.GetControlClassDefaultSize"/>
<link id="#lcl.controls.TControl.ControlStyle">TControl.ControlStyle</link>
<link id="#lcl.controls.TControl.SetInitialBounds">TControl.SetInitialBounds</link>
</seealso>
</element>
<element name="TCustomGroupBox.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomGroupBox.ParentBackground">
<short>Indicates if the control uses the background from the parent.</short>
<descr>
<p>
The write access specifier is overridden in <var>TCustomGroupBox</var>. It calls the inherited method on enty.
</p>
<p>
If <var>AParentBackground</var> is <b>True</b> and ParentColor is <b>True</b>, the <var>Color</var> from the <var>Parent</var> control is assigned to the <var>Color</var> property. Otherwise, the value <var>clDefault</var> is stored in the Color property.
</p>
<p>
The <var>UpdateOpaque</var> method is called to adjust the control style flags in the control.
</p>
<p>
The default value for the property is <b>True</b>.
</p>
</descr>
<seealso>
<link id="TCustomGroupBox.UpdateOpaque"/>
<link id="#lcl.controls.TWinControl.ParentBackground">TWinControl.ParentBackground</link>
</seealso>
</element>
<element name="TGroupBox">
<short>
A container that allows a number of objects to be grouped physically and conceptually on a form.
</short>
<descr>
<p>
<var>TGroupBox</var> is a <var>TCustomGroupBox</var> descendant which implements a visual component used to organize related controls into a group. It acts as a container for controls added to the component, and is assigned as the parent for each control.
</p>
<p>
TGroupBox sets the visibility for properties defined in ancestor classes.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="TCustomGroupBox"/>
</seealso>
</element>
<element name="TGroupBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TGroupBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TGroupBox.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TGroupBox.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TGroupBox.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TGroupBox.Caption" link="#lcl.controls.TControl.Caption"/>
<element name="TGroupBox.ChildSizing" link="#lcl.controls.TWinControl.ChildSizing"/>
<element name="TGroupBox.ClientHeight" link="#lcl.controls.TControl.ClientHeight"/>
<element name="TGroupBox.ClientWidth" link="#lcl.controls.TControl.ClientWidth"/>
<element name="TGroupBox.Color" link="#lcl.controls.TControl.Color"/>
<element name="TGroupBox.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TGroupBox.Ctl3D" link="#lcl.controls.TControl.Ctl3D"/>
<element name="TGroupBox.DockSite" link="#lcl.controls.TWinControl.DockSite"/>
<element name="TGroupBox.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TGroupBox.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TGroupBox.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TGroupBox.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TGroupBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TGroupBox.Font" link="#lcl.controls.TControl.Font"/>
<element name="TGroupBox.ParentBackground" link="#lcl.stdctrls.TCustomGroupBox.ParentBackground"/>
<element name="TGroupBox.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TGroupBox.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TGroupBox.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TGroupBox.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TGroupBox.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TGroupBox.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TGroupBox.OnDockDrop" link="#lcl.controls.TWinControl.OnDockDrop"/>
<element name="TGroupBox.OnDockOver" link="#lcl.controls.TWinControl.OnDockOver"/>
<element name="TGroupBox.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TGroupBox.OnEndDock" link="#lcl.controls.TControl.OnEndDock"/>
<element name="TGroupBox.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TGroupBox.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TGroupBox.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TGroupBox.OnGetSiteInfo" link="#lcl.controls.TWinControl.OnGetSiteInfo"/>
<element name="TGroupBox.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TGroupBox.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TGroupBox.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TGroupBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TGroupBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TGroupBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TGroupBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TGroupBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TGroupBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TGroupBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TGroupBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TGroupBox.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TGroupBox.OnStartDock" link="#lcl.controls.TControl.OnStartDock"/>
<element name="TGroupBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TGroupBox.OnUnDock" link="#lcl.controls.TWinControl.OnUnDock"/>
<element name="TGroupBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TGroupBox.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TGroupBox.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TGroupBox.ParentCtl3D" link="#lcl.controls.TWinControl.ParentCtl3D"/>
<element name="TGroupBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TGroupBox.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TGroupBox.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TGroupBox.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TGroupBox.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TGroupBox.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
<element name="TGroupBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TEmulatedTextHintStatus">
<short>Status values for an emulated TextHint display in a control.</short>
<descr>
<p>
<var>TEmulatedTextHintStatus</var> is an enumerated type with values which indicate the status for an emulated TextHint display in a control. TEmulatedTextHintStatus is the type used for the <var>EmulatedTextHintStatus</var> property in both <var>TCustomComboBox</var> and <var>TCustomEdit</var>.
</p>
</descr>
<seealso>
<link id="TCustomEdit.EmulatedTextHintStatus"/>
<link id="TCustomComboBox.EmulatedTextHintStatus"/>
</seealso>
</element>
<element name="TEmulatedTextHintStatus.thsHidden">
<short>An emulated TextHint not currently displayed for the control.</short>
</element>
<element name="TEmulatedTextHintStatus.thsShowing">
<short>
An emulated TextHint is currently being shown for the control. The value for control has been temporarily set to the value in TextHint.
</short>
</element>
<element name="TEmulatedTextHintStatus.thsChanging">
<short>
The emulated TextHint is being displayed. Occurs while the HintFont is being created, and the hint text value and password character are passed to the widgetset class. Changes to thsShowing when the actions have been completed.
</short>
</element>
<element name="TComboBoxAutoCompleteTextOption">
<short>
Defines the behavior of the <var>AutoComplete</var> feature in a combo-box control.
</short>
<descr>
<p>
<var>TComboBoxAutoCompleteTextOption</var> is an enumerated type with values which control the auto-completion features and behaviors in combo-box controls. Values from the enumeration are stored in the <var>TComboBoxAutoCompleteText</var> type used in the <var>AutoCompleteText</var> property in <var>TCustomComboBox</var> and descendent classes.
</p>
</descr>
<seealso>
<link id="TComboBoxAutoCompleteText"/>
<link id="TCustomComboBox.AutoCompleteText"/>
</seealso>
</element>
<element name="TComboBoxAutoCompleteTextOption.cbactEnabled">
<short>Enable Auto-Completion features.</short>
</element>
<element name="TComboBoxAutoCompleteTextOption.cbactEndOfLineComplete">
<short>Perform Auto-Complete only when cursor is at the end of the string.</short>
</element>
<element name="TComboBoxAutoCompleteTextOption.cbactRetainPrefixCase">
<short>
Retains the case of characters user has typed. This option has no effect if cbactEndOfLineComplete is not set.
</short>
</element>
<element name="TComboBoxAutoCompleteTextOption.cbactSearchCaseSensitive">
<short>Search for the completion string with case sensitivity.</short>
</element>
<element name="TComboBoxAutoCompleteTextOption.cbactSearchAscending">
<short>
Search completion strings in ascending order when set. Otherwise, search in descending order.
</short>
</element>
<element name="TComboBoxAutoCompleteText">
<short>Set of <var>TComboBoxAutoCompleteTextOption</var> values.</short>
<descr>
<p>
<var>TComboBoxAutoCompleteText</var> is a set type used to store zero (0) or more values from the <var>TComboBoxAutoCompleteTextOption</var> enumeration. TComboBoxAutoCompleteText is the type used to implement the <var>AutoCompleteText</var> property in <var>TCustomComboBox</var> and descendent classes. It is also the type used for the <var>DefaultComboBoxAutoCompleteText</var> constant which defines the default values used in combo-box controls.
</p>
</descr>
<seealso>
<link id="TComboBoxAutoCompleteTextOption"/>
<link id="TCustomComboBox.AutoCompleteText"/>
<link id="DefaultComboBoxAutoCompleteText"/>
</seealso>
</element>
<element name="DefaultComboBoxAutoCompleteText">
<short>Default values for the AutoCompleteText property in combo-box controls.</short>
<descr>
<p>
<var>DefaultComboBoxAutoCompleteText</var> is a constant which contains the set of default values used in the <var>AutoCompleteText</var> property in combo-box controls. DefaultComboBoxAutoCompleteText is assigned to the property in the constructor for the class instance.
</p>
<p>
DefaultComboBoxAutoCompleteText contains the following values from the <var>TComboBoxAutoCompleteTextOption</var> enumeration:
</p>
<ul>
<li>cbactEndOfLineComplete</li>
<li>cbactSearchAscending</li>
</ul>
</descr>
<seealso>
<link id="TComboBoxAutoCompleteTextOption"/>
<link id="TCustomComboBox.AutoCompleteText"/>
<link id="TCustomComboBox.Create"/>
</seealso>
</element>
<element name="TComboBoxStyle">
<short>The display style available for combo-box controls.</short>
<descr>
<p>
<var>TComboBoxStyle</var> is an enumerated type with values which control the display style for combo-box controls. TComboBoxStyle is the type used for the <var>Style</var> property in <var>TCustomComboBox</var> and descendent classes.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Style"/>
</seealso>
</element>
<element name="TComboBoxStyle.csDropDown">
<short>
The combo-box has an edit control and a button to open and close the drop-down list. This is the default value used for the control.
</short>
</element>
<element name="TComboBoxStyle.csSimple">
<short>
The combo-box has an edit control and a list box which is always visible.
</short>
</element>
<element name="TComboBoxStyle.csDropDownList">
<short>
The combo-box has a drop-down list for selecting an entry. The selected value is displayed like a label and is not editable.
</short>
</element>
<element name="TComboBoxStyle.csOwnerDrawFixed">
<short>
Similar to csDropDownList, but is owner-drawn with a fixed height for items in the list.
</short>
</element>
<element name="TComboBoxStyle.csOwnerDrawVariable">
<short>
The drop-down list elements are owner-drawn and can have a variable height for items in the list.
</short>
</element>
<element name="TComboBoxStyleHelper">
<short>Helper for the TComboBoxStyle type.</short>
<descr>
<p>
<var>TComboBoxStyleHelper</var> is a type helper for <var>TComboBoxStyle</var>. TComboBoxStyleHelper provides convenience methods used to examine, adjust, or translate values in the TComboBoxStyle enumeration.
</p>
<p>
For example:
</p>
<code>
// does the style include an edit box?
if AComboBox.Style.HasEditBox then DoSomething;
// does the style use owner-draw?
if AComboBox.Style.IsOwnerDrawn then DoSomething;
// does the style use variable height items?
if AComboBox.Style.IsVariable then DoSomething;
// toggle the edit box visibility and use in the current style
AComboBox.Style := AComboBox.Style.SetEditBox(False);
</code>
</descr>
<seealso>
<link id="TCustomComboBox.Style"/>
<link id="TComboBoxStyle"/>
</seealso>
</element>
<element name="TComboBoxStyleHelper.HasEditBox">
<short>Determines if the style includes an edit box.</short>
<descr/>
<seealso/>
</element>
<element name="TComboBoxStyleHelper.HasEditBox.Result">
<short>True if an selected item value is editable.</short>
</element>
<element name="TComboBoxStyleHelper.SetEditBox">
<short>Enables or disables an edit box according to the current style.</short>
<descr/>
<seealso/>
</element>
<element name="TComboBoxStyleHelper.SetEditBox.Result">
<short>Style values after adding or removing the edit box.</short>
</element>
<element name="TComboBoxStyleHelper.SetEditBox.AHasEditBox">
<short>True enables the edit box; False disables the edit box.</short>
</element>
<element name="TComboBoxStyleHelper.IsOwnerDrawn">
<short>Indicates if the combo-box control is owner-drawn.</short>
<descr/>
<seealso/>
</element>
<element name="TComboBoxStyleHelper.IsOwnerDrawn.Result">
<short>True if the style includes an owner-drawn option.</short>
</element>
<element name="TComboBoxStyleHelper.IsVariable">
<short>Indicates if list items can have a variable height in the combo-box control.</short>
<descr/>
<seealso/>
</element>
<element name="TComboBoxStyleHelper.IsVariable.Result">
<short>True when the option is included for variable height list items.</short>
</element>
<element name="TOwnerDrawState">
<short>Alias for the TOwnerDrawState type in <file>lcltype.pp</file>.</short>
<descr>
<p>
<var>TOwnerDrawState</var> instances are passed as an argument to methods which draw list items in controls, like <var>TCustomComboBox.DrawItem</var> and <var>TCustomListBox.DrawItem</var>.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.DrawItem"/>
<link id="TCustomListBox.DrawItem"/>
<link id="#lcl.lcltype.TOwnerDrawState">TOwnerDrawState</link>
</seealso>
</element>
<element name="TDrawItemEvent">
<short>
Specifies an event handler used to paint a single item in an owner-drawn list box or combo-box.
</short>
<descr>
<p>
<var>TDrawItemEvent</var> is an object procedure type which specifies an event handler signalled to paint an single item in a owner-drawn list box or combo-box control. Arguments passed to the event handler identify the control, the index for the list item, the canvas coordinates, and the drawing state for the operation. The event handler is responsible for rendering the list item to its control in its entirety when the control uses owner-drawn style settings.
</p>
<p>
TDrawItemEvent is the type used to implement the <var>OnDrawItem</var> property in <var>TCustomComboBox</var> and <var>TCustomListBox</var>. An application must implement and assign an object procedure using the signature for the handler to respond to the event notification.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.OnDrawItem"/>
<link id="TCustomListBox.OnDrawItem"/>
</seealso>
</element>
<element name="TDrawItemEvent.Control">
<short>The control for the owner-drawn operation.</short>
</element>
<element name="TDrawItemEvent.Index">
<short>Index of the list item to draw.</short>
</element>
<element name="TDrawItemEvent.ARect">
<short>The Canvas rectangle for the list item.</short>
</element>
<element name="TDrawItemEvent.State">
<short>Flags describing the drawing state for the list item.</short>
</element>
<element name="TMeasureItemEvent">
<short>
Specifies an event handler used to get the Height for a single item in an owner-drawn list box or combo-box.
</short>
<descr>
<p>
<var>TMeasureItemEvent</var> is an object procedure type which specifies an event handler signalled to get the height for a single item in an owner-drawn list box or combo-box control. Arguments passed to the handler include the control for the event notification, the index position for the item measured in the handler, and the derived height for the item.
</p>
<p>
TMeasureItemEvent is the type used for the <var>OnMeasureItem</var> property in <var>TCustomComboBox</var> and <var>TCustomListBox</var>. An application must implement and assign a procedure using the signature for the handler to respond to the event notification. The handler should account for variable height items when enabled in settings for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.OnMeasureItem"/>
<link id="TCustomListBox.OnMeasureItem"/>
</seealso>
</element>
<element name="TMeasureItemEvent.Control">
<short>The list box or combo-box control.</short>
</element>
<element name="TMeasureItemEvent.Index">
<short>Index of the list item to measure.</short>
</element>
<element name="TMeasureItemEvent.AHeight">
<short>Height of the list item in pixels.</short>
</element>
<element name="TCustomComboBox">
<short>The base class for combo-box components.</short>
<descr>
<p>
<var>TCustomComboBox</var> is a <var>TWinControl</var> descendant which implements the base class for combo-box components in the LCL (Lazarus Component Library).
</p>
<p>
A combo-box is visually represented as an edit control and a scrollable list of items which can be selected. The list can be always visible, or opened when needed using a drop-down indicator. In addition, the items in the control be drawn using using the built-in mechanisms for the widgetset class or using an owner-drawn style.
</p>
<p>
Despite similarities in appearance to <var>TCustomEdit</var> and <var>TCustomList</var>, the class inherits no properties from these classes (Delphi compatible).
</p>
<p>
Use the <var>Style</var> property to control the display style and drawing mechanism enabled for Items in the control.
</p>
<p>
Use properties like <var>AutoComplete</var>, <var>AutoCompleteText</var>, and <var>AutoDropDown</var> to control the behavior of the edit field or drop-down list in the control.
</p>
<p>
Use <var>Items</var> to access existing list items defined the control. Use <var>AddItem</var> or <var>AddHistoryItem</var> to add entries to the list items in the control. Use <var>OnGetItems</var> to dynamically populate the Items in the control when the drop-down list is displayed.
</p>
<p>
Do not create instances of TCustomComboBox. Use one of the descendent classes, like <var>TComboBox</var> or <var>TComboBoxEx</var>.
</p>
</descr>
</element>
<element name="TCustomComboBox.FArrowKeysTraverseList"/>
<element name="TCustomComboBox.FAutoCompleteText"/>
<element name="TCustomComboBox.FAutoSelect"/>
<element name="TCustomComboBox.FAutoSelected"/>
<element name="TCustomComboBox.FAutoDropDown"/>
<element name="TCustomComboBox.FCanvas"/>
<element name="TCustomComboBox.FCharCase"/>
<element name="TCustomComboBox.FDropDownCount"/>
<element name="TCustomComboBox.FDroppedDown"/>
<element name="TCustomComboBox.FDroppingDown"/>
<element name="TCustomComboBox.FEditingDone"/>
<element name="TCustomComboBox.FEmulatedTextHintStatus"/>
<element name="TCustomComboBox.FItemHeight"/>
<element name="TCustomComboBox.FItemIndex"/>
<element name="TCustomComboBox.FItemWidth"/>
<element name="TCustomComboBox.FItems"/>
<element name="TCustomComboBox.FMaxLength"/>
<element name="TCustomComboBox.FOnChange"/>
<element name="TCustomComboBox.FOnCloseUp"/>
<element name="TCustomComboBox.FOnDrawItem"/>
<element name="TCustomComboBox.FOnDropDown"/>
<element name="TCustomComboBox.FOnGetItems"/>
<element name="TCustomComboBox.FOnMeasureItem"/>
<element name="TCustomComboBox.FOnSelect"/>
<element name="TCustomComboBox.FReadOnly"/>
<element name="TCustomComboBox.FReturnArrowState">
<short>Used internally, to return the state of arrow keys from temporary change.</short>
</element>
<element name="TCustomComboBox.FSelLength"/>
<element name="TCustomComboBox.FSelStart"/>
<element name="TCustomComboBox.FSorted"/>
<element name="TCustomComboBox.FStyle"/>
<element name="TCustomComboBox.FTextHint"/>
<element name="TCustomComboBox.GetAutoComplete">
<short>Gets the value for the AutoComplete property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.AutoComplete"/>
</seealso>
</element>
<element name="TCustomComboBox.GetAutoComplete.Result">
<short>Value for the AutoComplete property.</short>
</element>
<element name="TCustomComboBox.GetDroppedDown">
<short>Gets the value for the DroppedDown property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.DroppedDown"/>
</seealso>
</element>
<element name="TCustomComboBox.GetDroppedDown.Result">
<short>Value for the DroppedDown property.</short>
</element>
<element name="TCustomComboBox.GetItemWidth">
<short>Gets the value for the ItemWidth property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.ItemWidth"/>
</seealso>
</element>
<element name="TCustomComboBox.GetItemWidth.Result">
<short>Value for the ItemWidth property.</short>
</element>
<element name="TCustomComboBox.SetAutoComplete">
<short>Sets the value for the AutoComplete property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.AutoComplete"/>
</seealso>
</element>
<element name="TCustomComboBox.SetAutoComplete.AValue">
<short>New value for the AutoComplete property.</short>
</element>
<element name="TCustomComboBox.SetArrowKeysTraverseList">
<short>Sets the value for the ArrowKeysTraverseList property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.ArrowKeysTraverseList"/>
</seealso>
</element>
<element name="TCustomComboBox.SetArrowKeysTraverseList.Value">
<short>New value for the ArrowKeysTraverseList property.</short>
</element>
<element name="TCustomComboBox.SetItemWidth">
<short>Sets the value for the ItemWidth property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.ItemWidth"/>
</seealso>
</element>
<element name="TCustomComboBox.SetItemWidth.AValue">
<short>New value for the ItemWidth property.</short>
</element>
<element name="TCustomComboBox.SetCharCase">
<short>Sets the value for the CharCase property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.CharCase"/>
</seealso>
</element>
<element name="TCustomComboBox.SetCharCase.eccCharCase">
<short>New value for the CharCase property.</short>
</element>
<element name="TCustomComboBox.SetReadOnly">
<short>Sets the value for the ReadOnly property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.ReadOnly"/>
</seealso>
</element>
<element name="TCustomComboBox.SetReadOnly.AValue">
<short>New value for the ReadOnly property.</short>
</element>
<element name="TCustomComboBox.SetTextHint">
<short>Sets the value for the TextHint property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.TextHint"/>
</seealso>
</element>
<element name="TCustomComboBox.SetTextHint.AValue">
<short>New value for the TextHint property.</short>
</element>
<element name="TCustomComboBox.ShowEmulatedTextHintIfYouCan">
<short>Tries to display an emulated TextHint for the control.</short>
<descr>
<p>
<var>ShowEmulatedTextHintIfYouCan</var> is a method which attempts to display an emulated <var>TextHint</var> for the control. ShowEmulatedTextHintIfYouCan calls <var>CanShowEmulatedTextHint</var> to determine if the control requires an emulated TextHint display, and is in a state which allows it. If CanShowEmulatedTextHint returns <b>True</b>, the <var>ShowEmulatedTextHint</var> method is called to display the TextHint.
</p>
<p>
ShowEmulatedTextHintIfYouCan is called from the implementation of the <var>InitializeWnd</var> and <var>WMKillFocus</var> methods, and when a new value is assigned to the TextHint property.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.TextHint"/>
<link id="TCustomComboBox.CanShowEmulatedTextHint"/>
<link id="TCustomComboBox.ShowEmulatedTextHint"/>
<link id="TCustomComboBox.WMKillFocus"/>
<link id="TCustomComboBox.InitializeWnd"/>
</seealso>
</element>
<element name="TCustomComboBox.ShowEmulatedTextHint">
<short>Displays an emulated TextHint for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBox.HideEmulatedTextHint">
<short>Hides an emulated TextHint display for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBox.UpdateSorted">
<short>Performs actions needed when the Sorted property is changed.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.Sorted"/>
</seealso>
</element>
<element name="TCustomComboBox.LMDrawListItem">
<short>Handler for custom drawing items; calls DrawItem.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBox.LMDrawListItem.TheMessage">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.LMMeasureItem">
<short>Determines the height of an item, using MeasureItem in variable owner-draw mode.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBox.LMMeasureItem.TheMessage">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.LMSelChange">
<short>Handles selection change messages for the control.</short>
<descr>
<p>
<var>LMSelChange</var> is a method used to handle a <var>LM_CHANGED</var> message for the control. No actions are performed in the method during component streaming, when the control is freed, or at design-time.
</p>
<p>
<var>LMSelChange</var> calls the <var>Select</var> method to signal the <var>OnSelect</var> event handler (when assigned).
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Select"/>
<link id="TCustomComboBox.OnSelect"/>
</seealso>
</element>
<element name="TCustomComboBox.LMSelChange.TheMessage">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.CNCommand">
<short>Handles a CN_COMMAND notification message for the control.</short>
<descr>
<p>
<var>CNCommand</var> is a method used to handle a <var>CN_COMMAND</var> control notification message for the control. CNCommand examines <var>TheMessage</var> to determine the actions needed for the NotifyCode in the message.
</p>
<p>
When NotifyCode is <var>CBN_DROPDOWN</var>, the following actions are performed:
</p>
<ul>
<li>DroppedDown is set to True.</li>
<li>Calls DropDown to signal the OnDropDown event handler (when assigned).</li>
<li>Calls AdjustDropDown to configure the height and width for the drop down list.</li>
</ul>
<p>
When NotifyCode is <var>CBN_CLOSEUP</var>, the following actions are performed:
</p>
<ul>
<li>DroppedDown is set to False.</li>
<li>Calls CloseUp to signal the OnCloseUp event handler (when assigned).</li>
</ul>
</descr>
<seealso/>
</element>
<element name="TCustomComboBox.CNCommand.TheMessage">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.WMChar">
<short>Handles LM_CHAR window messages for the control.</short>
<descr>
<p>
Prevents ordinary characters from triggering the accelerator key for the control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomComboBox.WMChar.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.WMKillFocus">
<short>Implements a handler for the LM_KILLFOCUS message.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBox.WMKillFocus.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.WMSetFocus">
<short>Implements a handler for the LM_SETFOCUS message.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBox.WMSetFocus.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomComboBox.CanShowEmulatedTextHint">
<short>Indicates whether an emulated TextHint can be displayed for the control.</short>
<descr>
<p>
<var>CanShowEmulatedTextHint</var> is a <var>Boolean</var> function which indicates whether an emulated text hint can be displayed for the control. Emulated text hints are the fallback mechanism used when text hints are not natively supported for a platform / widgetset.
</p>
<p>
The return value is <b>True</b> when <b>all</b> of the following conditions are met:
</p>
<ul>
<li>A Handle has been allocated for the widgetset class instance.</li>
<li>Text hints are not natively supported as an LCL capability for the platform.</li>
<li>The ComponentState property does not contain csDesigning or csLoading.</li>
<li>TextHint is not an empty string value.</li>
<li>Text is an empty string value.</li>
<li>The control is not Focused.</li>
</ul>
<p>
CanShowEmulatedTextHint is called during execution of the InitializeWnd method, when the LM_KILLFOCUS window message is handled for the control, and when a new value is assigned to the TextHint property.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomComboBox.CanShowEmulatedTextHint.Result">
<short>True when emulated TextHints are used, and the control state allows the hint display.</short>
</element>
<element name="TCustomComboBox.CreateParams">
<short>
Updates the specified creation parameters to include additional flags for the control.
</short>
<descr>
<p>
<var>CreateParams</var> is an overridden method in <var>TCustomComboBox</var>, and calls the inherited method on entry. CreateParams ensures that the style information in <var>Params</var> is updated to include constants needed to represent values in the <var>Style</var> property for the control. The following constants are also included:
</p>
<ul>
<li>WS_VSCROLL</li>
<li>CBS_AUTOHSCROLL</li>
<li>CBS_HASSTRINGS</li>
</ul>
<p>
When <var>Sorted</var> is set to <b>True</b>, the value CBS_SORT is also included in the style information in Params.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.Sorted"/>
<link id="#lcl.controls.TWinControl.CreateParams">TWinControl.CreateParams</link>
</seealso>
</element>
<element name="TCustomComboBox.CreateParams.Params">
<short>Creation parameters updated in the method.</short>
</element>
<element name="TCustomComboBox.InitializeWnd">
<short>
Synchronizes the control and its widgetset class instance when the handle is created.
</short>
<descr>
<p>
<var>InitializeWnd</var> is overridden in <b>TCustomComboBox</b> to ensure that the widgetset class and the current class instance are synchronized. InitializeWnd calls the inherited method on entry.
</p>
<p>
InitializeWnd gets the string values for list items stored in the widgetset class instance (when present), and applies them to the <var>Items</var> property. Other property values are forwarded <b>to</b> the widgetset class instance, including:
</p>
<ul>
<li>ArrowKeysTraverseList</li>
<li>DropDownCount</li>
<li>ItemIndex</li>
<li>MaxLength</li>
<li>ReadOnly</li>
<li>Style</li>
</ul>
<p>
Values in <var>SelStart</var> and <var>SelLength</var> are re-applied to update the edit box in the control to reflect any changes to property values.
</p>
<p>
InitializeWnd is called from CreateWnd after the Window handle has been allocated, and before any child handles are allocated.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.ReadOnly"/>
<link id="TCustomComboBox.MaxLength"/>
<link id="TCustomComboBox.DropDownCount"/>
<link id="TCustomComboBox.ArrowKeysTraverseList"/>
<link id="#lcl.controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
<link id="#lcl.controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
</seealso>
</element>
<element name="TCustomComboBox.DestroyWnd">
<short>Destroys the handle for the control (and its children).</short>
<descr>
<p>
<var>DestroyWnd</var> is an overridden method in TCustomComboBox used to destroy the handle for the windowed control. This occurs when the control is freed, and when the handle is re-created in the widgetset class. DestroyWnd ensures that values for the ItemIndex and Items properties are retrieved from the widgetset class before it is destroyed or re-created. The value in Sorted is applied to the Items retrieved from the widgetset class.
</p>
<p>
DestroyWnd calls the inherited method prior to exit.
</p>
</descr>
<errors>
DestroyWnd calls <var>RaiseGDBException</var> to raise a catchable debugger exception if a handle has not been allocated for the control.
</errors>
<seealso>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.Sorted"/>
<link id="#lcl.controls.TWinControl.DestroyWnd">TWinControl.DestroyWnd</link>
<link id="#lcl.lclproc.RaiseGDBException">RaiseGDBException</link>
</seealso>
</element>
<element name="TCustomComboBox.DoEnter">
<short>Updates the control when the Enter key is applied.</short>
<descr>
<p>
<var>DoEnter</var> is an overridden method used to update the edit and list box when the <b>Enter</b> or <b>Return</b> key is handled in messages to the control. The inherited method is called to signal the <var>OnEnter</var> event handler (when assigned).
</p>
<p>
DoEnter uses the value in <var>Style</var> to determine if an edit box is enabled for the control. If an edit box is <b>not</b> used, no additional actions are performed in the method.
</p>
<p>
When <var>AutoSelect</var> is enabled, the <var>SelectAll</var> method is called to select the text in the edit box and to locate the entry in the <var>Items</var> for the control. <var>AutoSelected</var> is updated to indicate if <var>SelText</var> matches the value in Text.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.AutoSelect"/>
<link id="TCustomComboBox.AutoSelected"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.SelectAll"/>
<link id="TCustomComboBox.SelText"/>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.Text"/>
<link id="#lcl.controls.TWinControl.DoEnter">TWinControl.DoEnter</link>
<link id="#lcl.controls.TWinControl.OnEnter">TWinControl.OnEnter</link>
</seealso>
</element>
<element name="TCustomComboBox.DoExit">
<short>Updates the control when the CM_EXIT control message is handled.</short>
<descr>
<p>
<var>DoExit</var> is an overridden method in <var>TCustomComboBox</var> used to perform actions needed when the <b>CM_EXIT</b> control message is handled for the control. DoExit sets the value in <var>AutoSelected</var> to <b>False</b>, and calls the inherited method to signal the <var>OnExit</var> event handler (when assigned).
</p>
</descr>
<seealso>
<link id="TCustomComboBox.AutoSelected"/>
<link id="#lcl.controls.TWinControl.DoExit">TWinControl.DoExit</link>
<link id="#lcl.controls.TWinControl.OnExit">TWinControl.OnExit</link>
</seealso>
</element>
<element name="TCustomComboBox.DrawItem">
<short>Draws a list item, using the OnDrawItem handler (when assigned).</short>
<descr>
<p>
<var>DrawItem</var> is a procedure used to draw a list item defined in the <var>Items</var> property. DrawItem is called when the <var>LM_DrawListItem</var> message is handled for the control. Arguments passed to the method include the position in Items for the value drawn, the canvas rectangle where the drawing occurs, and the drawing state for the list item.
</p>
<p>
DrawItem signals the <link id="TCustomComboBox.OnDrawItem">OnDrawItem</link> handler (when assigned) to perform the drawing operation. Otherwise, default painting is performed by filling the background for the Canvas rectangle (if needed) and calling the InternalDrawItem routine.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.OnDrawItem"/>
<link id="TDrawItemEvent"/>
<link id="TOwnerDrawState"/>
<link id="#rtl.types.TRect">TRect</link>
</seealso>
</element>
<element name="TCustomComboBox.DrawItem.Index">
<short>The position for the item drawn in the method.</short>
</element>
<element name="TCustomComboBox.DrawItem.ARect">
<short>The area to paint on the Canvas.</short>
</element>
<element name="TCustomComboBox.DrawItem.State">
<short>The drawing state for the item (selected...).</short>
</element>
<element name="TCustomComboBox.KeyUpAfterInterface">
<short>Handles key up events forwarded from the LCL interface.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomComboBox.KeyUpAfterInterface.Key">
<short>Key code examined in the method.</short>
</element>
<element name="TCustomComboBox.KeyUpAfterInterface.Shift">
<short>Shift, Ctrl, or Alt modifier for the key code.</short>
</element>
<element name="TCustomComboBox.MeasureItem">
<short>Gets the height for an item in the drop-down list.</short>
<descr>
<p>
<var>MeasureItem</var> is a procedure used to get the height for an item in the drop-down list for the control.
</p>
<p>
MeasureItem is called when the <b>LM_MeasureItem</b> message is handled for the control. The value in <var>ItemHeight</var> has already been updated in the message handler, and is used for a list box <var>Style</var> that has a fixed item height. MeasureItem is called from the message handler when the Style uses a variable item height. The derived item height is stored in the <var>ItemHeight</var> property when it is a non-zero positive value.
</p>
<p>
MeasureItem signals the <var>OnMeasureItem</var> event handler (when assigned) to calculate the height for the specified item. The value in the <var>Index</var> argument determines the string value in <var>Items</var> used for the calculation. <var>TheHeight</var> is updated with the derived height for the list box item. An application must implement the OnMeasureItem event handler to calculate the height for variable height items in the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.OnMeasureItem"/>
<link id="TCustomComboBox.ItemWidth"/>
<link id="TCustomComboBox.ItemHeight"/>
<link id="TCustomComboBox.Style"/>
<link id="#lcl.lmessages.TLMMeasureItem">TLMMeasureItem</link>
</seealso>
</element>
<element name="TCustomComboBox.MeasureItem.Index">
<short>The index of the item whose height is required.</short>
</element>
<element name="TCustomComboBox.MeasureItem.TheHeight">
<short>The height of the item, in pixels, calculated in the OnMeasureItem handler.</short>
</element>
<element name="TCustomComboBox.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomComboBox.GetControlClassDefaultSize.Result">
<short>Default size (bounds) for the new class instance.</short>
</element>
<element name="TCustomComboBox.LMChanged">
<short>Handles the LM_CHANGED message for the control.</short>
<descr>
<p>
<var>LMChanged</var> is a procedure used to handle a <b>LM_CHANGED</b> message received for the control. LMChanged occurs when the widgetset class calls the LCLSendChangeMsg routine for the control. LMChanged calls the <var>Change</var> method to perform the control message and to signal the <var>OnChange</var> event handler (when assigned).
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Change"/>
<link id="TCustomComboBox.OnChange"/>
<link id="#lcl.controls.TControl.Perform">TControl.Perform</link>
</seealso>
</element>
<element name="TCustomComboBox.LMChanged.Msg">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.CMWantSpecialKey">
<short>Handles the CM_WANTSPECIALKEY control message for the control.</short>
<descr>
<p>
For the Darwin (macOS) platform, cursor keys (VK_LEFT, VK_RIGHT, VK_UP, VK_DOWN) in Message are marked as handled for edit controls.
</p>
<p>
The inherited method is called (for all platforms) prior to exiting from the method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomComboBox.CMWantSpecialKey.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomComboBox.Change">
<short>Invokes the OnChange handler, signalling a change in the edit box.</short>
<descr>
<p>
<var>Change</var> is a procedure used to perform actions needed when the value for the control is changed. Change is called from the <var>LMChanged</var> method used to process the change notification message. Change calls the <var>Changed</var> method, inherited from TControl, to <var>Perform</var> the control message. The <var>OnChange</var> event handler is signalled (when assigned).
</p>
</descr>
<seealso>
<link id="TCustomComboBox.LMChanged"/>
<link id="TCustomComboBox.OnChange"/>
<link id="#lcl.controls.TControl.Changed">TControl.Changed</link>
<link id="#lcl.controls.TControl.Perform">TControl.Perform</link>
</seealso>
</element>
<element name="TCustomComboBox.Select">
<short>Signals the <var>OnSelect</var> event handler when ItemIndex is changed.</short>
<descr>
<p>
<var>Select</var> is a procedure called when the item selection in the drop-down list for the control has changed. This can happen when text is entered and auto-completion is enabled, or when a new value is selected from the drop-down list.
</p>
<p>
Select signals the <var>OnSelect</var> event handler (when assigned). For Delphi compatibility, the event handler is <b>not</b> signalled when <var>ItemIndex</var> contains <b>-1</b> (<var>Text</var> is not located in the <var>Items</var> for the control).
</p>
</descr>
<seealso>
<link id="TCustomComboBox.OnSelect"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.AutoComplete"/>
<link id="TCustomComboBox.AutoCompleteText"/>
<link id="TCustomComboBox.Text"/>
<link id="TCustomComboBox.SelText"/>
<link id="TCustomComboBox.SelStart"/>
<link id="TCustomComboBox.SelLength"/>
</seealso>
</element>
<element name="TCustomComboBox.DropDown">
<short>Signals the <var>OnDropDown</var> event handler.</short>
<descr>
<p>
<var>DropDown</var> is a procedure called whenever the drop-down list is displayed. DropDown is called when a <b>CN_Command</b> message with a <b>CBN_DROPDOWN</b> notification code is handled for the control. DropDown signals the <var>OnDropDown</var> event handler (when assigned).
</p>
<p>
Use <var>DroppedDown</var> to determine if the drop-down list has been displayed.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.CloseUp"/>
<link id="TCustomComboBox.DroppedDown"/>
<link id="TCustomComboBox.OnDropDown"/>
</seealso>
</element>
<element name="TCustomComboBox.GetItems">
<short>Signals the <var>OnGetItems</var> event handler.</short>
<descr>
<p>
<var>GetItems</var> is a procedure used to dynamically populate the values stored in the <var>Items</var> property. GetItems signals the <var>OnGetItems</var> event handler (when assigned) to perform actions needed to fill the Items property. GetItems is called from the <var>IntfGetItems</var> method executed when the widgetset class makes its drop-down list visible.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.OnGetItems"/>
<link id="TCustomComboBox.IntfGetItems"/>
</seealso>
</element>
<element name="TCustomComboBox.SetItems">
<short>Sets the value for the Items property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.Items"/>
</seealso>
</element>
<element name="TCustomComboBox.SetItems.Value">
<short>New value for the Items property.</short>
</element>
<element name="TCustomComboBox.CloseUp">
<short>Called when the drop-down list is closed.</short>
<descr>
<p>
<var>CloseUp</var> is a method called whenever the drop-down list for the control is closed. CloseUp is called when a <b>CN_Command</b> message with a <b>CBN_CLOSEUP</b> notification code is received in the control.
</p>
<p>
CloseUp does not perform any actions in the method at design-time, when the component is being loaded using LCL streaming, or when the control is freed.
</p>
<p>
CloseUp signals the <var>OnEditingDone</var> event handler when an edit box is enabled in the <var>Style</var> property in the control. The <var>OnCloseUp</var> event handler is signalled (when assigned).
</p>
<p>
When <var>AutoSelect</var> is enabled, the <var>SelectAll</var> method is called and the <var>AutoSelected</var> property is updated.
</p>
</descr>
<seealso>
<link id="TComboBox.OnEditingDone"/>
<link id="TCustomComboBox.OnCloseUp"/>
<link id="TCustomComboBox.DroppedDown"/>
<link id="TCustomComboBox.DropDown"/>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.SelectAll"/>
<link id="TCustomComboBox.AutoSelect"/>
<link id="TCustomComboBox.AutoSelected"/>
</seealso>
</element>
<element name="TCustomComboBox.AdjustDropDown">
<short>Adjusts the extent for the drop-down list.</short>
<descr>
<p>
<var>AdjustDropDown</var> is used to adjust the bounds for the drop-list list in the control. AdjustDropDown is called when the drop-list becomes visible, and when the value in the <var>ItemWidth</var> property is changed.
</p>
<p>
AdjustDropDown does not perform any actions in the method if a handle has not been assigned for the control.
</p>
<p>
AdjustDropDown ensures that the value in <var>DropDownCount</var> is applied (when needed) to the drop-down list for the control. The minimum height and width for the list is calculated using the <var>ItemWidth</var> and <var>ItemHeight</var> properties. The dimensions are passed to the widgetset class using the SetComboMinDropDownSize routine in the LCL interface.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.ItemWidth"/>
<link id="TCustomComboBox.ItemHeight"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.DropDownCount"/>
<link id="TCustomComboBox.DropDown"/>
</seealso>
</element>
<element name="TCustomComboBox.DoAutoAdjustLayout">
<short>Performs actions needed to auto-adjust the control using the specified layout policy.</short>
<descr>
<p>
<var>DoAutoAdjustLayout</var> is an overridden method used to apply an auto-adjust layout policy to the control. DoAutoAdjustLayout calls the inherited method on entry.
</p>
<p>
DoAutoAdjustLayout ensures that the item height for the control is scaled using the factor in <var>AYProportion</var> when <var>AMode</var> contains the <var>lapAutoAdjustWithoutHorizontalScrolling</var> or <var>lapAutoAdjustForDPI</var> layout adjustment policy values.
</p>
<p>
DoAutoAdjustLayout is called from the <var>AutoAdjustLayout</var> method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.DoAutoAdjustLayout">TControl.DoAutoAdjustLayout</link>
<link id="#lcl.controls.TLayoutAdjustmentPolicy">TLayoutAdjustmentPolicy</link>
</seealso>
</element>
<element name="TCustomComboBox.DoAutoAdjustLayout.AMode">
<short>Layout adjustment policy applied in the method.</short>
</element>
<element name="TCustomComboBox.DoAutoAdjustLayout.AXProportion">
<short>Factor used to scale horizontal dimensions.</short>
</element>
<element name="TCustomComboBox.DoAutoAdjustLayout.AYProportion">
<short>Factor used to scale vertical dimensions.</short>
</element>
<element name="TCustomComboBox.GetItemCount">
<short>Returns the number of items defined in the drop-down list.</short>
<descr>
<p>
<var>GetItemCount</var> is an <var>Integer</var> function used to get the number of values stored in the <var>Items</var> for the control. It is a convenience method, and is equivalent to reading the value for the <var>Count</var> property in <var>Items</var>.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
</seealso>
</element>
<element name="TCustomComboBox.GetItemCount.Result">
<short>The number of Items defined in the control.</short>
</element>
<element name="TCustomComboBox.GetItemHeight">
<short>Gets the value for the ItemHeight property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.ItemHeight"/>
</seealso>
</element>
<element name="TCustomComboBox.GetItemHeight.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomComboBox.GetSelLength">
<short>Gets the value for the SelLength property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.SelLength"/>
</seealso>
</element>
<element name="TCustomComboBox.GetSelLength.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomComboBox.GetSelStart">
<short>Gets the value for the SelStart property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.SelStart"/>
</seealso>
</element>
<element name="TCustomComboBox.GetSelStart.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomComboBox.GetSelText">
<short>Gets the value for the SelText property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.SelText"/>
</seealso>
</element>
<element name="TCustomComboBox.GetSelText.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomComboBox.GetItemIndex">
<short>Gets the value for the ItemIndex property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.ItemIndex"/>
</seealso>
</element>
<element name="TCustomComboBox.GetItemIndex.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomComboBox.GetMaxLength">
<short>Gets the value for the MaxLength property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.MaxLength"/>
</seealso>
</element>
<element name="TCustomComboBox.GetMaxLength.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomComboBox.SetDropDownCount">
<short>Sets the value for the DropDownCount property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.DropDownCount"/>
</seealso>
</element>
<element name="TCustomComboBox.SetDropDownCount.AValue">
<short>New value for the DropDOwnCount property.</short>
</element>
<element name="TCustomComboBox.SetDroppedDown">
<short>Sets the value for the DroppedDown property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.DroppedDown"/>
</seealso>
</element>
<element name="TCustomComboBox.SetDroppedDown.AValue">
<short>New value for the DroppedDown property.</short>
</element>
<element name="TCustomComboBox.SetItemHeight">
<short>Sets the value for the ItemHeight property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.ItemHeight"/>
</seealso>
</element>
<element name="TCustomComboBox.SetItemHeight.AValue">
<short>New value for the ItemHeight property.</short>
</element>
<element name="TCustomComboBox.SetItemIndex">
<short>Sets the value for the ItemIndex property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.ItemIndex"/>
</seealso>
</element>
<element name="TCustomComboBox.SetItemIndex.Val">
<short>New value for the ItemIndex property.</short>
</element>
<element name="TCustomComboBox.SetMaxLength">
<short>Sets the value for the MaxLength property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.MaxLength"/>
</seealso>
</element>
<element name="TCustomComboBox.SetMaxLength.AValue">
<short>New value for the MaxLength property.</short>
</element>
<element name="TCustomComboBox.SetSelLength">
<short>Sets the value for the SelLength property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.SelLength"/>
</seealso>
</element>
<element name="TCustomComboBox.SetSelLength.Val">
<short>New value for the SelLength sproperty.</short>
</element>
<element name="TCustomComboBox.SetSelStart">
<short>Sets the value for the SelStart property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.SelStart"/>
</seealso>
</element>
<element name="TCustomComboBox.SetSelStart.Val">
<short>New value for the SelStart property.</short>
</element>
<element name="TCustomComboBox.SetSelText">
<short>Sets the value for the SelText property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.SelText"/>
</seealso>
</element>
<element name="TCustomComboBox.SetSelText.Val">
<short>New value for the SelText property.</short>
</element>
<element name="TCustomComboBox.SetSorted">
<short>Sets the value for the Sorted property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.Sorted"/>
</seealso>
</element>
<element name="TCustomComboBox.SetSorted.Val">
<short>New value for the Sorted property.</short>
</element>
<element name="TCustomComboBox.SetStyle">
<short>Sets the value for the Style property.</short>
<descr/>
<seealso>
<link id="TCustomComboBox.Style"/>
</seealso>
</element>
<element name="TCustomComboBox.SetStyle.Val">
<short>New value for the Style property.</short>
</element>
<element name="TCustomComboBox.RealGetText">
<short>Gets the text/caption for the control.</short>
<descr>
<p>
<var>RealGetText</var> is an overridden method in <var>TCustomComboBox</var> which provides additional debugging support in the method. RealGetText ensures that a handle has been allocated for the control and the value in Text is available in the widgetset class prior to calling the inherited method.
</p>
<p>
The return value contains the Caption assigned to the control, or an empty string ('') when the control handle is not available.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.RealGetText">TWinControl.RealGetText</link>
</seealso>
</element>
<element name="TCustomComboBox.RealGetText.Result">
<short>Caption for the control, or an empty string.</short>
</element>
<element name="TCustomComboBox.RealSetText">
<short>Updates ItemIndex when the new value for the control is updated.</short>
<descr>
<p>
<var>RealSetText</var> is an overridden method in <var>TCustomComboBox</var>. It ensures that <var>ItemIndex</var> is updated with the ordinal position in <var>Items</var> where the <var>AValue</var> argument is found. If there are no values stored in Items, ItemIndex is set to <b>-1</b>. A visible emulated <var>TextHint</var> is hidden when AValue is not an empty string ('').
</p>
<p>
The inherited method is called prior to exit. This causes the widgetset class to be updated when its <var>Handle</var> is valid. The value in <var>Caption</var> is also updated, and a <b>CM_TEXTCHANGED</b> control message is performed for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.RealGetText"/>
<link id="#lcl.controls.TWinControl.RealSetText">TWinControl.RealSetText</link>
<link id="#lcl.controls.TWinControl.RealGetText">TWinControl.RealGetText</link>
</seealso>
</element>
<element name="TCustomComboBox.RealSetText.AValue">
<short>The new value for the control.</short>
</element>
<element name="TCustomComboBox.KeyDown">
<short>Filters keys used to traverse the list.</short>
<descr>
<p>
<var>KeyDown</var> is an overridden method in <var>TCustomComboBox</var>. KeyDown ensures that keys like Escape, Tab, and Return are handled in the manner needed for the <var>Style</var> in the control. If the values in <var>Key</var> and <var>Shift</var> are not specifically handled in the method, the inherited KeyDown method is called.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.AutoDropDown"/>
<link id="TCustomComboBox.ArrowKeysTraverseList"/>
<link id="#lcl.controls.TWinControl.KeyDown">TWinControl.KeyDown</link>
</seealso>
</element>
<element name="TCustomComboBox.KeyDown.Key">
<short>The pressed key.</short>
</element>
<element name="TCustomComboBox.KeyDown.Shift">
<short>The state of the modifier keys and mouse buttons.</short>
</element>
<element name="TCustomComboBox.KeyUp">
<short>Handles AutoComplete and AutoSelect for the control.</short>
<descr>
<p>
<var>KeyUp</var> is an overridden method in TCustomComboBox, and calls the inherited method on entry.
</p>
<p>
KeyUp ensures that the <b>VK_RETURN</b> key code causes <var>SelectAll</var> to be called when <var>AutoCompletion</var> or <var>AutoSelect</var> is enabled for the control. <var>AutoSelected</var> is set to <b>True</b> when the values in <var>SelText</var> and <var>Text</var> are the same.
</p>
<p>
In addition, alphanumeric key codes are used to perform AutoComplete text location using the options enabled in the <var>AutoCompleteText</var> property. The values in Text, <var>SelStart</var>, and <var>SelLength</var> are updated (when needed) and the <var>Select</var> method is called to reflect the operation.
</p>
<p>
KeyUp is called when <var>TLMKeyUp</var> control messages are processed in the handlers for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.AutoSelect"/>
<link id="TCustomComboBox.AutoSelected"/>
<link id="TCustomComboBox.AutoComplete"/>
<link id="TCustomComboBox.AutoCompleteText"/>
<link id="TCustomComboBox.Text"/>
<link id="TCustomComboBox.SelText"/>
<link id="TCustomComboBox.SelStart"/>
<link id="TCustomComboBox.SelLength"/>
<link id="TCustomComboBox.Select"/>
<link id="#lcl.controls.TWinControl.KeyUp">TWinControl.KeyUp</link>
</seealso>
</element>
<element name="TCustomComboBox.KeyUp.Key">
<short>Virtual key code examined in the method.</short>
</element>
<element name="TCustomComboBox.KeyUp.Shift">
<short>Shift, Alt, or Ctrl modifier for the key code.</short>
</element>
<element name="TCustomComboBox.UTF8KeyPress">
<short>
<var>UTF8KeyPress</var> converts character case if required then calls the inherited method.
</short>
<descr>
<p>
<var>UTF8KeyPress</var> is an overridden method, and calls the inherited method on entry. The inherited method emulates a UTF-8-encoded keypress. The UTF-8 encoding should be used when there is the possibility that input/output will occur in any language that requires multiple bytes to represent each character, i.e. all languages except English.
</p>
<p>
UTF8KeyPress uses the value in <var>CharCase</var> to determine if the character case for <var>UTF8Key</var> is converted:
</p>
<dl>
<dt>ecNormalCase</dt>
<dd>No conversion is required.</dd>
<dt>ecLowerCase</dt>
<dd>Calls UTF8LowerCase to convert the value in UTF8Key.</dd>
<dt>ecUpperCase</dt>
<dd>Calls UTF8UpperCase to convert the value in UTF8Key.</dd>
</dl>
</descr>
<seealso>
<link id="TCustomComboBox.CharCase"/>
<link id="#lazutils.lazutf8.UTF8LowerCase">UTF8LowerCase</link>
<link id="#lazutils.lazutf8.UTF8UpperCase">UTF8UpperCase</link>
<link id="#lcl.controls.TWinControl.UTF8KeyPress">TWinControl.UTF8KeyPress</link>
</seealso>
</element>
<element name="TCustomComboBox.UTF8KeyPress.UTF8Key">
<short>UTF-8-encoded character examined in the method.</short>
</element>
<element name="TCustomComboBox.MouseUp">
<short>Highlights the selected text in the control when the left mouse button is released.</short>
<descr>
<p>
<var>MouseUp</var> is an overridden method, and calls the inherited method on entry. MouseUp ensures that the selected text in the control is highlighted when the Left mouse button is released and <var>AutoSelect</var> is enabled. MouseUp calls <var>SelectAll</var> to select the value in the <var>Text</var> property in the edit box for the control. The value in <var>AutoSelected</var> is set to <b>True</b>.
</p>
<p>
No selection is performed in the method when AutoSelect is set to <b>False</b>.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.AutoSelect"/>
<link id="TCustomComboBox.AutoSelected"/>
<link id="TCustomComboBox.SelectAll"/>
<link id="TCustomComboBox.Text"/>
<link id="TCustomComboBox.SelText"/>
<link id="TCustomComboBox.SelStart"/>
<link id="TCustomComboBox.SelLength"/>
<link id="#lcl.controls.TControl.MouseUp">TControl.MouseUp</link>
</seealso>
</element>
<element name="TCustomComboBox.MouseUp.Button">
<short>Mouse button for the notification.</short>
</element>
<element name="TCustomComboBox.MouseUp.Shift">
<short>Shift, Alt, or Ctrl modifier for the notification.</short>
</element>
<element name="TCustomComboBox.MouseUp.X">
<short>Horizontal coordinate for the mouse pointer.</short>
</element>
<element name="TCustomComboBox.MouseUp.Y">
<short>Vertical coordinate for the mouse pointer.</short>
</element>
<element name="TCustomComboBox.SelectItem">
<short>Selects the list item with the specified text.</short>
<descr>
<p>
<var>SelectItem</var> is a <var>Boolean</var> function used to select the list item in the control with the value specified in <var>AnItem</var>. The return value is <b>True</b> when the <var>Items</var> property contains an entry with the value in <var>AnItem</var>.
</p>
<p>
The value in <var>ItemIndex</var> is updated with the ordinal position in Items for the specified value, or <b>-1</b> when AnItem does not exist in Items. When the value in ItemIndex is changed, the <var>Click</var> and <var>Select</var> methods are called to refresh the control display and to signal the <var>OnClick</var> and <var>OnSelect</var> event handlers.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.Select"/>
<link id="TCustomComboBox.OnSelect"/>
<link id="#lcl.controls.TControl.Click">TControl.Click</link>
<link id="#lcl.controls.TControl.OnClick">TControl.OnClick</link>
</seealso>
</element>
<element name="TCustomComboBox.SelectItem.Result">
<short>True when a matching item was found and selected.</short>
</element>
<element name="TCustomComboBox.SelectItem.AnItem">
<short>The text to find in Items.</short>
</element>
<element name="TCustomComboBox.ShouldAutoAdjust">
<short>Indicates if the width and/or height for the control can be adjusted by a layout policy.</short>
<descr>
<p>
<var>ShouldAutoAdjust</var> is an overridden method in <var>TCustomComboBox</var>. It sets the values in the <var>AWidth</var> and <var>AHeight</var> parameters to indicate if the control can adjust the bound(s) when a layout policy is applied to the control. True indicates the value for the property can be adjusted.
</p>
<p>
ShouldAutoAdjust is used in the implementation of the <var>DoAutoAdjustLayout</var> method.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.DoAutoAdjustLayout"/>
<link id="#lcl.controls.TControl.ShouldAutoAdjust">TControl.ShouldAutoAdjust</link>
</seealso>
</element>
<element name="TCustomComboBox.ShouldAutoAdjust.AWidth">
<short>Always set to True in the method.</short>
</element>
<element name="TCustomComboBox.ShouldAutoAdjust.AHeight">
<short>True when AutoSize is not enabled for the control.</short>
</element>
<element name="TCustomComboBox.ItemHeight">
<short>The default height of an item in the drop-down for the control.</short>
<descr>
<p>
<var>ItemHeight</var> is an Integer property which contains the height (in pixels) used when drawing an item in the drop-down list.
</p>
<p>
The value for the property is retrieved from the widgetset class when not already assigned in the class instance, or when using an owner-drawn <var>Style</var>. Setting a new value for ItemHeight calls the <var>SetItemHeight</var> method in the widgetset class for owner-drawn Styles.
</p>
<p>
The property value is updated when the <var>LM_MeasureItem</var> message is handled for the control. When variable height items are enabled in Style, the <var>OnMeasureItem</var> event handler must be implemented to calculate the height for individual value in <var>Items</var>.
</p>
<p>
<var>ItemHeight</var>, <var>ItemWidth</var>, <var>Items</var>, and <var>DropDownCount</var> are used in the <var>AdjustDropDown</var> method to determine the dimensions for the drop-down list in the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.OnMeasureItem"/>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.ItemWidth"/>
<link id="TCustomComboBox.DropDownCount"/>
<link id="TCustomComboBox.AdjustDropDown"/>
</seealso>
</element>
<element name="TCustomComboBox.ItemWidth">
<short>The minimum width of the items in the drop-down list.</short>
<descr>
<p>
<var>ItemWidth</var> is an <var>Integer</var> property which contains the minimum number of pixels used when displaying the static or drop-down list for the control. The default value for the property is 0 (zero).
</p>
<p>
Setting a new value for the property causes the <var>AdjustDropDown</var> method to be called to adjust the dimensions for the list to the values in <var>ItemHeight</var>, <var>ItemWidth</var>, and <var>DropDownCount</var>.
</p>
<p>
Use <var>ItemHeight</var> to specify the number of pixels required for items displayed in the drop-down list for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.DropDownCount"/>
<link id="TCustomComboBox.ItemHeight"/>
<link id="TCustomComboBox.AdjustDropDown"/>
</seealso>
</element>
<element name="TCustomComboBox.MaxLength">
<short>The maximum length for text entered in the edit box for the control.</short>
<descr>
<p>
<var>MaxLength</var> is an <var>Integer</var> property which contains the maximum length for a value entered in the <var>Text</var> for the control. It controls the number of characters allowed in the edit box, but does not limit the length of the value that can be directly assigned to Text. MaxLength is passed to and read from the widgetset class when a handle has been assigned for the control.
</p>
<p>
The default value for the property is <b>0</b> (zero), and indicates that a maximum length has not been specified in the property. Setting the value for the property does not alter the existing value in Text.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Text"/>
</seealso>
</element>
<element name="TCustomComboBox.OnChange">
<short>Event handler signalled for user changes to the text in the edit box.</short>
<descr>
<p>
<var>OnChange</var> is a <var>TNotifyEvent</var> property which implements the event handler signalled when the value in the edit box has been changed.
</p>
<p>
The event applies to interactive changes to <var>Text</var> made by the user, not those made programmatically. Note that this differs from how other OnChange events work. For example: TEdit.OnChange is triggered by text changes that occur in code. This event is also triggered when the item selection is changed using the drop-down list in the combo-box.
</p>
<p>
OnChange is signalled (when assigned) in the <var>Change</var> method called when the control messages are handled in the window procedure. An application must implement and assign an object procedure using the signature in TNotifyEvent to respond to the event notification.
</p>
</descr>
<seealso>
<link id="TCustomEdit.OnChange"/>
<link id="TCustomEdit.Change"/>
<link id="TCustomEdit.Text"/>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomComboBox.OnCloseUp">
<short>Handler invoked when the drop-down list closes.</short>
<descr>
<p>
<var>OnCloseUp</var> is a <var>TNotifyEvent</var> property which contains the event handler signalled when the drop-down list in the control is hidden or closed. It can be used to perform any actions needed in an application, such as comparing pre-selection and post-selection values for properties. An application must implement and assign an object procedure to the property to respond to the event notification.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomComboBox.OnDrawItem">
<short>Handler for special painting of an item (in owner-draw mode).</short>
<descr>
<p>
<var>OnDrawItem</var> is a <var>TDrawItemEvent</var> property which contains an event handler used to draw an item in the drop-down list for the control. OnDrawItem is used when <var>Style</var> contains one of the owner-drawn values. See <var>TComboBoxStyle</var> for more information about the owner-drawn styles available.
</p>
<p>
OnDrawItem is signalled (when assigned) from the <var>DrawItem</var> method. The event handler is responsible for all drawing operations needed to render the specified list item. This can include the text and any images or overlays drawn for the list item. Use the <var>Canvas</var> property to render the list item to the specified coordinate rectangle.
</p>
<p>
If OnDrawItem is not assigned, an internal default drawing routine is called to render the list item. It handles filling the canvas rectangle with the background for the item, and drawing the item text using the style, layout, and alignment defined in the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.DrawItem"/>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.Canvas"/>
<link id="TDrawItemEvent"/>
<link id="TComboBoxStyle"/>
</seealso>
</element>
<element name="TCustomComboBox.OnDropDown">
<short>Handler invoked when the list has dropped down.</short>
<descr>
<p>
<var>OnDropDown</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the drop-down list for the control is displayed. OnDropDown is signalled (when assigned) from the <var>DropDown</var> method. DropDown is called when the <b>CBN_DROPDOWN</b> message is handled for the control.
</p>
<p>
Implement and assign an object procedure to the handler to respond to the event notification.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.DropDown"/>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomComboBox.OnGetItems">
<short>Handler invoked when widgetset items list can be populated.</short>
<descr>
<p>
<var>OnGetItems</var> is a <var>TNotifyEvent</var> property with the event handler signalled to load the values used in the <var>Items</var> property.
</p>
<p>
OnGetItems is signalled (when assigned) from the <var>GetItems</var> method. Some widgetsets, like GTK, call GetItems (via <var>IntfGetItems</var>) just before the drop-down list is displayed. Others call GetItems when the handle for the control is created. OnGetItems provides one event to handle both cases.
</p>
<p>
An application should implement and assign an object procedure to the handler to respond to the event notification. The procedure must perform any actions needed to load the values for the Items property from an appropriate source.
</p>
<p>
Values can always be stored in the Items property using code at run-time, or by entering the values using the Object Inspector at design-time.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.GetItems"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.IntfGetItems"/>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomComboBox.OnMeasureItem">
<short>Handler invoked when the height for an item is needed.</short>
<descr>
<p>
<var>OnMeasureItem</var> is a <var>TMeasureItemEvent</var> property with the event handler signalled to get the height for an item displayed in the list box for the control.
</p>
<p>
OnMeasureItem is signalled (when assigned) from the <var>MeasureItem</var> method. MeasureItem (and OnMeasureItem) are used when the <var>Style</var> property indicates that the control uses a variable height for each item displayed in the list box. OnMeasureItem occurs when the <b>LM_MeasureItem</b> message is handled for the control.
</p>
<p>
Use the <var>Index</var> argument to get the value in <var>Items</var> examined in the event handler. Use <var>ItemWidth</var> to determine the maximum width allowed for the variable height item. <var>Canvas</var> can be used to get text metrics for the <var>Font</var> used in the control. Update the <var>AHeight</var> argument with the height calculated for the item.
</p>
<p>
Use <var>ItemHeight</var> for the item height used for fixed height drawing styles.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.MeasureItem"/>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.ItemHeight"/>
<link id="TCustomComboBox.ItemWidth"/>
<link id="TCustomComboBox.Canvas"/>
<link id="TMeasureItemEvent"/>
</seealso>
</element>
<element name="TCustomComboBox.OnSelect">
<short>Handler invoked when an item is selected.</short>
<descr>
<p>
<var>OnSelect</var> is a <var>TNotifyEvent</var> property with the event handler signalled when an item is selected in the list box for the control.
</p>
<p>
OnSelect is signalled (when assigned) from the <var>Select</var> method when <var>ItemIndex</var> contains a positive non-zero value. Select (and subsequently OnSelect) are called from multiple methods in TCustomComboBox. <var>SelectItem</var> calls Select when the value in ItemIndex is changed as a result of assigning a value to <var>Text</var>. <var>KeyUp</var> calls Select when the value in Text is updated by auto-completion features in the control. Select is also called when the <b>LM_SelChange</b> message is handled for the control.
</p>
<p>
Implement and assign an object procedure to the handler to respond to the event notification.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Select"/>
<link id="TCustomComboBox.SelectItem"/>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.KeyUp"/>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomComboBox.ParentColor">
<short>Uses the Color from the Parent control, when enabled.</short>
<descr>
<p>
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TCustomComboBox.
</p>
<p>
When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
</seealso>
</element>
<element name="TCustomComboBox.Sorted">
<short>Determines whether the list entries are sorted in alphanumeric order.</short>
<descr>
<p>
<var>Sorted</var> is a <var>Boolean</var> property which indicates if values in <var>Items</var> are stored and displayed in alphanumeric sort order.
</p>
<p>
Setting this property to <b>True</b> enforces ascending alphanumeric case-insensitive sorting of the list. When set to <b>True</b>, new entries are added in sort order, and not to the end of the Items list. When a new value is assigned to the property, the <var>UpdateSorted</var> method is called to set the <var>Sorted</var> property in <var>Items</var> to the corresponding value. <var>ItemIndex</var> is also set to the location in Items where the value in <var>Text</var> is stored, or <b>-1</b> when not found.
</p>
<p>
The default value for the property is <b>False</b>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomComboBox.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 constructor on entry. Create ensures that resources are allocated for members in the class instance. Create sets the default values for properties, including the following:
</p>
<dl>
<dt>ControlSyle</dt>
<dd>Removes csCaptureMouse from the style flags.</dd>
<dt>DropDownCunt</dt>
<dd>Set to display 8 items by default.</dd>
<dt>ArrowKeysTraverseList</dt>
<dd>Set to True to enable cursor key navigation in the control.</dd>
<dt>AutoCompleteText</dt>
<dd>Set to the values in the DefaultComboBoxAutoCompleteText constant.</dd>
<dt>AutoSelect</dt>
<dd>Set to True.</dd>
<dt>CharCase</dt>
<dd>Set to ecNormal.</dd>
<dt>AutoSize</dt>
<dd>
Set to True. AutoSize must be true by default since some widgetsets (win32, wince) ignore the combo-box height and others (gtk2) look ugly with a very small height.
</dd>
</dl>
</descr>
<seealso>
<link id="TCustomComboBox.Destroy"/>
</seealso>
</element>
<element name="TCustomComboBox.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomComboBox.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy calls <var>DestroyHandle</var> if a handle has been allocated for the control. Destroy frees resources allocated for the <var>Canvas</var> property, and calls the inherited destructor.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Create"/>
</seealso>
</element>
<element name="TCustomComboBox.IntfGetItems">
<short>Gets the values in the Items property for the widgetset class.</short>
<descr>
<p>
<var>IntfGetItems</var> is a procedure used to populate the values in the <var>Items</var> property. IntfGetItems is called when the widgetset class retrieves the values for the items displayed in the control. Some widgetsets perform this action when the handle is allocated, or the focus is set for the control. Others perform the action when the drop-list for the control is displayed.
</p>
<p>
IntfGetItems calls the <var>GetItems</var> method to signal the <var>OnGetItems</var> event handler (when assigned).
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.GetItems"/>
<link id="TCustomComboBox.OnGetItems"/>
</seealso>
</element>
<element name="TCustomComboBox.AddItem">
<short>
Adds the specified string (and optional object) to the Items displayed in the control.
</short>
<descr>
<p>
<var>AddItem</var> is a procedure used to add the specified value (and an optional associated object) to the <var>Items</var> in the control. AddItem calls the <var>AddObject</var> method in Items to store the values in <var>Item</var> and <var>AnObject</var>.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="#rtl.classes.TStrings.AddObject">TStrings.AddObject</link>
</seealso>
</element>
<element name="TCustomComboBox.AddItem.Item">
<short>The string added to Items.</short>
</element>
<element name="TCustomComboBox.AddItem.AnObject">
<short>The associated object, can be Nil.</short>
</element>
<element name="TCustomComboBox.AddHistoryItem">
<short>
Add an item as the first entry in the history list for the control.
</short>
<descr>
<p>
<var>AddHistoryItem</var> is a procedure used to add the values in <var>Item</var> and <var>AnObject</var> to the beginning of the list items displayed for the control. AddHistoryItem uses the value in <var>CaseSensitive</var> to determine if case is significant when comparing the value in Item to the existing value at the beginning of <var>Items</var>.
</p>
<p>
AddHistoryItem calls the <var>InsertObject</var> method in Items to store the values at the initial position in the Items list (ordinal position 0). When Item exists at another position in Items, it is removed.
</p>
<p>
<var>MaxHistoryCount</var> contains the maximum number of entries allowed in the Items property. When the number of entries in Items exceeds the value in MaxHistoryCount, the excess is removed from the end of the Items property.
</p>
<p>
When <var>SetText</var> is <b>True</b>, the value in Item is stored to the <var>Text</var> property.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.Text"/>
<link id="#rtl.classes.TStrings.InsertObject">TStrings.InsertObject</link>
<link id="#rtl.classes.TStrings.Delete">TStrings.Delete</link>
</seealso>
</element>
<element name="TCustomComboBox.AddHistoryItem.Item">
<short>The string to be added to the list.</short>
</element>
<element name="TCustomComboBox.AddHistoryItem.AnObject">
<short>Optional associated object added for the item.</short>
</element>
<element name="TCustomComboBox.AddHistoryItem.MaxHistoryCount">
<short>The maximum number of items that can be added to the history.</short>
</element>
<element name="TCustomComboBox.AddHistoryItem.SetAsText">
<short>When True the string also is copied into the edit box for the control.</short>
</element>
<element name="TCustomComboBox.AddHistoryItem.CaseSensitive">
<short>
True means that the list can contain multiple items with the same text, differing in case.
</short>
</element>
<element name="TCustomComboBox.AddHistoryItem.AnObject">
<short>The object associated with the item; can be Nil.</short>
</element>
<element name="TCustomComboBox.Clear">
<short>Removes all items from the list, and clears the edit box.</short>
<descr>
<p>
<var>Clear</var> is a procedure used to remove all values stored in the <var>Items</var> property for the control. Clear calls the Clear method in Items to removed the strings and any associated objects stored in the <var>TStrings</var> property. Clear sets the value in <var>Text</var> to an empty string (<b>''</b>) which forces the value in ItemIndex to be changed to <b>-1</b>.
</p>
<p>
Use the Clear method in Items to remove all of the the values stored in Items but keep the current value in Text.
</p>
<p>
Use ClearSelection to reset the value in ItemIndex and de-select the selected value in Items.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.ClearSelection"/>
<link id="#rtl.classes.TStrings.Clear">TStrings.Clear</link>
</seealso>
</element>
<element name="TCustomComboBox.ClearSelection">
<short>Removes the item selection in the list box for the control.</short>
<descr>
<p>
<var>ClearSelection</var> is a procedure used to remove the current item selection in the list box for the control. This causes the value in <var>ItemIndex</var> to be changed to <b>-1</b>, and the value in Text is set to an empty string ('').
</p>
<p>
Use SelStart, SelLength, and SelText to access or modify the text selection in the edit control. Set <var>SelLength</var> to zero (<b>0</b>) to remove the text selection in the edit box.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.SelLength"/>
<link id="TCustomComboBox.SelStart"/>
<link id="TCustomComboBox.SelText"/>
</seealso>
</element>
<element name="TCustomComboBox.CharCase">
<short>
Indicates the case conversion applied to the value entered in the edit box for the control.
</short>
<descr>
<p>
<var>CharCase</var> is a <var>TEditCharCase</var> property which indicates the case conversion applied to the value entered in the edit box for the control. The default value for the property is <var>ecNormal</var>, and indicates that no case conversion is performed.
</p>
<p>
Setting a new value for the property causes the value in <var>Text</var> to be converted to the specified case by calling either the <var>UTF8LowerCase</var> or the <var>UTF8UpperCase</var> routine. Text is not modified when <var>ecNormal</var> is assigned to the property.
</p>
<p>
The value in CharCase is used when the <var>UTF8KeyPress</var> is called to apply key press events for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Text"/>
<link id="TCustomComboBox.UTF8KeyPress"/>
<link id="#lazutils.lazutf8.UTF8LowerCase">UTF8LowerCase</link>
<link id="#lazutils.lazutf8.UTF8UpperCase">UTF8UpperCase</link>
</seealso>
</element>
<element name="TCustomComboBox.DroppedDown">
<short>Indicates whether the drop-down list has been displayed.</short>
<descr>
<p>
<var>DroppedDown</var> is a <var>Boolean</var> property which indicates whether the drop-down list for the control has been displayed.
</p>
<p>
Reading the value for the property causes the widgetset class to be queried when a handle has been allocated for the control. Otherwise, the stored value for the property is used.
</p>
<p>
Setting a new value for the property causes the widgetset class to be notified of the changed property value. No actions are performed if a handle has not been allocated for the control, or during LCL component streaming. Setting this property opens or closes the drop-down list.
</p>
<p>
The value in DroppedDown is maintained when the <var>Style</var> for the control is altered, when <b>CBN_DROPDOWN</b> or <b>CBN_CLOSEUP</b> control messages are handled, and when key down events are handled which change the visibility of the drop-down list.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.KeyDown"/>
</seealso>
</element>
<element name="TCustomComboBox.DroppingDown">
<short>Deprecated.</short>
<descr>Deprecated. Will be removed in Lazarus 2.2.</descr>
<seealso/>
</element>
<element name="TCustomComboBox.SelectAll">
<short>Selects the text content in the edit box for the control.</short>
<descr>
<p>
<var>SelectAll</var> is a procedure used to select/highlight the <var>Text</var> displayed in the edit box for the control. SelectAll requires a <var>Style</var> that uses an edit box in the control. No actions are performed in the method when Style does not include an enabled edit box.
</p>
<p>
SelectAll sets the value in <var>SelStart</var> to <b>0</b> (zero) to move the selection to the beginning of the edit box, and sets <var>SelLength</var> to the number of UTF-8-encoded characters in Text. No selection/highlighting is performed when Text contains an empty string (<b>''</b>).
</p>
<p>
SelectAll is called from methods like <var>DoEnter</var>, <var>KeyUp</var>, <var>CloseUp</var>, and <var>MouseUp</var>.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.Text"/>
<link id="TCustomComboBox.SelStart"/>
<link id="TCustomComboBox.SelLength"/>
<link id="TCustomComboBox.SelText"/>
<link id="TCustomComboBox.DoEnter"/>
<link id="TCustomComboBox.KeyUp"/>
<link id="TCustomComboBox.CloseUp"/>
<link id="TCustomComboBox.MouseUp"/>
</seealso>
</element>
<element name="TCustomComboBox.AutoComplete">
<short>Positions the list box using partial text matching.</short>
<descr>
<p>
<var>AutoComplete</var> is a <var>Boolean</var> property which indicates if partial text matching is used to locate values in the Items displayed for the control. When set to <b>True</b>, keystrokes entered in the edit box for the control are used to locate a value in Items which begins with the entered value. The <var>ItemIndex</var> property is updated with the ordinal position for the matching item, or -1 if an entry is not found that starts with the partial value.
</p>
<p>
Reading the value in AutoComplete causes the <var>AutoCompleteText</var> property to be examined, and returns <b>True</b> when the value <var>cbactEnabled</var> is included in the auto-complete options. Assigning a value to AutoComplete causes the AutoCompleteText property to include or exclude the corresponding value as needed.
</p>
<p>
Use AutoCompleteText to enable or disable other auto-complete features and behaviors in the control.
</p>
<p>
Auto-completion related tasks are performed when the <var>KeyUp</var> method handles valid keystrokes for the control.
</p>
<p>
Use <var>AutoSelect</var> to control whether text is automatically highlighted in the edit box when a new list item is selected in the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.AutoCompleteText"/>
<link id="TCustomComboBox.AutoSelect"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.KeyUp"/>
</seealso>
</element>
<element name="TCustomComboBox.AutoCompleteText">
<short>Options for the behavior of the Auto-Complete feature.</short>
<descr>
<dl>
<dt>Enabled</dt>
<dd> Enable Auto-Completion features.</dd>
<dt>EndOfLineComplete</dt>
<dd>Perform Auto-Complete only when cursor is at the end of the string.</dd>
<dt>RetainPrefixCase</dt>
<dd>
Retains the case of characters user has typed. This option has no effect if cbactEndOfLineComplete is <b>False</b>.
</dd>
<dt>SearchCaseSensitive</dt>
<dd>Search completion string with case sensitivity.</dd>
<dt>SearchAscending</dt>
<dd>
Search completion string in ascending order. <b>False</b> will search in descending order.
</dd>
</dl>
<p>
This property exists as a <var>Set</var> of <var>Options</var>, so zero or more options may be operational.
</p>
</descr>
<seealso>
<link id="TComboBoxAutoCompleteTextOption"/>
</seealso>
</element>
<element name="TCustomComboBox.AutoDropDown">
<short>Makes the drop-down list appear as soon as the user starts entering text.</short>
<descr>
<p>
<var>AutoDropDown</var> is a <var>Boolean</var> property which indicates if the drop-down list for the control is automatically displayed. When set to <b>False</b>, the drop-down list appears when the down button is clicked, or the Alt+Down key sequence is entered. The value in AutoDropDown is maintained, based on the <var>Style</var> for the control, when <var>KeyDown</var> is called to handle key events.
</p>
<p>
Use <var>DroppedDown</var> to show or hide the list box for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.KeyDown"/>
<link id="TCustomComboBox.DroppedDown"/>
</seealso>
</element>
<element name="TCustomComboBox.AutoSelect">
<short>Selects the entire content of the edit box when the control receives the focus.</short>
<descr>
<p>
When <b>True</b>, the edit control will select all its text when:
</p>
<ul>
<li>It receives focus</li>
<li>The Enter key is pressed.</li>
<li>A new item is selected.</li>
</ul>
</descr>
<seealso>
<link id="TCustomComboBox.AutoSelected"/>
</seealso>
</element>
<element name="TCustomComboBox.AutoSelected">
<short>True indicates that the selection was marked automatically by the control.</short>
<descr>
<p>
<b>True</b> indicates that the combo-box control has just performed an <var>AutoSelect</var> operation so that subsequent mouse-clicks and keystrokes proceed normally without selecting the text.
</p>
<p>
<b>False</b> is set when the combo-box control loses focus.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.AutoSelect"/>
</seealso>
</element>
<element name="TCustomComboBox.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TCustomComboBox.ArrowKeysTraverseList">
<short>
Indicates if keyboard Arrow (or cursor) keys can be used to move through the list.
</short>
<descr>
<p>
<var>ArrowKeysTraverseList</var> indicates if Arrow (or Cursor) keys on the keyboard can be used to navigate the <var>Items</var> displayed in the drop-down list box for the control. The default value for the property is <b>True</b>.
</p>
<p>
The value in the property is passed to the widgetset class when the LCL interface object is created. Changing the value for the property causes the widgetset class to be notified using its <var>SetArrowKeysTraverseList</var> method.
</p>
<p>
The property value is used in the implementation of the <var>KeyDown</var> method, and may be updated as the drop-down list for the control is displayed or hidden. For some widgetsets (Darwin), the arrow keys cannot be handled in the LCL and the keyboard message(s) are ignored.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.KeyDown"/>
</seealso>
</element>
<element name="TCustomComboBox.Canvas">
<short>Provides access to the drawing surface for the control.</short>
<descr>
<p>
<var>Canvas</var> is a read-only <var>TCanvas</var> property which provides access to the drawing surface used for the control. The class implementation actually uses a <var>TControlCanvas</var> instance in the member.
</p>
<p>
Canvas is used in methods like <var>DrawItem</var>, and in private methods which handle the <b>LM_DrawListItem</b> message for the control. Canvas is also passed as an argument to methods in the ancestor class like <var>PaintTo</var>. Canvas can be useful in <var>OnDrawItem</var> event handler when used to render list items for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.DrawItem"/>
<link id="TCustomComboBox.OnDrawItem"/>
<link id="#lcl.controls.TWinControl.PaintTo">TWinControl.PaintTo</link>
<link id="#lcl.graphics.TCanvas">TCanvas</link>
<link id="#lcl.controls.TControlCanvas">TControlCanvas</link>
</seealso>
</element>
<element name="TCustomComboBox.DropDownCount">
<short>The maximum number of Items visible in the drop-down list for the control.</short>
<descr>
<p>
<var>DropDownCount</var> is an <var>Integer</var> property which specifies the maximum number of values from <var>Items</var> that can be displayed in the drop-down list for the control. Setting a new value for the property causes the widgetset class to be notified using its <var>SetDropDownCount</var> method when a handle has been allocated for the control.
</p>
<p>
DropDownCount is used (along with the item count and <var>ItemHeight</var>) in the <var>AdjustDropDown</var> method to set the minimum dimensions for the drop-down list.
</p>
<p>
The default value for the property is <b>8</b>.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.ItemHeight"/>
<link id="TCustomComboBox.GetItemCount"/>
<link id="TCustomComboBox.AdjustDropDown"/>
</seealso>
</element>
<element name="TCustomComboBox.EmulatedTextHintStatus">
<short>Status for the emulated TextHint in the control.</short>
<descr>
<p>
<var>EmulatedTextHintStatus</var> is a read-only <var>TEmulatedTextHintStatus</var> property which contains the status value for an emulated TextHint display in the control. EmulatedTextHintStatus is used when a value has been assigned to the <var>TextHint</var> property and the widgetset does not natively implement the capability. The LCL emulates the TextHint display by assigning the value in TextHint to the <var>Text</var> for the control.
</p>
<p>
EmulatedTextHintStatus is updated in the private <var>ShowEmulatedTextHint</var> and <var>HideEmulatedTextHint</var> methods.
</p>
</descr>
<seealso>
<link id="TEmulatedTextHintStatus"/>
<link id="TCustomComboBox.TextHint"/>
<link id="TCustomComboBox.Text"/>
</seealso>
</element>
<element name="TCustomComboBox.Items">
<short>The list of items displayed in the combo-box control.</short>
<descr>
<p>
<var>Items</var> is a <var>TStrings</var> property which contains the strings displayed in the static or drop-down list for the control. Settings a new TStrings value for the property causes the Assign method to be called to load the string values into the current class instance.
</p>
<p>
As an alternative, use the <var>OnGetItems</var> event handler to dynamically populate the values in Items when the drop-down list for the control is displayed (or created).
</p>
<p>
String values in Items can be ordered alphabetically by setting the <var>Sorted</var> property to <b>True</b>. This also affects the ordinal position for new values added to Items. Its index will be the position in the sorted order, and not necessarily at the end of the list.
</p>
<p>
Use ItemIndex to determine the ordinal position in Items with the value displayed the edit box for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.Sorted"/>
<link id="TCustomComboBox.OnGetItems"/>
<link id="TCustomComboBox.Text"/>
<link id="#rtl.classes.TStrings">TStrings</link>
</seealso>
</element>
<element name="TCustomComboBox.ItemIndex">
<short>The index of the currently selected item, or -1 if none is selected.</short>
<descr>
<p>
<var>ItemIndex</var> is an <var>Integer</var> property which contains the ordinal position in <var>Items</var> for the current list box selection in the control. The first value in Items is at index position <b>0</b> (<b>zero</b>). The final value in Items is at the index position <var>ItemCount</var><b>-1</b>. When no value is selected in the list box, ItemIndex is set to <b>-1</b>. The default value for the property is <b>-1</b>.
</p>
<p>
When the value for the property is read, the widgetset class is queried when a handle has been assigned for the control.
</p>
<p>
Assigning a new value to the property causes the value in <var>Text</var> to be updated to reflect the new selection in the control. When ItemIndex is <b>-1</b>, Text is set to an empty string ('').
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.AddItem"/>
<link id="TCustomComboBox.Text"/>
<link id="TCustomComboBox.AddHistoryItem"/>
</seealso>
</element>
<element name="TCustomComboBox.ReadOnly">
<short>Disallows free-form entry of Text into the combo-box edit field.</short>
<descr>
<p>
When <b>True</b>, the text can be changed only by selecting an item from the combo-box items list. When <b>False</b>, the text can be changed by free-form entry of a value in the edit field.
</p>
<p>
Changing the property value doesn't affect the style for the control in any manner. Changing the style doesn't affect the value in the property, as well. For some styles (such as csDropDownList) the property might have no effect because it is ignored.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Text"/>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.AutoComplete"/>
</seealso>
</element>
<element name="TCustomComboBox.SelLength">
<short>The number of selected UTF-8 characters in the edit box.</short>
<descr>
<p>
<var>SelLength</var> is an <var>Integer</var> property which indicates the number of UTF-8-encoded characters selected in the edit box for the control. SelLength is used along with <var>SelStart</var> to determine the value in <var>SelText</var>.
</p>
<p>
Use SelStart to determine the position in Text for the selected value in the edit box for the control.
</p>
<p>
Use SelText to get the content selected in the edit box. Assigning a new value to SelText causes the value in SelLength to be updated.
</p>
<p>
SelLength is updated in the <var>SelectAll</var> method after the selection text is updated. It is also updated when <var>KeyUp</var> performs auto-completion for alphanumeric values entered in the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.SelStart"/>
<link id="TCustomComboBox.SelText"/>
<link id="TCustomComboBox.Text"/>
<link id="TCustomComboBox.SelectAll"/>
<link id="TCustomComboBox.KeyUp"/>
<link id="TCustomComboBox.AutoComplete"/>
<link id="TCustomComboBox.AutoCompleteText"/>
</seealso>
</element>
<element name="TCustomComboBox.SelStart">
<short>
<b>zero-based</b> index to the UTF-8 character at the beginning of the selected text in the edit box.
</short>
<descr>
<p>
If text is selected in the edit box for the control, this is the starting position. When no text is selected, SelStart is the cursor position and SelLength is 0 (zero).
</p>
<p>
Writing a new value to the property moves the cursor, and removes the current text selection. Set SelLength after changing SelStart, to establish a new text selection.
</p>
<p>
SelStart is a <b>zero-based</b> index to UTF-8 character in the Text, in contrast to the usual <b>1-based</b> string indices. The value 0 means the first UTF-8 character, the value 1 means the second UTF-8 character, etc.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.SelLength"/>
<link id="TCustomComboBox.SelText"/>
</seealso>
</element>
<element name="TCustomComboBox.SelText">
<short>The selected text in the edit box for the control.</short>
<descr>
<p>
<var>SelText</var> is a <var>String</var> property which contains the selected text in the edit box for the control. The property value is determined by the values in <var>SelStart</var> and <var>SelLength</var>. Assign a new string value to replace the selected text within the <var>Text</var> for the control.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.SelStart"/>
<link id="TCustomComboBox.SelLength"/>
<link id="TCustomComboBox.Text"/>
</seealso>
</element>
<element name="TCustomComboBox.Style">
<short>Appearance and behavior of the combo-box.</short>
<descr>
<p>
Style is quite Windows centric, reflecting the evolution of combo-box styles. The basic styles are:
</p>
<dl>
<dt>csSimple</dt>
<dd>Displays an edit box with an attached list (not a drop-down list).</dd>
<dt>csDropDown</dt>
<dd>Displays an edit box with a drop-down list.</dd>
<dt>csDropDownList</dt>
<dd>
Values cannot be entered by the user in the edit box, only selected from the drop-down list.
</dd>
</dl>
<p>
Owner-drawn drop-down lists have been added, with the values:
</p>
<dl>
<dt>csOwnerDrawFixed</dt>
<dd>All items in the drop-down list are drawn with the same height.</dd>
<dt>csOwnerDrawVariable</dt>
<dd>Each item in the list can have a different height.</dd>
</dl>
</descr>
</element>
<element name="TCustomComboBox.TabStop">
<short>Enables or disables navigation using the Tab key.</short>
<descr>
<p>
Allows the user to navigate to this control, by pressing the Tab key. The default value for the property is True in TCustomComboBox.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.TabStop">TWinControl.TabStop</link>
</seealso>
</element>
<element name="TCustomComboBox.Text">
<short>The value in the edit box for the control.</short>
<descr>
<p>
<var>Text</var> is a public property in <var>TCustomComboBox</var> and contains the <var>TCaption</var> value for the control. It is the value displayed in the edit box for the control.
</p>
<p>
Setting a new value for Text in program code causes the <var>RealSetText</var> method to be called. The new property value is located in the <var>Items</var> property, and the value in <var>ItemIndex</var> is updated with the ordinal position for the found value. A case-insensitive comparison is used to locate the value in Items. The value applied to Text retains the original case used in the new property value. ItemIndex is set to <b>-1</b> if a value is not located in Items that is a case-insensitive match the new property value.
</p>
<p>
At run-time, the value in Text can be updated using the edit box for the control when it is enabled for the selected <var>Style</var> (such as <var>csDropDown</var> and <var>csSimple</var>). When Style contains <var>csDropDownList</var>, the edit box is not displayed. But the button for the drop-down list handles the first character key pressed, and locates a value in Items when the button has focus.
</p>
<p>
<var>AutoComplete</var> enables or disables auto-completion for the value in Text. When set to <b>True</b>, the first item that matches the entered character(s) is located in Items and the value is highlighted in the drop-down list for the control. By default, a case-insensitive comparison is used to find the entered value. Case sensitivity can be enabled using <var>cbactSearchCaseSensitive</var> in the <var>AutoCompleteText</var> options, and requires the value in Items to be an exact case-sensitive match for the character(s) entered in the edit box. Text is updated to contain the complete value for the entry in Items. By default, the case for the value in Items is retained and applied to Text. Include <var>cbactRetainPrefixCase</var> in AutoCompleteText options to use the value as entered in the edit box in the Text property.
</p>
<p>
When the edit box loses input focus, ItemIndex is updated with the ordinal position in Items where the partial value was found. It is set to <b>-1</b> when a matching value could not be located in Items.
</p>
<p>
When AutoComplete is disabled (set to <b>False</b>), the entered value is still located located and highlighted in the drop-down list for Items. However, the value in Text is not expanded and the the value in ItemIndex is not updated. The item must be selected using the drop-down list to apply the value to Text and update the value in ItemIndex.
</p>
<p>
Use ItemIndex to select one of the Items by its ordinal position, and apply the value to the Text property.
</p>
</descr>
<notes>
<note>
A test application was used to verify the described functionality on the Windows platform. It has been attached to Issue #39413 to allow testing for other platforms / widgetsets.
</note>
</notes>
<seealso>
<link id="TCustomComboBox.Style"/>
<link id="TCustomComboBox.AutoComplete"/>
<link id="TCustomComboBox.AutoCompleteText"/>
<link id="TCustomComboBox.Items"/>
<link id="TCustomComboBox.ItemIndex"/>
<link id="TCustomComboBox.ReadOnly"/>
<link id="TComboBoxAutoCompleteText"/>
<link id="TComboBoxAutoCompleteTextOption"/>
</seealso>
</element>
<element name="TCustomComboBox.TextHint">
<short>Default hint text shown when the Text property is empty and the control is not focused.</short>
<descr>
<p>
<var>TextHint</var> is a <var>TTranslateString</var> property which contains the inline hint text displayed for the control. TextHint is displayed in the editable area for the control when <var>Text</var> is an empty string (<b>''</b>) and the control is not focused. As a TTranslateString value, it can be translated using the LCL localization mechanism when enabled for the project.
</p>
</descr>
<seealso>
<link id="TCustomComboBox.Text"/>
</seealso>
</element>
<element name="TComboBox">
<short>
A combination of an edit box and a (drop-down) list allowing one of several options to be chosen.
</short>
<descr>
<p>
The Text property reflects the text entered into the edit box, or selected from the list.
</p>
<p>
The selectable values are kept in the <var>Items</var> list. Clicking on the ellipsis character (<b>...</b>), next to <var>Items</var> in the Object Inspector, opens an editor which allows the designer to populate the Items list.
</p>
<p>
At run-time, the entry selected from the list replaces the text in the edit box, and <var>ItemIndex</var> holds the (zero-based) index number of the selected item.
</p>
<p>
If no value is selected from the drop-down list, the default text (if any) remains, or any information typed directly into <var>Text</var> will be returned, and <var>ItemIndex</var> takes the value of -1.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="TComboBox.Items"/>
<link id="TComboBox.ItemIndex"/>
</seealso>
</element>
<element name="TComboBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TComboBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TComboBox.ArrowKeysTraverseList" link="#lcl.stdctrls.TCustomComboBox.ArrowKeysTraverseList"/>
<element name="TComboBox.AutoComplete" link="#lcl.stdctrls.TCustomComboBox.AutoComplete"/>
<element name="TComboBox.AutoCompleteText" link="#lcl.stdctrls.TCustomComboBox.AutoCompleteText"/>
<element name="TComboBox.AutoDropDown" link="#lcl.stdctrls.TCustomComboBox.AutoDropDown"/>
<element name="TComboBox.AutoSelect" link="#lcl.stdctrls.TCustomComboBox.AutoSelect"/>
<element name="TComboBox.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TComboBox.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TComboBox.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TComboBox.BorderStyle" link="#lcl.controls.TWinControl.BorderStyle"/>
<element name="TComboBox.CharCase" link="#lcl.stdctrls.TCustomComboBox.CharCase"/>
<element name="TComboBox.Color" link="#lcl.controls.TControl.Color"/>
<element name="TComboBox.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TComboBox.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TComboBox.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TComboBox.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TComboBox.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TComboBox.DropDownCount" link="#lcl.stdctrls.TCustomComboBox.DropDownCount"/>
<element name="TComboBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TComboBox.Font" link="#lcl.controls.TControl.Font"/>
<element name="TComboBox.ItemHeight" link="#lcl.stdctrls.TCustomComboBox.ItemHeight"/>
<element name="TComboBox.ItemIndex" link="#lcl.stdctrls.TCustomComboBox.ItemIndex"/>
<element name="TComboBox.Items" link="#lcl.stdctrls.TCustomComboBox.Items"/>
<element name="TComboBox.ItemWidth" link="#lcl.stdctrls.TCustomComboBox.ItemWidth"/>
<element name="TComboBox.MaxLength" link="#lcl.stdctrls.TCustomComboBox.MaxLength"/>
<element name="TComboBox.OnChange" link="#lcl.stdctrls.TCustomComboBox.OnChange"/>
<element name="TComboBox.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TComboBox.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TComboBox.OnCloseUp" link="#lcl.stdctrls.TCustomComboBox.OnCloseUp"/>
<element name="TComboBox.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TComboBox.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TComboBox.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TComboBox.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TComboBox.OnDrawItem" link="#lcl.stdctrls.TCustomComboBox.OnDrawItem"/>
<element name="TComboBox.OnDropDown" link="#lcl.stdctrls.TCustomComboBox.OnDropDown"/>
<element name="TComboBox.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TComboBox.OnEditingDone" link="#lcl.controls.TControl.OnEditingDone"/>
<element name="TComboBox.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TComboBox.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TComboBox.OnGetItems" link="#lcl.stdctrls.TCustomComboBox.OnGetItems"/>
<element name="TComboBox.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TComboBox.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TComboBox.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TComboBox.OnMeasureItem" link="#lcl.stdctrls.TCustomComboBox.OnMeasureItem"/>
<element name="TComboBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TComboBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TComboBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TComboBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TComboBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TComboBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TComboBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TComboBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TComboBox.OnSelect" link="#lcl.stdctrls.TCustomComboBox.OnSelect"/>
<element name="TComboBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TComboBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TComboBox.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TComboBox.ParentColor" link="#lcl.stdctrls.TCustomComboBox.ParentColor"/>
<element name="TComboBox.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TComboBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TComboBox.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TComboBox.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TComboBox.ReadOnly" link="#lcl.stdctrls.TCustomComboBox.ReadOnly"/>
<element name="TComboBox.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TComboBox.Sorted" link="#lcl.stdctrls.TCustomComboBox.Sorted"/>
<element name="TComboBox.Style" link="#lcl.stdctrls.TCustomComboBox.Style"/>
<element name="TComboBox.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TComboBox.TabStop" link="#lcl.stdctrls.TCustomComboBox.TabStop"/>
<element name="TComboBox.Text" link="#lcl.stdctrls.TCustomComboBox.Text"/>
<element name="TComboBox.TextHint" link="#lcl.stdctrls.TCustomComboBox.TextHint"/>
<element name="TComboBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TListBoxStyle">
<short>Determines how items are drawn in a list box control.</short>
<descr>
<p>
<var>TListBoxStyle</var> is an enumerated type with values that determine how items in the list box control are populated and drawn. TListBoxStyle is the type used to implement the <var>Style</var> property in <var>TCustomListBox</var>.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Style"/>
</seealso>
</element>
<element name="TListBoxStyle.lbStandard">
<short>Items drawn by the widgetset class.</short>
</element>
<element name="TListBoxStyle.lbOwnerDrawFixed">
<short>Items drawn by user code, and all items have the same height.</short>
</element>
<element name="TListBoxStyle.lbOwnerDrawVariable">
<short>Items drawn by user code, and each item can have a different height.</short>
</element>
<element name="TListBoxStyle.lbVirtual">
<short>Not used in the current LCL version.</short>
</element>
<element name="TSelectionChangeEvent">
<short>Specifies an event handler for change notifications from a list box control.</short>
<descr>
<p>
<var>TSelectionChangeEvent</var> is an object procedure type which specifies an event handler signalled when the select is changed in a list box control. Arguments passed to the handler identify the list box control, and the origin of the change notification.
</p>
<p>
TSelectionChangeEvent is the type used to implement the <var>OnSelectionChange</var> property in <var>TCustomListBox</var>. The application must implement and assign an object procedure using the signature for the handler to respond to the event notification.
</p>
</descr>
<seealso/>
</element>
<element name="TSelectionChangeEvent.Sender">
<short>The list box control for the notification.</short>
</element>
<element name="TSelectionChangeEvent.User">
<short>True if the user changed the selection, False if changed by code.</short>
</element>
<element name="TListBoxOption">
<short>Represents options available in a list box control.</short>
<descr/>
<seealso>
<link id="TListBoxOptions"/>
</seealso>
</element>
<element name="TListBoxOption.lboDrawFocusRect">
<short>Draws a focus rectangle when owner draw is enabled.</short>
</element>
<element name="TListBoxOptions">
<short>Set type used to store values from the TListBoxOption enumeration.</short>
<descr>
<p>
Set type used to store zero or more values for the <var>TListBoxOption</var> enumeration. <var>TListBoxOptions</var> is the type used for the <var>Options</var> property in <var>TCustomListBox</var>.
</p>
</descr>
<seealso>
<link id="TListBoxOption"/>
<link id="TCustomListBox.Options"/>
</seealso>
</element>
<element name="TCustomListBox">
<short>The base class for <var>TListBox</var>.</short>
<descr>
<p>
<var>TCustomListBox</var> is a <var>TWinControl</var> descendant which specifies the base class used for a list box control. A list box displays a scrollable list which allows selection of one or more of the item values.
</p>
<p>
TCustomListBox provides methods, properties, and events used to display, order, and select item values. The Items for the control can be assigned at design-time in the Lazarus IDE, or stored at run-time. Owner-drawn styles are available to render icons or bitmaps along with the text for the items, or using a variable height for list items. A Canvas property is provided for owner-drawn usage. Items in the list box can be display in one or more columns.
</p>
<p>
Do not create instances of TCustomListBox; use the <var>TListBox</var> descendant.
</p>
</descr>
<seealso>
<link id="TListBox"/>
<link id="#lcl.controls.TWinControl">TWinControl</link>
</seealso>
</element>
<element name="TCustomListBox.FCacheValid"/>
<element name="TCustomListBox.FCanvas"/>
<element name="TCustomListBox.FClickOnSelChange" link="#lcl.stdctrls.TCustomListBox.ClickOnSelChange"/>
<element name="TCustomListBox.FClickTriggeredBySelectionChange"/>
<element name="TCustomListBox.FColumns" link="#lcl.stdctrls.TCustomListBox.Columns"/>
<element name="TCustomListBox.FExtendedSelect" link="#lcl.stdctrls.TCustomListBox.ExtendedSelect"/>
<element name="TCustomListBox.FIntegralHeight" link="#lcl.stdctrls.TCustomListBox.IntegralHeight"/>
<element name="TCustomListBox.FItemHeight" link="#lcl.stdctrls.TCustomListBox.ItemHeight"/>
<element name="TCustomListBox.FItemIndex" link="#lcl.stdctrls.TCustomListBox.ItemIndex"/>
<element name="TCustomListBox.FItems" link="#lcl.stdctrls.TCustomListBox.Items"/>
<element name="TCustomListBox.FLockSelectionChange"/>
<element name="TCustomListBox.FMultiSelect" link="#lcl.stdctrls.TCustomListBox.MultiSelect"/>
<element name="TCustomListBox.FOnDrawItem" link="#lcl.stdctrls.TCustomListBox.OnDrawItem"/>
<element name="TCustomListBox.FOnMeasureItem" link="#lcl.stdctrls.TCustomListBox.OnMeasureItem"/>
<element name="TCustomListBox.FOnSelectionChange" link="#lcl.stdctrls.TCustomListBox.OnSelectionChange"/>
<element name="TCustomListBox.FScrollWidth" link="#lcl.stdctrls.TCustomListBox.ScrollWidth"/>
<element name="TCustomListBox.FSorted" link="#lcl.stdctrls.TCustomListBox.Sorted"/>
<element name="TCustomListBox.FStyle" link="#lcl.stdctrls.TCustomListBox.Style"/>
<element name="TCustomListBox.FTopIndex" link="#lcl.stdctrls.TCustomListBox.TopIndex"/>
<element name="TCustomListBox.GetCount" link="#lcl.stdctrls.TCustomListBox.Count"/>
<element name="TCustomListBox.GetCount.Result">
<short>Value for the Count property.</short>
</element>
<element name="TCustomListBox.GetScrollWidth" link="#lcl.stdctrls.TCustomListBox.ScrollWidth"/>
<element name="TCustomListBox.GetScrollWidth.Result">
<short>Value for the ScrollWidth property.</short>
</element>
<element name="TCustomListBox.GetTopIndex" link="#lcl.stdctrls.TCustomListBox.TopIndex"/>
<element name="TCustomListBox.GetTopIndex.Result">
<short>Value for the TopIndex property.</short>
</element>
<element name="TCustomListBox.RaiseIndexOutOfBounds">
<short>
Raises an exception if an invalid index position is used to access Items in the list box control.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.RaiseIndexOutOfBounds.AIndex">
<short>Index position generating the exception.</short>
</element>
<element name="TCustomListBox.SetColumns" link="#lcl.stdctrls.TCustomListBox.Columns"/>
<element name="TCustomListBox.SetColumns.AValue">
<short>New value for the Columns property.</short>
</element>
<element name="TCustomListBox.SetScrollWidth" link="#lcl.stdctrls.TCustomListBox.ScrollWidth"/>
<element name="TCustomListBox.SetScrollWidth.AValue">
<short>New value for the ScrollWidth property.</short>
</element>
<element name="TCustomListBox.SetTopIndex" link="#lcl.stdctrls.TCustomListBox.TopIndex"/>
<element name="TCustomListBox.SetTopIndex.AValue">
<short>New value for the TopIndex property.</short>
</element>
<element name="TCustomListBox.UpdateSelectionMode">
<short>Sends values for ExtendedSelect and MultiSelect to the widgetset class.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.UpdateSorted">
<short>Sends values in Items and Sorted to the widgetset class.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.LMDrawListItem">
<short>Handles the LM_DrawListItem message for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.LMDrawListItem.TheMessage">
<short>Message handled in the method.</short>
</element>
<element name="TCustomListBox.LMMeasureItem">
<short>Handles the LM_MeasureItem message for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.LMMeasureItem.TheMessage">
<short>Message handled in the method.</short>
</element>
<element name="TCustomListBox.LMSelChange">
<short>Handles the LM_SelChange message for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.LMSelChange.TheMessage">
<short>Message handled in the method.</short>
</element>
<element name="TCustomListBox.WMLButtonUp">
<short>
Handles Left mouse button Up events for the control.
</short>
<descr>
Prevents Click from being called twice when using ClickOnSelChange to trigger a click event.
</descr>
<seealso>
<link id="#lcl.controls.TControl.WMLButtonUp">TControl.WMLButtonUp</link>
</seealso>
</element>
<element name="TCustomListBox.WMLButtonUp.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomListBox.SendItemSelected">
<short>Notifies the widgetset class when the selected item in the control is changed.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.SendItemSelected.Index">
<short>Ordinal position for the item.</short>
</element>
<element name="TCustomListBox.SendItemSelected.IsSelected">
<short>True when the item is selected; False when it is not selected.</short>
</element>
<element name="TCustomListBox.ClearSelectedCache">
<short>Resets cached item selections for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.SetSelectedCache">
<short>Sets the cached selection state for the specified item.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.SetSelectedCache.Index">
<short>Ordinal position in Items to update in the cache.</short>
</element>
<element name="TCustomListBox.SetSelectedCache.IsSelected">
<short>Selection state for the cached item.</short>
</element>
<element name="TCustomListBox.GetSelectedCache">
<short>Gets the selection state for the specified item from the cache.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.GetSelectedCache.Result">
<short>True when the item is selected in the cache.</short>
</element>
<element name="TCustomListBox.GetSelectedCache.Index">
<short>Ordinal position in Items for the cached item.</short>
</element>
<element name="TCustomListBox.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomListBox.AssignItemDataToCache">
<short>Copies selected state for an item to the cache.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.AssignItemDataToCache.AIndex">
<short>Ordinal position in Items for the entry updated in the cache.</short>
</element>
<element name="TCustomListBox.AssignItemDataToCache.AData">
<short>Pointer to the data stored in the cache for the specified item.</short>
</element>
<element name="TCustomListBox.AssignCacheToItemData">
<short>Sends the cached selection state to the widget.</short>
<descr>Called to restore the ItemData after a handle is created.</descr>
<seealso/>
</element>
<element name="TCustomListBox.AssignCacheToItemData.AIndex">
<short>Ordinal position for the item data read from the cache.</short>
</element>
<element name="TCustomListBox.AssignCacheToItemData.AData">
<short>Pointer to the data read from the cache for the specified item.</short>
</element>
<element name="TCustomListBox.BeforeDragStart">
<short>
Notifies the widgetset class that a Drag operation is starting.
</short>
<descr>
<p>
<var>BeforeDragStart</var> is an overridden method in <var>TCustomListBox</var> used to perform actions needed to start a drag operation for the control. In TCustomListBox, this means that the DragStart method in the widgetset class is called. No actions are performed in the method if the Handle has not been allocated for the control.
</p>
<p>
BeforeDragStart is called when mouse up, down, and move messages are handled by the DragManager for an application.
</p>
</descr>
<seealso>
<link id="TControl.BeforeDragStart"/>
</seealso>
</element>
<element name="TCustomListBox.BeginAutoDrag">
<short>
Starts a non-immediate drag / dock operation for the control.
</short>
<descr>
<p>
Calls the inherited <var>BeginDrag</var> method with the <var>Immediate</var> argument set to <b>False</b>. The drag operation is detected and handled by the DragManager for the application.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.BeginAutoDrag">TControl.BeginAutoDrag</link>
</seealso>
</element>
<element name="TCustomListBox.CalculateStandardItemHeight">
<short>
Determines the standard Height of the items, when the widget has yet been created.
</short>
<descr>
<p>
<var>CalculateStandardItemHeight</var> is an <var>Integer</var> function used to get the standard height for items in the control. CalculateStandardItemHeight is used in descendent classes, like <var>TCustomCheckListBox</var>, when its Style property is set to <var>lbStandard</var> and the Handle for the control (and its Canvas) has not been allocated.
</p>
<p>
CalculateStandardItemHeight gets the height for items using a temporary TBitmap instance.
The Font for the control is assigned to the Canvas in the the bitmap instance, and its TextHeight method is called to get the return value.
</p>
<p>
CalculateStandardItemHeight is called from the MeasureItem and FontChanged methods in the TCustomCheckListBox descendent.
</p>
</descr>
<seealso>
<link id="#lcl.checklst.TCustomCheckListBox.MeasureItem">TCustomCheckListBox.MeasureItem</link>
<link id="#lcl.checklst.TCustomCheckListBox.FontChanged">TCustomCheckListBox.FontChanged</link>
</seealso>
</element>
<element name="TCustomListBox.CalculateStandardItemHeight.Result">
<short>Height for the items in the control.</short>
</element>
<element name="TCustomListBox.CreateParams">
<short>
Initializes the creation parameters for the class instance.
</short>
<descr>
<p>
<var>CreateParams</var> is an overridden method used initialize the creation parameters for the class instance.
</p>
<p>
CreateParams calls the inherited method, and ensures that the <var>Params</var> argument is updated to include style constants needed for properties in the list box control. These include the constants needed for the <var>Sorted</var>, <var>MultiSelect</var>, and <var>Columns</var> properties. Owner-drawn constants are also included based on the value in <var>Style</var>. Style constants are always included for scrollbars (horizontal and vertical), non-integral item height, string content, and notify events.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Sorted"/>
<link id="TCustomListBox.MultiSelect"/>
<link id="TCustomListBox.Columns"/>
<link id="TCustomListBox.Style"/>
<link id="#lcl.controls.TWinControl.CreateParams">TWinControl.CreateParams</link>
</seealso>
</element>
<element name="TCustomListBox.CreateParams.Params">
<short>The creation parameters and flags for the instance.</short>
</element>
<element name="TCustomListBox.InitializeWnd">
<short>
Updates Items from the widgetset class and invalidates the item cache.
</short>
<descr>
<p>
<var>InitializeWnd</var> is an overridden method used to synchronize the control and the widgetset class. InitializeWnd copies values for the <var>Items</var> property from the ones allocated in the widgetset class. The value in <var>ItemIndex</var> is passed to the widgetset class when needed. An internal flag is reset to invalidate the item cache for the control, and the item data from the widgetset class is applied. Finally, the value in <var>ScrollWidth</var> is passed to the widgetset class.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Sorted"/>
<link id="TCustomListBox.ItemIndex"/>
<link id="TCustomListBox.ScrollWidth"/>
<link id="#lcl.controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
</seealso>
</element>
<element name="TCustomListBox.DestroyWnd">
<short>Frees the handle for the window and its canvas.</short>
<descr>
<p>
Calls the inherited method to free the window handle and update flags for the control. Frees the handle for the <var>Canvas</var> when assigned.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Canvas"/>
<link id="#lcl.controls.TWinControl.DestroyWnd">TWinControl.DestroyWnd</link>
</seealso>
</element>
<element name="TCustomListBox.FinalizeWnd">
<short>Caches the Items stored in the widgetset class.</short>
<descr>
<p>
<var>FinalizeWnd</var> is an overridden method used to capture values from the widgetset class when the handle is destroyed or re-created. FinalizeWnd gets the value for <var>ItemIndex</var> when the handle is being re-created. Values in <var>Items</var> (and its cached item data) are copied before they are freed in the widgetset class. The value in <var>Sorted</var> is re-applied to the new values in Items.
</p>
<p>
FinalizeWnd calls the inherited method prior to exit.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Sorted"/>
<link id="#lcl.controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
</seealso>
</element>
<element name="TCustomListBox.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomListBox.GetControlClassDefaultSize.Result">
<short>Default dimensions for a new instance of the class.</short>
</element>
<element name="TCustomListBox.CheckIndex">
<short>Ensures that the Item index is within the bounds for the Items in the control.</short>
<descr>
<p>
<var>CheckIndex</var> is a procedure used to ensure that the specified index value is within the range of values allowed for the Items in the control. CheckIndex examines the value in <var>AIndex</var>, and raises an <var>IndexOutOfBounds</var> exception if it is not in the range 0 (zero) to Items.Count-1.
</p>
<p>
CheckIndex is used in the access specifiers for the <var>Selected</var> property (GetSelected, SetSelected).
</p>
</descr>
<errors>
Raises an <var>IndexOutOfBounds</var> exception when the index is out of bounds.
</errors>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.GetSelected"/>
<link id="TCustomListBox.SetSelected"/>
</seealso>
</element>
<element name="TCustomListBox.CheckIndex.AIndex">
<short>Index position examined in the method.</short>
</element>
<element name="TCustomListBox.GetItemHeight">
<short>Gets the value for the ItemHeight property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.ItemHeight"/>
</seealso>
</element>
<element name="TCustomListBox.GetItemHeight.Result">
<short>Value for the ItemHeight property.</short>
</element>
<element name="TCustomListBox.GetItemIndex">
<short>Gets the value for the ItemIndex property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.ItemIndex"/>
</seealso>
</element>
<element name="TCustomListBox.GetItemIndex.Result">
<short>Value for the ItemIndex property.</short>
</element>
<element name="TCustomListBox.GetSelCount">
<short>Gets the value for the SelCount property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.SelCount"/>
</seealso>
</element>
<element name="TCustomListBox.GetSelCount.Result">
<short>Value for the SelCount property.</short>
</element>
<element name="TCustomListBox.GetSelected">
<short>Gets the value for the Selected property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.Selected"/>
</seealso>
</element>
<element name="TCustomListBox.GetSelected.Result">
<short>Value for the Selected property.</short>
</element>
<element name="TCustomListBox.GetSelected.Index">
<short>Ordinal position for the item retrun as the property value.</short>
</element>
<element name="TCustomListBox.GetCachedDataSize">
<short>Returns the size for cached item data in the control.</short>
<descr>
<p>
Passed as an argument when creating the <var>TExtendedStringList</var> instance used in the Items property.
</p>
</descr>
<seealso>
<link id="#lazutils.extendedstrings.TExtendedStringList">TExtendedStringList</link>
</seealso>
</element>
<element name="TCustomListBox.GetCachedDataSize.Result">
<short>Number f bytes required for the item data in the cache.</short>
</element>
<element name="TCustomListBox.GetCachedData">
<short>Returns a pointer to the cached item data.</short>
<descr>
<p>
Gets a pointer to the item data for the specified list box item. The return value contains the attributes stored in Items at the position in AIndex. Items is cast to a TExtendedStringList instance to access its indexed Records property.
</p>
</descr>
<errors>
Raises an InvalidOperation exception when the cache is marked as invalid, i. e. when the widgetset class has already been created.
</errors>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="#lazutils.extendedstrings.TExtendedStringList.Records">TExtendedStringList.Records</link>
</seealso>
</element>
<element name="TCustomListBox.GetCachedData.Result">
<short>Pointer to the item data in the cache.</short>
</element>
<element name="TCustomListBox.GetCachedData.AIndex">
<short>Ordinal position in Items for the values retrieved in the method.</short>
</element>
<element name="TCustomListBox.SetExtendedSelect">
<short>Sets the value for the ExtendedSelect property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.ExtendedSelect"/>
</seealso>
</element>
<element name="TCustomListBox.SetExtendedSelect.Val">
<short>New value for the ExtendedSelect property.</short>
</element>
<element name="TCustomListBox.SetItemIndex">
<short>Sets the value for the ItemIndex property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.ItemIndex"/>
</seealso>
</element>
<element name="TCustomListBox.SetItemIndex.AIndex">
<short>New value for the ItemIndex property.</short>
</element>
<element name="TCustomListBox.SetItems">
<short>Sets the value for the Items property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.Items"/>
</seealso>
</element>
<element name="TCustomListBox.SetItems.Value">
<short>New value for the Items property.</short>
</element>
<element name="TCustomListBox.SetItemHeight">
<short>Sets the value for the ItemHeight property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.ItemHeight"/>
</seealso>
</element>
<element name="TCustomListBox.SetItemHeight.Value">
<short>New value for the ItemHeight property.</short>
</element>
<element name="TCustomListBox.SetMultiSelect">
<short>Sets the value for the MultiSelect property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.MultiSelect"/>
</seealso>
</element>
<element name="TCustomListBox.SetMultiSelect.Val">
<short>New value for the MultiSelect property.</short>
</element>
<element name="TCustomListBox.SetSelected">
<short>Sets the value for the Selected property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.Selected"/>
</seealso>
</element>
<element name="TCustomListBox.SetSelected.Index">
<short>Ordinal position for the item updated in the method.</short>
</element>
<element name="TCustomListBox.SetSelected.Val">
<short>New value for the Selected property.</short>
</element>
<element name="TCustomListBox.SetSorted">
<short>Sets the value for the Sorted property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.Sorted"/>
</seealso>
</element>
<element name="TCustomListBox.SetSorted.Val">
<short>New value for the Sorted property.</short>
</element>
<element name="TCustomListBox.SetStyle">
<short>Sets the value for the Style property.</short>
<descr/>
<seealso>
<link id="TCustomListBox.Style"/>
</seealso>
</element>
<element name="TCustomListBox.SetStyle.Val">
<short>New value for the Style property.</short>
</element>
<element name="TCustomListBox.DrawItem">
<short>Paints an item in owner-draw mode.</short>
<descr>
<p>
<var>DrawItem</var> is a procedure used to render an item in the list box control using the owner-draw mode.
</p>
<p>
<var>Item</var> contains the ordinal position in Items for the item drawn in the method.
</p>
<p>
<var>ARect</var> is a <var>TRect</var> instance with the canvas coordinates where the drawing operation is performed.
</p>
<p>
<var>State</var> contains the drawing state for the owner-drawn item.
</p>
<p>
DrawItem signals the <var>OnDrawItem</var> event handler (when assigned). An internal default drawing method is used when the event handler has not been implemented.
</p>
<p>
DrawItem is called when the <b>LM_DrawListItem</b> message is handled for the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.OnDrawItem"/>
<link id="TCustomListBox.Canvas"/>
<link id="TDrawItemEvent"/>
</seealso>
</element>
<element name="TCustomListBox.DrawItem.Index">
<short>Ordinal position for the item drawn in the method.</short>
</element>
<element name="TCustomListBox.DrawItem.ARect">
<short>Canvas rectangle with the coordinate for the drawing operation.</short>
</element>
<element name="TCustomListBox.DrawItem.State">
<short>Drawing state for the item.</short>
</element>
<element name="TCustomListBox.DoAutoAdjustLayout">
<short>
Performs actions needed to auto-adjust the control using the specified layout policy.
</short>
<descr>
<p>
<var>DoAutoAdjustLayout</var> is an overridden method used to apply an auto-adjust layout policy to the control. DoAutoAdjustLayout calls the inherited method on entry.
</p>
<p>
DoAutoAdjustLayout ensures that the item height for the control is scaled using the factor in <var>AYProportion</var> when <var>AMode</var> contains the <var>lapAutoAdjustWithoutHorizontalScrolling</var> or <var>lapAutoAdjustForDPI</var> layout adjustment policy values.
</p>
<p>
DoAutoAdjustLayout is called from the <var>AutoAdjustLayout</var> method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.DoAutoAdjustLayout">TControl.DoAutoAdjustLayout</link>
</seealso>
</element>
<element name="TCustomListBox.DoAutoAdjustLayout.AMode">
<short>Layout adjustment policy applied in the method.</short>
</element>
<element name="TCustomListBox.DoAutoAdjustLayout.AXProportion">
<short>Factor used to scale horizontal dimensions.</short>
</element>
<element name="TCustomListBox.DoAutoAdjustLayout.AYProportion">
<short>Factor used to scale vertical dimensions.</short>
</element>
<element name="TCustomListBox.DoSelectionChange">
<short>Signals the OnSelectionChange handler.</short>
<descr>
<p>
<var>DoSelectionChange</var> performs actions needed when the selected item in the list box control has been changed. DoSelectionChange signals the <var>OnSelectionChange</var> event handler (when assigned).
</p>
<p>
<var>User</var> indicates if the selection was changed as a result of user interaction with the control, as opposed to a change performed in code at run-time. When User is set to <b>True</b>, and <var>ClickOnSelChange</var> is enabled, an internal flag is set to prevent execution of the method by a subsequent mouse click.
</p>
<p>
DoSelectionChange is called when the <b>LM_SelChange</b> message is handled for the control, and when a new value is assigned to the <var>ItemIndex</var> property. User is set to <b>False</b> when the selection change is caused by setting a new value in ItemIndex.
</p>
</descr>
<seealso>
<link id="TCustomListBox.OnSelectionChange"/>
<link id="TCustomListBox.ItemIndex"/>
<link id="TCustomListBox.ClickOnSelChange"/>
</seealso>
</element>
<element name="TCustomListBox.DoSelectionChange.User">
<short>True when the selection change results from user interaction with the control.</short>
</element>
<element name="TCustomListBox.SendItemIndex">
<short>Sends the value in ItemIndex to the widgetset class instance.</short>
<descr>
<p>
Called at run-time when a new value is assigned to the <var>ItemIndex</var> property and the <var>Handle</var> is valid for the widgetset class instance. It is called before the <var>OnSelectionChange</var> event handler is signalled.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ItemIndex"/>
<link id="TCustomListBox.OnSelectionChange"/>
</seealso>
</element>
<element name="TCustomListBox.WMGetDlgCode">
<short>Handles Tab, Return, Cursor keys, and Escape characters in control messages.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.WMGetDlgCode.Message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomListBox.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 constructor on entry. Create sets the component style to <b>csListBox</b>, and allocates resources needed for the <var>Items</var> and <var>Canvas</var> properties. Create sets the default values for properties, including:
</p>
<dl>
<dt>BorderStyle</dt>
<dd>Set to bsSingle.</dd>
<dt>ClickOnSelChange</dt>
<dd>Set to <b>True</b>.</dd>
<dt>ItemIndex</dt>
<dd>Set to -1 to indicate no item is selected.</dd>
<dt>ExtendedSelect</dt>
<dd>Set to <b>True</b>.</dd>
<dt>Options</dt>
<dd>Set to DefOptions.</dd>
<dt>Canvas</dt>
<dd>Cast to a TControlCanvas instance for the current class instance.</dd>
<dt>ParentColor</dt>
<dd>Set to <b>False</b>.</dd>
<dt>TabStop</dt>
<dd>Set to <b>True</b>.</dd>
</dl>
<p>
Create calls <var>SetInitialBounds</var> to assign the dimensions from the <var>GetControlClassDefaultSize</var> method.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Canvas"/>
<link id="#lcl.controls.TWinControl.Create">TWinControl.Create</link>
</seealso>
</element>
<element name="TCustomListBox.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomListBox.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>Items</var> and <var>Canvas</var> properties. Destroy calls the inherited destructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Create"/>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Canvas"/>
</seealso>
</element>
<element name="TCustomListBox.AddItem">
<short>Adds an item to the list.</short>
<descr>
<p>
<var>AddItem</var> is a method used to add a string (and an optional associated object) to the <var>Items</var> for the control. AddItem calls the <var>AddObject</var> method in Items using <var>Item</var> and <var>AnObject</var> as arguments.
</p>
<p>
<var>Item</var> contains the string value added to the Items in the control.
</p>
<p>
<var>AnObject</var> is an optional object instance associated with the item, and contains <b>Nil</b> when an object instance has not been assigned. The object can be retrieved using the <var>Items.Objects</var> property for the <var>ItemIndex</var>, and must be cast to the required class type to access values in the object instance.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
</seealso>
</element>
<element name="TCustomListBox.AddItem.Item">
<short>The item text.</short>
</element>
<element name="TCustomListBox.AddItem.AnObject">
<short>The associated object, or Nil when not used.</short>
</element>
<element name="TCustomListBox.Click">
<short>Performs the Changed method when the control is clicked.</short>
<descr>
<p>
<var>Click</var> is an overridden method in <var>TCustomListBox</var>, and calls the inherited method on entry. Click calls the <var>Changed</var> method (inherited from <var>TControl</var>) to perform the <b>CM_CHANGED</b> control message. Click is used in the implementation of the <var>DoSelectionChange</var> method when the control is changed by a user interaction.
</p>
</descr>
<seealso>
<link id="TCustomListBox.DoSelectionChange"/>
<link id="#lcl.controls.TControl.Changed">TControl.Changed</link>
<link id="#lcl.controls.TControl.Click">TControl.Click</link>
</seealso>
</element>
<element name="TCustomListBox.Clear">
<short>Removes all items from the list box control.</short>
<descr>
<p>
<var>Clear</var> is a procedure used to remove all values stored in the <var>Items</var> property. Clear calls the Clear method in Items, and sets the value in <var>ItemIndex</var> to <b>-1</b> to indicate that no item is selected in the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.ItemIndex"/>
<link id="#lazutils.extendedstrings.TExtendedStringList.Clear">TExtendedStringList.Clear</link>
<link id="#rtl.classes.TStrings.Clear">TStrings.Clear</link>
</seealso>
</element>
<element name="TCustomListBox.ClearSelection">
<short>Unselects all items in the control.</short>
<descr>
<p>
<var>ClearSelection</var> is a procedure used to clear one or more selected items in the control. When <var>MultiSelect</var> is enabled, values in the <var>Selected</var> property are reset to <b>False</b>. Otherwise, the <var>ItemIndex</var> property is set to <b>-1</b> to indicate that no item is selected in the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.ItemIndex"/>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.SelectRange"/>
</seealso>
</element>
<element name="TCustomListBox.GetIndexAtXY">
<short>Gets the index for the item at the given client coordinates.</short>
<descr>
<p>
<var>GetIndexAtXY</var> is an <var>Integer</var> function used to get the ordinal position in <var>Items</var> for the list item at the specified coordinates. No actions are performed in the method if a handle has not been allocated for the control (the widgetset class instance). GetIndexAtXY calls the <var>GetIndexAtXY</var> method in the widgetset class to get the return value.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TCustomListBox.GetIndexAtXY.Result">
<short>The item index, -1 if an item could not be found.</short>
</element>
<element name="TCustomListBox.GetIndexAtXY.X">
<short>The X client coordinate.</short>
</element>
<element name="TCustomListBox.GetIndexAtXY.Y">
<short>The Y client coordinate.</short>
</element>
<element name="TCustomListBox.GetIndexAtY">
<short>Gets the index position for the item at the specified vertical coordinate.</short>
<descr>
<p>
Calls GetIndextAtXY to get the return value using the vertical coordinate in Y. The value 1 is used as the horizontal coordinate.
</p>
</descr>
<seealso>
<link id="TCustomListBox.GetIndexAtXY"/>
</seealso>
</element>
<element name="TCustomListBox.GetIndexAtY.Result">
<short>The item index, -1 if no item could be found.</short>
</element>
<element name="TCustomListBox.GetIndexAtY.Y">
<short>The vertical client coordinate.</short>
</element>
<element name="TCustomListBox.GetSelectedText">
<short>Get the text for all selected items as a string value.</short>
<descr>
<p>
<var>GetSelectedText</var> is a <var>String</var> function used to retrieve a string with all selected items in the control. The return values uses each selected entry in Items separated by the LineEnding character sequence for the platform or operating system. The return value is an empty string ('') when <var>ItemIndex</var> does not contain a positive non-zero value (no item is selected) or <var>SelCount</var> contain 0 (zero).
</p>
<p>
GetSelectedText iterates over the values in Items, and includes the string when its <var>Selected</var> property is set to <b>True</b>. This is useful when <var>MultiSelect</var> is enabled for the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.MultiSelect"/>
<link id="TCustomListBox.SelCount"/>
</seealso>
</element>
<element name="TCustomListBox.GetSelectedText.Result">
<short>The item strings, one per line.</short>
</element>
<element name="TCustomListBox.ItemAtPos">
<short>Get the item index for the given client coordinates.</short>
<descr>
<p>
<var>ItemAtPos</var> is an <var>Integer</var> function used to get the index position in Items for the value at the specified screen coordinates.
</p>
<p>
<var>Pos</var> is <var>TPoint</var> instance with the X and Y coordinates used in the method.
</p>
<p>
<var>Existing</var> indicates whether the return value is set to -1 or the number of entries in <var>Items</var> when Pos refers to entry which does not exist. When Existing is set to <b>True</b>, -1 is returned for an invalid entry. Otherwise, the value in <var>Item.Count</var> is returned.
</p>
<p>
ItemAtPos calls <var>GetIndexAtXY</var> using the X and Y values in Pos to locate the index for the item.
</p>
</descr>
<seealso>
<link id="TCustomListBox.GetIndexAtXY"/>
</seealso>
</element>
<element name="TCustomListBox.ItemAtPos.Result">
<short>The calculated item index, can be out of the Items bounds.</short>
</element>
<element name="TCustomListBox.ItemAtPos.Pos">
<short>The item position.</short>
</element>
<element name="TCustomListBox.ItemAtPos.Existing">
<short>True when the index is requested for insertion of a new item.</short>
</element>
<element name="TCustomListBox.ItemRect">
<short>Returns the client rectangle for an item (including scrollbar area).</short>
<descr>
<p>
<var>Index</var> must be in the range 0 to <var>ItemCount</var> to be considered valid. The result is valid also for the next item, that will be added subsequently.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomListBox.ItemRect.Result">
<short>The item area; all zeroes for an invalid item index.</short>
</element>
<element name="TCustomListBox.ItemRect.Index">
<short>The tentative item index.</short>
</element>
<element name="TCustomListBox.ItemVisible">
<short>Returns True if the item is at least partially visible in the scrollable list.</short>
<descr>
<p>
<var>ItemVisible</var> is a <var>Boolean</var> function used to determine if the item at the position in <var>Index</var> is at least partially visible in the list box control. The return value is <b>False</b> for the following conditions:
</p>
<ul>
<li>Index is out of range for the values in Items.</li>
<li>An item rectangle could not be retrieved from the widgetset class.</li>
<li>
The item rectangle is invalid for the control (where Bottom < 0 or Top > ClientHeight).
</li>
</ul>
<p>
Use <var>ItemFullyVisible</var> to determine if the specified list box item is fully visible in the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ItemFullyVisible"/>
</seealso>
</element>
<element name="TCustomListBox.ItemVisible.Result">
<short>True when the specified item is at least partially visible in the control.</short>
</element>
<element name="TCustomListBox.ItemVisible.Index">
<short>Ordinal position for the item examined in the method.</short>
</element>
<element name="TCustomListBox.ItemFullyVisible">
<short>Returns True if the item is fully visible in the scrollable list.</short>
<descr>
<p>
<var>ItemFullyVisible</var> is a <var>Boolean</var> function used to determine the item at the position in <var>Index</var> is fully visible in the list box control. The return value is <b>False</b> under the following conditions:
</p>
<ul>
<li>Index is out of range for the values in Items.</li>
<li>An item rectangle could not be retrieved from the widgetset class.</li>
<li>
The item rectangle is invalid or obscured in the control (where Top < 0 or Bottom > ClientHeight).
</li>
</ul>
<p>
Use <var>ItemVisible</var> to determine if the specified item is at least partially visible in the list box control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ItemVisible"/>
</seealso>
</element>
<element name="TCustomListBox.ItemFullyVisible.Result">
<short>True when the specified item is fully visible in the list box control.</short>
</element>
<element name="TCustomListBox.ItemFullyVisible.Index">
<short>Ordinal position for the item examined in the method.</short>
</element>
<element name="TCustomListBox.LockSelectionChange">
<short>Blocks selection changes during update to the widgetset class.</short>
<descr>
<p>
Increments the internal counter used to track selection change events. Used in the implementation of the <var>AssignCacheToItemData</var>, <var>InitializeWnd</var>, <var>FinalizeWnd</var>, <var>UpdateSelectionMode</var>, <var>UpdateSorted</var>, and <var>SetItems</var> methods.
</p>
<p>
The value is examined when the <b>LM_SelChange</b> message is handled for the control.
</p>
<p>
<var>UnlockSelectionChange</var> is used to decrement the internal counter.
</p>
</descr>
<seealso>
<link id="TCustomListBox.UnlockSelectionChange"/>
</seealso>
</element>
<element name="TCustomListBox.MakeCurrentVisible">
<short>Makes the item at ItemIndex visible, possibly scrolling the list.</short>
<descr>
<p>
<var>MakeCurrentVisible</var> is a procedure used to ensure that the current item selected in the control is also visible. The current selection is the value in Items stored at the position in ItemIndex. No actions are performed in the method when ItemIndex is out of bounds.
</p>
<p>
MakeCurrentVisible calls <var>ItemFullyVisible</var> to determine if the item at <var>ItemIndex</var> is already visible in the scrollable list. No additional actions are needed in the method when the item is already visible. Otherwise, the value in ItemIndex is assigned to the <var>TopIndex</var> property which causes the selected item to scroll to the top of the visible area in the list box.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ItemIndex"/>
<link id="TCustomListBox.ItemFullyVisible"/>
<link id="TCustomListBox.ItemVisible"/>
<link id="TCustomListBox.TopIndex"/>
<link id="TCustomListBox.Items"/>
</seealso>
</element>
<element name="TCustomListBox.MeasureItem">
<short>Gets the height for an item in the list.</short>
<descr>
<p>
<var>MeasureItem</var> is a procedure used to get the height for an item displayed in the list box control.
</p>
<p>
<var>Integer</var> is the ordinal position in <var>Items</var> for the value measured in the method.
</p>
<p>
<var>TheHeight</var> is a variable parameter which contains the calculated height for the text in the item. The value on entry is the text height for the current font calculated using the <var>Canvas</var> for the control. The value returned in TheHeight is assigned to the <var>ItemHeight</var> property when it is a non-zero value.
</p>
<p>
MeasureItems signals the <var>OnMeasureItem</var> event handler (when assigned) using the arguments passed to the method. An application must implement an object procedure to calculate the height for the requested item using the logic required.
</p>
<p>
MeasureItem is called when the <b>LM_MeasureItem</b> message is handled for the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.OnMeasureItem"/>
<link id="TCustomListBox.ItemHeight"/>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Font"/>
<link id="TCustomListBox.Canvas"/>
</seealso>
</element>
<element name="TCustomListBox.MeasureItem.Index">
<short>Ordinal position in Items for the string examined in the method.</short>
</element>
<element name="TCustomListBox.MeasureItem.TheHeight">
<short>The height of the item in pixels, can be changed by the event handler.</short>
</element>
<element name="TCustomListBox.SelectAll">
<short>Selects all items in the list (in ExtendedSelect mode).</short>
<descr>
<p>
<var>SelectAll</var> is a procedure used to mark all of the values defined in the <var>Items</var> property as <var>Selected</var>. No actions are performed in the method when Items is empty (Count is 0). SelectAll calls the <var>SelectRange</var> method to select items at position 0 (zero) through Count-1 (inclusive).
</p>
<p>
Use Selected to change the selection state for an individual item when <var>MultiSelect</var> is enabled. Set <var>ItemIndex</var> to -1 to clear the current selection when MultiSelect is not used.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ExtendedSelect"/>
<link id="TCustomListBox.SelectRange"/>
<link id="TCustomListBox.Count"/>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.MultiSelect"/>
<link id="TCustomListBox.ItemIndex"/>
</seealso>
</element>
<element name="TCustomListBox.SelectRange">
<short>Changes the selection state for a range of Items in the control.</short>
<descr>
<p>
<var>SelectRange</var> is a procedure used to change the selection state for a range of <var>Items</var> in the list box control to the value specified in <var>ASelected</var>.
</p>
<p>
<var>ALow</var> and <var>AHigh</var> contain the ordinal positions in Items affected in the method. ALow must be a positive integer value or zero (<b>0</b>). AHigh must be less than the value in the Count property for Items. When either value is out of range, no actions are performed in the method.
</p>
<p>
When <var>MultiSelect</var> is set to <b>True</b>, the widgetset class is notified of the changes to item selection state and <var>DoSelectionChange</var> is called to trigger the <var>OnSelectionChange</var> event handler (when assigned). No actions are performed in the method when MultiSelect is set to <b>False</b>.
</p>
<p>
SelectRange is similar to the <var>SelectAll</var> method, but limits the affected items to the specified range of values - and only when MultiSelect is enabled.
</p>
<p>
Use <var>SelCount</var> to determine the number of Items selected in the control when MultiSelect is enabled.
</p>
<p>
Use <var>Selected</var> to maintain the selection state for a single entry in the Items property.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.SelectAll"/>
<link id="TCustomListBox.DoSelectionChange"/>
<link id="TCustomListBox.OnSelectionChange"/>
<link id="TCustomListBox.ClickOnSelChange"/>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.SelCount"/>
</seealso>
</element>
<element name="TCustomListBox.SelectRange.ALow">
<short>Ordinal position for the initial item changed in the method.</short>
</element>
<element name="TCustomListBox.SelectRange.AHigh">
<short>Ordinal position for the final item changed in the method.</short>
</element>
<element name="TCustomListBox.SelectRange.ASelected">
<short>True if the items are selected; False when they are unselected.</short>
</element>
<element name="TCustomListBox.DeleteSelected">
<short>Removes one or more selected entries from the Items property.</short>
<descr>
<p>
<var>DeleteSelected</var> is a procedure used to delete one or more entries in the <var>Items</var> property based on their selection state.
</p>
<p>
DeleteSelected uses the value in <var>MultiSelect</var> to determine if multiple values in Items are examined and removed. When MultiSelect is <b>True</b>, the values in Items are visited in reverse order and the Delete method in Items is called if the item is <var>Selected</var>. When MultiSelect is not enabled, the value in the <var>ItemIndex</var> property is used to examine a single entry and remove it when it is Selected.
</p>
<p>
No values are removed from Items when none of the entries in Selected are <b>True</b>.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.MultiSelect"/>
</seealso>
</element>
<element name="TCustomListBox.UnlockSelectionChange">
<short>Removes a previous selection change lock.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TCustomListBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TCustomListBox.BorderStyle">
<short>Line style used for the border on the control.</short>
<descr>
<p>
Indicates the line style drawn as a border around the control. The default value for the property is bsSingle in TCustomListBox.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.BorderStyle">TWinControl.BorderStyle</link>
</seealso>
</element>
<element name="TCustomListBox.Canvas">
<short>Drawing surface where the control is drawn.</short>
<descr>
<p>
<var>Canvas</var> is a read-only <var>TCanvas</var> property with the drawing surface where the control is drawn.
</p>
<p>
Its value is assigned the constructor for the class instance, and uses a <var>TControlCanvas</var> instance to maintain an association between the control and its device context. It is freed when the control is destroyed.
</p>
<p>
Values in the <var>Font</var> and <var>Brush</var> properties are assigned to Canvas, and used to measure and draw the Items for the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.DrawItem"/>
<link id="TCustomListBox.MeasureItem"/>
<link id="#lcl.controls.TWinControl.Brush">TWinControl.Brush</link>
<link id="#lcl.controls.TControl.Font">TControl.Font</link>
<link id="#lcl.controls.TControlCanvas">TControlCanvas</link>
<link id="#lcl.graphics.TCanvas">TCanvas</link>
</seealso>
</element>
<element name="TCustomListBox.ClickOnSelChange">
<short>Allows selection changes to generate a Click event.</short>
<descr>
<p>
Delphi generates an <var>OnClick</var> event when the selection changes. The LCL adds a more specific <var>OnSelectionChange</var> event.
</p>
<p>
Set <var>ClickOnSelChange</var> to <b>False</b> when selection changes should be handled by the OnSelectionChange event, and should not generate an OnClick event. Setting ClickOnSelChange to <b>True</b> gives the Delphi compatible behavior. The default value for the property is <b>True</b>.
</p>
</descr>
<seealso>
<link id="TCustomListBox.OnClick"/>
<link id="TCustomListBox.OnSelectionChange"/>
</seealso>
</element>
<element name="TCustomListBox.Columns">
<short>The number of visible vertical columns displayed in the control.</short>
<descr>
<p>
A list box can have multiple columns, as well as multiple rows. When <var>Columns</var> is greater than 0 (zero), it specifies the number of columns that are visible without horizontal scrolling. i. e. the width of a single column becomes Width/Columns. Setting a new value for Columns causes the widgetset class to be notified when a handle has been allocated for the control.
</p>
</descr>
</element>
<element name="TCustomListBox.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TCustomListBox.Count">
<short>The number of items defined in the scrollable list box.</short>
<descr>
<p>
<var>Count</var> is a read-only <var>Integer</var> property which indicates the number of <var>Items</var> defined in the control. Count is provided for Delphi compatibility, and redirects access to the Count property in Items.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
</seealso>
</element>
<element name="TCustomListBox.ExtendedSelect">
<short>
True when a contiguous range of items can be selected by a Shift+Click. Default is True.
</short>
<descr>
<p>
Normally a click into the list selects one item, and deselects all other items.
</p>
<p>
When <var>MultiSelect</var> is <b>True</b>, the user can select/deselect further items with Ctrl+Click.
</p>
<p>
When <var>ExtendedSelect</var> is also <b>True</b>, the user can Shift-click on an item, to select all items between this and the last selected item.
</p>
</descr>
</element>
<element name="TCustomListBox.Font" link="#lcl.controls.TControl.Font"/>
<element name="TCustomListBox.IntegralHeight">
<short>
Not implemented: shrink the Height of the widget, so that it only shows fully visible rows.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomListBox.ItemHeight">
<short>The default height for an item displayed in the list.</short>
<descr>
<p>
<var>ItemHeight</var> is an <var>Integer</var> property which contains the default height for an item displayed in the list box control. For a list box using the <b>lbStandard</b> <var>Style</var>, the property value is derived using the dimensions in the <var>ItemRect</var> for the item stored at <var>TopIndex</var>. For other styles, the stored property`value is used. Setting a new value for the property causes the <var>RecreateWnd</var> method to be called when a handle has been allocated for the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ItemRect"/>
<link id="TCustomListBox.TopIndex"/>
<link id="TCustomListBox.CalculateStandardItemHeight"/>
</seealso>
</element>
<element name="TCustomListBox.ItemIndex">
<short>Ordinal position for the currently selected item, -1 if none.</short>
<descr>
<p>
<var>ItemIndex</var> is an <var>Integer</var> property which contains the position for the current selection in the control. If <var>MultiSelect</var> is <b>True</b>, ItemIndex represents the selected item which also has focus. Use the <var>Selected</var> property to access individual items when MultiSelect is enabled.
</p>
</descr>
<seealso>
<link id="TCustomListBox"/>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.MultiSelect"/>
<link id="TCustomListBox.ExtendedSelect"/>
</seealso>
</element>
<element name="TCustomListBox.Items">
<short>The list of all items defined in the control.</short>
<descr>
<p>
<var>Items</var> is a <var>TStrings</var> property which contains the string values (and associated objects) displayed in the list box control. Reading allows access to the contents of the list (TStrings compatible). Assign another string list to the property to replace the Items in the control. Internally, Items is cast to a <var>TExtendedStringList</var> type to access the item attribute data for the entries.
</p>
<p>
Use <var>ItemIndex</var> to access the selected item in the list box control. Use the <var>Selected</var> property to select or de-select values in Items when <var>MultiSelect</var> is enabled. Use <var>SelectRange</var> to select a range of Items in the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ItemIndex"/>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.MultiSelect"/>
<link id="TCustomListBox.SelectRange"/>
<link id="#rtl.classes.TStrings">TStrings</link>
</seealso>
</element>
<element name="TCustomListBox.MultiSelect">
<short>Allows selection of more than one item from the list.</short>
<descr>
<p>
<var>MultiSelect</var> is a <var>Boolean</var> property which indicates if multiple values in <var>Items</var> can be selected using the Ctrl+Click mouse button, or by setting values in the indexed <var>Selected</var> property. When set to <b>True</b>, selection state is determined by reading / writing the cached item data for the Selected items in the widgetset class. When set to <b>False</b>, the value in <var>ItemIndex</var> is used to determine the selected item.
</p>
<p>
The default value for the property is <b>False</b>. Setting a new value for the property causes <var>UpdateSelectionMode</var> to be called to notify the widgetset class of the change.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ExtendedSelect"/>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.ItemIndex"/>
<link id="TCustomListBox.MultiSelect"/>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.SelectRange"/>
<link id="TCustomListBox.DeleteSelected"/>
<link id="TCustomListBox.ClearSelection"/>
</seealso>
</element>
<element name="TCustomListBox.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TCustomListBox.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TCustomListBox.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TCustomListBox.OnDrawItem">
<short>Handler for painting of a list item in owner-draw mode.</short>
<descr>
<p>
<var>OnDrawItem</var> is a <var>TDrawItemEvent</var> property with the event handler signalled to render a list item when an owner-drawn method is used in the <var>Style</var> property. OnDrawItem is signalled (when assigned) from the <var>DrawItem</var> method. DrawItem provides the arguments for the event handler.
</p>
<p>
An application should implement an object procedure to respond to the event notification. Use the Canvas for the control to get text metrics or render the control and any graphic images. An internal drawing routine which uses the Font, Color, Layout and Alignment in the control is called when OnDrawItem has not been assigned.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Style"/>
<link id="TCustomListBox.DrawItem"/>
<link id="TCustomListBox.Canvas"/>
<link id="TCustomListBox.Font"/>
<link id="TCustomListBox.Align"/>
<link id="TListBoxStyle"/>
<link id="TDrawItemEvent"/>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
<link id="#lcl.graphics.TCanvas.TextStyle">TCanvas.TextStyle</link>
<link id="#lcl.graphics.TTextStyle">TTextStyle</link>
</seealso>
</element>
<element name="TCustomListBox.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TCustomListBox.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TCustomListBox.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TCustomListBox.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TCustomListBox.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TCustomListBox.OnMeasureItem">
<short>Handler invoked when the height for an item is needed.</short>
<descr>
<p>
<var>OnMeasureItem</var> is a <var>TMeasureItemEvent</var> property with the event handler signalled to get the height for specified item in the list box control. OnMeasureItem is signalled (when assigned) from the <var>MeasureItem</var> method, and occurs when the <b>LM_MeasureItem</b> message is handled for the control. MeasureItem provides the arguments passed to the event handler, while the message handler stores the calculated height in <var>ItemHeight</var> when it is not 0 (zero).
</p>
<p>
An application must implement an object procedure to respond to the event notification. <var>Index</var> contains the position in <var>Items</var> with the string to examine in the event handler. On entry, <var>TheHeight</var> contains the text height for the current <var></var>Font calculated using the <var>Canvas</var> in the control. The value in TheHeight can be updated with the value derived in the event handler.
</p>
</descr>
<seealso>
<link id="TCustomListBox.MeasureItem"/>
<link id="TCustomListBox.ItemHeight"/>
<link id="TCustomListBox.Style"/>
<link id="TCustomListBox.Font"/>
<link id="TCustomListBox.Canvas"/>
<link id="TMeasureItemEvent"/>
</seealso>
</element>
<element name="TCustomListBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TCustomListBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TCustomListBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TCustomListBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TCustomListBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TCustomListBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TCustomListBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TCustomListBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TCustomListBox.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TCustomListBox.OnSelectionChange">
<short>Handler invoked when an item is selected in the control.</short>
<descr>
<p>
<var>OnSelectionChange</var> is a <var>TSelectionChangeEvent</var> property with the event handler signalled when a selection is changed in the list box control. OnSelectionChange is signalled (when assigned) from the <var>DoSelectionChange</var> method, and occurs prior to calling the <var>Click</var> method for the control.
</p>
<p>
The <var>User</var> argument indicates whether the selection change results from user interaction with the control (<b>True</b>), or from code or methods called at run-time (<b>False</b>).
</p>
</descr>
<seealso>
<link id="TCustomListBox.DoSelectionChange"/>
<link id="TCustomListBox.Click"/>
<link id="TCustomListBox.ClickOnSelChange"/>
<link id="TCustomListBox.SelectRange"/>
<link id="TCustomListBox.MultiSelect"/>
</seealso>
</element>
<element name="TCustomListBox.ParentColor">
<short>Use the Color from the Parent control, when enabled.</short>
<descr>
<p>
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TCustomListBox.
</p>
<p>
When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
</seealso>
</element>
<element name="TCustomListBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TCustomListBox.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TCustomListBox.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TCustomListBox.ScrollWidth">
<short>The virtual width of the list box, in pixels.</short>
<descr>
<p>
<var>ScrollWidth</var> is an <var>Integer</var> property with the logical horizontal extent for the list box, or the scrollable area inside the control. When ScrollWidth is set to a value larger than <var>ClientWidth</var>, the horizontal scrollbar is displayed for the control.
</p>
<p>
The value for ScrollWidth is read from the widgetset class (at run-time) when a Handle has been allocated for the control. Changing the value for the property causes the value in the widgetset class to be updated.
</p>
<p>
The default value for the property is <b>0</b> (<b>zero</b>).
</p>
<p>
Use <var>Columns</var> to set the number of adjacent vertical columns used to display the items in the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Columns"/>
</seealso>
</element>
<element name="TCustomListBox.SelCount">
<short>The number of selected items in the list.</short>
<descr>
<p>
<var>SelCount</var> is a read-only <var>Integer</var> property which contains the number of <var>Items</var> selected in the list box control. The return value is the result returned by the <var>GetSelCount</var> method in the widgetset class, or 0 (zero) when a handle has not been allocated for the control. SelCount is significant when the <var>MultiSelect</var> property is enabled.
</p>
<p>
Use <var>Selected</var> to read or write the selected state for a single value defined in the Items for the control.
</p>
<p>
Use <var>SelectRange</var> to set the selected state for Items in a specified range of positions.
</p>
<p>
Use <var>SelectAll</var> to select all Items in the control.
</p>
<p>
Use <var>ClearSelection</var> to remove all item selections in the control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Selected"/>
<link id="TCustomListBox.SelectRange"/>
<link id="TCustomListBox.SelectAll"/>
<link id="TCustomListBox.ClearSelection"/>
<link id="TCustomListBox.MultiSelect"/>
<link id="TCustomListBox.ExtendedSelect"/>
</seealso>
</element>
<element name="TCustomListBox.Selected">
<short>The Selected state for an item in the control.</short>
<descr>
<p>
<var>Selected</var> is an indexed <var>Boolean</var> property used to set the selection state for an item defined in the list box control.
</p>
<p>
The index value is the ordinal position in <var>Items</var> with the selection state value. Read and write access for the property value call the <var>CheckIndex</var> method to verify that the index is in bounds for the defined Items in the control. CheckIndex raises an exception if an index value is not in the required range.
</p>
<p>
Property values are read from the widgetset class when it has been created, or from the cached selection values when it has not. Write access ensures that <var>ItemIndex</var> is updated as needed, and notifies the widgetset class and/or the item selection cache when a value is changed.
</p>
<p>
Use <var>SelectAll</var> to set the selection state for all Items in the control.
</p>
<p>
Use <var>SelectRange</var> to set the selection state for Items in the specified range of positions in the control.
</p>
<p>
Use <var>ClearSelection</var> to reset the selection state for all Items in the list box control.
</p>
</descr>
<seealso>
<link id="TCustomListBox.CheckIndex"/>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.ItemIndex"/>
<link id="TCustomListBox.SelectAll"/>
<link id="TCustomListBox.SelectRange"/>
<link id="TCustomListBox.ClearSelection"/>
</seealso>
</element>
<element name="TCustomListBox.Selected.Index">
<short>Ordinal position in the item list.</short>
</element>
<element name="TCustomListBox.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TCustomListBox.Sorted">
<short>Determines whether the list entries are sorted in alphanumeric order.</short>
<descr>
<p>
<var>Sorted</var> is a <var>Boolean</var> property which determines whether the values in <var>Items</var> are sorted and stored in alphanumeric order in the control.
</p>
<p>
Setting this property to <b>True</b> enables use of ascending alphanumeric case-insensitive sorting of items in the list. When <b>True</b>, new entries are added in sort order, and are not necessarily stored at the end of the list.
</p>
<p>
Setting a new value for the property causes the private <var>UpdateSorted</var> method to be called to notify the widgetset class of the change in order, or to update the <var>Sorted</var> property in <var>Items</var> when needed.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.AddItem"/>
</seealso>
</element>
<element name="TCustomListBox.Style">
<short>Appearance of the list box (standard, owner-draw fixed, or owner-draw variable).</short>
<descr>
<p>
<var>Style</var> is a <var>TListBoxStyle</var> property which controls the appearance of the <var>Items</var> drawn in the list box control. The default value for the property is <var>lbStandard</var>, and causes the appearance and text height native to the widgetset to be used. When another value from TListBoxStyle is used, Items are drawn using the routine assigned to the <var>OnDrawItem</var> event handler.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.ItemHeight"/>
<link id="TCustomListBox.OnDrawItem"/>
<link id="TListBoxStyle"/>
</seealso>
</element>
<element name="TCustomListBox.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TCustomListBox.TabStop">
<short>Enables navigation using the Tab key.</short>
<descr>
<p>
Allows the user to navigate to this control, by pressing the Tab or Shift+Tab keys.
The default value for the property is <b>True</b> in <var>TCustomListBox</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.TabStop"/>
</seealso>
</element>
<element name="TCustomListBox.TopIndex">
<short>Index of the first visible (or top-most) item.</short>
<descr>
<p>
<var>TopIndex</var> is an <var>Integer</var> property which contains the ordinal position in <var>Items</var> for the first visible list item in the scrollable control. The default value for the property is <b>0</b> (the first value in Items).
</p>
<p>
The property value is retrieved from the widgetset class when a handle has been allocated for the control. Setting a new value for the property causes the widgetset class to be notified of the value change when a handle has been allocated for the control.
</p>
<p>
The value in TopIndex is updated in the <var>MakeCurrentVisible</var> method where the current selection in <var>ItemIndex</var> is assigned to the property.
</p>
</descr>
<seealso>
<link id="TCustomListBox.Items"/>
<link id="TCustomListBox.ItemHeight"/>
<link id="TCustomListBox.MakeCurrentVisible"/>
</seealso>
</element>
<element name="TCustomListBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TCustomListBox.Options">
<short>Contains options enabled for the list box control.</short>
<descr>
<p>
<var>Options</var> is a <var>TListBoxOptions</var> property with the options enabled for the list box control. The values in the property are assigned in the <var>Create</var> constructor, and used when the <var>LM_DrawListItem</var> message is handled for the control.
</p>
<p>
The default value for the property is <b>[lboDrawFocusRect]</b>, and draws a focus rectangle for the selected item in the list box.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomListBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TListBox">
<short>Control which displays a scrollable list of strings.</short>
<descr>
<p>
The strings are stored in the <var>Items</var> list.
</p>
<p>
At design time, a click on the ellipsis character (<b>...</b>) next to the <var>Items</var> entry in the Object Inspector opens a string-list editor in which the individual text-strings for the list items can be entered or edited. The editor also allows the entries to be sorted alphabetically in normal or reverse order.
</p>
</descr>
<seealso>
<link id="TComboBox"/>
<link id="HowToUseStdCtrls"/>
</seealso>
</element>
<element name="TListBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TListBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TListBox.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TListBox.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TListBox.BorderStyle" link="#lcl.stdctrls.TCustomListBox.BorderStyle"/>
<element name="TListBox.ClickOnSelChange" link="#lcl.stdctrls.TCustomListBox.ClickOnSelChange"/>
<element name="TListBox.Color" link="#lcl.controls.TControl.Color"/>
<element name="TListBox.Columns" link="#lcl.stdctrls.TCustomListBox.Columns"/>
<element name="TListBox.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TListBox.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TListBox.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TListBox.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TListBox.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TListBox.ExtendedSelect" link="#lcl.stdctrls.TCustomListBox.ExtendedSelect"/>
<element name="TListBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TListBox.Font" link="#lcl.controls.TControl.Font"/>
<element name="TListBox.IntegralHeight" link="#lcl.stdctrls.TCustomListBox.IntegralHeight"/>
<element name="TListBox.Items" link="#lcl.stdctrls.TCustomListBox.Items"/>
<element name="TListBox.ItemHeight">
<short>Get or set the height of a single item in the control.</short>
<descr>
<p>
<var>ItemHeight</var> is an <var>Integer</var> property which contains the height used to render the <var>Items</var> in the control.
</p>
<p>
The property value is used when the drawing <var>Style</var> for the control is set to <var>lbStandard</var>, or when the handle has not been allocated for the control. For other drawing styles, the property value is determined using the item rectangle used for the first visible item in the list or by using the <var>OnMeasureItem</var> event handler.
</p>
<p>
Changing the value for the property causes <var>RecreateWnd</var> to be called to re-create the widgetset handle for the control.
</p>
<p>
The value in ItemHeight may be scaled when <var>AutoAdjustLayout</var> is called using a layout policy that includes auto-adjustment for display density.
</p>
</descr>
<seealso>
<link id="TCustomListBox.ItemHeight"/>
</seealso>
</element>
<element name="TListBox.ItemIndex" link="#lcl.stdctrls.TCustomListBox.ItemIndex"/>
<element name="TListBox.MultiSelect" link="#lcl.stdctrls.TCustomListBox.MultiSelect"/>
<element name="TListBox.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TListBox.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TListBox.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TListBox.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TListBox.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TListBox.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TListBox.OnDrawItem" link="#lcl.stdctrls.TCustomListBox.OnDrawItem"/>
<element name="TListBox.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TListBox.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TListBox.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TListBox.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TListBox.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TListBox.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TListBox.OnMeasureItem" link="#lcl.stdctrls.TCustomListBox.OnMeasureItem"/>
<element name="TListBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TListBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TListBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TListBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TListBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TListBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TListBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TListBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TListBox.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TListBox.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TListBox.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TListBox.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TListBox.OnSelectionChange" link="#lcl.stdctrls.TCustomListBox.OnSelectionChange"/>
<element name="TListBox.OnShowHint" link="#lcl.controls.TControl.OnShowHint"/>
<element name="TListBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TListBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TListBox.Options" link="#lcl.stdctrls.TCustomListBox.Options"/>
<element name="TListBox.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TListBox.ParentColor" link="#lcl.stdctrls.TCustomListBox.ParentColor"/>
<element name="TListBox.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TListBox.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TListBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TListBox.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TListBox.ScrollWidth" link="#lcl.stdctrls.TCustomListBox.ScrollWidth"/>
<element name="TListBox.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TListBox.Sorted" link="#lcl.stdctrls.TCustomListBox.Sorted"/>
<element name="TListBox.Style" link="#lcl.stdctrls.TCustomListBox.Style"/>
<element name="TListBox.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TListBox.TabStop" link="#lcl.stdctrls.TCustomListBox.TabStop"/>
<element name="TListBox.TopIndex" link="#lcl.stdctrls.TCustomListBox.TopIndex"/>
<element name="TListBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TCustomEdit">
<short>The base class for controls presenting editable text.</short>
<descr>
<p>
<var>TCustomEdit</var> is a <var>TWinControl</var> descendant which implements the base class for an edit control presenting a single line of text. TCustomEdit provides properties, methods, and events needed for common editing features in the control, including:
</p>
<ul>
<li>Text</li>
<li>TextHint</li>
<li>Modified</li>
<li>ReadOnly</li>
<li>MaxLength</li>
<li>Clear</li>
<li>NumbersOnly</li>
<li>CharCase</li>
<li>EchoMode</li>
<li>PasswordChar</li>
<li>AutoSelect</li>
<li>SelectAll</li>
<li>SelStart</li>
<li>SelLength</li>
<li>SelText</li>
<li>HideSelection</li>
<li>ClearSelection</li>
<li>CaretPos</li>
<li>CopyToClipboard</li>
<li>CutToClipboard</li>
<li>PasteFromClipboard</li>
<li>Undo</li>
</ul>
<p>
Do not create instances of TCustomEdit in an application; use one of the descendent classes like <var>TEdit</var>, <var>TLabeledEdit</var>, <var>TMaskEdit</var>, or <var>TMemo</var>.
</p>
</descr>
<seealso>
<link id="TEdit"/>
<link id="TMemo"/>
<link id="#lcl.extctrls.TLabeledEdit">TLabeledEdit</link>
<link id="#lcl.maskedit.TMaskEdit">TMaskEdit</link>
<link id="#lcl.controls.TWinControl">TWinControl</link>
</seealso>
</element>
<element name="TCustomEdit.FAlignment" link="#lcl.stdctrls.TCustomEdit.Alignment"/>
<element name="TCustomEdit.FAutoSelect" link="#lcl.stdctrls.TCustomEdit.AutoSelect"/>
<element name="TCustomEdit.FAutoSelected" link="#lcl.stdctrls.TCustomEdit.AutoSelected"/>
<element name="TCustomEdit.FCharCase" link="#lcl.stdctrls.TCustomEdit.CharCase"/>
<element name="TCustomEdit.fCaretPos" link="#lcl.stdctrls.TCustomEdit.CaretPos"/>
<element name="TCustomEdit.FEchoMode" link="#lcl.stdctrls.TCustomEdit.EchoMode"/>
<element name="TCustomEdit.FEmulatedTextHintStatus">
<short>Status for the emulated TextHint for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomEdit.FHideSelection" link="#lcl.stdctrls.TCustomEdit.HideSelection"/>
<element name="TCustomEdit.FMaxLength" link="#lcl.stdctrls.TCustomEdit.MaxLength"/>
<element name="TCustomEdit.FModified" link="#lcl.stdctrls.TCustomEdit.Modified"/>
<element name="TCustomEdit.FOnChangeHandler" link="#lcl.stdctrls.TCustomEdit.AddHandlerOnChange"/>
<element name="TCustomEdit.FPasswordChar" link="#lcl.stdctrls.TCustomEdit.PasswordChar"/>
<element name="TCustomEdit.FReadOnly" link="#lcl.stdctrls.TCustomEdit.ReadOnly"/>
<element name="TCustomEdit.FNumbersOnly" link="#lcl.stdctrls.TCustomEdit.NumbersOnly"/>
<element name="TCustomEdit.FOnChange" link="#lcl.stdctrls.TCustomEdit.OnChange"/>
<element name="TCustomEdit.FSelLength" link="#lcl.stdctrls.TCustomEdit.SelLength"/>
<element name="TCustomEdit.FSelStart" link="#lcl.stdctrls.TCustomEdit.SelStart"/>
<element name="TCustomEdit.FTextChangedByRealSetText" link="#lcl.stdctrls.TCustomEdit.RealSetText"/>
<element name="TCustomEdit.FTextChangedLock" link="#lcl.stdctrls.TCustomEdit.TextChanged"/>
<element name="TCustomEdit.FTextHint" link="#lcl.stdctrls.TCustomEdit.TextHint"/>
<element name="TCustomEdit.ShowEmulatedTextHintIfYouCan">
<short>Displays an emulated text hint when possible.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomEdit.ShowEmulatedTextHint">
<short>Displays a TextHint using the hint font for the control.</short>
<descr>
<p>
<var>ShowEmulatedTextHint</var> is a method used to display an emulated Text hint using the hint font for the control. Emulated text hints are used for widgetsets that do not natively support the <var>TextHint</var> capability.
</p>
<p>
ShowEmulatedTextHint gets the Hint font for the display by calling <var>CreateEmulatedTextHintFont</var>, and passes the value to the widgetset class. The value in <var>Text</var> is set to the text in the TextHint property. The widgetset class is notified of the property changes, and an internal flag used to track emulated hint display is set to <b>True</b>.
</p>
<p>
The compliment to ShowEmulatedTextHint is <var>HideEmulatedTextHint</var>.
</p>
<p>
ShowEmulatedTextHint is used in the implementation of the private <var>ShowEmulatedTextHintIfYouCan</var> method.
</p>
</descr>
<seealso>
<link id="TCustomEdit.TextHint"/>
<link id="TCustomEdit.HideEmulatedTextHint"/>
<link id="TCustomEdit.Text"/>
<link id="CreateEmulatedTextHintFont"/>
</seealso>
</element>
<element name="TCustomEdit.HideEmulatedTextHint">
<short>
Hides an emulated TextHint display, and restores the Font and PasswordChar in the control.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomEdit.SetAlignment">
<short>Sets the value for the Alignment property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.Alignment"/>
</seealso>
</element>
<element name="TCustomEdit.SetAlignment.AValue">
<short>New value for the Alignment property.</short>
</element>
<element name="TCustomEdit.GetCanUndo">
<short>Gets the value for the CanUndo property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.CanUndo"/>
</seealso>
</element>
<element name="TCustomEdit.GetCanUndo.Result">
<short>Value for the CanUndo property.</short>
</element>
<element name="TCustomEdit.GetModified">
<short>Gets the value for the Modified property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.Modified"/>
</seealso>
</element>
<element name="TCustomEdit.GetModified.Result">
<short>Value for the Modified property.</short>
</element>
<element name="TCustomEdit.SetHideSelection">
<short>Sets the value for the HideSelection property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.HideSelection"/>
</seealso>
</element>
<element name="TCustomEdit.SetHideSelection.AValue">
<short>New value for the HideSelection property.</short>
</element>
<element name="TCustomEdit.SetMaxLength">
<short>Sets the value for the MaxLength property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.MaxLength"/>
</seealso>
</element>
<element name="TCustomEdit.SetMaxLength.Value">
<short>New value for the MaxLength property.</short>
</element>
<element name="TCustomEdit.SetModified">
<short>Sets the value for the Modified property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.Modified"/>
</seealso>
</element>
<element name="TCustomEdit.SetModified.Value">
<short>New value for the Modified property.</short>
</element>
<element name="TCustomEdit.SetPasswordChar">
<short>Sets the value for the PasswordChar property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.PasswordChar"/>
</seealso>
</element>
<element name="TCustomEdit.SetPasswordChar.AValue">
<short>New value for the PasswordChar property.</short>
</element>
<element name="TCustomEdit.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomEdit.CanShowEmulatedTextHint">
<short>Indicates if the value in TextHint can be displayed in the edit control.</short>
<descr>
<p>
<var>CanShowEmulatedTextHint</var> is a <var>Boolean</var> function which indicates if the value in TextHint can be emulated for the edit control. The return value is <b>True</b> when the following conditions are met:
</p>
<ul>
<li>A handle has been allocated for the control.</li>
<li>
The widgetset class does <b>NOT</b> include the lcTextHint LCL capability flag (the lack of native widgetset support for the feature is why it's being emulated).
</li>
<li>
ComponentState indicates that the component is not being loaded using LCL streaming, and is not being edited at design-time.
</li>
<li>TextHint is <b>not</b> an empty string ('').</li>
<li>Text <b>is</b> an empty string ('').</li>
<li>The control is not Focused.</li>
</ul>
<p>
CanShowEmulatedTextHint is used in the <var>WMKillFocus</var> method, and when the values in <var>Text</var> or <var>TextHint</var> are applied for the control.
</p>
<remark>
In the current LCL implementation, TextHint display is emulated for all widgetsets except Win32/Win64 (since ComCtIVersionIE6) and QT5.
</remark>
</descr>
<seealso>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.TextHint"/>
<link id="#lcl.controls.TWinControl.Focused">TWinControl.Focused</link>
<link id="#rtl.classes.TComponent.ComponentState">TComponent.ComponentState</link>
</seealso>
</element>
<element name="TCustomEdit.CanShowEmulatedTextHint.Result">
<short>True when the emulated text hint can be displayed.</short>
</element>
<element name="TCustomEdit.CalculatePreferredSize">
<short>Gets the preferred size for a new instance of the class.</short>
<descr>
<p>
<var>CalculatePreferredSize</var> is overridden in <var>TCustomEdit</var>, and calls the inherited method on entry. CalculatePreferredSize sets the value in the <var>PreferredWidth</var> parameter to <b>0</b> (<b>zero</b>).
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.CalculatePreferredSize">TWinControl.CalculatePreferredSize</link>
</seealso>
</element>
<element name="TCustomEdit.CalculatePreferredSize.PreferredWidth">
<short>Preferred width calculated for the control.</short>
</element>
<element name="TCustomEdit.CalculatePreferredSize.PreferredHeight">
<short>Preferred height calculated for the control.</short>
</element>
<element name="TCustomEdit.CalculatePreferredSize.WithThemeSpace">
<short>True when space is reserved for theme element details.</short>
</element>
<element name="TCustomEdit.CreateParams">
<short>Ensures the required creation parameters are set for handle creation.</short>
<descr>
<p>
<var>CreateParams</var> is an overridden method used to ensure that the creation parameters for the control are updated to reflect property values in the control instance. CreateParams is called when the handle for the control is create (or re-created).
</p>
<p>
CreateParams calls the inherited method on entry, and updates the Style flags in <var>Params</var> to include values required for the control. The following edit style flags are included in the method:
</p>
<dl>
<dt>ES_AUTOHSCROLL</dt>
<dd>Always included in TCustomEdit.</dd>
<dt>ES_LEFT</dt>
<dd>Included when Alignment contains taLeftJustify.</dd>
<dt>ES_RIGHT</dt>
<dd>Included when Alignment contains taRightJustify.</dd>
<dt>ES_CENTER</dt>
<dd>Included when Alignment contains taCenter.</dd>
<dt>ES_READONLY</dt>
<dd>Included when ReadOnly is set to True.</dd>
<dt>ES_NUMBER</dt>
<dd>Included when NumbersOnly is set to True.</dd>
<dt>ES_NOHIDESEL</dt>
<dd>Included when HideSelection is set to False.</dd>
</dl>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.CreateParams">TWinControl.CreateParams</link>
</seealso>
</element>
<element name="TCustomEdit.CreateParams.Params">
<short>Creation parameters updated in the method.</short>
</element>
<element name="TCustomEdit.InitializeWnd">
<short>Initializes the window handle for the control.</short>
<descr>
<p>
<var>InitializeWnd</var> is an overridden method used to ensure that property values from the class instance are stored in the widgetset class when the handle for the control is created (or re-created). InitializeWnd calls the inherited method on entry.
</p>
<p>
Values in the following properties are posted using methods in the widgetset class:
</p>
<ul>
<li>CharCase</li>
<li>EchoMode</li>
<li>MaxLength</li>
<li>PasswordChar</li>
<li>ReadOnly</li>
<li>Alignment</li>
<li>CaretPos</li>
<li>SelStart</li>
<li>SelLength</li>
<li>TextHint</li>
</ul>
<p>
The ShowEmulatedTextHintIfYouCan method is called when inline hints are emulated for the widgetset.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.InitializeWnd">TWinControl.InitializeWnd</link>
</seealso>
</element>
<element name="TCustomEdit.TextChanged">
<short>Applies case conversion (if needed), and updates the editing cursor selection text.</short>
<descr>
<p>
<var>TextChanged</var> is a an overridden method used to perform actions needed when the <b>CM_TEXTCHANGED</b> message is handled for the control. No actions are performed in the method when a previous call to TextChanged has not been completed.
</p>
<p>
TextChanged uses the value in <var>CharCase</var> to determine if case conversion is applied to the value in Text. When CharCase contains <var>ecUpperCase</var> or <var>ecLowerCase</var>, the corresponding UTF-8 conversion routine is called. When Text is modified in the method, the values in <var>CaretPos</var>, <var>SelStart</var>, and <var>SelLength</var> are re-applied to the control. At run-time, the value in <var>Modified</var> is set to <b>True</b> when Text has been changed in the method.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CharCase"/>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.CaretPos"/>
<link id="TCustomEdit.SelStart"/>
<link id="TCustomEdit.SelLength"/>
<link id="TCustomEdit.Modified"/>
<link id="TCustomEdit.RealSetText"/>
<link id="#lazutils.lazutf8.UTF8UpperCase">UTF8UpperCase</link>
<link id="#lazutils.lazutf8.UTF8LowerCase">UTF8LowerCase</link>
<link id="#lcl.controls.TControl.TextChanged">TControl.TextChanged</link>
</seealso>
</element>
<element name="TCustomEdit.FontChanged">
<short>Handles changes to the font used in the control.</short>
<descr>
<p>
<var>FontChanged</var> is an overridden method in <var>TCustomEdit</var>. It ensures that the <var>Font</var> used for an emulated <var>TextHint</var> display is (re-)created when visible by calling <var>CreateEmulatedTextHintFont</var>.
</p>
<p>
FontChanged calls the inherited method to set flags in the control, and to perform notifications of the changed value to any child controls. The hint font is freed when the inherited method is completed.
</p>
<p>
FontChanged is assigned as the <var>OnChange</var> event handler for the <var>TFont</var> class instance in the Font property.
</p>
</descr>
<seealso>
<link id="TCustomEdit.TextHint"/>
<link id="#lcl.controls.TWinControl.FontChanged">TWinControl.FontChanged</link>
<link id="#lcl.controls.TControl.Font">TControl.Font</link>
<link id="CreateEmulatedTextHintFont"/>
</seealso>
</element>
<element name="TCustomEdit.FontChanged.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TCustomEdit.Change">
<short>Performs actions needed when the text in the control is changed.</short>
<descr>
<p>
<var>Change</var> is a procedure used to perform actions need when the <b>CM_CHANGED</b> message is handled in the control. Change calls the inherited <var>Changed</var> method, and signals the <var>OnChange</var> and/or the internal FOnChangeHandler event handlers (when assigned).
</p>
<p>
Change is called from the <var>TextChanged</var> method after case conversion and updates to the editing cursor and text selection.
</p>
</descr>
<seealso>
<link id="TCustomEdit.OnChange"/>
<link id="TCustomEdit.TextChanged"/>
<link id="#lcl.controls.TControl.Changed">TControl.Changed</link>
</seealso>
</element>
<element name="TCustomEdit.DoEnter" >
<short>
Signals the OnEnter event handler, and selects the entire text when AutoSelect is True.
</short>
<descr>
<p>
This special handling is required when the control is entered using keystrokes (keyboard navigation), and not by a mouse click.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.DoEnter">TWinControl.DoEnter</link>
</seealso>
</element>
<element name="TCustomEdit.DoExit">
<short>Clears the value in AutoSelected when the control loses focus.</short>
<descr>
<p>
<var>DoExit</var> is an overridden method in <var>TCustomEdit</var>. It ensures that the AutoSelected property is set to <b>False</b> prior to signalling the OnExit event handler (when assigned) in the ancestor class. DoExit is called when the <b>CM_EXIT</b> control message is handled in the ancestor class.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.DoExit">TWinControl.DoExit</link>
<link id="#lcl.controls.TWinControl.OnExit">TWinControl.OnExit</link>
<link id="#lcl.controls.TWinControl.CMExit">TWinControl.CMExit</link>
</seealso>
</element>
<element name="TCustomEdit.EditingDone">
<short>Enforces the setting in the ReadOnly property when editing is finished in the control.</short>
<descr>
<p>
<var>EditingDone</var> is an overridden method in <var>TCustomEdit</var>. It ensures that the inherited method is <b>NOT</b> called when the value in <var>ReadOnly</var> is <b>True</b>. EditingDone is called from the <var>KeyUpAfterInterface</var> method when the <var>VK_RETURN</var> key code is handled.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.EditingDone">TControl.EditingDone</link>
</seealso>
</element>
<element name="TCustomEdit.GetCaretPos">
<short>Gets the value for the CaretPos property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.CaretPos"/>
</seealso>
</element>
<element name="TCustomEdit.GetCaretPos.Result">
<short>Value for the CaretPos property.</short>
</element>
<element name="TCustomEdit.GetNumbersOnly">
<short>Gets the value for the NumbersOnly property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.NumbersOnly"/>
</seealso>
</element>
<element name="TCustomEdit.GetNumbersOnly.Result">
<short>Value for the NumbersOnly property.</short>
</element>
<element name="TCustomEdit.GetReadOnly">
<short>Gets the value for the ReadOnly property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.ReadOnly"/>
</seealso>
</element>
<element name="TCustomEdit.GetReadOnly.Result">
<short>Value for the ReadOnly property.</short>
</element>
<element name="TCustomEdit.GetSelLength">
<short>Gets the value for the SelLength property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.SelLength"/>
</seealso>
</element>
<element name="TCustomEdit.GetSelLength.Result">
<short>The number of selected UTF-8 characters in the control.</short>
</element>
<element name="TCustomEdit.GetSelStart">
<short>Gets the value for the SelStart property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.SelStart"/>
</seealso>
</element>
<element name="TCustomEdit.GetSelStart.Result">
<short>Value for the SelStart property.</short>
</element>
<element name="TCustomEdit.GetSelText">
<short>Gets the value for the SelText property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.SelText"/>
</seealso>
</element>
<element name="TCustomEdit.GetSelText.Result">
<short>Value for the SelText property.</short>
</element>
<element name="TCustomEdit.GetTextHint">
<short>Gets the value for the TextHint property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.TextHint"/>
</seealso>
</element>
<element name="TCustomEdit.GetTextHint.Result">
<short>Value for the TextHint property.</short>
</element>
<element name="TCustomEdit.SetCaretPos">
<short>Sets the value for the CaretPos property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.CaretPos"/>
</seealso>
</element>
<element name="TCustomEdit.SetCaretPos.Value">
<short>New value for the CaretPos property.</short>
</element>
<element name="TCustomEdit.SetCharCase">
<short>Sets the value for the CharCase property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.CharCase"/>
</seealso>
</element>
<element name="TCustomEdit.SetCharCase.Value">
<short>New value for the CharCase property.</short>
</element>
<element name="TCustomEdit.SetEchoMode">
<short>Sets the value for the EchoMode property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.EchoMode"/>
</seealso>
</element>
<element name="TCustomEdit.SetEchoMode.Val">
<short>New value for the EchoMode property.</short>
</element>
<element name="TCustomEdit.SetNumbersOnly">
<short>Sets the value for the NumbersOnly property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.NumbersOnly"/>
</seealso>
</element>
<element name="TCustomEdit.SetNumbersOnly.Value">
<short>New value for the NumbersOnly property.</short>
</element>
<element name="TCustomEdit.SetReadOnly">
<short>Sets the value for the ReadOnly property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.ReadOnly"/>
</seealso>
</element>
<element name="TCustomEdit.SetReadOnly.Value">
<short>New value for the ReadOnly property.</short>
</element>
<element name="TCustomEdit.SetSelLength">
<short>Sets the value for the SelLength property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.SelLength"/>
</seealso>
</element>
<element name="TCustomEdit.SetSelLength.Val">
<short>New value for the SelLength property.</short>
</element>
<element name="TCustomEdit.SetSelStart">
<short>Sets the value for the SelStart property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.SelStart"/>
</seealso>
</element>
<element name="TCustomEdit.SetSelStart.Val">
<short>New value for the SelStart property.</short>
</element>
<element name="TCustomEdit.SetSelText">
<short>Sets the value for the SelText property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.SelText"/>
</seealso>
</element>
<element name="TCustomEdit.SetSelText.Val">
<short>New value for the SelText property.</short>
</element>
<element name="TCustomEdit.SetTextHint">
<short>Sets the value for the TextHint property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.TextHint"/>
</seealso>
</element>
<element name="TCustomEdit.SetTextHint.AValue">
<short>New value for the TextHint property.</short>
</element>
<element name="TCustomEdit.ChildClassAllowed">
<short>Indicates whether child controls using the specified class are allowed.</short>
<descr>
<p>
<var>ChildClassAllowed</var> is overridden in <var>TCustomEdit</var> to use the widgetset class to determine whether child controls can be embedded within the control. The return value is <b>True</b> when the <var>GetLCLCapability</var> method in the widgetset class returns <var>LCL_CAPABILITY_YES</var> for the lcAllowChildControlsInNativeControls query.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.ChildClassAllowed">TWinControl.ChildClassAllowed</link>
</seealso>
</element>
<element name="TCustomEdit.ChildClassAllowed.Result">
<short>True if a child control using the specified class type are allowed for the control.</short>
</element>
<element name="TCustomEdit.ChildClassAllowed.ChildClass">
<short>Class type for the child control.</short>
</element>
<element name="TCustomEdit.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomEdit.MouseUp">
<short>Handles mouse up events for the control.</short>
<descr>
<p>
Selects all of the Text in the control when a left mouse button event occurs in the focused control and AutoSelect is set to <b>True</b>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.MouseUp">TControl.MouseUp</link>
</seealso>
</element>
<element name="TCustomEdit.MouseUp.Button">
<short>Mouse button examined in the method.</short>
</element>
<element name="TCustomEdit.MouseUp.Shift">
<short>Shift / Ctrl / Alt modifier for the mouse event.</short>
</element>
<element name="TCustomEdit.MouseUp.X">
<short>Horizontal screen coordinate for the mouse event.</short>
</element>
<element name="TCustomEdit.MouseUp.Y">
<short>Vertical screen coordinate for the mouse event.</short>
</element>
<element name="TCustomEdit.RealGetText">
<short>Uses the TextHint display status when getting the value for Text.</short>
<descr>
<p>
<var>RealGetText</var> is an overridden method in <var>TCustomEdit</var>. It ensures that an emulated <var>TextHint</var> display status is considered when getting the value for the <var>Text</var> property. In other words, the inherited method is <b>not</b> called when the TextHint display is visible. The return value is an empty string (<b>''</b>) in this case.
</p>
</descr>
<seealso>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.TextHint"/>
<link id="#lcl.controls.TControl.RealGetText">TControl.RealGetText</link>
</seealso>
</element>
<element name="TCustomEdit.RealGetText.Result">
<short>Value used for the Text property.</short>
</element>
<element name="TCustomEdit.RealSetText">
<short>Updates Modified and the TextHint display when storing the new Text value.</short>
<descr>
<p>
<var>RealSetText</var> is an overridden method in <var>TCustomEdit</var>. It ensures that the value in <var>Modified</var> is updated when a new value in <var>Text</var> is applied to the <var>Caption</var> for the control. It also hides the <var>TextHint</var> display when the new value is not an empty string (<b>''</b>) by calling <var>HideEmulatedTextHint</var>.
</p>
<p>
RealSetText calls the inherited method to store the Text value, and to adjust the control size when needed.
</p>
<p>
The TextHint is re-displayed when it is hidden and <var>CanShowEmulatedTextHint</var> returns <b>True</b>.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CanShowEmulatedTextHint"/>
<link id="TCustomEdit.Modified"/>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.TextHint"/>
<link id="#lcl.controls.TWinControl.RealSetText">TWinControl.RealSetText</link>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
</seealso>
</element>
<element name="TCustomEdit.RealSetText.AValue">
<short>New value stored as the text/caption for the control.</short>
</element>
<element name="TCustomEdit.KeyUpAfterInterface">
<short>Handles Key Up events forwarded from the LCL interface.</short>
<descr>
<p>
<var>KeyUpAfterInterface</var> handles the <var>VK_RETURN</var> key code for the control. It calls <var>EditingDone</var> to signal the <var>OnEditingDone</var> event handler (when assigned). When <var>AutoSelect</var> is set to <b>True</b>, the <var>SelectAll</var> method is called to select all of the <var>Text</var> in the control. <var>AutoSelected</var> is updated to reflect the action.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.KeyUpAfterInterface">TWinControl.KeyUpAfterInterface</link>
</seealso>
</element>
<element name="TCustomEdit.KeyUpAfterInterface.Key">
<short>Virtual key code examined in the method.</short>
</element>
<element name="TCustomEdit.KeyUpAfterInterface.Shift">
<short>Shift, Ctrl, or Alt modifier for the key code.</short>
</element>
<element name="TCustomEdit.WMChar">
<short>Handles a WM_CHAR window message for the control.</short>
<descr>
<p>
Prevents keystrokes for normal characters from acting as accelerator keys. When the Shift state in Message contains ssCtrl or ssAlt, the inherited method is called to handle the WM_CHAR message.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.WMChar">TWinControl.WMChar</link>
</seealso>
</element>
<element name="TCustomEdit.WMChar.Message">
<short>Window message examined in the method.</short>
</element>
<element name="TCustomEdit.CMWantSpecialKey">
<short>Handles the CM_WANTSPECIALKEY message for the control.</short>
<descr>
<p>
For the Darwin platform/widgetset, the LCL must be prevented from handling the arrow (cursor) keys VK_LEFT, VK_RIGHT, VK_UP, and VK_DOWN. The Result in Message is set to 1 to indicate that these keys have already been handled.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomEdit.CMWantSpecialKey.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomEdit.WndProc">
<short>Suppresses the CM_CHANGED control message when an emulated TextHint is visible.</short>
<descr>
<p>
<var>WndProc</var> is an overridden method in <var>TCustomEdit</var>. It ensures that the <b>CM_CHANGED</b> message is suppressed when an emulated <var>TextHint</var> is visible for the control. Otherwise, the inherited method is called to dispatch the control <var>Message</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.WndProc">TWinControl.WndProc</link>
</seealso>
</element>
<element name="TCustomEdit.WndProc.Message">
<short>Message examined and handled for the control.</short>
</element>
<element name="TCustomEdit.ShouldAutoAdjust">
<short>Determines if the control should auto-adjust its Height and/or Width.</short>
<descr>
<p>
<var>ShouldAutoAdjust</var> is an overridden method in <var>TCustomEdit</var> used to determine if the control can auto-adjust its Height and/or Width.
</p>
<p>
<var>AWidth</var> and <var>AHeight</var> are variable Boolean parameters which indicate if the corresponding property can be auto-sized. AWidth is always set to True for TCustomEdit. AHeight is set to the inverse of the value in <var>AutoSize</var>.
</p>
<p>
ShouldAutoAdjust does <b>NOT</b> call the inherited method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.ShouldAutoAdjust">TControl.ShouldAutoAdjust</link>
</seealso>
</element>
<element name="TCustomEdit.ShouldAutoAdjust.AWidth">
<short>True when Width can be auto-adjusted.</short>
</element>
<element name="TCustomEdit.ShouldAutoAdjust.AHeight">
<short>True when Height can be auto-adjusted.</short>
</element>
<element name="TCustomEdit.WMSetFocus">
<short>Handles the LM_SETFOCUS message for the control.</short>
<descr>
<p>
<var>WMSetFocus</var> is an overridden method in <var>TCustomEdit</var>. It is used to hide a visible emulated <var>TextHint</var> display when the control is focused. Calls <var>HideEmulatedTextHint</var> to remove the TextHint display. Calls the inherited method prior to exit.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.WMSetFocus">TWinControl.WMSetFocus</link>
</seealso>
</element>
<element name="TCustomEdit.WMSetFocus.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomEdit.WMKillFocus">
<short>Handles the LM_KILLFOCUS message for the control.</short>
<descr>
<p>
Calls the inherited WMKillFocus method on entry to perform the EditingDone method when the parent form is Active. Ensures that an emulated TextHint is displayed when needed and allowed.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CanShowEmulatedTextHint"/>
<link id="TCustomEdit.TextHint"/>
<link id="TCustomEdit.EditingDone"/>
<link id="#lcl.controls.TWinControl.WMKillFocus">TWinControl.WMKillFocus</link>
</seealso>
</element>
<element name="TCustomEdit.WMKillFocus.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomEdit.AutoSelect">
<short>Enables auto-selection of text when focused.</short>
<descr>
<p>
<var>AutoSelect</var> is a <var>Boolean</var> property which enables or disables auto-selection of text when the control receives focus. If <b>True</b>, the edit control will select all its text when it receives focus or when the Enter key is pressed. The default value for the property is <b>True</b>.
</p>
<p>
AutoSelect is used in the KeyUpAfterInterface method, and determines if the SelectAll method is called when editing is completed in the control. It is used in MouseUp to determine if SelectAll is called when the Left mouse button is clicked. It is also used in DoEnter to determine if SelectAll is called when the Enter key is pressed.
</p>
</descr>
<seealso>
<link id="TCustomEdit.SelectAll"/>
<link id="TCustomEdit.AutoSelected"/>
<link id="TCustomEdit.KeyUpAfterInterface"/>
<link id="TCustomEdit.MouseUp"/>
<link id="TCustomEdit.DoEnter"/>
</seealso>
</element>
<element name="TCustomEdit.AutoSelected">
<short>Set to True when the text selection was made automatically.</short>
<descr>
<p>
<var>AutoSelected</var> is a <var>Boolean</var> property which indicates if the text selection in the control was made automatically after handling key press or mouse events.
</p>
<p>
AutoSelected is used in conjunction with the <var>AutoSelect</var> property which enables the capability. AutoSelected is not set to <b>True</b> when AutoSelect has not been enabled. AutoSelect is enabled by default in <var>TCustomEdit</var>.
</p>
<p>
AutoSelected is updated when the <b>Enter</b> (<b>^M</b>) key is handled for the control, or when a left mouse up event is handled for an already focused control. When AutoSelect is set to <b>True</b>, the <var>SelectAll</var> method is called to select all of the the text in the control. AutoSelected is set to <b>True</b> when <var>SelText</var> has the same value as the <var>Text</var> property.
</p>
<p>
AutoSelected is set to <b>False</b> when focus leaves the control.
</p>
</descr>
<seealso>
<link id="TCustomEdit.AutoSelect"/>
<link id="TCustomEdit.SelectAll"/>
<link id="TCustomEdit.SelText"/>
<link id="TCustomEdit.KeyUpAfterInterface"/>
<link id="TCustomEdit.MouseUp"/>
<link id="TCustomEdit.DoEnter"/>
<link id="TCustomEdit.DoExit"/>
</seealso>
</element>
<element name="TCustomEdit.ParentColor">
<short>Uses the Color from the Parent control, when enabled.</short>
<descr>
<p>
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value is False in TCustomEdit.
</p>
<p>
When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
</p>
<p>
Using ParentColor when the Color value is clDefault can cause problems in resolving the actual color value. To obtain the Color property of a control while taking into account clDefault and ParentColor, use the GetColorResolvingParent method. This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use the GetRGBColorResolvingParent method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
<link id="#lcl.controls.TControl.GetColorResolvingParent">TControl.GetColorResolvingParent</link>
<link id="#lcl.controls.TControl.GetRGBColorResolvingParent">TControl.GetRGBColorResolvingParent</link>
</seealso>
</element>
<element name="TCustomEdit.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 constructor on entry. Create ensures that values in the component and <var>ControlStyle</var> properties are set for the control. ControlStyle excludes the value csCaptureMouse and includes the value csRequiresKeyboardInput.
</p>
<p>
Create sets the default values for properties, including: <var>MaxLength, HideSelection, ParentColor, TabStop, EchoMode, BorderStyle, AutoSelect, AutoSelected,</var> and <var>TextHint</var>.
</p>
</descr>
<seealso>
</seealso></element>
<element name="TCustomEdit.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomEdit.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy ensures that resources allocated for the internal change handler are freed, and calls the inherited destructor prior to exit.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomEdit.Clear">
<short>Deletes all text in the edit box for the control.</short>
<descr>
<p>
<var>Clear</var> is a procedure used to remove the text in the control. Clear sets the value in <var>Text</var> to an empty string (<b>''</b>).
</p>
</descr>
<seealso>
<link id="TCustomEdit.Text"/>
</seealso>
</element>
<element name="TCustomEdit.SelectAll">
<short>Selects the entire text in the edit control.</short>
<descr>
<p>
<var>SelectAll</var> is a procedure used to select all of the text content in the edit box for the control.
</p>
<p>
SelectAll checks the value in <var>Text</var> to ensure that content is available for the selection. No actions are performed in the method when Text is an empty string (<b>''</b>).
</p>
<p>
When Text is not empty, the values in <var>SelStart</var> and <var>SelLength</var> are updated to use the content in Text starting at the first UTF-8-encoded character. UTF8Length is called to get the length for Text, and the value stored in SelLength.
</p>
</descr>
<seealso>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.SelStart"/>
<link id="TCustomEdit.SelLength"/>
<link id="TCustomEdit.SelText"/>
</seealso>
</element>
<element name="TCustomEdit.ClearSelection">
<short>Clears the current text selection in the edit control.</short>
<descr>
<p>
<var>ClearSelection</var> is a procedure used to clear the currently selected text in the edit control. ClearSelection sets the value in <var>SelText</var> to an empty string ('') to discard selected value in the edit control. It does <b>not</b> affect the values in the <var>Text</var> property.
</p>
<p>
No actions are performed in the method when <var>SelLength</var> contains <b>0</b> (<b>zero</b>).
</p>
<p>
Use <var>HideSelection</var> to disable text selection in the edit control.
</p>
</descr>
<seealso>
<link id='TCustomEdit.SelText'/>
<link id='TCustomEdit.SelStart'/>
<link id='TCustomEdit.SelLength'/>
<link id='TCustomEdit.HideSelection'/>
</seealso>
</element>
<element name="TCustomEdit.CopyToClipboard">
<short>Copies the selected text in the control to the clipboard.</short>
<descr>
<p>
<var>CopyToClipboard</var> is a procedure used to copy the selected text in the control to the clipboard. CopyToClipboard is performed for selected text when the <b>Ctrl+C</b> or <b>Ctrl+Insert</b> key combination is handled for the edit control. <b>Meta+C</b> or <b>Meta+Insert</b> is used for macOS. No actions are performed when text is not selected in the control.
</p>
<p>
CopyToClipboard calls the <var>Copy</var> method in the widgetset class when a handle has been allocated for the control.
</p>
<p>
Use <var>CutToClipboard</var> to copy the selected text to the clipboard, and delete it from the text in the edit control.
</p>
<p>
Use <var>PasteFromClipboard</var> to insert the contents of the clipboard into the text for the edit control.
</p>
<p>
Use <var>Undo</var> to revert the last editing action performed in the control.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CutToClipboard"/>
<link id="TCustomEdit.PasteFromClipboard"/>
</seealso>
</element>
<element name="TCustomEdit.CutToClipboard">
<short>Moves the selected text into the clipboard (removes it from the control).</short>
<descr>
<p>
<var>CutToClipboard</var> is a method used to move the current text selection in the control to the clipboard. The selected value is removed from the Text in the control.
</p>
<p>
CutToClipboard is performed when the <b>Ctrl+X</b> or <b>Shift+Delete</b> key combination is handled in the control (macOS uses <b>Meta+X</b> or <b>Shift+Delete</b>). Pressing <b>Shift+Delete</b> when text is not selected (<var>SelLength</var> is 0) causes the the character prior to the editing cursor to be deleted but not copied to the clipboard. No actions are performed if the editing cursor is positioned before the first character in the Text for the control.
</p>
<p>
CutToClipboard calls the <var>Cut</var> method in the widgetset class when its handle has been allocated.
</p>
<p>
Use <var>CopyToClipboard</var> to copy the current text selection in the control to the clipboard.
</p>
<p>
Use <var>PasteFromClipboard</var> to insert the contents of the clipboard at the current position in the edit control.
</p>
<p>
Use <var>Undo</var> to revert the last editing action performed in the control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomEdit.PasteFromClipboard">
<short>Inserts text from the clipboard at the current position in the control.</short>
<descr>
<p>
<var>PasteFromClipboard</var> is a method used to insert the contents of the clipboard at the current position in the edit control. If Text is selected in the control, the SelText is replaced with the clipboard content. When SelLength is 0, the clipboard values are inserted at the position for the editing cursor.
</p>
<p>
PasteFromClipboard is performed when the <b>Ctrl+V</b> or <b>Shift+Insert</b> key combination is handled for the control (macOS uses <b>Meta+V</b> or <b>Shift+Insert</b>).
</p>
<p>
PasteFromClipboard calls the <var>Paste</var> method in the widgetset class when its handle has been allocated.
</p>
<p>
Use <var>CopyToClipboard</var> to copy the current text selection in the control to the clipboard.
</p>
<p>
Use <var>CutToClipboard</var> to copy the selected text to the clipboard, and delete it from the text in the edit control.
</p>
<p>
Use <var>Undo</var> to revert the last editing action performed in the control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomEdit.Undo">
<short>Reverts the last editing action in the control.</short>
<descr>
<p>
<var>Undo</var> is a method used to revert the last editing action performed in the control. Undo is performed when the <b>Ctrl+Z</b> (or <b>Meta+Z</b> on macOS) key combination is handled for the control. Pressing <b>Ctrl+Z</b> causes the value in Text to revert to its value before editing. A subsequent <b>Ctrl+Z</b> key press causes the edited value to be toggled.
</p>
<p>
Undo calls the <var>Undo</var> method in the widgetset class when its handle has been allocated.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomEdit.RemoveAllHandlersOfObject">
<short>Removes all event handlers assigned for the specified object.</short>
<descr>
<p>
<var>RemoveAllHandlersOfObject</var> is an overridden method in TCustomEdit, and calls the inherited method on entry to remove handlers for the specified object.
</p>
<p>
RemoveAllHandlersOfObject uses the internal <var>TMethodList</var> instance (when assigned) and calls its RemoveAllMethodsOfObject method to remove entries where the <var>TMethod</var> data points to the object specified in AnObject.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.RemoveAllHandlersOfObject">TControl.RemoveAllHandlersOfObject</link>
</seealso>
</element>
<element name="TCustomEdit.RemoveAllHandlersOfObject.AnObject">
<short>Object instance to remove for the list of handlers in the control.</short>
</element>
<element name="TCustomEdit.AddHandlerOnChange">
<short>Adds the specified OnChange event handler to the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomEdit.AddHandlerOnChange.AnOnChangeEvent">
<short>Event handler added in the method.</short>
</element>
<element name="TCustomEdit.AddHandlerOnChange.AsFirst">
<short>True if the handler is stored at the top of the method list for the handler type.</short>
</element>
<element name="TCustomEdit.RemoveHandlerOnChange">
<short>Removes the specified OnChange event handler for the list of handlers in the control.</short>
<descr>
<p>
<var>RemoveHandlerOnChange</var> is a method used to remove the event handler specified in <var>AnOnChangeEvent</var> from the list of <var>OnChange</var> handlers for the control. AnOnChangeEvent is a <var>TNotifyEvent</var> instance, and it is used to locate and remove the <var>TMethod</var> entry registered for the handler. RemoveHandlerOnChange reverses the actions performed in <var>AddHandlerOnChange</var>, called when an OnChange event handler is assigned to the control.
</p>
<p>
No actions are performed in the method when the internal OnChange method list has not been assigned (contains <b>Nil</b>).
</p>
</descr>
<seealso>
<link id="#lazutils.lazmethodlist.TMethodList">TMethodList</link>
<link id="#lazutils.lazmethodlist.TMethodList.Remove">TMethodList.Remove</link>
<link id="#rtl.system.TMethod">TMethod</link>
<link id="#rtl.classes.TNotifyEvent">TNotifyEvent</link>
</seealso>
</element>
<element name="TCustomEdit.RemoveHandlerOnChange.AnOnChangeEvent">
<short>Event handler removed from the list of handlers in the control.</short>
</element>
<element name="TCustomEdit.Alignment">
<short>The horizontal alignment for the text in the control (left, right, or centered).</short>
<descr>
<p>
<var>Alignment</var> is a <var>TAlignment</var> property which controls the horizontal alignment of text in the control. The default value for the property is taLeftJustify. See <link id="#rtl.classes.TAlignment">TAlignment</link> for more information about the enumeration values and their meanings.
</p>
<p>
Alignment is used in <var>CreateParams</var> when alignment style flags are added to the creation parameters for the method. The value is also passed to the widgetset class then the handle is created (or re-created) for the class instance. Changing the value in the property causes the widgetset class to be notified when a handle has been allocated for the control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomEdit.AutoSize">
<short>
Allows automatic adjustment of the size for the control, according to its content.
</short>
<descr>
<p>
The action performed depends on the control type. For example, a label or button can become bigger or smaller to accommodate a longer or shorter caption. The default value for the property is True in TCustomEdit. and enables auto-sizing the control instance to its content.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
</seealso>
</element>
<element name="TCustomEdit.BorderStyle">
<short>Indicates the line style drawn as a border around the control.</short>
<descr>
<p>
<var>BorderStyle</var> is a <var>TBorderStyle</var> property with the line style used for borders on the control. The default value for the property is bsSingle in TCustomEdit, and causes the control to be drawn with the client edges style enabled. Use bsNone if borders are not needed for the control.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.BorderStyle">TWinControl.BorderStyle</link>
<link id="#lcl.controls.TBorderStyle">TBorderStyle</link>
</seealso>
</element>
<element name="TCustomEdit.CanUndo">
<short>Indicates whether the last change can be reverted in the control.</short>
<descr>
<p>
<var>CanUndo</var> is a read-only <var>Boolean</var> property which indicates whether the last editing change can be reverted in the control using the Undo method.
</p>
<p>
The property value is <b>False</b> if a handle has not been allocated for the widgetset class. Otherwise, the property value is determined by calling the <var>GetCanUndo</var> method in the widgetset class.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomEdit.CaretPos">
<short>The position of the editing cursor in the control.</short>
<descr>
<p>
CaretPos is a TPoint property which contains the coordinates for the caret (or editing cursor) in the control. The coordinates reflects logical (UTF-8) characters and lines.
</p>
<dl>
<dt>TPoint.X</dt>
<dd>
Contains the zero-based offset into the UTF-8-encoded characters in the control Text. Position 0 is immediately prior to the first UTF-8 character in Text. If there is selected text in the control, the caret is considered to be positioned right <b>after</b> the last selected character. Character positions are independent of the LTR/RTL BiDi-ness for the control.
</dd>
<dt>TPoint.Y</dt>
<dd>
Contains the zero-based relative line number for the editing cursor. For single-line edits the value is normally 0.
</dd>
</dl>
<p>
The value in CaretPos is updated by the widgetset class when key and selection control messages are handled.
</p>
</descr>
</element>
<element name="TCustomEdit.CharCase">
<short>Controls the character case applied to values entered in the control.</short>
<descr>
<p>
CharCase is a TEditCharCase property which indicates how values in Text are converted and displayed in the control.
</p>
<dl>
<dt>ecNormal</dt>
<dd>
Normal letter case is applied; no conversion is applied. Use the Shift key to change the case for a character entered in the control.
</dd>
<dt>ecUpperCase</dt>
<dd>
Values in Text are converted to uppercase letters. Shift key state is ignored.
</dd>
<dt>ecLowerCase</dt>
<dd>
Values in Text are converted to lowercase letters. Shift key state is ignored.
</dd>
</dl>
<p>
The default value for the property is ecNormal. Changing the value for the property causes the existing values in Text to be converted to the case indicated in the new property value.
</p>
<remark>
Conversions apply to the entire value in Text, and <b>cannot</b> be reverted.
</remark>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Text">TControl.Text</link>
<link id="#lcl.stdctrls.TEditCharCase"/>
</seealso>
</element>
<element name="TCustomEdit.EchoMode">
<short>Allows to modify the text display, useful for entering passwords.</short>
<descr>
<p>
The following conversions can be specified:
</p>
<dl>
<dt>emNormal</dt>
<dd>No changes are performed.</dd>
<dt>emNone</dt>
<dd>Spaces are echoed instead for the control value.</dd>
<dt>emPassword</dt>
<dd>The value in PasswordChar is echoed.</dd>
</dl>
<remark>Conversions apply to the entire text, and <b>cannot</b> be reverted.</remark>
</descr>
</element>
<element name="TCustomEdit.EmulatedTextHintStatus">
<short>Status for the emulated TextHint in the control.</short>
<descr>
<p>
<var>EmulatedTextHintStatus</var> is a read-only <var>TEmulatedTextHintStatus</var> property which contains the status value for an emulated TextHint display in the control. EmulatedTextHintStatus is used when a value has been assigned to the <var>TextHint</var> property and the widgetset does not natively implement the capability. The LCL emulates the TextHint display by assigning the value in TextHint to the <var>Text</var> for the control.
</p>
<p>
EmulatedTextHintStatus is updated in the <var>ShowEmulatedTextHint</var> and <var>HideEmulatedTextHint</var> methods.
</p>
</descr>
<seealso>
<link id="TEmulatedTextHintStatus"/>
<link id="TCustomEdit.TextHint"/>
<link id="TCustomEdit.Text"/>
</seealso>
</element>
<element name="TCustomEdit.HideSelection">
<short>Determines if selected text to be hidden when the control does not have focus.</short>
<descr>
<p>
<var>HideSelection</var> is a <var>Boolean</var> property which determines whether the selected text in the control is hidden when the control does not have focus.
</p>
<p>
HideSelection negates the default behavior in the edit control. The default behavior hides the selection when the control loses focus, and displays the text selection when the control receives focus. When set to False, the selected text (if any) is <b>always</b> displayed in the selected state - even when the control loses focus.
</p>
<p>
The default value for the property is <b>True</b>.
</p>
<p>
Changing the value for the property causes the <var>SetHideSelection</var> method in the widgetset class to be called when its handle has been allocated. No actions are performed in the method when the handle has not been allocated for the widgetset class.
</p>
<p>
The value in HideSelection is used in the <var>CreateParams</var> method to determine whether the <var>ES_NOHIDESEL</var> edit style flag is included in or omitted from the creation parameters for the control. When HideSelection is set to <b>False</b>, the ES_NOHIDESEL edit style is included in the flag values.
</p>
<p>
Use SelText, SelStart, and SelLength to change the text selection in program code. Use ClearSelection to remove the current text selection in the edit control.
</p>
</descr>
<seealso>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.SelText"/>
<link id="TCustomEdit.SelStart"/>
<link id="TCustomEdit.SelLength"/>
<link id="TCustomEdit.ClearSelection"/>
<link id="TCustomEdit.CreateParams"/>
</seealso>
</element>
<element name="TCustomEdit.MaxLength">
<short>The maximum length of the value entered in Text, or 0 (zero) for unlimited length.</short>
<descr>
<p>
In Delphi MaxLength only limits user input. The LCL actually restricts the maximum length of the stored text; this simplifies the implementation for non-Win32 widgetsets.
</p>
</descr>
</element>
<element name="TCustomEdit.Modified">
<short>True when the value in Text has been changed.</short>
<descr>
<p>
<var>Modified</var> is a <var>Boolean</var> property which indicates if the value in <var>Text</var> has been changed when a <b>CM_TEXTCHANGED</b> message is handled for the control. The value is set to <b>True</b> in the <var>TextChanged</var> method. The value is reset to <b>False</b> when <var>RealSetText</var> is called to store the value in Text to the buffer for the control.
</p>
</descr>
<seealso>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.TextChanged"/>
<link id="TCustomEdit.RealSetText"/>
</seealso>
</element>
<element name="TCustomEdit.NumbersOnly">
<short>Indicates if the edit control accepts numeric values only.</short>
<descr>
<p>
<var>NumbersOnly</var> is a <var>Boolean</var> property which controls whether the edit control is limited to numeric characters when edited. The default value for the property is <b>False</b>.
</p>
<p>
Changing the property value causes the widgetset class to be notified when a handle has been allocated for the control.
</p>
<p>
NumbersOnly is used in <var>CreateParams</var> to include the <b>ES_NUMBER</b> edit style in the creation parameters for the control when set to <b>True</b>.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CreateParams"/>
</seealso>
</element>
<element name="TCustomEdit.OnChange">
<short>Event handler signalled when the text for the control is changed.</short>
<descr>
<p>
<var>OnChange</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the text for the control is changed.
</p>
<p>
OnChange is triggered when the value in <var>Text</var> is modified either by using the keyboard or assigning a new value in program code. Please note that this differs from controls, like <var>TCustomComboBox</var> / <var>TComboBox</var>, where the event is not signalled when the control value is changed in program code.
</p>
<p>
OnChange is signalled (when assigned) from the <var>Change</var> method, and occurs after the <var>Changed</var> method is used to post the <var>CM_CHANGED</var> control message.
</p>
<p>
When the control value is edited using the keyboard, OnChange is signalled after each character or keystroke is handled and applied to the value in Text. To avoid visible delays during editing, the event handler should not be too time or resource intensive.
</p>
</descr>
<seealso>
<link id="TCustomEdit.Change"/>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.Modified"/>
<link id="#lcl.controls.TControl.Changed">TControl.Changed</link>
</seealso>
</element>
<element name="TCustomEdit.PasswordChar">
<short>Allows obfuscation of the displayed text, showing all characters as PasswordChar.</short>
<descr>
<p>
Typically used in password input, to hide the input from other viewers. The value in <var>Text</var> is still available for the <b>WM_GETTEXT</b> message.
</p>
</descr>
<seealso>
<link id="TCustomEdit.EchoMode"/>
</seealso>
</element>
<element name="TCustomEdit.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TCustomEdit.ReadOnly">
<short>Indicates if the user is prevented from changing the value for the Text in the control.</short>
<descr>
<p>
<var>ReadOnly</var> is a <var>Boolean</var> property which indicates if the user is prevented from changing the value in the control.
</p>
<p>
ReadOnly is used in the <var>CreateParams</var> method to determine if the <b>ES_READONLY</b> edit style flag is included in the creation parameters for the control. The value is also passed to the widgetset class in the <var>InitializeWnd</var> method, and when the value for the property is changed.
</p>
<p>
When ReadOnly is <b>True</b>, the <var>EditingDone</var> method does not signal the <var>OnEditingDone</var> event handler (in the ancestor).
</p>
<p>
The default value for the property is <b>False</b>, and indicates that the value can be edited in the control.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CreateParams"/>
<link id="TCustomEdit.InitializeWnd"/>
<link id="TCustomEdit.EditingDone"/>
<link id="#lcl.controls.TControl.EditingDone">TControl.EditingDone</link>
<link id="#lcl.controls.TControl.OnEditingDone">TControl.OnEditingDone</link>
</seealso>
</element>
<element name="TCustomEdit.SelLength">
<short>The number of currently selected UTF-8-encoded characters in the control.</short>
<descr>
<p>
<var>SelLength</var> is an <var>Integer</var> property which contains the number of UTF-8-encoded characters currently selected in the edit box for the control. The current selection is the value in <var>Text</var> starting at the ordinal position in <var>SelStart</var> and continuing for the number of characters in the property.
</p>
<p>
The value for the property is read from the widgetset class when a handle has been allocated for the control. Otherwise, the internal member is read get the value for the property. Setting a new value for the property notifies the widgetset class when a handle has been allocated for the control.
</p>
<p>
Use <var>SelStart</var> to set the zero-based position in Text for the first UTF-8-encoded character in the current text selection.
</p>
<p>
Use <var>SelText</var> to examine the values selected in the control, or to replace the value in the current text selection. <var>ClearSelection</var> can be used to remove the characters in the current text selection for the control.
</p>
<p>
Use <var>SelectAll</var> to make all values in Text the current text selection in the control.
</p>
<p>
Use <var>HideSelection</var> to un-select the current text selection in the control.
</p>
</descr>
<seealso>
<link id="TCustomEdit.SelText"/>
<link id="TCustomEdit.SelStart"/>
<link id="TCustomEdit.SelectAll"/>
<link id="TCustomEdit.HideSelection"/>
<link id="TCustomEdit.ClearSelection"/>
</seealso>
</element>
<element name="TCustomEdit.SelStart">
<short>The zero-based index for the first UTF-8 character in the current text selection.</short>
<descr>
<p>
<var>SelStart</var> is an <var>Integer</var> property which contains the ordinal position in <var>Text</var> for the UTF-8-encoded character at the start of the current text selection. The current text selection includes the number of characters in <var>SelLength</var>. SelStart is a zero-based value.
</p>
<p>
The value for SelStart is read from the widgetset class when a handle has been allocated for the control. Otherwise, the value is read from the internal member for the property. Setting a new value for the property notifies the widgetset class when a handle has been allocated for the control.
</p>
<p>
Use <var>SelLength</var> for the number of UTF-8-encoded characters in the current text selection.
</p>
<p>
Use <var>SelText</var> to examine the values selected in the control, or to replace the value in the current text selection. <var>ClearSelection</var> can be used to remove the characters in the current text selection for the control.
</p>
<p>
Use <var>SelectAll</var> to make all values in Text the current text selection in the control.
</p>
<p>
Use <var>HideSelection</var> to un-select the current text selection in the control.
</p>
</descr>
<seealso>
<link id="TCustomEdit.SelLength"/>
<link id="TCustomComboBox.SelStart"/>
</seealso>
</element>
<element name="TCustomEdit.SelText">
<short>The currently selected text in the edit box for the control.</short>
<descr>
<p>
<var>SelText</var> is a <var>String</var> property which contains the current text selection in the control. The current text selection is the UTF-8-encoded characters in <var>Text</var> identified by the <var>SelStart</var> and <var>SelLength</var> properties.
</p>
<p>
The property value is derived by calling the <var>UTF8Copy</var> routine in <file>lazutf8.pas</file>. Setting a new value for the property causes the text selection in Text to be replaced with the specified value. The widgetset class is notified when a handle has been allocated for the control.
</p>
<p>
Values must assigned to the SelStart and SelLength property before accessing SelText.
</p>
<p>
SelText is updated when the <var>ClearSelection</var> is called to remove the text selection value from the content in Text. SelText is compared to Text to determine the value for <var>AutoSelected</var> when <b>VK_RETURN</b> key or <b>MouseUp</b> messages are handled.
</p>
</descr>
<seealso>
<link id="TCustomEdit.SelLength"/>
<link id="TCustomEdit.SelStart"/>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.AutoSelected"/>
<link id="TCustomEdit.ClearSelection"/>
<link id="#lazutils.lazutf8.UTF8Copy">UTF8Copy</link>
</seealso>
</element>
<element name="TCustomEdit.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TCustomEdit.TabStop">
<short>Enables navigation using the Tab key.</short>
<descr>
<p>
Allows the user to navigate to this control by pressing the Tab or Shift+Tab keys. The default value for the property is <b>True</b> in <var>TCustomEdit</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.TabStop">TWinControl.TabStop</link>
</seealso>
</element>
<element name="TCustomEdit.Text">
<short>The text displayed and edited for the control.</short>
<descr>
<p>
<var>Text</var> is a <var>TCaption</var> property which contains the UTF-8-encoded characters maintained as the value for the edit control. The value in Text is read and written using the <var>RealGetText</var> and <var>RealSetText</var> methods. Not only do they provide code compatibility with the Delphi VCL, they support use of emulated <var>TextHint</var> displays. The value in TextHint is assigned to Text when the inline hint text is displayed for the control.
</p>
<p>
The value in Text may be altered in the <var>TextChanged</var> method when the setting in <var>CharCase</var> requires case conversion for the value in the control.
</p>
</descr>
<seealso>
<link id="TCustomEdit.RealGetText"/>
<link id="TCustomEdit.RealSetText"/>
<link id="TCustomEdit.TextChanged"/>
<link id="TCustomEdit.CharCase"/>
<link id="TCustomEdit.TextHint"/>
<link id="#lcl.controls.TControl.Text">TControl.Text</link>
</seealso>
</element>
<element name="TCustomEdit.TextHint">
<short>Default hint text shown when the Text property is empty and the control is not focused.</short>
<descr>
<p>
<var>TextHint</var> fills the <var>TCustomEdit</var> with the value in the property when the Text in the control is empty and the control does not have focus. This is different than Hint, which displays a balloon tip when ShowHint is set to <b>True</b> and the mouse is over the control.
</p>
<p>
Setting a new value in TextHint causes the widgetset class to be notified, and the value is displayed in the edit control when allowed. If the new value is an empty string (''), the text hint is removed from the control.
</p>
</descr>
<seealso/>
</element>
<element name="TMemoScrollbar">
<short>A scrollbar for use in Memo controls.</short>
<descr>
<p>
<var>TMemoScrollbar</var> is a scrollbar specifically for use with <var>TMemo</var> controls. It provides overridden GetHorzScrollBar and GetVertScrollBar methods used to access the individual scrollbars in the associated TCustomMemo/TMemo control. TMemoScrollbar inherits its properties from its ancestor, <link id="#lcl.forms.TControlScrollBar">TControlScrollBar</link>.
</p>
</descr>
<seealso>
<link id="TCustomMemo"/>
<link id="TMemo"/>
<link id="#lcl.forms.TControlScrollBar">TControlScrollBar</link>
</seealso>
</element>
<element name="TMemoScrollbar.GetHorzScrollBar">
<short>Gets the HorzScrollBar in the associated memo control.</short>
<descr/>
<seealso>
<link id="TCustomMemo.HorzScrollBar"/>
</seealso>
</element>
<element name="TMemoScrollbar.GetHorzScrollBar.Result">
<short>Value for the HorzScrollBar property in the memo control.</short>
</element>
<element name="TMemoScrollbar.GetVertScrollBar">
<short>Gets the VertScrollBar in the associated memo control.</short>
<descr/>
<seealso>
<link id="TCustomMemo.VertScrollBar"/>
</seealso>
</element>
<element name="TMemoScrollbar.GetVertScrollBar.Result">
<short>Value for the VertScrollBar property in the memo control.</short>
</element>
<element name="TMemoScrollbar.Increment" link="#lcl.forms.TControlScrollBar.Increment"/>
<element name="TMemoScrollbar.Page" link="#lcl.forms.TControlScrollBar.Page"/>
<element name="TMemoScrollbar.Smooth" link="#lcl.forms.TControlScrollBar.Smooth"/>
<element name="TMemoScrollbar.Position" link="#lcl.forms.TControlScrollBar.Position"/>
<element name="TMemoScrollbar.Range" link="#lcl.forms.TControlScrollBar.Range"/>
<element name="TMemoScrollbar.Size" link="#lcl.forms.TControlScrollBar.Size"/>
<element name="TMemoScrollbar.Visible" link="#lcl.forms.TControlScrollBar.Visible"/>
<element name="TCustomMemo">
<short>The base class for multi-line text controls.</short>
<descr>
<p>
<var>TCustomMemo</var> is a <var>TCustomEdit</var> descendant which implements the base class used for a multi-line edit control. TCustomMemo extends TCustomEdit with additional properties and methods needed for the control. Overridden methods are provided to create and initialize the control using style flags needed for the widgetset class.
</p>
<p>
The textual values in the multi-line control can be accessed using the <var>Lines</var> property. An individual line of text can be accessed by its ordinal position in the list of values. For example:
</p>
<code>
// var sContent: String; ...
sContent := AMemo.Lines[2];
</code>
<p>
This provides access to the third value in List (index positions are zero-based).
</p>
<p>
The values for all of the text in Lines can be retrieved as a single String using the <var>Text</var> property in the <var>TStrings</var> class instance. Each line of text is separated by the <var>LineEnding</var> character sequence for the host platform or operating system. For example:
</p>
<code>
// var sContent: String; ...
sContent := AMemo.Lines.Text;
</code>
<p>
Please note: There is a difference in TCustomMemo / TMemo between the <var>Text</var> and <var>Lines</var> properties. Text is actually the Caption for the control as inherited from TControl. Lines is the multi-line TStrings instance specific to the memo control. Setting the control value using Text does <b>NOT</b> cause the <var>Modified</var> property to be updated. Setting the value using the Lines property does cause the Modified property to be updated.
</p>
<p>
This is important if an <var>OnChange</var> event handler is used to detect changes to the value in the control, and you need to identify whether the change was performed in program code. You can identify a programmatic change by manipulating the value in Modified.
</p>
<p>
For changes in program code, set Modified to False before setting the value using the Text property. If Modified is False when OnChange is signalled, the change occurred in program code. Modified can be set as desired in your program code after the value is assigned to Text. For example:
</p>
<code>
// use Modified and Text to track program changes
procedure TForm1.Button1Click(Sender: TObject);
begin
Memo1.Modified := False;
Memo1.Text := 'Whiskey' + LineEnding + 'Tango' + LineEnding + 'Foxtrot';
Memo1.Modified := True;
end;
procedure TForm1.Memo1Change(Sender: TObject);
begin
if not TCustomMemo(Sender).Modified then
StaticText1.Caption := 'Memo changed in code'
else
StaticText1.Caption := 'Memo changed by user';
end;
</code>
<p>
Changes entered by the user are applied when methods update the Lines property in the control. As a result, Modified is set to True. If Modified is True in OnChange, the change was triggered by user interaction with the control.
</p>
<p>
The value in Modified is retained when the control gains or loses focus whether by keyboard navigation or by using the mouse.
</p>
<p>
The text displayed in the control uses the attributes defined in the <var>Font</var> property. No capabilities are provided for formatting individual characters, words, or lines in the content for the control.
</p>
<p>
Both horizontal and vertical scrollbars can be used in the control. Use the <var>ScrollBar</var> property to define the scrollbars displayed for the control. It can be used to enable automatic scrollbars which are only displayed when the content for the control does not fit within its bounds.
</p>
<p>
Use the <var>Append</var> method to add a line of text to the values in Lines.
</p>
<p>
Use the <var>WantTabs</var> and <var>WantReturns</var> properties to determine whether the corresponding keys are captured and stored in Lines. This affects the way control messages are applied to the control.
</p>
<p>
Use <var>WordWrap</var> to indicate if the control should automatically wrap a line of text longer than the visible area for the control.
</p>
<p>
Applications should not create instances of TCustomMemo; use <var>TMemo</var> instead.
</p>
</descr>
<seealso>
<link id="TCustomMemo.ScrollBars"/>
<link id="TCustomMemo.HorzScrollBar"/>
<link id="TCustomMemo.VertScrollBar"/>
<link id="TCustomMemo.Lines"/>
<link id="TCustomMemo.WordWrap"/>
<link id="TCustomMemo.WantTabs"/>
<link id="TCustomMemo.WantReturns"/>
<link id="TCustomEdit.Modified"/>
<link id="TCustomEdit.Text"/>
<link id="TCustomEdit.OnChange"/>
<link id="TCustomEdit"/>
<link id="TMemo"/>
<link id="#lcl.controls.TControl.Font">TControl.Font</link>
</seealso>
</element>
<element name="TCustomMemo.FHorzScrollBar" link="#lcl.stdctrls.TCustomMemo.HorzScrollBar"/>
<element name="TCustomMemo.FLines" link="#lcl.stdctrls.TCustomMemo.Lines"/>
<element name="TCustomMemo.FScrollBars" link="#lcl.stdctrls.TCustomMemo.ScrollBars"/>
<element name="TCustomMemo.FVertScrollBar" link="#lcl.stdctrls.TCustomMemo.VertScrollBar"/>
<element name="TCustomMemo.FWantReturns" link="#lcl.stdctrls.TCustomMemo.WantReturns"/>
<element name="TCustomMemo.FWantTabs" link="#lcl.stdctrls.TCustomMemo.WantTabs"/>
<element name="TCustomMemo.FWordWrap" link="#lcl.stdctrls.TCustomMemo.WordWrap"/>
<element name="TCustomMemo.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomMemo.CreateParams">
<short>Updates creation flags used to create the handle for the control.</short>
<descr>
<p>
<var>CreateParams</var> is overridden in <var>TCustomMemo</var>, and calls the inherited method on entry. CreateParams ensures that style flags needed for the multi-line control are included in the <var>Style</var> property in the <var>Params</var> argument.
</p>
<p>
Values from the <var>ScrollBars</var> and <var>WordWrap</var> properties are checked, and flags are added as needed. ScrollBars causes window style flags to be added like WS_HSCROLL and/or WS_VSCROLL. When <var>WordWrap</var> is set to True, the WS_HSCROLL window style is removed from the creation parameters. Otherwise, the edit style ES_AUTOHSCROLL is added to the creation parameters.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CreateParams"/>
<link id="TCustomMemo.ScrollBars"/>
<link id="TCustomMemo.WordWrap"/>
</seealso>
</element>
<element name="TCustomMemo.CreateParams.Params">
<short>Creation parameters for the control.</short>
</element>
<element name="TCustomMemo.InitializeWnd">
<short>Copies existing string values from the widgetset class.</short>
<descr>
<p>
<var>InitializeWnd</var> is an overridden method in <var>TCustomMemo</var>. InitializeWnd ensures that property values from widgetset class are stored in the current class instance when handle for the control is created (or re-created). InitializeWnd is called after the handle for the control was created, but before the the handle for child controls is created.
</p>
<p>
InitializeWnd ensures that string values in the widgetset class (if any) are copied to a new <var>TStrings</var> instance and assigned to the <var>Lines</var> property. The previous TStrings instance in Lines is freed.
</p>
<p>
InitializeWnd calls the inherited method prior to exit.
</p>
</descr>
<seealso>
<link id="TCustomMemo.Lines"/>
<link id="TCustomEdit.InitializeWnd"/>
<link id="#rtl.classes.TStrings">TStrings</link>
</seealso>
</element>
<element name="TCustomMemo.FinalizeWnd">
<short>Frees resources when the handle for the control is freed.</short>
<descr>
<p>
<var>FinalizeWnd</var> ensures that string values in <var>Lines</var> are freed in the widgetset class before the handle is destroyed for the control. Existing text (and objects) are copied, and assigned to the member variable for Lines after the widgetset class has been notified.
</p>
<p>
FinalizeWnd calls the inherited method proper to exit.
</p>
</descr>
<seealso>
<link id="TCustomMemo.Lines"/>
<link id="#lcl.controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
</seealso>
</element>
<element name="TCustomMemo.RealGetText">
<short>Returns the textual content stored in Lines as a single String value.</short>
<descr/>
<seealso>
<link id="#rtl.classes.TStrings.Text">TStrings.Text</link>
<link id="#LCL.Controls.TControl.RealGetText">TControl.RealGetText</link>
</seealso>
</element>
<element name="TCustomMemo.RealGetText.Result">
<short>The entire text in a single string.</short>
</element>
<element name="TCustomMemo.RealSetText">
<short>Replaces the value in <var>Lines.Text</var>.</short>
<descr/>
<seealso>
<link id="#LCL.Controls.TControl.RealSetText">TControl.RealSetText</link>
</seealso>
</element>
<element name="TCustomMemo.RealSetText.AValue">
<short>
Sets the value for the control from a single string.
</short>
<descr>
<p>
Sets the value for the control from a single string. Lines are separated by LineFeed (LF) and/or CarriageReturn (CR) characters.
</p>
</descr>
</element>
<element name="TCustomMemo.GetCachedText" link="#lcl.controls.TControl.GetCachedText"/>
<element name="TCustomMemo.GetCachedText.Result">
<short>Always False, a cache is not implemented in TCustomMemo.</short>
</element>
<element name="TCustomMemo.GetCachedText.CachedText">
<short>TCaption instance with the cached value for the control.</short>
</element>
<element name="TCustomMemo.GetCaretPos">
<short>Get the value for the CaretPos property.</short>
<descr>
<p>
<var>GetCaretPosition</var> is an overridden method in <var>TCustomMemo</var> used to get the value for the <var>CaretPos</var> property. It calls the GetCaretPos method in the widgetset class to get the return value for the method.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CaretPos"/>
<link id="TCustomMemo.GetCaretPos"/>
<link id="TCustomMemo.SetCaretPos"/>
</seealso>
</element>
<element name="TCustomMemo.GetCaretPos.Result">
<short>Returns the position of the editing cursor or caret.</short>
</element>
<element name="TCustomMemo.KeyUpAfterInterface">
<short>Handles Key Up events forwarded from the LCL interface.</short>
<descr>
<p>
<var>KeyUpAfterInterface</var> handles the <var>VK_RETURN</var> key code for the control when WantReturns is set to True. It sets the value in Key to 0 to indicate that the key code does not finish editing in the control.
</p>
<p>
It calls the inherited method prior to exit to handle the key code normally when WantReturns is set to False.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.KeyUpAfterInterface">TWinControl.KeyUpAfterInterface</link>
</seealso>
</element>
<element name="TCustomMemo.KeyUpAfterInterface.Key">
<short>Virtual key code examined in the method.</short>
</element>
<element name="TCustomMemo.KeyUpAfterInterface.Shift">
<short>Shift, Ctrl, or Alt modifier for the key code.</short>
</element>
<element name="TCustomMemo.SetCaretPos">
<short>
Sets the position for the editing cursor or caret to the specified location.
</short>
<descr>
<p>
<var>SetCaretPos</var> is an overridden method in <var>TCustomMemo</var> used to set the position for the editing cursor (or caret).
</p>
<p>
<var>AValue</var> is a <var>TPoint</var> instance with the character and line coordinates for the editing cursor. The X member contains the 0-based relative column offset to the UTF-8-encoded character where the caret is positioned. 0 is immediately before the first character in the current line of text. The Y member contains the 0-based offset to the line where the caret is positioned.
</p>
<p>
SetCaretPos ensures that the widgetset class is cast to a TWSCustomMemoClass instance, and calls its SetCaretPos method.
</p>
</descr>
<seealso>
<link id="TCustomEdit.SetCaretPos"/>
</seealso>
</element>
<element name="TCustomMemo.SetCaretPos.AValue">
<short>New position for the editing cursor or caret.</short>
</element>
<element name="TCustomMemo.SetLines">
<short>Sets the value for the Lines property.</short>
<descr/>
<seealso>
<link id="TCustomMemo.Lines"/>
</seealso>
</element>
<element name="TCustomMemo.SetLines.Value">
<short>New value for the Lines property.</short>
</element>
<element name="TCustomMemo.SetSelText">
<short>Sets the value for the SelText property.</short>
<descr/>
<seealso>
<link id="TCustomEdit.SelText"/>
</seealso>
</element>
<element name="TCustomMemo.SetSelText.AValue">
<short>New value for the SelText property.</short>
</element>
<element name="TCustomMemo.SetWantReturns">
<short>Sets the value for the WantReturns property.</short>
<descr/>
<seealso>
<link id="TCustomMemo.WantReturns"/>
</seealso>
</element>
<element name="TCustomMemo.SetWantReturns.AValue">
<short>New value for the WantReturns property.</short>
</element>
<element name="TCustomMemo.SetWantTabs">
<short>Sets the value for the WantTabs property.</short>
<descr/>
<seealso>
<link id="TCustomMemo.WantTabs"/>
</seealso>
</element>
<element name="TCustomMemo.SetWantTabs.NewWantTabs">
<short>New value for the WantTabs property.</short>
</element>
<element name="TCustomMemo.SetWordWrap">
<short>Sets the value for the WordWrap property.</short>
<descr/>
<seealso>
<link id="TCustomMemo.WordWrap"/>
</seealso>
</element>
<element name="TCustomMemo.SetWordWrap.AValue">
<short>New value for the WordWrap property.</short>
</element>
<element name="TCustomMemo.SetScrollBars">
<short>Sets the value for the ScrollBars property.</short>
<descr/>
<seealso>
<link id="TCustomMemo.ScrollBars"/>
</seealso>
</element>
<element name="TCustomMemo.SetScrollBars.AValue">
<short>New value for the ScrollBars property.</short>
</element>
<element name="TCustomMemo.Loaded">
<short>
Performs actions needed when the component has been loaded using the LCL streaming mechanism.
</short>
<descr>
<p>
<var>Loaded</var> is an overridden method in <var>TCustomMemo</var>, and calls the inherited method on entry. When a handle has been allocated for the control, the widgetset class is notified of the current values in the <var>ScrollBars</var> and <var>WordWrap</var> properties.
</p>
</descr>
<seealso>
<link id="TCustomMemo.ScrollBars"/>
<link id="TCustomMemo.WordWrap"/>
<link id="#lcl.controls.TWinControl.Loaded"/>
</seealso>
</element>
<element name="TCustomMemo.CMWantSpecialKey">
<short>Handles control messages for Return and Tab keys when enabled in the control.</short>
<descr>
<p>
<var>CMWantSpecialKey</var> is an overridden method in <var>TCustomMemo</var>. It ensures that control messages for VK_RETURN and VK_TAB keys are marked as handled when WantReturns or WantTabs are enabled in the control. All other messages are handled by calling the inherited method.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CMWantSpecialKey"/>
</seealso>
</element>
<element name="TCustomMemo.CMWantSpecialKey.Message">
<short>Message examined and updated in the method.</short>
</element>
<element name="TCustomMemo.WMGetDlgCode">
<short>Handles Tab, Return, and Escape characters in control messages.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomMemo.WMGetDlgCode.Message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomMemo.GetControlClassDefaultSize">
<short>Gets the default size used for new instances of the class.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomMemo.GetControlClassDefaultSize.Result">
<short>Returns the default size for the control as a TPoint value.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomMemo.UTF8KeyPress">
<short>Implements the handler for UTF8 key press events in the control.</short>
<descr>
<p>
<var>UTF8KeyPress</var> is an overridden method in <var>TCustomMemo</var> which implements the handler for UTF-8-encoded key press events in the control.
</p>
<p>
UTF8KeyPress calls the inherited method on entry to signal the OnUTF8KeyPress event handler (when assigned). It ensures that a <b>Carriage Return</b> (decimal character 13) key is handled using the setting specified in the <var>WantReturns</var> property. When WantReturns is set to <b>False</b>, the value in <var>UTF8Key</var> is set to an empty string (<b>''</b>) to discard the character.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.UTF8KeyPress">TWinControl.UTF8KeyPress</link>
</seealso>
</element>
<element name="TCustomMemo.UTF8KeyPress.UTF8Key">
<short>Key examined in the method.</short>
</element>
<element name="TCustomMemo.CanShowEmulatedTextHint">
<short>Indicates if an emulated TextHint can be displayed for the control.</short>
<descr>
<p>
<var>CanShowEmulatedTextHint</var> is an overridden <var>Boolean</var> function in <var>TCustomMemo</var>, and does <b>not</b> call the inherited method in its implementation.
</p>
<p>
CanShowEmulatedTextHint determines whether an emulated <var>TextHint</var> can be displayed for the control. Normally, this requires a control handle and an unassigned value in the control text. In addition, some widgetsets implement text hints natively, and do not require LCL to emulate the capability (Windows, QT5). Emulated hint displays can also be suppressed when the widgetset class is being freed (when the Lines in the control have already been destroyed).
</p>
<p>
The current implementation always returns <b>False</b> for Memo controls.
</p>
</descr>
<seealso>
<link id="TCustomEdit.CanShowEmulatedTextHint"/>
</seealso>
</element>
<element name="TCustomMemo.CanShowEmulatedTextHint.Result">
<short>True when an emulated TextHint can be displayed for the control.</short>
</element>
<element name="TCustomMemo.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 constructor on entry.
</p>
<p>
Create allocates resources needed for the <var>Lines</var>, <var>HorzScrollBar</var>, and <var>VertScrollBar</var> properties. It also sets the default values for properties, including: <var>WantTabs</var>, <var>WantReturns</var>, <var>WordWrap</var>, <var>AutoSelect</var>, and <var>AutoSize</var>.
</p>
</descr>
<seealso>
<link id="TCustomMemo.Destroy"/>
</seealso>
</element>
<element name="TCustomMemo.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomMemo.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy ensures that resources allocated for the <var>Lines</var>, <var>HorzScrollBar</var>, and <var>VertScrollBar</var> properties are freed by calling the <var>FreeThenNil</var> routine in <file>lazutilities.pas</file>.
</p>
<p>
Destroy calls the inherited destructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TCustomMemo.Create"/>
</seealso>
</element>
<element name="TCustomMemo.Append">
<short>Appends the specified text to the Lines in the control.</short>
<descr>
<p>
<var>Append</var> is a procedure used to append the line of text in <var>AValue</var> to the end of the values in the <var>Lines</var> property. It is a convenience method, and calls the <var>Add</var> method in the Lines member.
</p>
<code>
// var sLine: String;
// the following are equivalent
AMemo.Append(sLine);
AMemo.Lines.Add(sLine);
</code>
</descr>
<seealso/>
</element>
<element name="TCustomMemo.Append.AValue">
<short>The text value added to Lines in the method.</short>
</element>
<element name="TCustomMemo.ScrollBy">
<short>Scrolls the visible area in the control by the specified amounts.</short>
<descr>
<p>
<var>ScrollBy</var> is an overridden method in <var>TCustomMemo</var> used to scroll the visible area for the control by the specified amounts.
</p>
<p>
<var>DeltaX</var> and <var>DeltaY</var> contain the number of pixels the content in the control is scrolled. DeltaX is applied to the horizontal position. DeltaY is applied to the vertical position. A positive value means that he control scrolls towards its bottom or right (respectively). Conversely, a negative value scrolls the content towards its top or left.
</p>
<p>
ScrollBy calls the <var>ScrollBy_WS</var> method in the ancestor class. It essentially replaces the method in the ancestor with the same name, and does not call the inherited method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.ScrollBy">TWinControl.ScrollBy</link>
<link id="#lcl.controls.TWinControl.ScrollBy_WS">TWinControl.ScrollBy_WS</link>
</seealso>
</element>
<element name="TCustomMemo.ScrollBy.DeltaX">
<short>Amount to scroll horizontally.</short>
</element>
<element name="TCustomMemo.ScrollBy.DeltaY">
<short>Amount to scroll vertically.</short>
</element>
<element name="TCustomMemo.Lines">
<short>
Contains the individual lines of text in the multi-line edit control.
</short>
<descr>
<p>
<var>Lines</var> is a <var>TStrings</var> property which contains the individual lines of text in the multi-line edit control. The values in Lines can be accessed using the <var>Strings</var> and <var>Text</var> properties defined in TStrings. The Strings property in Lines allows an individual line of text to be accessed by its ordinal position. For example:
</p>
<code>
// var sContent: String;
sContent := AMemo.Lines.Strings[2];
// equivalent to preceding since Strings is the default property
sContent := AMemo.Lines[2];
</code>
<p>
The Text property in Lines allows access to all of the values stored in Lines. Text lines are separated by the <var>LineEnding</var> character sequence defined for the host platform or operating system. For example:
</p>
<code>
// var sContent: String;
sContent := AMemo.Lines.Text;
</code>
<p>
Changing the values in Lines causes the Modified property to be set to True. Use Text to make changes to the control value that do not cause the Modified property to be updated.
</p>
<p>
Use the <var>Append</var> method to add a line of text to the end of the values in Lines.
</p>
<p>
Set values in the <var>WantTabs</var>, <var>WantReturns</var>, and <var>WordWrap</var> properties to control the content and behavior for the multi-line edit control.
</p>
<p>
Use the <var>OnChange</var> event handler to perform actions needed when the value for the control has been changed.
</p>
</descr>
<seealso>
<link id="TCustomMemo.Append"/>
<link id="TCustomMemo.WantTabs"/>
<link id="TCustomMemo.WantReturns"/>
<link id="TCustomMemo.WordWrap"/>
<link id="TCustomEdit.OnChange"/>
<link id="TCustomEdit.Modified"/>
<link id="#rtl.classes.TStrings">TStrings</link>
<link id="#lazutils.textstrings.TTextStrings">TTextStrings</link>
</seealso>
</element>
<element name="TCustomMemo.HorzScrollBar">
<short>The horizontal scrollbar for the control.</short>
<descr>
<p>
<var>HorzScrollBar</var> is a <var>TMemoScrollBar</var> property which contains the horizontal scrollbar displayed for the control. Resources are allocated to the property in the constructor, and freed in the destructor.
</p>
<p>
Use ScrollBars to determine the scrollbars visible for the control.
</p>
</descr>
<seealso>
<link id="TCustomMemo.ScrollBars"/>
<link id="TCustomMemo.VertScrollBar"/>
</seealso>
</element>
<element name="TCustomMemo.VertScrollBar">
<short>The vertical scrollbar for the control.</short>
<descr>
<p>
<var>VertScrollBar</var> is a <var>TMemoScrollBar</var> property which contains the vertical scrollbar displayed for the control. Resources are allocated to the property in the constructor, and freed in the destructor.
</p>
<p>
Use ScrollBars to determine the scrollbars visible for the control.
</p>
</descr>
<seealso>
<link id="TCustomMemo.ScrollBars"/>
<link id="TCustomMemo.HorzScrollBar"/>
</seealso>
</element>
<element name="TCustomMemo.ScrollBars">
<short>Defines the vertical and/or horizontal scrollbars used in the control.</short>
<descr>
<p>
<var>ScrollBars</var> is a <var>TScrollStyle</var> property which defines whether the horizontal and vertical scrollbars are displayed for the control. It is a single value from the <link id="TScrollStyle">TScrollStyle</link> enumeration.
</p>
<p>
The default value for the property is <var>ssNone</var>, and disables both horizontal and vertical scrollbars in the control.
</p>
<p>
Setting a new value for the property causes the widgetset class to be notified when a handle has been allocated for the control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomMemo.WantReturns">
<short>Allows the user to insert Return characters (line breaks) into the text.</short>
<descr>
<p>
The <b>Enter</b> key is normally used to press the default button in a form, so it cannot be used to add line breaks into the text by default. Set <var>WantReturns</var> to <b>True</b> to allow line breaks to be entered using <b>Enter</b> when the control has the input focus. <b>Ctrl+Enter</b> can be used to insert a line break, even if WantReturns is set to <b>False</b>.
</p>
</descr>
<seealso>
<link id="TCustomMemo.WantTabs"/>
</seealso>
</element>
<element name="TCustomMemo.WantTabs">
<short>Allows Tab characters to be entered into the text.</short>
<descr>
<p>
The Tab key is normally used to move the input focus to the next control, and does not add Tab characters to the text.
</p>
<p>
When <var>WantTabs</var> is <b>True</b>, the Tab key inserts a Tab character into the text, instead of moving the focus to then next control. Even if WantTabs is <b>True</b>, the Tab key can be used to navigate <b>into</b> the control. But it prevents use of Tab to <b>exit</b> the control.
</p>
</descr>
<seealso>
<link id="TCustomMemo.WantReturns"/>
</seealso>
</element>
<element name="TCustomMemo.WordWrap">
<short>
Allows long lines (paragraphs) to wrap into multiple display lines.
</short>
<descr>
<p>
When <b>False</b>, the display for long lines is truncated at the right margin for the control. It can be made visible when the text can be scrolled horizontally.
</p>
</descr>
<seealso>
<link id="TCustomMemo.ScrollBars"/>
</seealso>
</element>
<element name="TEdit">
<short>Implements an edit control with a single line of text.</short>
<descr>
<p>
<var>TEdit</var> is a <var>TCustomEdit</var> descendant which implements an edit control presenting a single line of text. TEdit sets the visibility for properties and events introduced in the TCustomEdit ancestor, and does not introduce any new methods.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="TCustomEdit"/>
<link id="TMemo"/>
<link id="#lcl.extctrls.TLabeledEdit">TLabeledEdit</link>
<link id="#lcl.maskedit.TMaskEdit">TMaskEdit</link>
</seealso>
</element>
<element name="TEdit.Action" link="#lcl.controls.TControl.Action"/>
<element name="TEdit.Align" link="#lcl.controls.TControl.Align"/>
<element name="TEdit.Alignment" link="#lcl.stdctrls.TCustomEdit.Alignment"/>
<element name="TEdit.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TEdit.AutoSelect" link="#lcl.stdctrls.TCustomEdit.AutoSelect"/>
<element name="TEdit.AutoSelected" link="#lcl.stdctrls.TCustomEdit.AutoSelected"/>
<element name="TEdit.AutoSize" link="#lcl.stdctrls.TCustomEdit.AutoSize"/>
<element name="TEdit.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TEdit.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TEdit.BorderStyle" link="#lcl.stdctrls.TCustomEdit.BorderStyle"/>
<element name="TEdit.Color" link="#lcl.controls.TControl.Color"/>
<element name="TEdit.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TEdit.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TEdit.CharCase" link="#lcl.stdctrls.TCustomEdit.CharCase"/>
<element name="TEdit.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TEdit.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TEdit.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TEdit.EchoMode" link="#lcl.stdctrls.TCustomEdit.EchoMode"/>
<element name="TEdit.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TEdit.Font" link="#lcl.controls.TControl.Font"/>
<element name="TEdit.HideSelection" link="#lcl.stdctrls.TCustomEdit.HideSelection"/>
<element name="TEdit.MaxLength" link="#lcl.stdctrls.TCustomEdit.MaxLength"/>
<element name="TEdit.NumbersOnly" link="#lcl.stdctrls.TCustomEdit.NumbersOnly"/>
<element name="TEdit.OnChange" link="#lcl.stdctrls.TCustomEdit.OnChange"/>
<element name="TEdit.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TEdit.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TEdit.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TEdit.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TEdit.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TEdit.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TEdit.OnEditingDone" link="#lcl.controls.TControl.OnEditingDone"/>
<element name="TEdit.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TEdit.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TEdit.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TEdit.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TEdit.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TEdit.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TEdit.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TEdit.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TEdit.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TEdit.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TEdit.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TEdit.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TEdit.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TEdit.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TEdit.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TEdit.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TEdit.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TEdit.ParentColor" link="#lcl.stdctrls.TCustomEdit.ParentColor"/>
<element name="TEdit.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TEdit.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TEdit.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TEdit.PasswordChar" link="#lcl.stdctrls.TCustomEdit.PasswordChar"/>
<element name="TEdit.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TEdit.ReadOnly" link="#lcl.stdctrls.TCustomEdit.ReadOnly"/>
<element name="TEdit.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TEdit.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TEdit.TabStop" link="#lcl.stdctrls.TCustomEdit.TabStop"/>
<element name="TEdit.Text" link="#lcl.stdctrls.TCustomEdit.Text"/>
<element name="TEdit.TextHint" link="#lcl.stdctrls.TCustomEdit.TextHint"/>
<element name="TEdit.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TEdit.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TMemo">
<short>Control used to display and edit multi-line text.</short>
<descr>
<p>
<var>TMemo</var> is a <var>TCustomMemo</var> descendant which implements a multi-line text edit control. TMemo sets the visibility for properties introduced in TCustomMemo, but does not introduce any new methods.
</p>
<p>
The textual values in the multi-line control can be accessed using the <var>Lines</var> property. An individual line of text can be accessed by its ordinal position in the list of values. For example:
</p>
<code>
// var sContent: String; ...
sContent := AMemo.Lines[2];
</code>
<p>
This provides access to the third value in List (index positions are zero-based).
</p>
<p>
The values for all of the text in Lines can be retrieved as a single String using the <var>Text</var> property in the <var>TStrings</var> class instance. Each line of text is separated by the <var>LineEnding</var> character sequence for the host platform or operating system. For example:
</p>
<code>
// var sContent: String; ...
sContent := AMemo.Lines.Text;
</code>
<p>
Please note: There is a difference in TCustomMemo / TMemo between the <var>Text</var> and <var>Lines</var> properties. Text is actually the Caption for the control as inherited from TControl. Lines is the multi-line TStrings instance specific to the memo control. Setting the control value using Text does <b>NOT</b> cause the <var>Modified</var> property to be updated. Setting the value using the Lines property does cause the Modified property to be updated.
</p>
<p>
This is important if an <var>OnChange</var> event handler is used to detect changes to the value in the control, and you need to identify whether the change was performed in program code. You can identify a programmatic change by manipulating the value in Modified.
</p>
<p>
For changes in program code, set Modified to False before setting the value using the Text property. If Modified is False when OnChange is signalled, the change occurred in program code. Modified can be set as desired in your program code after the value is assigned to Text. For example:
</p>
<code>
// use Modified and Text to track program changes
procedure TForm1.Button1Click(Sender: TObject);
begin
Memo1.Modified := False;
Memo1.Text := 'Whiskey' + LineEnding + 'Tango' + LineEnding + 'Foxtrot';
Memo1.Modified := True;
end;
procedure TForm1.Memo1Change(Sender: TObject);
begin
if not TCustomMemo(Sender).Modified then
StaticText1.Caption := 'Memo changed in code'
else
StaticText1.Caption := 'Memo changed by user';
end;
</code>
<p>
Changes entered by the user are applied when methods update the Lines property in the control. As a result, Modified is set to True. If Modified is True in OnChange, the change was triggered by user interaction with the control.
</p>
<p>
The value in Modified is retained when the control gains or loses focus whether by keyboard navigation or by using the mouse.
</p>
<p>
The text displayed in the control uses the attributes defined in the <var>Font</var> property. No capabilities are provided for formatting individual characters, words, or lines in the content for the control.
</p>
<p>
Both horizontal and vertical scrollbars can be used in the control. Use the <var>ScrollBar</var> property to define the scrollbars displayed for the control. It can be used to enable automatic scrollbars which are only displayed when the content for the control does not fit within its bounds.
</p>
<p>
Use the <var>Append</var> method to add a line to text to the values in Lines.
</p>
<p>
Use the <var>WantTabs</var> and <var>WantReturns</var> properties to determine whether the corresponding keys are captured and stored in Lines. This affects the way control messages are applied to the control.
</p>
<p>
Use <var>WordWrap</var> to indicate if the control should automatically wrap a line of text longer than the visible area for the control.
</p>
<p>
Applications should use TEdit for a single line edit control.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="TCustomMemo"/>
<link id="TEdit"/>
</seealso>
</element>
<element name="TMemo.Align" link="#lcl.controls.TControl.Align"/>
<element name="TMemo.Alignment" link="#lcl.stdctrls.TCustomEdit.Alignment"/>
<element name="TMemo.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TMemo.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TMemo.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TMemo.BorderStyle" link="#lcl.stdctrls.TCustomEdit.BorderStyle"/>
<element name="TMemo.CharCase" link="#lcl.stdctrls.TCustomEdit.CharCase"/>
<element name="TMemo.Color" link="#lcl.controls.TControl.Color"/>
<element name="TMemo.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TMemo.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TMemo.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TMemo.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TMemo.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TMemo.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TMemo.Font" link="#lcl.controls.TControl.Font"/>
<element name="TMemo.HideSelection" link="#lcl.stdctrls.TCustomEdit.HideSelection"/>
<element name="TMemo.Lines" link="#lcl.stdctrls.TCustomMemo.Lines"/>
<element name="TMemo.MaxLength" link="#lcl.stdctrls.TCustomEdit.MaxLength"/>
<element name="TMemo.OnChange" link="#lcl.stdctrls.TCustomEdit.OnChange"/>
<element name="TMemo.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TMemo.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TMemo.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TMemo.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TMemo.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TMemo.OnEditingDone" link="#lcl.controls.TControl.OnEditingDone"/>
<element name="TMemo.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TMemo.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TMemo.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TMemo.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TMemo.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TMemo.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TMemo.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TMemo.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TMemo.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TMemo.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TMemo.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TMemo.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TMemo.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TMemo.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TMemo.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TMemo.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TMemo.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TMemo.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TMemo.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TMemo.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TMemo.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TMemo.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TMemo.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TMemo.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TMemo.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TMemo.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TMemo.ReadOnly" link="#lcl.stdctrls.TCustomEdit.ReadOnly"/>
<element name="TMemo.ScrollBars" link="#lcl.stdctrls.TCustomMemo.ScrollBars"/>
<element name="TMemo.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TMemo.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TMemo.TabStop" link="#lcl.stdctrls.TCustomEdit.TabStop"/>
<element name="TMemo.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TMemo.WantReturns" link="#lcl.stdctrls.TCustomMemo.WantReturns"/>
<element name="TMemo.WantTabs" link="#lcl.stdctrls.TCustomMemo.WantTabs"/>
<element name="TMemo.WordWrap" link="#lcl.stdctrls.TCustomMemo.WordWrap"/>
<element name="TStaticBorderStyle">
<short>Contains border styles used for static text controls.</short>
<descr>
<p>
<var>TStaticBorderStyle</var> is an enumerated type with values that represents border styles used for static text controls. TStaticBorderStyle is the type used for the <var>BorderStyle</var> property in <var>TCustomStaticText</var> and decendants.
</p>
</descr>
<seealso>
<link id="TCustomStaticText.BorderStyle"/>
</seealso>
</element>
<element name="TStaticBorderStyle.sbsNone">
<short>No border.</short>
</element>
<element name="TStaticBorderStyle.sbsSingle">
<short>Single line border.</short>
</element>
<element name="TStaticBorderStyle.sbsSunken">
<short>Sunken 3-D border.</short>
</element>
<element name="TCustomStaticText">
<short>The base class for <var>TStaticText</var>.</short>
<descr>
<p>
Specifies the base ancestor for TStaticText, a control used to display static text. TCustomStaticText is a TWinControl descendant. It can be used in place of TLabel for situations where a TWinControl descendant is required.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomStaticText.FAlignment"/>
<element name="TCustomStaticText.FFocusControl"/>
<element name="TCustomStaticText.FShowAccelChar"/>
<element name="TCustomStaticText.FStaticBorderStyle"/>
<element name="TCustomStaticText.GetTransparent" link="#lcl.stdctrls.TCustomStaticText.Transparent">
<short>Gets the value for the Transparent property.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomStaticText.GetTransparent.Result">
<short>Value for the Transparent property.</short>
</element>
<element name="TCustomStaticText.SetAlignment">
<short>Sets the value for the Alignment property.</short>
<descr/>
<seealso>
<link id="TCustomStaticText.Alignment"/>
</seealso>
</element>
<element name="TCustomStaticText.SetAlignment.Value">
<short>New value for the Alignment property.</short>
</element>
<element name="TCustomStaticText.SetStaticBorderStyle">
<short>Sets the value for the BorderStyle property.</short>
<descr/>
<seealso>
<link id="TCustomStaticText.BorderStyle"/>
</seealso>
</element>
<element name="TCustomStaticText.SetStaticBorderStyle.Value">
<short>New value for the StaticBorderStyle property.</short>
</element>
<element name="TCustomStaticText.SetTransparent">
<short>Sets the value for the Transparent property.</short>
<descr/>
<seealso>
<link id="TCustomStaticText.Transparent"/>
</seealso>
</element>
<element name="TCustomStaticText.SetTransparent.AValue">
<short>New value for the Transparent property.</short>
</element>
<element name="TCustomStaticText.WMActivate">
<short>Handles the window activate message for the control.</short>
<descr>
<p>
Received when the control has a registered activation shortcut for the FocusControl. Defers the focus to FocusControl when assigned and enabled.
</p>
</descr>
<seealso>
<link id="TCustomStaticText.FocusControl"/>
</seealso>
</element>
<element name="TCustomStaticText.WMActivate.Message">
<short>Window message examined in the method.</short>
</element>
<element name="TCustomStaticText.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomStaticText.GetLabelText">
<short>Returns the Caption for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomStaticText.GetLabelText.Result">
<short>The text stored in Caption.</short>
</element>
<element name="TCustomStaticText.RealSetText" link="#lcl.controls.TControl.RealSetText"/>
<element name="TCustomStaticText.RealSetText.AValue">
<short/>
</element>
<element name="TCustomStaticText.Notification">
<short>Handles a notification that a component used in the control has been added or removed.</short>
<descr>
<p>
<var>Notification</var> is an overridden method in <var>TCustomStaticText</var>, and calls the inherited method on entry. Notification ensures that <var>FocusControl</var> is set to <b>Nil</b> when it is the component for the <var>opRemove</var> <var>Operation</var>.
</p>
</descr>
<seealso>
<link id="TCustomStaticText.FocusControl"/>
<link id="#lcl.controls.TControl.Notification">TControl.Notification</link>
</seealso>
</element>
<element name="TCustomStaticText.Notification.AComponent">
<short>Component for the notification.</short>
</element>
<element name="TCustomStaticText.Notification.Operation">
<short>Operation for the notification.</short>
</element>
<element name="TCustomStaticText.SetFocusControl">
<short>Sets the value for the FocusControl property.</short>
<descr/>
<seealso>
<link id="TCustomStaticText.FocusControl"/>
</seealso>
</element>
<element name="TCustomStaticText.SetFocusControl.Val">
<short>New value for the FocusControl property.</short>
</element>
<element name="TCustomStaticText.SetShowAccelChar">
<short>Sets the value for the ShowAccelChar property.</short>
<descr/>
<seealso>
<link id="TCustomStaticText.ShowAccelChar"/>
</seealso>
</element>
<element name="TCustomStaticText.SetShowAccelChar.Val">
<short>New value for the ShowAccelChar property.</short>
</element>
<element name="TCustomStaticText.DialogChar">
<short>Handles an accelerator key for the control.</short>
<descr>
<p>
<var>DialogChar</var> is an overridden method in <var>TCustomStaticText</var>. It checks the character code in <var>Message</var> to determine if it is used as the accelerator (shortcut) in the <var>Caption</var> for the control. When the character code is found, the <var>FocusControl</var> is given focus and the return value is set to True.
</p>
<p>
If the character code is not found, the inherited method is called to broadcast the Message to child controls and get the return value.
</p>
</descr>
<seealso>
<link id="TCustomStaticText.FocusControl"/>
<link id="#lcl.forms.IsAccel">IsAccel</link>
<link id="#lcl.controls.TWinControl.CanFocus">TWinControl.CanFocus</link>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
<link id="#lcl.controls.TControl.DialogChar">TControl.DialogChar</link>
</seealso>
</element>
<element name="TCustomStaticText.DialogChar.Result">
<short>True if the message was handled as an accelerator key.</short>
</element>
<element name="TCustomStaticText.DialogChar.Message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomStaticText.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomStaticText.GetControlClassDefaultSize.Result">
<short>TSize instance with the default size for new instances of the class.</short>
</element>
<element name="TCustomStaticText.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. It sets the default values for properties and component style flags, as well as the initial bounds for the control.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.Create">TWinControl.Create</link>
</seealso>
</element>
<element name="TCustomStaticText.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomStaticText.Alignment">
<short>The horizontal alignment for the text; centered, left- or right-justified.</short>
<descr>
<p>
The default value for the property is taLeftJustify. Changing the value for the property causes the widgetset class instance to be updated when its Handle has been allocated.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomStaticText.BorderStyle">
<short>The border drawn around the control.</short>
<descr>
<p>
<var>BorderStyle</var> is a <var>TStaticBorderStyle</var> property in <var>TCustomStaticText</var>. it contains the line style used to draw the borders around the static text control. It allows an additional border style (<var>sbsSunken</var>) that is not available in its <var>TBorderStyle</var> counterpart.
</p>
<p>
The default value for the property is <var>sbsNone</var>. Changing the value for the property causes the widgetset class instance to be updated and optionally resized when its Handle has been allocated.
</p>
</descr>
<seealso>
<link id="TStaticBorderStyle"/>
<link id="#lcl.controls.TBorderStyle">TBorderStyle</link>
<link id="#lcl.controls.TWinControl.BorderStyle">TWinControl.BorderStyle</link>
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
</seealso>
</element>
<element name="TCustomStaticText.FocusControl">
<short>The control that receives focus instead of this control.</short>
<descr>
<p>
<var>FocusControl</var> is a <var>TWinControl</var> property with the control given focus when the accelerator (shortcut) key is handled for the control. The accelerator is defined using the '&' character in the <var>Caption</var> for the control. If the key is detected and handled in <var>DialogChar</var>, the control in FocusControl is given focus.
</p>
</descr>
<seealso/>
<link id="TCustomStaticText.DialogChar"/>
<link id="TCustomStaticText.ShowAccelChar"/>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
<link id="#lcl.controls.TWinControl.Focused">TWinControl.Focused</link>
<link id="#lcl.controls.TWinControl.CanFocus">TWinControl.CanFocus</link>
</element>
<element name="TCustomStaticText.ShowAccelChar">
<short>Indicates if an accelerator character is drawn in the displayed text.</short>
<descr>
<p>
<var>ShowAccelChar</var> is a <var>Boolean</var> property which indicates if the character used as an accelerator key is drawn with an underline in the control.
</p>
<p>
An accelerator character is any value with a leading Ampersand (&) character in <var>Caption</var>. To use an Ampersand character as an accelerator, it must be entered as 2 Ampersand characters (&&).
</p>
<p>
Set ShowAccelChar to <b>True</b> to enable underline drawing for the accelerator character. The default value for the property is <b>True</b>. Changing the value in the property causes the <var>InvalidatePreferredSize</var> method to be called to update the bounds for the control.
</p>
<p>
The value in ShowAccelChar is used in widgetset class methods, such as when the text value is assigned and when the handle for the control is created (or re-created).
</p>
<p>
Use <var>FocusControl</var> to specify the control which receives focus when the accelerator key is handled in <var>DialogChar</var>.
</p>
</descr>
<seealso>
<link id="TCustomStaticText.FocusControl"/>
<link id="TCustomStaticText.DialogChar"/>
<link id="TCustomStaticText.GetLabelText"/>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
<link id="#lcl.controls.TControl.InvalidatePreferredSize">TControl.InvalidatePreferredSize</link>
</seealso>
</element>
<element name="TCustomStaticText.Transparent">
<short>Makes the background color for the control transparent when True.</short>
<descr>
<p>
The property value is <b>True</b> when the <var>csOpaque</var> flag is not present in the <var>ControlStyle</var> property. Changing the value for the property causes ControlStyle to be updated accordingly, and the control is redrawn. The default value for the property is <b>True</b>.
</p>
<p>
Transparent is used when the <var>InvalidateControl</var> and <var>InvalidateRect</var> methods are called to paint the control.
</p>
</descr>
<seealso/>
</element>
<element name="TStaticText">
<short>Control used to display a text value which does not change.</short>
<descr>
<p>
<var>TStaticText</var> is a <var>TCustomStaticText</var> descendant which implements a control used to display text that does not change. It can be used in place of TLabel for situations where a TWinControl descendant is required. It has a window handle, and allows the accelerator key for the control to be forwarded to another windowed control.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
</seealso>
</element>
<element name="TStaticText.Align" link="#lcl.controls.TControl.Align"/>
<element name="TStaticText.Alignment" link="#lcl.stdctrls.TCustomStaticText.Alignment"/>
<element name="TStaticText.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TStaticText.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TStaticText.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TStaticText.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TStaticText.BorderStyle" link="#lcl.stdctrls.TCustomStaticText.BorderStyle"/>
<element name="TStaticText.Caption" link="#lcl.controls.TControl.Caption">
<short>Text displayed in the control.</short>
<descr/>
<seealso/>
</element>
<element name="TStaticText.Color" link="#lcl.controls.TControl.Color"/>
<element name="TStaticText.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TStaticText.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TStaticText.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TStaticText.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TStaticText.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TStaticText.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TStaticText.FocusControl" link="#lcl.stdctrls.TCustomStaticText.FocusControl"/>
<element name="TStaticText.Font" link="#lcl.controls.TControl.Font"/>
<element name="TStaticText.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TStaticText.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TStaticText.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TStaticText.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TStaticText.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TStaticText.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TStaticText.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TStaticText.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TStaticText.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TStaticText.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TStaticText.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TStaticText.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TStaticText.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TStaticText.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TStaticText.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TStaticText.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TStaticText.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TStaticText.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TStaticText.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TStaticText.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TStaticText.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TStaticText.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TStaticText.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TStaticText.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TStaticText.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TStaticText.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TStaticText.ShowAccelChar" link="#lcl.stdctrls.TCustomStaticText.ShowAccelChar"/>
<element name="TStaticText.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TStaticText.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TStaticText.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
<element name="TStaticText.Transparent" link="#lcl.stdctrls.TCustomStaticText.Transparent"/>
<element name="TStaticText.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TButtonControl">
<short>Specifies a base class for button controls.</short>
<descr>
<p>
<var>TButtonControl</var> is a <var>TWinControl</var> descendant which specifies the base class used for controls with button-like behavior, such as: <var>TCustomButton</var>, <var>TButton</var>, <var>TCustomCheckBox</var>, <var>TCheckBox</var>, <var>TToggleBox</var>, and <var>TRadioButton</var>.
</p>
<p>
TButtonControl introduces properties, methods, and events needed to read and write the Checked state for the control, handle Click events, and perform actions using OnChange or an action link.
</p>
<p>
Do not create instances of TButtonControl in an application; use one of the descendent classes.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TButtonControl.FClicksDisabled" link="#lcl.stdctrls.TButtonControl.ClicksDisabled"/>
<element name="TButtonControl.FOnChange" link="#lcl.stdctrls.TButtonControl.OnChange"/>
<element name="TButtonControl.IsCheckedStored" link="#lcl.stdctrls.TButtonControl.Checked"/>
<element name="TButtonControl.IsCheckedStored.Result">
<short>True when the value in Checked is included in the LCL streaming mechanism.</short>
</element>
<element name="TButtonControl.WMDefaultClicked">
<short>Implements the default handler for the LM_CLICKED message.</short>
</element>
<element name="TButtonControl.WMDefaultClicked.Message">
<short>Message handled in the method.</short>
</element>
<element name="TButtonControl.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TButtonControl.GetActionLinkClass" link="#lcl.controls.TControl.GetActionLinkClass"/>
<element name="TButtonControl.GetActionLinkClass.Result"/>
<element name="TButtonControl.GetChecked">
<short>Gets the value for the Checked property.</short>
<descr/>
<seealso>
<link id="TButtonControl.Checked"/>
</seealso>
</element>
<element name="TButtonControl.GetChecked.Result">
<short>Value for the property.</short>
</element>
<element name="TButtonControl.SetChecked">
<short>Sets the value for the Checked property.</short>
<descr/>
<seealso>
<link id="TButtonControl.Checked"/>
</seealso>
</element>
<element name="TButtonControl.SetChecked.Value">
<short>New value for the Checked property.</short>
</element>
<element name="TButtonControl.DoOnChange">
<short>Signals the OnEditingDone and OnChange event handlers (when assigned).</short>
<descr>
<p>
<var>DoOnChange</var> performs actions needed when the button control is clicked. DoOnChange calls <var>EditingDone</var> to signal the <var>OnEditingDone</var> event handler (when assigned). The <var>OnChange</var> event handler is also signalled (when assigned).
</p>
<p>
DoOnChange is called from the <var>Click</var> method before the inherited method in TControl is executed. DoOnChange performs no actions at design-time, during component streaming, or when the component is freed.
</p>
</descr>
<seealso>
<link id="TButtonControl.OnChange"/>
<link id="#lcl.controls.TControl.EditingDone">TControl.EditingDone</link>
<link id="#lcl.controls.TControl.OnEditingDone">TControl.OnEditingDone</link>
<link id="#lcl.controls.TControl.Click">TControl.Click</link>
<link id="#rtl.classes.TComponent.ComponentState">TComponent.ComponentState</link>
</seealso>
</element>
<element name="TButtonControl.Click">
<short>Performs actions needed when a click message is handled for the control.</short>
<descr>
<p>
<var>Click</var> is an overridden method in <var>TButtonControl</var>. Click calls the <var>DoOnChange</var> method to signal the <var>OnEditingDone</var> and <var>OnChange</var> event handlers (when assigned). Click calls the inherited method prior to exit.
</p>
<p>
Click is used when messages are handled in the control and <var>csClickEvents</var> is not used in the <var>ControlStyle</var> property.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Click">TControl.Click</link>
</seealso>
</element>
<element name="TButtonControl.CMWantSpecialKey" link="#lcl.controls.TControl.CMWantSpecialKey">
<short>Handles the CM_WANTSPECIALKEY message for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TButtonControl.CMWantSpecialKey.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TButtonControl.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. <var>TheOwner</var> is the owner for the new class instance, or <b>Nil</b>.
</p>
<p>
Create ensures that values in ControlStyle are updated to remove the csMultiClicks, csAcceptsControls, and csCaptureMouse style flags. The accessibility role and description are set to "Button" for the new class instance.
</p>
</descr>
<seealso/>
</element>
<element name="TButtonControl.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TButtonControl.Checked">
<short>Indicates the checked state for the control.</short>
<descr>
<p>
<var>Checked</var> is a <var>Boolean</var> property which indicates if the control is displayed using its "checked" or "unchecked" state. The value for the property is always <b>False</b> in <var>TButtonControl</var>, and is overridden in a descendent class.
</p>
</descr>
</element>
<element name="TButtonControl.ClicksDisabled">
<short>Disables clicking on the button, without showing the button in a disabled state.</short>
<descr/>
<seealso/>
</element>
<element name="TButtonControl.OnChange">
<short>Event handler for changes to properties in the control.</short>
<descr/>
<seealso/>
</element>
<element name="TButtonActionLink">
<short>Links a button control to a basic action.</short>
<descr>
<p>
<var>TButtonActionLink</var> is a <var>TWinControlActionLink</var> descendant which links a <var>TButtonControl</var> to a <var>TBasicAction</var> component.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControlActionLink">TWinControlActionLink</link>
<link id="#rtl.classes.TBasicAction">TBasicAction</link>
</seealso>
</element>
<element name="TButtonActionLink.FClientButton">
<short>The button control for the action link.</short>
</element>
<element name="TButtonActionLink.AssignClient">
<short>Assigns the button control for the action link.</short>
<descr/>
<seealso/>
</element>
<element name="TButtonActionLink.AssignClient.AClient">
<short>Button assigned in the method.</short>
</element>
<element name="TButtonActionLink.SetChecked">
<short>Sets the value in the Checked property for the linked button.</short>
<descr/>
<seealso>
<link id="#LCL.ActnList.TActionLink.SetChecked">TActionLink.SetChecked</link>
</seealso>
</element>
<element name="TButtonActionLink.SetChecked.Value">
<short>New value for the checked property.</short>
</element>
<element name="TButtonActionLink.IsCheckedLinked" link="#LCL.ActnList.TActionLink.IsCheckedLinked"/>
<element name="TButtonActionLink.IsCheckedLinked.Result" link="#LCL.ActnList.TActionLink.IsCheckedLinked.Result"/>
<element name="TButtonActionLinkClass">
<short>Class reference used to create new instances of TButtonActionLink.</short>
<descr/>
<seealso>
<link id="TButtonActionLink"/>
</seealso>
</element>
<element name="TCustomButton">
<short>The base class for a push button control.</short>
<descr>
<p>
<var>TCustomButton</var> is a <var>TButtonControl</var> descendant which provides the base class for a push button control.
</p>
<p>
TCustomButton / TButton are used to perform an action when the control is clicked. An <var>OnClick</var> event handler is provided to perform actions needed when the push button is clicked.
</p>
<p>
Properties are provided to control the appearance and behavior for the control. This includes whether it is the Default or Cancel button on a modal form, and the modal result returned when the push button is clicked.
</p>
<p>
The control displays a text-based caption and is drawn using a style appropriate for the platform or widgetset. An accelerator key can be defined in the caption which simulates clicking on the push button when the shortcut key is pressed. Support for TBasicAction from the FPC Run-time Library (RTL) is present, but not published in the control.
</p>
<p>
Please note that the Caption is always center aligned on the push button. The values in properties like BiDiMode and UseRightToLeftAlignment are ignored in the control.
</p>
<p>
Please note that the Color for the control defaults to the system-defined color used for button controls (clDefault or clBtnFace).
</p>
<p>
Do not create instances of TCustomButton; use the TButton descendant instead.
</p>
<p>
Use TBitBtn for a push button control which displays a bitmap instead of a text-based caption.
</p>
<p>
Use TSpeedButton for a push button control which can remain in the pressed or down state.
</p>
</descr>
<seealso>
<link id="TButton"/>
<link id="TButtonControl"/>
</seealso>
</element>
<element name="TCustomButton.FModalResult"/>
<element name="TCustomButton.FShortCut"/>
<element name="TCustomButton.FShortCutKey2"/>
<element name="TCustomButton.FCancel"/>
<element name="TCustomButton.FDefault"/>
<element name="TCustomButton.FActive"/>
<element name="TCustomButton.SetCancel">
<short>Sets the value for the Cancel property.</short>
<descr/>
<seealso>
<link id="TCustomButton.Cancel"/>
</seealso>
</element>
<element name="TCustomButton.SetCancel.NewCancel">
<short>New value for the Cancel property.</short>
</element>
<element name="TCustomButton.SetDefault">
<short>Sets the value for the Default property.</short>
<descr/>
<seealso>
<link id="TCustomButton.Default"/>
</seealso>
</element>
<element name="TCustomButton.SetDefault.Value">
<short>New value for the Default property.</short>
</element>
<element name="TCustomButton.SetModalResult">
<short>Sets the value for the ModalResult property.</short>
<descr/>
<seealso>
<link id="TCustomButton.ModalResult"/>
</seealso>
</element>
<element name="TCustomButton.SetModalResult.AValue">
<short>New value for the ModalResult property.</short>
</element>
<element name="TCustomButton.CMUIActivate">
<short>Handles a UIActivate control message.</short>
<descr>
<p>
Calls <var>UpdateFocus</var> to make the button the active control in the parent form.
</p>
</descr>
<seealso>
<link id="TCustomButton.UpdateFocus"/>
</seealso>
</element>
<element name="TCustomButton.CMUIActivate.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomButton.WMSetFocus">
<short>Handles a set focus window message for the control.</short>
<descr>
<p>
<var>WMSetFocus</var> calls the inherited method in <var>TWinControl</var> on entry. Calls <var>UpdateFocus</var> to make the button the active control in the parent form.
</p>
</descr>
<seealso>
<link id="TCustomButton.UpdateFocus"/>
<link id="#lcl.controls.TWinControl.WMSetFocus">TWinControl.WMSetFocus</link>
</seealso>
</element>
<element name="TCustomButton.WMSetFocus.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomButton.WMKillFocus">
<short>Handles a kill focus message for the control.</short>
<descr>
<p>
<var>WMKillFocus</var> calls the inherited method in <var>TWinControl</var> on entry. When the window handle in <var>Message</var> is the <var>Handle</var> for the control, the <var>UpdateFocus</var> method is called to remove the button as the active default control in the parent form.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.WMKillFocus">TWinControl.WMKillFocus</link>
<link id="#lcl.controls.TWinControl.Handle">TWinControl.Handle</link>
<link id="#lcl.lmessages.TLMKillFocus">TLMKillFocus</link>
</seealso>
</element>
<element name="TCustomButton.WMKillFocus.Message">
<short>Message handled in the method.</short>
</element>
<element name="TCustomButton.UpdateFocus">
<short>Handles changes to the focus for the control.</short>
<descr>
<p>
<var>UpdateFocus</var> is a method used to update the control and its parent form when the control gets or loses focus on its form.
</p>
<p>
<var>AFocused</var> indicates whether the control is getting or losing focus.
</p>
<p>
UpdateFocus calls GetParentForm to get the parent form for the control. No additional actions are performed in the method when the parent form has not been assigned for the control.
</p>
<p>
When AFocused is <b>True</b>, <var>ActiveDefaultControlChanged</var> is called to synchronize values in the control and the parent form. Active (in the control) is updated to reflect its use as the ActiveControl on the parent form. ActiveDefaultControl (in the parent form) is updated when the control is focused.
</p>
<p>
UpdateFocus is called when the LM_SETFOCUS or LM_KILLFOCUS messages are handled for the control. It is also called when the <var>CM_UIACTIVATE</var> message is dispatched by the parent form when it is focused.
</p>
</descr>
<seealso>
<link id="TCustomButton.Active"/>
<link id="TCustomButton.Default"/>
<link id="TCustomButton.ActiveDefaultControlChanged"/>
<link id="#lcl.forms.GetParentForm">GetParentForm</link>
<link id="#lcl.forms.TCustomForm.SetWindowFocus">TCustomForm.SetWindowFocus</link>
</seealso>
</element>
<element name="TCustomButton.UpdateFocus.AFocused">
<short>True when the button is focused, False when it loses focus.</short>
</element>
<element name="TCustomButton.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomButton.CreateWnd">
<short>Creates the handle for the widgetset class instance.</short>
<descr>
<p>
Calls the inherited method on entry. Calls UpdateDefaultCancel to set the Default and Cancel controls on the Parent form (when needed).
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
</seealso>
</element>
<element name="TCustomButton.CreateParams">
<short>Updates creation parameters to use values needed for the control.</short>
<descr>
<p>
Calls the inherited method on entry. Ensures that the style flags in <var>Params</var> is updated to include <var>BS_DEFPUSHBUTTON</var> when the <var>Default</var> property is <b>True</b>. Otherwise, <var>BS_PUSHBUTTON</var> is included in the style flags.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.CreateParams">TWinControl.CreateParams</link>
</seealso>
</element>
<element name="TCustomButton.CreateParams.Params">
<short>Creation parameters updated in the method.</short>
</element>
<element name="TCustomButton.ControlKeyDown" link="#lcl.controls.TWinControl.ControlKeyDown"/>
<element name="TCustomButton.ControlKeyDown.Key">
<short>Virtual key code examined in the method.</short>
</element>
<element name="TCustomButton.ControlKeyDown.Shift">
<short>Shift, Ctrl, or Alt modifier for the key.</short>
</element>
<element name="TCustomButton.ControlKeyUp" link="#lcl.controls.TWinControl.ControlKeyUp"/>
<element name="TCustomButton.ControlKeyUp.Key">
<short>Virtual key code examined in the method.</short>
</element>
<element name="TCustomButton.ControlKeyUp.Shift">
<short>Shift, Ctrl, or Alt modifier for the key.</short>
</element>
<element name="TCustomButton.DialogChar">
<short>Handles an accelerator key for the control.</short>
<descr>
<p>
<var>DialogChar</var> is an overridden <var>Boolean</var> function used to handle a <var>TLMKey</var> message received for the control.
</p>
<p>
DialogChar examines the <var>CharCode</var> member in <var>Message</var> to determine if it contains the accelerator key defined in the <var>Caption</var> for the control. If it is found, and the control can receive focus, the <var>Click</var> method is called and the return value is set to <b>True</b>. If the Message has a CharCode that is not the accelerator key, the inherited method is called to handle the message and get the return value for the method.
</p>
<p>
The return value is <b>True</b> when the Message is successfully handled for the control.
</p>
</descr>
<seealso>
<link id="TCustomButton.Click"/>
<link id="#lcl.controls.TControl.DialogChar">TControl.DialogChar</link>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
<link id="#lcl.controls.TControl.OnClick">TControl.OnClick</link>
</seealso>
</element>
<element name="TCustomButton.DialogChar.Result">
<short>True if the message was handled as an accelerator key.</short>
</element>
<element name="TCustomButton.DialogChar.Message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomButton.ChildClassAllowed" link="#lcl.controls.TWinControl.ChildClassAllowed"/>
<element name="TCustomButton.ChildClassAllowed.Result">
<short>True when the widgetset class indicates child controls are allowed.</short>
</element>
<element name="TCustomButton.ChildClassAllowed.ChildClass">
<short>Not used in the current implementation.</short>
</element>
<element name="TCustomButton.GetControlClassDefaultSize">
<short>Gets the default size for new instances of the control.</short>
<descr>
<p>
<var>GetControlClassDefaultSize</var> is an overridden <var>TSize</var> class function used to get the default height and width for new instances of the control. GetControlClassDefaultSize sets the <var>CX</var> and <var>CY</var> members in the return value to the defaults used for the control. CX contains the width and is set to 75 (pixels). CY contains the height and is set to 25 (pixels).
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
<link id="#rtl.types.TSize">TSize</link>
</seealso>
</element>
<element name="TCustomButton.GetControlClassDefaultSize.Result">
<short>TSize instance with the width and height for the new control.</short>
</element>
<element name="TCustomButton.WSSetDefault">
<short>Notifies the widgetset class of a change to the Default property.</short>
<descr>
<p>
<var>WSSetDefault</var> is a method used to notify the widgetset class when the value in the <var>Default</var> property has been changed.
</p>
<p>
WSSetDefault calls the <var>SetDefault</var> method in the widgetset class using the value in the <var>Active</var> property. Active is used because Default represents the design-time setting for the control. At run-time, Active contains the default button clicked when the Enter key is pressed.
</p>
<p>
Called when a new value is assigned to the <var>Default</var> property. Called when the value in <var>Active</var> is changed in the <var>ActiveDefaultControlChanged</var> method. Called when <var>UpdateDefaultCancel</var> sets the default and cancel controls on the parent form.
</p>
</descr>
<seealso>
<link id="TCustomButton.Default"/>
<link id="TCustomButton.Active"/>
<link id="TCustomButton.ActiveDefaultControlChanged"/>
<link id="TCustomButton.UpdateDefaultCancel"/>
</seealso>
</element>
<element name="TCustomButton.WSSetText">
<short>Notifies the widgetset class of a change to the caption text for the control.</short>
<descr>
<p>
<var>WSSetText</var> is an overridden method used to notify the widgetset class instance when the value in the caption text has been changed. No actions are performed in the method when the handle for the control has not been allocated, or at design-time.
</p>
<p>
WSSetText ensures that <b>Ampersand</b> (<b>&</b>) characters used to define an accelerator key in <var>AText</var> are handled for the widgetset class. The Ampersand character(s) are removed from AText, and the virtual key code equivalent is stored in the <var>Shortcut</var> property. By default, the Shortcut uses the <var>ssCtrl</var> shift modifier for the accelerator key.
</p>
<p>
The <var>SetShortCut</var> method in the widgetset class is called to store values from both <var>Shortcut</var> and <var>ShortCutKey2</var>.
</p>
<p>
The inherited <var>WSSetText</var> method is called prior to exit.
</p>
</descr>
<seealso>
<link id="TCustomButton.Shortcut"/>
<link id="TCustomButton.ShortCutKey2"/>
<link id="#lcl.controls.TControl.Text">TControl.Text</link>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
<link id="#lcl.menus.ShortCut">ShortCut</link>
<link id="#lcl.lcltype.Char2VK">Char2VK</link>
</seealso>
</element>
<element name="TCustomButton.WSSetText.AText">
<short>New value for the caption text in the control.</short>
</element>
<element name="TCustomButton.TextChanged">
<short>Performs actions needed when the CM_TEXTCHANGED message is handled in the control.</short>
<descr>
<p>
<var>TextChanged</var> is an overridden method used to performs actions needed when the <var>CM_TEXTCHANGED</var> message is handled in the control.
</p>
<p>
TextChanged calls <var>InvalidatePreferredSize</var> to force the preferred height and width for the control to be recalculated. When <var>Parent</var> has been assigned and its <var>AutoSize</var> property is set to <b>True</b>, the <var>AdjustSize</var> method in Parent is called. The AdjustSize method for the control is called to resize the control or update control flags when delayed auto-sizing is in use.
</p>
<p>
TextChanged calls the inherited method prior to exit.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.TextChanged">TControl.TextChanged</link>
<link id="#lcl.controls.TControl.AdjustSize">TControl.AdjustSize</link>
<link id="#lcl.controls.TControl.AutoSizeDelayed">TControl.AutoSizeDelayed</link>
</seealso>
</element>
<element name="TCustomButton.Loaded">
<short>Performs actions needed when LCL component streaming has been completed.</short>
<descr>
<p>
<var>Loaded</var> is an overridden method used to perform actions needed when LCL component streaming has been completed.
</p>
<p>
Loaded calls the inherited method on entry. Loaded calls <var>UpdateDefaultCancel</var> to update the default and cancel controls on the parent form.
</p>
</descr>
<seealso>
<link id="TCustomButton.UpdateDefaultCancel"/>
<link id="#lcl.controls.TWinControl.Loaded"/>
</seealso>
</element>
<element name="TCustomButton.UpdateDefaultCancel">
<short>Updates the Default and Cancel properties in the parent form.</short>
<descr>
<p>
<var>UpdateDefaultCancel</var> is a method used to update the default and cancel controls on the parent form.
</p>
<p>
UpdateDefaultCancel calls <var>GetParentForm</var> to get the parent for the control. When the parent form has been assigned, its <var>DefaultControl</var> and <var>CancelControl</var> properties are updated when needed. DefaultControl is updated when the <var>Default</var> property is set to <b>True</b>. CancelControl is updated when the <var>Cancel</var> property is set to <b>True</b>.
</p>
<p>
UpdateDefaultCancel calls <var>WSSetDefault</var> to notify the widgetset class when the control is the default control.
</p>
<p>
UpdateDefaultCancel is called from the <var>CreateWnd</var> and <var>Loaded</var> methods.
</p>
</descr>
<seealso>
<link id="TCustomButton.Cancel"/>
<link id="TCustomButton.Default"/>
<link id="TCustomButton.Active"/>
<link id="TCustomButton.WSSetDefault"/>
<link id="#lcl.forms.GetParentForm">GetParentForm</link>
<link id="#lcl.forms.TCustomForm.CancelControl"/>
<link id="#lcl.forms.TCustomForm.DefaultControl">TCustomForm.DefaultControl</link>
</seealso>
</element>
<element name="TCustomButton.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overridden constructor for the class instance, and calls the inherited constructor on entry.
</p>
<p>
Create updates the internal component style and <var>ControlStyle</var> with values needed for the control. Create sets the default values for properties, including:
</p>
<dl>
<dt>Color</dt>
<dd>Set to clDefault or clBtnFace (depending on the platform or widgetset).</dd>
<dt>ParentColor</dt>
<dd>Set to False.</dd>
<dt>TabStop</dt>
<dd>Set to True.</dd>
<dt>Align</dt>
<dd>Set to alNone.</dd>
</dl>
<p>
Create calls <var>SetInitialBounds</var> using the height and width returned from <var>GetControlClassDefaultSize</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomButton.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomButton.Click">
<short>Handles a button click event for the control.</short>
<descr>
<p>
<var>Click</var> is an overridden method used to handle a button click event for the control.
</p>
<p>
Click uses the value in <var>ModalResult</var> to determine if the modal result for the button control is posted to the parent form. When ModalResult contains a value other than <var>mrNone</var>, it is stored in the ModalResult property in the parent form (when assigned).
</p>
<p>
Click calls the inherited method to signal other event handlers or an <var>Action</var> used for the control. <var>OnChange</var> is signalled first. <var>OnClick</var> is signalled if an Action is not in use, or the Action does not have an <var>OnExecute</var> event handler.
</p>
<p>
Click is called from <var>ExecuteDefaultAction</var> when the control is both <var>Active</var> and the <var>Default</var> button on the parent form. It is called from <var>ExecuteCancelAction</var> when the control is the <var>Cancel</var> button on the parent form. It is called from <var>DialogChar</var> when the accelerator key in <var>Shortcut</var> is handled for the control.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Click">TControl.Click</link>
</seealso>
</element>
<element name="TCustomButton.ExecuteDefaultAction">
<short>Performs the Click method if the control is an Active or a Default button.</short>
<descr>
<p>
<var>ExecuteDefaultAction</var> is an overridden method used to perform the <var>Click</var> method when the button control is <var>Active</var> or the <var>Default</var> button. No actions are performed in the method when both properties are set to <b>False</b>.
</p>
<p>
See <link id="TCustomButton.Click">Click</link> for more information about the actions performed in the method.
</p>
<p>
ExecuteDefaultAction is called when a <b>Return</b> (<b>VK_RETURN</b>) key is handled in the <var>Application</var> singleton for the ActiveDefaultControl in a Form.
</p>
</descr>
<seealso>
<link id="TCustomButton.Click"/>
<link id="TCustomButton.Active"/>
<link id="TCustomButton.Default"/>
<link id="#lcl.controls.TControl.ExecuteDefaultAction">TControl.ExecuteDefaultAction</link>
<link id="#lcl.forms.TApplication.DoReturnKey">TApplication.DoReturnKey</link>
</seealso>
</element>
<element name="TCustomButton.ExecuteCancelAction">
<short>Performs the Click method if the control is the Cancel button.</short>
<descr>
<p>
<var>ExecuteCancelAction</var> is an overridden method used to perform the <var>Click</var> method when the control is the <var>Cancel</var> button on its parent form. No actions are performed in the method when Cancel is set to <b>False</b>.
</p>
<p>
See <link id="TCustomButton.Click">Click</link> for more information about the actions performed in the method.
</p>
<p>
ExecuteCancelAction is called when an <b>Escape</b> (<b>VK_ESCAPE</b>) key is handled in the <var>Application</var> singleton for the CancelControl in a Form.
</p>
</descr>
<seealso>
<link id="TCustomButton.Click"/>
<link id="TCustomButton.Cancel"/>
<link id="#lcl.controls.TControl.ExecuteCancelAction">TControl.ExecuteCancelAction</link>
<link id="#lcl.forms.TApplication.DoEscapeKey">TApplication.DoEscapeKey</link>
</seealso>
</element>
<element name="TCustomButton.ActiveDefaultControlChanged">
<short>Updates the button and/or parent form when the active default control has been changed.</short>
<descr>
<p>
<var>ActiveDefaultControlChanged</var> is an overridden method used to update properties in the control and/or parent form when active default control has been changed. <var>NewControl</var> contains the control which is the <var>ActiveControl</var> given focus on the parent form, or <b>Nil</b> when a button control loses focus.
</p>
<p>
When NewControl is the current class instance, its Active property is set to True to reflect the active focused control status. The ActiveDefaultControl property in the parent form is set to the current control to indicate it is also the active default control for the form.
</p>
<p>
When NewControl is assigned, but a different control than the current instance, the button control is not focused and its Active property is set to False.
</p>
<p>
When NewControl is unassigned (<b>Nil</b>), the button control has just lost focus and Active is set to the value in the Default property. The control is also removed as the ActiveDefaultControl in the parent form (when needed).
</p>
<p>
ActiveDefaultControlChanged is called from the <var>UpdateFocus</var> method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.ActiveDefaultControlChanged">TControl.ActiveDefaultControlChanged</link>
</seealso>
</element>
<element name="TCustomButton.ActiveDefaultControlChanged.NewControl">
<short>New value assigned as the active default control in the parent form.</short>
</element>
<element name="TCustomButton.UpdateRolesForForm" link="#lcl.controls.TControl.UpdateRolesForForm"/>
<element name="TCustomButton.UseRightToLeftAlignment" link="#lcl.controls.TControl.UseRightToLeftAlignment"/>
<element name="TCustomButton.UseRightToLeftAlignment.Result">
<short>False; always uses center alignment.</short>
</element>
<element name="TCustomButton.Active">
<short>True if the control is the Cancel or Default button.</short>
<descr>
<p>
<var>Active</var> is a read-only <var>Boolean</var> property which indicates if the control is the active default control for the parent form.
</p>
<p>
The property value is updated in <var>ActiveDefaultControlChanged</var> when the focus for the control has been changed. It is set to <var>True</var> when the button gains focus and becomes the <var>ActiveDefaultControl</var> on the parent form. It is set to <var>False</var> when another control is set as the ActiveDefaultControl on the parent form. It is set to the value in the <var>Default</var> property when the ActiveDefaultControl is set to <b>Nil</b>.
</p>
</descr>
<seealso>
<link id="TCustomButton.ActiveDefaultControlChanged"/>
<link id="TCustomButton.Default"/>
<link id="#lcl.forms.TCustomForm.ActiveDefaultControl">TCustomForm.ActiveDefaultControl</link>
</seealso>
</element>
<element name="TCustomButton.Cancel">
<short>True if the button is the modal Cancel button.</short>
<descr>
<p>
<var>Cancel</var> is a <var>Boolean</var> property which indicates if the button is the modal Cancel button on a form. The default value for the property is <b>False</b>.
</p>
<p>
Setting a new value for the property causes the <var>CancelControl</var> in the parent form to be updated. When set to <b>True</b>, the CancelControl property in the parent form is set the current class instance. When set to the <b>False</b>, the form property is set to <b>Nil</b>.
</p>
<p>
No actions are performed in the method when <var>NewCancel</var> has the same value as the Cancel property, or the parent form has not been assigned.
</p>
<p>
The value in Cancel is automatically updated in methods like <var>UpdateRolesForForm</var> and <var>UpdateDefaultCancel</var>. The property value is used in <var>ExecuteCancelAction</var> to determine if the <var>Click</var> method can be called for the control.
</p>
<p>
Pressing <b>Escape (VK_ESCAPE)</b> in a modal form is equivalent to clicking on the Cancel button.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomButton.Color">
<short>Color used for the button face.</short>
<descr>
<p>
<var>Color</var> is a <var>TColor</var> property with color used for the surface (or face) on the button control. The default value for the property in <var>TCustomButton</var> is <var>clDefault</var> or <var>clBtnFace</var>, depending on the platform or widgetset.
</p>
<p>
Changes made to the Color for the control or its Font are ignored in TCustomButton. It is always drawn using the color(s) needed for the platform or widgetset.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
</seealso>
</element>
<element name="TCustomButton.Default">
<short>True if the button is the default button in a modal form.</short>
<descr>
<p>
<var>Default</var> is a <var>Boolean</var> property which indicates if the button can be used as the default button control on a form. Default is essentially a design-time setting that indicates an intent. At run-time, the default button is the ActiveDefaultControl on the form. The default value for the property is <b>False</b>.
</p>
<p>
Setting a new value for the property causes the button control to be assigned to the DefaultControl property in the parent form. The widgetset class is notified when the property value is set.
</p>
<p>
The value in Default is used in the CreateParams method to determine style flags included in the creation parameters for the control. It is used in ExecuteDefaultAction to determine if the Click method can be called for the control.
</p>
<p>
The value in Default is automatically updated in the UpdateRolesForForm method.
</p>
<p>
Pressing <b>Enter</b> in a modal form is equivalent to clicking on the Default button.
</p>
</descr>
</element>
<element name="TCustomButton.ModalResult">
<short>Value returned when the control is clicked in a modal form.</short>
<descr>
<p>
<var>ModalResult</var> is a <var>TModalResult</var> property used to provide the modal result value when the button control is clicked in a modal form.
</p>
<p>
The value in ModalResult is used in the Click method to update the ModalResult value in the parent form (when assigned). The default value for the property is mrNone, and indicates that the property value is not used as a modal result in the Click method.
</p>
<p>
By convention, the value in ModalResult is associated with the usage and caption for the button control. Common values and usage in ModalResult includes:
</p>
<dl>
<dt>mrNone</dt>
<dd>ModalResult is not used.</dd>
<dt>mrOK</dt>
<dd>The OK button was clicked.</dd>
<dt>mrCancel</dt>
<dd>The Cancel button was clicked.</dd>
<dt>mrAbort</dt>
<dd>The Abort button was clicked or the modal dialog was aborted.</dd>
<dt>mrRetry</dt>
<dd>The Retry button was clicked.</dd>
<dt>mrIgnore</dt>
<dd>The Ignore button was clicked.</dd>
<dt>mrYes</dt>
<dd>The Yes button was clicked.</dd>
<dt>mrNo</dt>
<dd>The No button was clicked.</dd>
<dt>mrAll</dt>
<dd>The All button was clicked.</dd>
<dt>mrNoToAll</dt>
<dd>The No To All button was clicked.</dd>
<dt>mrYesToAll</dt>
<dd>The Yes To All button was clicked.</dd>
<dt>mrClose</dt>
<dd>The Close button was clicked.</dd>
</dl>
</descr>
<seealso/>
</element>
<element name="TCustomButton.ParentColor">
<short>Indicates if the parent color is used to draw the control.</short>
<descr>
<p>
The default value for the property is <b>False</b> in <var>TCustomButton</var>. Changes to the property value are ignored in TCustomButton; the control is always drawn using the color(s) needed for the platform or widgetset.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
</seealso>
</element>
<element name="TCustomButton.ShortCut">
<short>Shortcut key for the control.</short>
<descr>
<p>
ShortCut is a TShortCut property with the primary shortcut key or accelerator key for the control. The property value contains both the virtual key code and the shift modifier for the short cut key.
</p>
<p>
The value in ShortCut is automatically updated when a caption is assigned for the control which includes an accelerator key. The accelerator key is designated using an Ampersand (&) character before the character used as the short cut. A value assigned in this manner always includes the ssCtrl modifier in the short cut value by default.
</p>
<p>
The property value (along with ShortcutKey2) is passed to the widgetset class when the WSSetText method is called.
</p>
<p>
Use the <var>ShortCut</var> and <var>ShortCutToKey</var> routines in the <file>menu.pp</file> unit to convert to and from virtual key codes with shift modifiers.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomButton.ShortCutKey2">
<short>Secondary shortcut key for the control.</short>
<descr>
<p>
ShortCutKey2 is a TShortCut property with the secondary shortcut key or accelerator key for the control. The property value contains both the virtual key code and the shift modifier for the short cut key. The property value (along with Shortcut) is passed to the widgetset class when the WSSetText method is called.
</p>
<p>
Use the <var>ShortCut</var> and <var>ShortCutToKey</var> routines in the <file>menu.pp</file> unit to convert to and from virtual key codes with shift modifiers.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomButton.TabStop">
<short>Enables navigation using the Tab key.</short>
<descr>
<p>
Allows the user to navigate to this control, by pressing the Tab key.
The default value for the property is True in TCustomButton.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.TabStop"/>
</seealso>
</element>
<element name="TButton">
<short>Implements a push button control.</short>
<descr>
<p>
<var>TButton</var> is a <var>TCustomButton</var> descendant which implements a push button control. TButton is used to perform an action when the control is clicked. An <var>OnClick</var> event handler is provided to perform actions needed when the push button is clicked. TButton provides support for the <var>TBasicAction</var> class defined in the FPC Run-time Library (RTL).
</p>
<p>
Properties are provided to control the appearance and behavior for the control. This includes whether it is the Default or Cancel button on a modal form, and the modal result returned when the push button is clicked.
</p>
<p>
The control displays a text-based caption and is drawn using a style appropriate for the platform or widgetset. An accelerator key can be defined in the caption which simulates clicking on the push button when the shortcut key is pressed.
</p>
<p>
Please note that the Caption in the control is always centered. The values in properties like BiDiMode and UseRightToLeftAlignment are ignored in the control.
</p>
<p>
Please note that the Color for the control defaults to the system-defined color used for button controls.
</p>
<p>
TButton sets the visibility for properties defined in the ancestor class, and does not introduce any new methods.
</p>
<p>
Use TBitBtn for a push button control which displays a bitmap instead of a text-based caption.
</p>
<p>
Use TSpeedButton for a push button control which can remain in the pressed or down state.
</p>
</descr>
<seealso>
<link id="TCustomButton"/>
</seealso>
</element>
<element name="TButton.Click" link="#lcl.controls.TControl.Click"/>
<element name="TButton.Action" link="#lcl.controls.TControl.Action"/>
<element name="TButton.Align" link="#lcl.controls.TControl.Align"/>
<element name="TButton.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TButton.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TButton.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TButton.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TButton.Cancel" link="#lcl.stdctrls.TCustomButton.Cancel"/>
<element name="TButton.Caption" link="#lcl.controls.TControl.Caption"/>
<element name="TButton.Color" link="#lcl.stdctrls.TCustomButton.Color"/>
<element name="TButton.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TButton.Default" link="#lcl.stdctrls.TCustomButton.Default"/>
<element name="TButton.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TButton.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TButton.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TButton.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TButton.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TButton.Font" link="#lcl.controls.TControl.Font"/>
<element name="TButton.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TButton.ModalResult" link="#lcl.stdctrls.TCustomButton.ModalResult"/>
<element name="TButton.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TButton.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TButton.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TButton.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TButton.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TButton.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TButton.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TButton.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TButton.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TButton.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TButton.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TButton.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TButton.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TButton.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TButton.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TButton.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TButton.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TButton.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TButton.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TButton.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TButton.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TButton.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TButton.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TButton.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TButton.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TButton.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TButton.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TButton.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TButton.TabStop" link="#lcl.stdctrls.TCustomButton.TabStop"/>
<element name="TButton.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TCheckBoxState">
<short>Represents the states for a check box.</short>
<descr>
<p>
<var>TCheckBoxState</var> is an enumerated type with values which represent the states for a check box control. TCheckBoxState is the type used to implement the <var>State</var> property in <var>TCustomCheckBox</var> and descendent classes.
</p>
</descr>
<seealso/>
</element>
<element name="TCheckBoxState.cbUnchecked">
<short>
The check box has no check mark, indicating that the item is not selected.
</short>
</element>
<element name="TCheckBoxState.cbChecked">
<short>
The check box has a check mark in it, indicating that the item is selected.
</short>
</element>
<element name="TCheckBoxState.cbGrayed">
<short>
The check box state cannot be changed by the user, or is disabled.
</short>
</element>
<element name="TCustomCheckBox">
<short>The base class for a check box component.</short>
<descr>
<p>
<var>TCustomCheckBox</var> is a <var>TButtonControl</var> descendant which specifies an interface used for a check box component. It is the common ancestor for <var>TCheckBox</var>, <var>TToggleBox</var>, <var>TRadioButton</var>, and <var>TDBCheckBox</var> descendants.
</p>
<p>
A check box control allows the user to choose the state for the control independent of other check box controls (unlike a radio button). TCustomCheckBox introduces the <var>State</var> property which contains the check, unchecked, or grayed state for the control. The <var>AllowGrayed</var> property indicates if the grayed state is allowed in the control; otherwise only checked and unchecked are used. The <var>Checked</var> property allows the value in State to be updated by setting a <var>Boolean</var> value that indicates the check or unchecked state for the control.
</p>
</descr>
<seealso>
<link id="TButtonControl"/>
<link id="TCheckBox"/>
<link id="TToggleBox"/>
<link id="TRadioButton"/>
<link id="#lcl.dbctrls.TDBCheckBox">TDBCheckBox</link>
</seealso>
</element>
<element name="TCustomCheckBox.FAllowGrayed" link="#lcl.stdctrls.TCustomCheckBox.AllowGrayed"/>
<element name="TCustomCheckBox.FState" link="#lcl.stdctrls.TCustomCheckBox.State"/>
<element name="TCustomCheckBox.FShortCut" link="#lcl.stdctrls.TCustomCheckBox.ShortCut"/>
<element name="TCustomCheckBox.FShortCutKey2" link="#lcl.stdctrls.TCustomCheckBox.ShortCutKey2"/>
<element name="TCustomCheckBox.SetState">
<short>Sets the value for the State property.</short>
<descr/>
<seealso>
<link id="TCustomCheckBox.State"/>
</seealso>
</element>
<element name="TCustomCheckBox.SetState.Value">
<short>New value for the State property.</short>
</element>
<element name="TCustomCheckBox.GetState">
<short>Gets the value for the State property.</short>
<descr/>
<seealso>
<link id="TCustomCheckBox.State"/>
</seealso>
</element>
<element name="TCustomCheckBox.GetState.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomCheckBox.DoChange">
<short>Handles the LM_CHANGED message for the control.</short>
<descr>
<p>
Performs either the <var>OnClick</var> or the <var>OnChange</var> event handler. Use <var>ClicksDisabled</var> is control the event handler signalled.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomCheckBox.DoChange.Msg">
<short>Message examined in the method.</short>
</element>
<element name="TCustomCheckBox.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomCheckBox.Click">
<short>Performs actions when the control is clicked.</short>
<descr>
<p>
Overridden in <var>TCustomCheckBox</var> to ignore mouse up event notifications.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.DoClickOnChange"/>
<link id="TButtonControl.ClicksDisabled"/>
<link id="#lcl.controls.TControl.Click">TControl.Click</link>
</seealso>
</element>
<element name="TCustomCheckBox.DoClickOnChange">
<short>Implements the Click behavior for the control.</short>
<descr>
<p>
<var>DoClickOnChange</var> is a procedure used to signal event handler(s) when the <b>LC_CHANGED</b> message is handled for the control. DoClickOnChange calls the <var>Changed</var> method to dispatch the control message. DoClickOnChange uses the value in <var>ClicksDisabled</var> to determine the event handler(s) signalled in the method.
</p>
<p>
When ClicksDisabled is <b>False</b>, the inherited <var>Click</var> method is called. When set to <b>True</b>, the <var>DoOnChange</var> method is called to signal the <var>OnEditingDone</var> and <var>OnChange</var> event handlers. This emulates the <var>OnClick</var> behavior in the Delphi VCL.
</p>
<p>
DoClickOnChange is called from the <var>DoChange</var> method after the value in <var>State</var> has been updated. It is also called when a new value is assigned to the <var>Checked</var> property.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.State"/>
<link id="TButtonControl.ClicksDisabled"/>
<link id="TButtonControl.Click"/>
<link id="TButtonControl.Checked"/>
<link id="TButtonControl.DoOnChange"/>
<link id="TButtonControl.OnChange"/>
<link id="#lcl.controls.TControl.Changed">TControl.Changed</link>
<link id="#lcl.controls.TControl.EditingDone">TControl.EditingDone</link>
<link id="#lcl.controls.TControl.OnEditingDone">TControl.OnEditingDone</link>
</seealso>
</element>
<element name="TCustomCheckBox.RetrieveState">
<short>Gets the checked state for the control from the widgetset class.</short>
<descr>
<p>
<var>RetrieveState</var> is a <var>TCheckBoxState</var> function used to get the checked, unchecked, or grayed state for the control from the widgetset class. Access to the widgetset class requires a valid handle in the control. If the handle has not been assigned, the return value is set to the existing value in the <var>State</var> member.
</p>
<p>
RetrieveState calls the RetrieveState method in the widgetset class to get the return value for the method.
</p>
<p>
RetrieveState is used to get the value for the <var>State</var> property. It is called from <var>DoChange</var> when the <var>LM_CHANGED</var> control message is handled for the control. It is also called when setting a new value for the <var>Checked</var> property.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomCheckBox.RetrieveState.Result">
<short>TCheckBoxState value returned from the widgetset class.</short>
</element>
<element name="TCustomCheckBox.InitializeWnd" link="#lcl.controls.TWinControl.InitializeWnd"/>
<element name="TCustomCheckBox.Toggle">
<short>Alternates between the checked and the unchecked state in the control.</short>
<descr>
<p>
Calls <var>GetChecked</var> to retrieve the current checked <var>State</var> for the control. Negates the value and calls <var>SetChecked</var> to store the toggled state value. Called from <var>DialogChar</var> when the accelerator key is handled for the focused control.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.DialogChar"/>
<link id="TCustomCheckBox.State"/>
<link id="TCustomCheckBox.GetChecked"/>
<link id="TCustomCheckBox.SetChecked"/>
<link id="TCustomCheckBox.ShortCut"/>
</seealso>
</element>
<element name="TCustomCheckBox.DialogChar">
<short>Implements support for accelerator keys in the control.</short>
<descr>
<p>
<var>DialogChar</var> is an overridden <var>Boolean</var> function in <var>TCustomCheckBox</var> which handles accelerator keys in messages for the control. The return value is set to <b>True</b> when the check box is successfully toggled in the method.
</p>
<p>
<var>Message</var> is the TLMKey instance with the key code examined in the method. When the key code matches the accelerator key in <var>Caption</var>, the control is focused and its <var>State</var> is toggled. If the control cannot be focused, or Message does not represent an accelerator key code, the inherited method is called to get the return value.
</p>
<p>
This method is called even if the control is disabled or hidden. Provided for Delphi VCL compatibility.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.DialogChar">TControl.DialogChar</link>
</seealso>
</element>
<element name="TCustomCheckBox.DialogChar.Result">
<short>True when the control state is toggled by the accelerator key.</short>
</element>
<element name="TCustomCheckBox.DialogChar.Message">
<short>Control message examined in the method.</short>
</element>
<element name="TCustomCheckBox.GetChecked">
<short>Gets the value for the Checked property.</short>
<descr/>
<seealso>
<link id="TCustomCheckBox.State"/>
<link id="TButtonControl.Checked"/>
</seealso>
</element>
<element name="TCustomCheckBox.GetChecked.Result">
<short>Value for the Checked property.</short>
</element>
<element name="TCustomCheckBox.SetChecked">
<short>Sets the value for the Checked property.</short>
<descr/>
<seealso>
<link id="TCustomCheckBox.State"/>
<link id="TButtonControl.Checked"/>
</seealso>
</element>
<element name="TCustomCheckBox.SetChecked.Value">
<short>New value for the Checked property.</short>
</element>
<element name="TCustomCheckBox.RealSetText" link="#lcl.controls.TControl.RealSetText"/>
<element name="TCustomCheckBox.RealSetText.Value">
<short>New value stored in the text/caption for the control.</short>
</element>
<element name="TCustomCheckBox.ApplyChanges">
<short>Sets the checked state in the widgetset class and redraws the control.</short>
<descr>
<p>
<var>ApplyChanges</var> is a method used to send a SetState message to the widgetset class to update the visual appearance for the control. No actions are performed in the method if a handle has not been allocated for the control, or during component streaming.
</p>
<p>
ApplyChanges is called when a new value is assigned to the <var>Checked</var> or <var>State</var> properties.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.State"/>
<link id="TButtonControl.Checked"/>
</seealso>
</element>
<element name="TCustomCheckBox.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomCheckBox.GetControlClassDefaultSize.Result">
<short>Size used for new instances of the class.</short>
</element>
<element name="TCustomCheckBox.Loaded">
<short>
Performs actions needed after the control is loaded using LCL component streaming.
</short>
<descr>
<p>
<var>Loaded</var> is an overridden method in <var>TCustomCheckBox</var>. Loaded ensures that the value in <var>State</var> is passed to the widgetset class when a handle has been allocated for the control. This prevents loss of the stored value in State during component streaming. The inherited method is called prior to exit.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.State"/>
<link id="#lcl.controls.TWinControl.Loaded">TWinControl.Loaded</link>
</seealso>
</element>
<element name="TCustomCheckBox.WSSetText" link="#lcl.controls.TWinControl.WSSetText"/>
<element name="TCustomCheckBox.WSSetText.AText">
<short>New value for Text.</short>
</element>
<element name="TCustomCheckBox.TextChanged">
<short>Performs actions needed when the CM_TEXTCHANGED message is handled for the control.</short>
<descr>
<p>
<var>TextChanged</var> is an overridden method in <var>TCustomCheckBox</var> used to perform actions needed when the <var>CM_TEXTCHANGED</var> control message is handled for the control.
</p>
<p>
TextChanged calls <var>InvalidatePreferredSize</var> to update the sizing flags for the control and its Parent. When <var>Parent</var> has been assigned and its <var>AutoSize</var> property is <b>True</b>, its <var>AdjustSize</var> method is called. The <var>AdjustSize</var> method in the control is called to resize the visible control.
</p>
<p>
TextChanged calls the inherited method prior to exit.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.TextChanged">TControl.TextChanged</link>
<link id="#lcl.controls.TControl.InvalidatePreferredSize">TControl.InvalidatePreferredSize</link>
<link id="#lcl.controls.TControl.AdjustSize">TControl.AdjustSize</link>
</seealso>
</element>
<element name="TCustomCheckBox.CreateParams" link="#lcl.controls.TWinControl.CreateParams"/>
<element name="TCustomCheckBox.CreateParams.Params">
<short>Creation parameters updated in the method.</short>
</element>
<element name="TCustomCheckBox.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. <var>TheOwner</var> is the owner for the new class instance. Create sets the default value for the <var>Alignment</var> property to <var>taRightJustify</var>. Create calls <var>SetInitialBounds</var> to set the initial control size to the values returned from the <var>GetControlClassDefaultSize</var> class method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomCheckBox.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomCheckBox.Alignment">
<short>Indicates the alignment for the caption text in the control.</short>
<descr>
<p>
<var>Alignment</var> is a <var>TLeftRight</var> property with the horizontal alignment for the caption text relative to the check box. The default value for the property is <var>taRightJustify</var>, and causes the text to be drawn to the right of the check box. Use <var>taLeftJustify</var> to draw the caption text in front of the check box.
</p>
<p>
Changing the value for the property causes the widgetset class to be updated when its <var>Handle</var> has been allocated.
</p>
<p>
The value in Alignment is used to set the creation parameters for the control.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.CreateParams"/>
<link id="#rtl.classes.TLeftRight">TLeftRight</link>
</seealso>
</element>
<element name="TCustomCheckBox.AllowGrayed">
<short>Allows the check box to use a "grayed" state.</short>
<descr>
<p>
If <var>AllowGrayed</var> is set to <b>True</b>, the check box has three possible states: checked, unchecked and grayed. If <var>AllowGrayed</var> is set to <b>False</b>, the check box has only two possible states: checked and unchecked.
</p>
</descr>
<example file="stdctrls/tcustomcheckbox_allowgrayed.pas"/>
</element>
<element name="TCustomCheckBox.State">
<short>The check, unchecked, or grayed state for the control.</short>
<descr>
<p>
Indicates whether the check box is checked (selected), unchecked (deselected) or grayed (disabled). See <var>TCheckBoxState</var> for the possible values in <var>State</var>.
</p>
</descr>
<seealso>
<link id="TCheckBoxState"/>
</seealso>
<example file="stdctrls/tcustomcheckbox_allowgrayed.pas"/>
</element>
<element name="TCustomCheckBox.ShortCut">
<short>Shortcut key for the control.</short>
<descr>
<p>
<var>ShortCut</var> is a <var>TShortCut</var> property with the primary shortcut key or accelerator key for the control. The property value contains both the virtual key code and the shift modifier for the short cut key.
</p>
<p>
The value in ShortCut is automatically updated when a caption is assigned for the control which includes an accelerator key. The accelerator key is designated using an Ampersand (&) character before the character used as the short cut. A value assigned in this manner always includes the ssCtrl modifier in the short cut value by default.
</p>
<p>
Use the <var>ShortCut</var> and <var>ShortCutToKey</var> routines in the <file>menu.pp</file> unit to convert to and from virtual key codes with shift modifiers.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomCheckBox.ShortCutKey2">
<short>Secondary shortcut key for the control.</short>
<descr>
<p>
<var>ShortCutKey2</var> is a <var>TShortCut</var> property with the secondary shortcut key or accelerator key for the control. The property value contains both the virtual key code and the shift modifier combined to form the short cut key.
</p>
<p>
The property value (along with Shortcut) is passed to the widgetst class when the WSSetText method is called.
</p>
<p>
Use the <var>ShortCut</var> and <var>ShortCutToKey</var> routines in the <file>menu.pp</file> unit to convert to and from virtual key codes with shift modifiers.
</p>
<remark>
ShortCutKey2 may not be implemented for all platforms supported in the LCL.
</remark>
</descr>
<seealso/>
</element>
<element name="TCustomCheckBox.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
<element name="TCustomCheckBox.OnChange" link="#lcl.stdctrls.TButtonControl.OnChange"/>
<element name="TCheckBox">
<short>A label with a box which can contain a check mark.</short>
<descr>
<p>
<var>TCheckBox</var> is a <var>TCustomCheckBox</var> descendant which implements a check box component. A check box control allows the user to choose the state for the control independent of other check box controls (unlike a radio button).
</p>
<p>
The <var>State</var> property contains the checked, unchecked, or grayed state for the control. The <var>AllowGrayed</var> property indicates if the grayed state is allowed in the control; otherwise only checked and unchecked are used. The <var>Checked</var> property allows the value in State to be updated by setting a <var>Boolean</var> value that indicates if the control is check or unchecked.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="TButtonControl"/>
<link id="TCustomCheckBox"/>
<link id="TToggleBox"/>
<link id="TRadioButton"/>
</seealso>
</element>
<element name="TCheckBox.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overridden constructor for the class instance, and calls the inherited method on entry. Creates sets the internal component style for the control to <var>csCheckbox</var>, and sets the default values for properties including <var>TabStop</var> (<b>True</b>) and <var>AutoSize</var> (<b>True</b>).
</p>
</descr>
<seealso/>
</element>
<element name="TCheckBox.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCheckBox.Action" link="#lcl.controls.TControl.Action"/>
<element name="TCheckBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TCheckBox.Alignment" link="#lcl.stdctrls.TCustomCheckBox.Alignment"/>
<element name="TCheckBox.AllowGrayed" link="#lcl.stdctrls.TCustomCheckBox.AllowGrayed"/>
<element name="TCheckBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TCheckBox.AutoSize">
<short>
Allows automatic adjustment of the size for the control, according to its content.
</short>
<descr>
<p>
The action performed depends on the control type. For example, a label or button can become bigger or smaller to accommodate a longer or shorter caption. The default value for the property is True in TCheckBox, and enables auto-sizing for the control instance.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
</seealso>
</element>
<element name="TCheckBox.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TCheckBox.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TCheckBox.Caption" link="#lcl.controls.TControl.Caption"/>
<element name="TCheckBox.Checked" link="#lcl.stdctrls.TButtonControl.Checked"/>
<element name="TCheckBox.Color" link="#lcl.controls.TControl.Color"/>
<element name="TCheckBox.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TCheckBox.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TCheckBox.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TCheckBox.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TCheckBox.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TCheckBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TCheckBox.Font" link="#lcl.controls.TControl.Font"/>
<element name="TCheckBox.Hint" link="#lcl.controls.TControl.Hint"/>
<element name="TCheckBox.OnChange" link="#lcl.stdctrls.TButtonControl.OnChange"/>
<element name="TCheckBox.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TCheckBox.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TCheckBox.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TCheckBox.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TCheckBox.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TCheckBox.OnEditingDone" link="#lcl.controls.TControl.OnEditingDone"/>
<element name="TCheckBox.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TCheckBox.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TCheckBox.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TCheckBox.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TCheckBox.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TCheckBox.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TCheckBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TCheckBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TCheckBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TCheckBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TCheckBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TCheckBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TCheckBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TCheckBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TCheckBox.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TCheckBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TCheckBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TCheckBox.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TCheckBox.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TCheckBox.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TCheckBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TCheckBox.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TCheckBox.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TCheckBox.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TCheckBox.State" link="#lcl.stdctrls.TCustomCheckBox.State"/>
<element name="TCheckBox.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TCheckBox.TabStop">
<short>Enables navigation using the Tab key.</short>
<descr>
<p>
Allows the user to navigate to this control, by pressing the Tab key.
The default value for the property is True in TCheckBox.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.TabStop">TWinControl.TabStop</link>
</seealso>
</element>
<element name="TCheckBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TToggleBox">
<short>A labelled box capable of being checked or unchecked.</short>
<descr>
<p>
<var>TToggleBox</var> is <var>TCustomCheckBox</var> descendant which implements a labelled control with state values like a check box control. TToggleBox differs from <var>TCheckBox</var> in that it displays only the <var>Caption</var> text for the control; the graphical check mark representation is not used. TToggleBox is similar in appearance to a push button control. The control state determines whether the button is drawn using its up or down position.
</p>
<p>
The programmer must ensure that the <var>OnClick</var> event handler recognizes the <var>State</var> of the control, takes the appropriate <var>Action</var>, and stores the <var>State</var> into the appropriate storage.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="TCustomCheckBox"/>
<link id="TCheckBox"/>
<link id="TButton"/>
</seealso>
</element>
<element name="TToggleBox.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TToggleBox.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TToggleBox.GetControlClassDefaultSize.Result">
<short>Bounds used for new instances of the class.</short>
</element>
<element name="TToggleBox.CreateParams" link="#lcl.controls.TWinControl.CreateParams"/>
<element name="TToggleBox.CreateParams.Params">
<short>Creation parameters with style flags updated in the method.</short>
</element>
<element name="TToggleBox.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TToggleBox.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overridden constructor for the class instance, and calls the inherited method using <var>TheOwner</var> as the owner for the new class instance. Create ensures that the internal component style for the control is set to <var>csToggleBox</var>, and sets the default values for the TabStop (<b>True</b>) and ParentColor (<b>False</b>) properties.
</p>
</descr>
<seealso/>
</element>
<element name="TToggleBox.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TToggleBox.AllowGrayed" link="#lcl.stdctrls.TCustomCheckBox.AllowGrayed"/>
<element name="TToggleBox.Align" link="#lcl.controls.TControl.Align"/>
<element name="TToggleBox.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TToggleBox.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TToggleBox.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TToggleBox.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TToggleBox.Caption" link="#lcl.controls.TControl.Caption"/>
<element name="TToggleBox.Checked" link="#lcl.stdctrls.TButtonControl.Checked"/>
<element name="TToggleBox.Color" link="#lcl.controls.TControl.Color"/>
<element name="TToggleBox.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TToggleBox.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TToggleBox.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TToggleBox.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TToggleBox.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TToggleBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TToggleBox.Font" link="#lcl.controls.TControl.Font"/>
<element name="TToggleBox.Hint" link="#lcl.controls.TControl.Hint"/>
<element name="TToggleBox.OnChange" link="#lcl.stdctrls.TButtonControl.OnChange"/>
<element name="TToggleBox.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TToggleBox.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TToggleBox.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TToggleBox.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TToggleBox.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TToggleBox.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TToggleBox.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TToggleBox.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TToggleBox.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TToggleBox.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TToggleBox.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TToggleBox.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TToggleBox.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TToggleBox.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TToggleBox.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TToggleBox.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TToggleBox.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TToggleBox.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TToggleBox.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TToggleBox.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TToggleBox.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TToggleBox.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TToggleBox.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TToggleBox.State" link="#lcl.stdctrls.TCustomCheckBox.State"/>
<element name="TToggleBox.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TToggleBox.TabStop">
<short>Enables navigation using the Tab key.</short>
<descr>
<p>
Allows the user to navigate to this control, by pressing the Tab key.
The default value for the property is True in TToggleBox.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.TabStop">TWinControl.TabStop</link>
</seealso>
</element>
<element name="TToggleBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TRadioButton">
<short>Implement a radio button control.</short>
<descr>
<p>
<var>TRadioButton</var> is a <var>TCustomCheckBox</var> descendant which implements a selection button that works with other radio buttons in a mutually exclusive way. If one radio button is selected, none of the others in the group can be selected.
</p>
<p>
Ensure that the <var>OnClick</var> event handler for each button has a unique <var>Action</var>, and that Actions for the other (deselected and therefore inactive) buttons are turned off.
</p>
<p>
<var>TRadioGroup</var> behaves differently from a group of <var>TRadioButton</var> controls placed on a form.
</p>
<p>
In the case of <var>TRadioButton</var>, the mutual exclusivity is a feature that applies to any <var>RadioButton</var> anywhere in the Form, and the <var>RadioButtons</var> can be rearranged in any order or placed anywhere within the containing <var>Form</var>, while in <var>TRadioGroup</var> the exclusivity applies only to buttons within the Group, which are ordered strictly according to their <var>ItemIndex</var> within the <var>Items</var> stringlist.
</p>
<p>
<var>TRadioButton</var> is an entity in itself, with a number of additional properties, whereas the buttons within <var>TRadioGroup</var> are not separate entities, but rather are simply entries in a list of strings, each of which is associated with the on-screen image of a <var>RadioButton</var>.
</p>
<p>
The example shows the difference between the use of <var>TRadioButton</var> and <var>TRadioGroup</var>.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="#lcl.extctrls.TRadioGroup">TRadioGroup</link>
</seealso>
<example file="extctrls/radiobutton.pas"/>
</element>
<element name="TRadioButton.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TRadioButton.ApplyChanges">
<short>Updates the state for sibling radio buttons in the parent.</short>
<descr>
<p>
<var>ApplyChanges</var> is an overridden method in <var>TRadioButton</var>. ApplyChanges ensures that other radio buttons in the <var>Parent</var> control are unchecked when the current class instance is <var>Checked</var>.
</p>
<p>
The siblings controls are normally unchecked by methods in the widgetset class. ApplyChanges performs the actions needed when a handle has not been allocated for the control (widgetset class). This involves iterating over the controls in Parent, and setting the Checked state for sibling TRadioButton instances to <b>False</b>.
</p>
<p>
ApplyChanges is called when the value in the <var>State</var> property is changed.
</p>
</descr>
<seealso>
<link id="TRadioButton.Checked"/>
<link id="TCustomCheckBox.State"/>
<link id="TCustomCheckBox.ApplyChanges"/>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
</seealso>
</element>
<element name="TRadioButton.DialogChar">
<short>Implements support for an accelerator key in the control.</short>
<descr>
<p>
<var>DialogChar</var> is an overridden <var>Boolean</var> function in <var>TRadioButton</var> which handles accelerator keys in messages for the control. The return value is set to <b>True</b> when the radio button is successfully toggled in the method.
</p>
<p>
<var>Message</var> is the TLMKey instance with the key code examined in the method. When the key code matches the accelerator key in <var>Caption</var>, the control is focused and the return value is set to True. If the control cannot be focused, or Message does not represent an accelerator key code, the inherited method is called to get the return value.
</p>
<p>
This method is called even if the control is disabled or hidden. Provided for Delphi VCL compatibility.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.DialogChar"/>
</seealso>
</element>
<element name="TRadioButton.DialogChar.Result">
<short>True when the message is handled and the control is focused.</short>
</element>
<element name="TRadioButton.DialogChar.Message">
<short>Message examined for the accelerator key.</short>
</element>
<element name="TRadioButton.RealSetText">
<short>Sets the value for the text and/or caption in the control.</short>
<descr>
<p>
<var>RealSetText</var> is an overridden method used to set value for the control using the <var>TCaption</var> instance in <var>Value</var>. In TRadioButton, the method ensures that the value in the caption is updated and that the control size is invalidated and adjusted using auto-sizing.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.RealSetText"/>
</seealso>
</element>
<element name="TRadioButton.RealSetText.Value">
<short>New value for the control.</short>
</element>
<element name="TRadioButton.DoClickOnChange">
<short>Performs actions needed when the control has been changed using a mouse click.</short>
<descr>
<p>
<var>DoClickOnChange</var> is an overridden method used to signal an <var>OnChange</var> event handler when the mouse is clicked on the control. DoClickOnChange ensures the value in <var>TabStop</var> is updated to reflect the <var>State</var> for the control. When State contains <var>cbChecked</var>, TabStop is set to <b>True</b>. Otherwise, it is set to <b>False</b>.
</p>
<p>
DoClickOnChange also ensures that the correct click/change behavior is used for the current control State. If the control is Checked, the inherited DoClickOnChange method is called. This also emulates the Delphi Click behavior where the <var>OnChange</var> event handler is signalled when <var>ClicksDisabled</var> is <b>True</b>. When the control is not Checked, the <var>DoOnChange</var> method is called to signal both the <var>OnEditingDone</var> and <var>OnChange</var> event handlers.
</p>
<p>
DoClickOnChange is called from the <var>DoChange</var> method in the <var>TCustomCheckBox</var> ancestor class.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.DoClickOnChange"/>
<link id="TButtonControl.DoOnChange"/>
</seealso>
</element>
<element name="TRadioButton.CreateParams">
<short>Initializes the creation parameters for the class instance.</short>
<descr>
<p>
<var>CreateParams</var> is an overridden method used to update creation parameters for the class instance, and calls the inherited method on entry. CreateParams ensures that <var>Style</var> flags in the <var>Params</var> argument are updated to include the <var>BS_RADIOBUTTON</var> style flag, and to exclude the <var>BS_3STATE</var> style flag.
</p>
</descr>
<seealso>
<link id="TCustomCheckBox.CreateParams"/>
</seealso>
</element>
<element name="TRadioButton.CreateParams.Params">
<short>Creation parameters updated in the method.</short>
</element>
<element name="TRadioButton.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 constructor on entry. Create ensures that the <var>csRadioButton</var> style flag is included in the component style flags for the control. The default value for the <var>AutoSize</var> property is set to <b>True</b>.
</p>
</descr>
<seealso/>
</element>
<element name="TRadioButton.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TRadioButton.Align" link="#lcl.controls.TControl.Align"/>
<element name="TRadioButton.Alignment" link="#lcl.stdctrls.TCustomCheckBox.Alignment"/>
<element name="TRadioButton.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TRadioButton.AutoSize">
<short>Enables or disables auto-sizing the control to its content.</short>
<descr>
<p>
The default value for the property is <b>True</b> in <var>TRadioButton</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
</seealso>
</element>
<element name="TRadioButton.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TRadioButton.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TRadioButton.Caption" link="#lcl.controls.TControl.Caption"/>
<element name="TRadioButton.Checked" link="#lcl.stdctrls.TButtonControl.Checked"/>
<element name="TRadioButton.Color" link="#lcl.controls.TControl.Color"/>
<element name="TRadioButton.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TRadioButton.DoubleBuffered" link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TRadioButton.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TRadioButton.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TRadioButton.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TRadioButton.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TRadioButton.Font" link="#lcl.controls.TControl.Font"/>
<element name="TRadioButton.Hint" link="#lcl.controls.TControl.Hint"/>
<element name="TRadioButton.OnChange" link="#lcl.stdctrls.TButtonControl.OnChange"/>
<element name="TRadioButton.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TRadioButton.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TRadioButton.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TRadioButton.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TRadioButton.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TRadioButton.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TRadioButton.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TRadioButton.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TRadioButton.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TRadioButton.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TRadioButton.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TRadioButton.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TRadioButton.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TRadioButton.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TRadioButton.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TRadioButton.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TRadioButton.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TRadioButton.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TRadioButton.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TRadioButton.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TRadioButton.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TRadioButton.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TRadioButton.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TRadioButton.ParentDoubleBuffered" link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TRadioButton.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TRadioButton.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TRadioButton.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TRadioButton.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TRadioButton.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TRadioButton.TabStop">
<short>Enables navigation using the Tab key.</short>
<descr>
<p>
Allows the user to navigate to this control, by pressing the Tab key.
The default value for the property is True in TRadioButton.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.TabStop">TWinControl.TabStop</link>
</seealso>
</element>
<element name="TRadioButton.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TCustomLabel">
<short>Control used to show static text optionally using multiple lines.</short>
<descr>
<p>
<var>TCustomLabel</var> is a <var>TWinControl</var> descendant which specifies a control to display static text on a form. The value in the control is not editable visually, and can be used to label or describe another control or a container on the form. Since it cannot be edited, it is not allowed to receive the input focus. It can, however, be used to set focus to an associated control using an accelerator key defined in the Caption for the control.
</p>
<p>
TCustomLabel is the ancestor class for <var>TLabel</var>. Do not create instances of TCustomLabel; use the TLabel descendant.
</p>
<p>
Use TStaticText to display static text and respond to keyboard input directly in the control.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="TLabel"/>
<link id="TStaticText"/>
<link id="#lcl.controls.TWinControl">TWinControl</link>
</seealso>
</element>
<element name="TCustomLabel.FAlignment" link="#lcl.stdctrls.TCustomLabel.Alignment"/>
<element name="TCustomLabel.FFocusControl" link="#lcl.stdctrls.TCustomLabel.FocusControl"/>
<element name="TCustomLabel.FOptimalFill" link="#lcl.stdctrls.TCustomLabel.OptimalFill"/>
<element name="TCustomLabel.FShowAccelChar" link="#lcl.stdctrls.TCustomLabel.ShowAccelChar"/>
<element name="TCustomLabel.FWordWrap" link="#lcl.stdctrls.TCustomLabel.WordWrap"/>
<element name="TCustomLabel.FLayout" link="#lcl.stdctrls.TCustomLabel.Layout"/>
<element name="TCustomLabel.FInternalSetBounds"/>
<element name="TCustomLabel.SetAlignment">
<short>Sets the value for the Alignment property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.Alignment"/>
</seealso>
</element>
<element name="TCustomLabel.SetAlignment.Value">
<short>New value for the Alignment property.</short>
</element>
<element name="TCustomLabel.SetOptimalFill">
<short>Sets the value for the OptimalFill property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.OptimalFill"/>
</seealso>
</element>
<element name="TCustomLabel.SetOptimalFill.AValue">
<short>New value for the OptimalFill property.</short>
</element>
<element name="TCustomLabel.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomLabel.CanTab">
<short>Always False, since you cannot tab into a label control.</short>
<descr>
<p>
<var>CanTab</var> is an overridden method in <var>TCustomLabel</var>. The return value is always <b>False</b> since the <b>Tab</b> key cannot be used to give focus to the control.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.CanTab">TControl.CanTab</link>
</seealso>
</element>
<element name="TCustomLabel.CanTab.Result">
<short>Always False in TCustomLabel.</short>
</element>
<element name="TCustomLabel.DoDrawText">
<short>Performs actions needed to draw the text for the label.</short>
<descr>
<p>
<var>DoDrawText</var> performs action needed to draw the text for the label.
</p>
<p>
The <var>GetLabelText</var> method is called to get the text value drawn in the method.
</p>
<p>
The <var>Font</var> color may be temporarily changed when when the <var>Enabled</var> property is <b>False</b>. If themes are enabled, the Font color is set to <var>clGrayText</var>. When themes are not enabled, the Font color is set to <var>clBtnHighlight</var>. The original Font color is restored prior to exiting the method.
</p>
<p>
DoDrawText calls the <var>DrawText</var> routine to draw the text on the <var>Canvas</var> using the text rectangle and flags passed as arguments. DrawText is called a second time to render the shadow for the label text when themes are not enabled. The shadow text uses the color <var>clBtnShadow</var>.
</p>
<p>
DoDrawText is called from the <var>Paint</var> method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomLabel.DoDrawText.Rect">
<short>Text rectangle used to draw the label text.</short>
</element>
<element name="TCustomLabel.DoDrawText.Flags">
<short>DrawText flags used to render the text.</short>
</element>
<element name="TCustomLabel.HasMultiLine">
<short>Checks for CR or LF characters in the label text for the control.</short>
<descr>
<p>
<var>HasMultiLine</var> is a <var>Boolean</var> function used to determine if <b>CR</b> (Carriage Return, Decimal 13) or <b>LF</b> (LineFeed, Decimal 10) characters are included in the text for the control. HasMultiLine calls GetLabelText to get the text stored in the label.
</p>
<p>
The return value is <b>True</b> when either character occurs in the text for the label.
</p>
<p>
HasMultiLine is used in the <var>CalculateSize</var> method to determine whether the <var>DT_SINGLELINE</var> flag is included in the drawing flags for the control.
</p>
</descr>
<seealso>
<link id="TCustomLabel.CalculateSize"/>
<link id="TCustomLabel.GetLabelText"/>
<link id="#lcl.lcltype.DT_SINGLELINE">DT_SINGLELINE</link>
</seealso>
</element>
<element name="TCustomLabel.HasMultiLine.Result">
<short>True when CR or LF characters are used in the text for the label.</short>
</element>
<element name="TCustomLabel.CalculatePreferredSize">
<short>Calculates the preferred size for the control using its anchoring and constraints.</short>
<descr>
<p>
<var>CalculatePreferredSize</var> is an overridden method used to calculated the preferred size for the control. Values stored in the <var>Anchors</var>, <var>Constraints</var>, and <var>WordWrap</var> properties are used to determine the effective width for the control. CalculateSize is called to calculate the text rectangle for the control using the requested dimensions.
</p>
<p>
CalculatePreferredSize checks the assigned <var>Font</var> for the control to determine whether text rotation is used in its <var>Orientation</var> property. When a value other than <b>0</b> (<b>zero</b>) is used, the text rectangle is rotated by the number of radians needed for the property value. The values in <var>PreferredWidth</var> and <var>PreferredHeight</var> are updated for the new text rectangle.
</p>
<p>
No actions are performed in the method if <var>Parent</var> has not been assigned (contains Nil), or when a handle has not been allocated in the Parent control.
</p>
<p>
Please note: CalculatePreferredSize does <b>not</b> call the inherited method.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.CalculatePreferredSize">TControl.CalculatePreferredSize</link>
</seealso>
</element>
<element name="TCustomLabel.CalculatePreferredSize.PreferredWidth">
<short>Preferred width calculated for the control.</short>
</element>
<element name="TCustomLabel.CalculatePreferredSize.PreferredHeight">
<short>Preferred height calculated for the control.</short>
</element>
<element name="TCustomLabel.CalculatePreferredSize.WithThemeSpace">
<short>True to reserve space for theme element details.</short>
</element>
<element name="TCustomLabel.CalculateSize">
<short>Gets the height and width needed for the label text.</short>
<descr>
<p>
Calculates the size for the label text using the formatting defined in related property values.
</p>
<p>
<var>NeededWidth</var> and <var>NeededHeight</var> are variable parameters updated in the method to reflect the values needed after applying DrawText flags to the label text. The DrawText flags include constants which represent the following properties:
</p>
<ul>
<li>WordWrap</li>
<li>HasMultiLine</li>
<li>ShowAccelChar</li>
<li>UseRightToLeftReading</li>
</ul>
<p>
The following constants are also used in the DrawText flags:
</p>
<ul>
<li>DT_CALCRECT</li>
<li>DT_EXPANDTABS</li>
<li>DT_NOCLIP</li>
</ul>
</descr>
<seealso/>
</element>
<element name="TCustomLabel.CalculateSize.MaxWidth">
<short>Maximum width for the text rectangle in the label.</short>
</element>
<element name="TCustomLabel.CalculateSize.NeededWidth">
<short>Width needed for the text.</short>
</element>
<element name="TCustomLabel.CalculateSize.NeededHeight">
<short>Height needed for the text.</short>
</element>
<element name="TCustomLabel.DoAutoSize" link="#lcl.controls.TControl.DoAutoSize"/>
<element name="TCustomLabel.DialogChar" link="#lcl.controls.TControl.DialogChar">
<short>Handles an accelerator key for the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomLabel.DialogChar.Result">
<short>True when the message is handled as an accelerator key.</short>
</element>
<element name="TCustomLabel.DialogChar.Message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomLabel.TextChanged" link="#lcl.controls.TControl.TextChanged">
<short>Performs actions when the CM_TEXTCHANGED message is handled for the control.</short>
<descr>
<p>
<var>TextChanged</var> is an overridden method used to perform actions needed when the <var>CM_TEXTCHANGED</var> message is handled for the control. TextChanged calls <var>Invalidate</var> to force the control to be redrawn. <var>UpdateSize</var> is called to perform auto-sizing, and recalculate the dimensions for the control and its font.
</p>
<p>
TextChanged does <b>not</b> calls the inherited method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomLabel.DoSetBounds">
<short>Performs a bounds change for the control.</short>
<descr>
<p>
<var>DoSetBounds</var> is an overridden method in <var>TCustomLabel</var>. It calls the inherited method to store the values in ALeft, ATop, AWidth, and AHeight to the corresponding properties in the control. Values in <var>OptimalFill</var>, <var>WordWrap</var>, and <var>Autosize</var> are used to determine if additional actions are needed for the bounds change.
</p>
<p>
When <var>OptimalFill</var> is <b>True</b> and <var>AutoSize</var> is <b>False</b>, the <var>AdjustFontForOptimalFill</var> method is called. If <var>Width</var> was changed and <var>WordWrap</var> is <b>True</b>, both the <var>InvalidatePreferredSize</var> and <var>AdjustSize</var> methods are called.
</p>
<p>
DoSetBounds is called from the <var>ChangeBounds</var> method in an ancestor class.
</p>
</descr>
<seealso>
<link id="TCustomLabel.OptimalFill"/>
<link id="TCustomLabel.AutoSize"/>
<link id="TCustomLabel.WordWrap"/>
<link id="TCustomLabel.AdjustFontForOptimalFill"/>
<link id="#lcl.controls.TControl.DoSetBounds">TControl.DoSetBounds</link>
</seealso>
</element>
<element name="TCustomLabel.DoSetBounds.ALeft">
<short>New value for the Left property.</short>
</element>
<element name="TCustomLabel.DoSetBounds.ATop">
<short>New value for the Top property.</short>
</element>
<element name="TCustomLabel.DoSetBounds.AWidth">
<short>New value for the Width property.</short>
</element>
<element name="TCustomLabel.DoSetBounds.AHeight">
<short>New value for the Height property.</short>
</element>
<element name="TCustomLabel.FontChanged">
<short>Implements the OnChange event handler for the Font in the control.</short>
<descr>
<p>
<var>FontChanged</var> is an overridden method in <var>TCustomLabel</var> which implements the <var>OnChange</var> event handler for the <var>Font</var> in the control. FontChanged calls the inherited method on entry, and calls <var>UpdateSize</var> to resize the control for any changes to font properties.
</p>
</descr>
<seealso>
<link id="TCustomLabel.UpdateSize"/>
<link id="#lcl.controls.TControl.FontChanged">TControl.FontChanged</link>
<link id="#lcl.graphics.TFont">TFont</link>
</seealso>
</element>
<element name="TCustomLabel.FontChanged.Sender">
<short>Object for the event notification.</short>
</element>
<element name="TCustomLabel.GetControlClassDefaultSize">
<short>Gets the size used for new instances of the class.</short>
<descr>
<p>
<var>GetControlClassDefaultSize</var> is an overridden <var>TSize</var> class function used to get the height and width for new instances of the control. GetControlClassDefaultSize uses 65 pixels for the width, and 17 pixels for the height.
</p>
<p>
The return value is the TSize instance where the values are stored; the <var>CX</var> member is used for the width and the <var>CY</var> member is used for the height.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
</seealso>
</element>
<element name="TCustomLabel.GetControlClassDefaultSize.Result">
<short>Size used for new instances of the class.</short>
</element>
<element name="TCustomLabel.WMActivate">
<short>Defers the focus to the control in the FocusControl property.</short>
<descr>
<p>
<var>WMActivate</var> is a procedure used to handle <b>LM_ACTIVATE</b> messages for the control.
</p>
<p>
WMActivate ensures that the control in the <var>FocusControl</var> property receives the input focus by calling its <var>SetFocus</var> method. No actions are performed in the method when FocusControl has not been assigned (contains <b>Nil</b>) or its <var>CanFocus</var> method returns <b>False</b>.
</p>
</descr>
<seealso>
<link id="TCustomLabel.FocusControl"/>
<link id="#lcl.controls.TWinControl.CanFocus">TWinControl.CanFocus</link>
<link id="#lcl.controls.TWinControl.SetFocus">TWinControl.SetFocus</link>
</seealso>
</element>
<element name="TCustomLabel.WMActivate.Message">
<short>Message examined in the method.</short>
</element>
<element name="TCustomLabel.Notification">
<short>
Handles a notification that a component used in the control has been added or removed.
</short>
<descr>
<p>
<var>Notification</var> is an overridden method in <var>TCustomLabel</var>, and calls the inherited method on entry. Notification ensures that <var>FocusControl</var> is set to <b>Nil</b> when it is the component for the <var>opRemove</var> <var>Operation</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Notification">TControl.Notification</link>
</seealso>
</element>
<element name="TCustomLabel.Notification.AComponent">
<short>Component for the notification.</short>
</element>
<element name="TCustomLabel.Notification.Operation">
<short>Operation for the notification.</short>
</element>
<element name="TCustomLabel.GetLabelText">
<short>Returns the string value in the Caption for the control.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
</seealso>
</element>
<element name="TCustomLabel.GetLabelText.Result">
<short>Text displayed in the control.</short>
</element>
<element name="TCustomLabel.GetTransparent">
<short>Gets the value for the Transparent property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.Transparent"/>
</seealso>
</element>
<element name="TCustomLabel.GetTransparent.Result">
<short>Value for the Transparent property.</short>
</element>
<element name="TCustomLabel.SetColor">
<short>Sets the value for the Color property.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TControl.SetColor">TControl.SetColor</link>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
</seealso>
</element>
<element name="TCustomLabel.SetColor.NewColor">
<short>New value for the Color property.</short>
</element>
<element name="TCustomLabel.SetFocusControl">
<short>Sets the value for the FocusControl property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.FocusControl"/>
</seealso>
</element>
<element name="TCustomLabel.SetFocusControl.Value">
<short>New value for the FocusControl property.</short>
</element>
<element name="TCustomLabel.SetLayout">
<short>Sets the value for the Layout property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.Layout"/>
</seealso>
</element>
<element name="TCustomLabel.SetLayout.Value">
<short>New value for the Layout property.</short>
</element>
<element name="TCustomLabel.SetShowAccelChar">
<short>Sets the value for the ShowAccelChar property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.ShowAccelChar"/>
</seealso>
</element>
<element name="TCustomLabel.SetShowAccelChar.Value">
<short>New value for the ShowAccelChar property.</short>
</element>
<element name="TCustomLabel.SetTransparent">
<short>Sets the value for the Transparent property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.Transparent"/>
</seealso>
</element>
<element name="TCustomLabel.SetTransparent.NewTransparent">
<short>New value for the Transparent property.</short>
</element>
<element name="TCustomLabel.SetWordWrap">
<short>Sets the value for the WordWrap property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.WordWrap"/>
</seealso>
</element>
<element name="TCustomLabel.SetWordWrap.Value">
<short>New value for the WordWrap property.</short>
</element>
<element name="TCustomLabel.Loaded">
<short>Performs actions when the component has been loaded using LCL component streaming.</short>
<descr>
<p>
<var>Loaded</var> is overridden in <var>TCustomLabel</var>, and calls the inherited method on Entry. Loaded calls the <var>AdjustSize</var> method to handle delayed calls to <var>AutoSize</var> during component streaming.
</p>
</descr>
<seealso>
<link id="TCustomLabel.AutoSize"/>
<link id="#lcl.controls.TControl.Loaded">TControl.Loaded</link>
<link id="#lcl.controls.TControl.AdjustSize">TControl.AdjustSize</link>
<link id="#lcl.controls.TControl.AutoSizeDelayed">TControl.AutoSizeDelayed</link>
</seealso>
</element>
<element name="TCustomLabel.UpdateSize">
<short>Adjusts the size for the control based on settings in AutoSize and OptimalFill.</short>
<descr>
<p>
<var>UpdateSize</var> is a method used to adjust the size for the control based on settings in the <var>AutoSize</var> and <var>OptimalFill</var> properties. UpdateSize calls <var>InvalidatePreferredSize</var>.
</p>
<p>
When <var>OptimalFill</var> is <b>True</b> and <var>AutoSize</var> is <b>False</b>, the <var>AdjustFontForOptimalFill</var> method is called to adjust the font size used in the control. <var>AdjustSize</var> is called to resize the control (and any parent controls). When <var>Alignment</var> is set to <var>taRightJustify</var>, the value in <var>Left</var> may be changed to reflect the new <var>Width</var> for the control.
</p>
<p>
UpdateSize is called from the implementation of the <var>FontChanged</var> and <var>TextChanged</var> methods, and when setting a new value for the <var>ShowAccelChar</var> or <var>WordWrap</var> properties.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomLabel.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 constructor on entry to the method.
</p>
<p>
Create updates the values in <var>ControlStyle</var> to enable mouse capture and both click and double-click events. Create calls <var>SetInitialBounds</var> using the default dimensions for the class instance. Create sets the default values for properties, including: <var>ShowAccelChar</var>, <var>Color</var>, <var>AutoSize</var>, and <var>AccessibleRole</var>.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomLabel.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomLabel.CalcFittingFontHeight">
<short>Calculates the font height needed to fill the specified width and height constraints.</short>
<descr>
<p>
<var>CalcFittingFontHeight</var> is a <var>Boolean</var> function used to calculate the maximum font height needed to make the specified string fill the available space, given the MaxWidth and MaxHeight constraints.
</p>
<p>
The return value is <b>True</b> when the text rectangle using the new font height fits within the size constraints in MaxWidth and MaxHeight. NeedWidth and NeedHeight are set to the values indicated in the text rectangle. The return value is <b>False</b> when the text rectangle is either too wide or too tall, or cannot be calculated using the specified parameter values.
</p>
<p>
No actions are performed in the method when AutoSizeDelayed is set to <b>True</b>, when TheText is an empty string, or when MaxHeight or MaxWidth contain 0 or a negative value.
</p>
<p>
The font height is calculated using a temporary TFont instance with the current Font for the control, setting its drawing flags to calculate the text rectangle. The drawing flags include wrapping when the WordWrap property is set to <b>True</b>. The font height is incrementally increased or decreased until the maximum font height which fits with MaxHeight and MaxWidth is determined.
</p>
<p>
CalcFittingFontHeight is used in the implementation of the <var>AdjustFontForOptimalFill</var> method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.Result">
<short>True when the text fits within the size constraints in MaxWidth and MaxHeight.</short>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.TheText">
<short>Text measured in the method.</short>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.MaxWidth">
<short>Width constraint for the text rectangle.</short>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.MaxHeight">
<short>Height constraint for the text rectangle.</short>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.FontHeight">
<short>Font height calculated in the method.</short>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.NeededWidth">
<short>Width needed for the text using the calculated font size.</short>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.NeededHeight">
<short>Height needed for the text using the calculated font size.</short>
</element>
<element name="TCustomLabel.ColorIsStored">
<short>Implements the storage specifier for the Color property.</short>
<descr/>
<seealso>
<link id="TCustomLabel.Color"/>
</seealso>
</element>
<element name="TCustomLabel.ColorIsStored.Result">
<short>True when a value other than clNone has been assigned to the Color property.</short>
</element>
<element name="TCustomLabel.AdjustFontForOptimalFill">
<short>Adjusts the font height for the control text to fill the available client area.</short>
<descr>
<p>
<var>AdjustFontForOptimalFill</var> is a <var>Boolean</var> function used to adjust the font height so that text in the label expands to fill the available client area for the control. AdjustFontForOptimalFill calls <var>CalcFittingFontHeight</var> to determine the font height needed to make the label text (caption) fill the Width for the control. The calculated font height is stored in the <var>Font</var> property.
</p>
<p>
The return value is <b>True</b> when the Font height was changed in the method.
</p>
<p>
AdjustFontForOptimalFill is called from <var>DoSetBounds</var> and <var>UpdateSize</var> when <var>OptimalFill</var> is set to <b>True</b> and <var>AutoSize</var> is set to <b>False</b>. It is also called when a new value is assigned to the <var>OptimalFill</var> property.
</p>
</descr>
<seealso>
<link id="TCustomLabel.CalcFittingFontHeight"/>
<link id="TCustomLabel.OptimalFill"/>
<link id="TCustomLabel.AutoSize"/>
<link id="TCustomLabel.UpdateSize"/>
<link id="TCustomLabel.DoSetBounds"/>
<link id="#lcl.controls.TControl.Font">TControl.Font</link>
</seealso>
</element>
<element name="TCustomLabel.AdjustFontForOptimalFill.Result">
<short>True when the font height was changed in the method.</short>
</element>
<element name="TCustomLabel.Paint">
<short>Performs actions needed to draw the control on its Canvas.</short>
<descr>
<p>
<var>Paint</var> is an overridden method in <var>TCustomLabel</var> used to draw the control on its <var>Canvas</var>. Paint ensures that property values in the control are applied to the Canvas before measuring and drawing its Text, including:
</p>
<ul>
<li>AutoSize</li>
<li>Alignment</li>
<li>Layout</li>
<li>WordWrap</li>
<li>Transparent</li>
<li>Color</li>
<li>Font</li>
<li>ShowAccel</li>
<li>Enabled</li>
<li>Alignment</li>
<li>UseRightToLeftAlignment</li>
<li>UseRightToLeftReading</li>
</ul>
<p>
DoDrawText is called to render the label text using the DrawText flags needed for the property values.
</p>
<remark>
Paint does <b>not</b> call the inherited method in <var>TGraphicControl</var>. As a result, it does not signal the <var>OnPaint</var> event handler in the ancestor class.
</remark>
</descr>
<seealso>
<link id="TCustomLabel.GetLabelText"/>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
<link id="#lcl.controls.TGraphicControl.Canvas">TGraphicControl.Canvas</link>
<link id="#lcl.controls.TGraphicControl.Paint">TGraphicControl.Paint</link>
<link id="#lcl.controls.TGraphicControl.OnPaint">TGraphicControl.OnPaint</link>
</seealso>
</element>
<element name="TCustomLabel.SetBounds">
<short>Sets the bounds (Top, Left, Width, Height) for the control.</short>
<descr>
<p>
Overridden to call <var>InvalidatePreferredSize</var> the first time the method is used and both <var>AutoSize</var> and <var>WordWrap</var> are enabled in the control. Calls the inherited method prior to exit.
</p>
</descr>
<seealso>
<link id="TCustomLabel.AutoSize"/>
<link id="TCustomLabel.WordWrap"/>
<link id="#lcl.controls.TControl.InvalidatePreferredSize">TControl.InvalidatePreferredSize</link>
<link id="#lcl.controls.TControl.SetBounds">TControl.SetBounds</link>
</seealso>
</element>
<element name="TCustomLabel.SetBounds.aLeft">
<short>Horizontal coordinate for the left-hand edge of the control.</short>
</element>
<element name="TCustomLabel.SetBounds.aTop">
<short>Vertical coordinate for the top edge of the control.</short>
</element>
<element name="TCustomLabel.SetBounds.aWidth">
<short>New width for the control.</short>
</element>
<element name="TCustomLabel.SetBounds.aHeight">
<short>New Height for the control.</short>
</element>
<element name="TCustomLabel.Alignment">
<short>Horizontal text justification in the control (centered, left- or right-justified).</short>
<descr>
<p>
<var>Alignment</var> is a <var>TAlignment</var> property which controls the horizontal justification of the text displayed in the control. The default value for the property is <var>taLeftJustify</var>. When a new value is assigned to the Alignment property, the <var>Invalidate</var> method is called to repaint the control.
</p>
<p>
Alignment (and other properties) are used in the <var>Paint</var> method when the text is rendered to the <var>Canvas</var> for the control. It is also used in <var>UpdateSize</var> when right alignment needs to be considered for an auto-sized or optimal-filled control.
</p>
<p>
Use the <var>Layout</var> property to control the vertical alignment of the text displayed in the control.
</p>
<p>
Use <var>OptimalFill</var> to indicate if the font height can be adjust to fill the client area for the control.
</p>
</descr>
<seealso>
<link id="TCustomLabel.AutoSize"/>
<link id="TCustomLabel.Layout"/>
<link id="TCustomLabel.OptimalFill"/>
<link id="TCustomLabel.Paint"/>
<link id="TCustomLabel.UpdateSize"/>
<link id="#lcl.controls.TControl.Invalidate">TControl.Invalidate</link>
<link id="#rtl.classes.TAlignment">TAlignment</link>
</seealso>
</element>
<element name="TCustomLabel.AutoSize">
<short>Enables or disables auto-sizing for the control to its content.</short>
<descr>
<p>
The action performed depends on the control type. For example, a label or button can become bigger or smaller to accommodate a longer or shorter caption.
</p>
<p>
The default value for the property is <b>True</b> in <var>TCustomLabel</var>.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
</seealso>
</element>
<element name="TCustomLabel.Color">
<short>Sets the color used for the background of the control.</short>
<descr>
<p>
The default value for the property is <var>clNone</var> in <var>TCustomLabel</var>. This value is used because labels, by default, are transparent in the LCL. Please note that this differs from the Delphi VCL where the default value for Transparent is <b>False</b>.
</p>
<p>
Changing the value in Color causes ControlStyle flags to be updated to include or exclude the value csOpaque as needed for the new property value. When set to clNone, the csOpaque flag is excluded from ControlStyle. Other values cause csOpaque to be included in ControlStyle.
</p>
<p>
Color is updated when a new value is assigned to the Transparent property. When Transparent is set to <b>True</b>, clNone is assigned to Color. When Transparent is set to <b>False</b> and color contains clNone, Color is changed to clBackground.
</p>
<p>
Values in Color and Font are used when the background and text for the control are drawn in the Paint method. Use the Font property to assign the typeface and color used for the text displayed on the control.
</p>
</descr>
<seealso>
<link id="TCustomLabel.Paint"/>
<link id="TCustomLabel.Transparent"/>
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
<link id="#lcl.controls.TControl.Font">TControl.Font</link>
<link id="#lcl.controls.TControl.ControlStyle">TControl.ControlStyle</link>
</seealso>
</element>
<element name="TCustomLabel.FocusControl">
<short>The control associated with the label and its accelerator key (AccelChar).</short>
<descr>
<p>
Set <var>FocusControl</var> to the control which is focused when the accelerator key in the label is pressed.
</p>
<p>
A label control cannot receive the input focus (it is read-only), but can display an accelerator key indicator, just like a menu entries. A windowed control (Edit...) can receive focus, but cannot indicate an accelerator key.
</p>
<p>
Using a combination of a label and another control allows setting the accelerator key in the label caption. The other control receives focus when the user presses the accelerator key.
</p>
<p>
An accelerator key is marked by an Ampersand '&' in the label caption, immediately preceding the character to be used as the accelerator key. The marked character appears underlined on screen, when ShowAccelChar is set to <b>True</b>.
</p>
<p>
For example: When you have a NameEdit1 control on a form, preceded by a label NameLabel1, you can set NameLabel1.FocusControl to NameEdit1, and NameLabel1.Caption to '&Name'.
</p>
</descr>
<seealso>
<link id="TCustomLabel.ShowAccelChar"/>
</seealso>
</element>
<element name="TCustomLabel.Layout">
<short>Vertical alignment for control text (at the top, bottom, or center).</short>
<descr>
<p>
<var>Layout</var> is a <var>TTextLayout</var> property with the vertical alignment used for the text displayed in the control. The default value for the property is <var>tlTop</var>. Changing the value in Layout causes the <var>Invalidate</var> method to be called to redraw the control.
</p>
<p>
Use the <var>Alignment</var> property to control the horizontal alignment for the text in the control.
</p>
<p>
Use <var>OptimalFill</var> to indicate if the font height can be adjusted to fill the client area for the control.
</p>
</descr>
<seealso>
<link id="TCustomLabel.Alignment"/>
<link id="TCustomLabel.OptimalFill"/>
<link id="#lcl.graphics.TTextLayout">TTextLayout</link>
<link id="#lcl.controls.TControl.Invalidate">TControl.Invalidate</link>
</seealso>
</element>
<element name="TCustomLabel.OptimalFill">
<short>If True, the font size is adjusted for optimal fill of the available space.</short>
<descr>
<p>
<var>OptimalFill</var> is a <var>Boolean</var> property which indicates that the <var>Font</var> height should be maximized to fill the available width in the control. The default value for the property is <b>False</b>.
</p>
<p>
Setting OptimalFill to <b>True</b> causes <var>AutoSize</var> to be set to <b>False</b>. The <var>AdjustFontForOptimalFill</var> method is called to get and apply the maximum font height allowed for the <var>Width</var> and <var>Height</var> in the control.
</p>
<p>
Changing the value for the property causes <var>Invalidate</var> to be called to redraw the control.
</p>
</descr>
<seealso>
<link id="TCustomLabel.AutoSize"/>
<link id="TCustomLabel.AdjustFontForOptimalFill"/>
<link id="#lcl.controls.TControl.Width">TControl.Width</link>
<link id="#lcl.controls.TControl.Height">TControl.Height</link>
<link id="#lcl.controls.TControl.Font">TControl.Font</link>
<link id="#lcl.controls.TControl.Invalidate">TControl.Invalidate</link>
</seealso>
</element>
<element name="TCustomLabel.ShowAccelChar">
<short>Underlines the character in the label that acts as the accelerator or short cut key.</short>
<descr>
<p>
When <b>False</b>, an <b>Ampersand (&)</b> character in the label caption is displayed as an ordinary character (as used in the Object Inspector).
</p>
<p>
When <b>True</b>, the character following the <b>Ampersand</b> is drawn with an underline. When the user presses the accelerator key, input focus is given to the associated <var>FocusControl</var>.
</p>
</descr>
<seealso>
<link id="TCustomLabel.FocusControl"/>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
</seealso>
</element>
<element name="TCustomLabel.Transparent">
<short>Indicates whether the viewer can see through the control.</short>
<descr>
<p>
When Transparent is set to <b>False</b>, the enclosing rectangle for the control is filled with the background Color for the label. If Color contains clNone, then clBackground is used in the Color property.
</p>
<p>
When set to <b>True</b>, Color is changed to clNone and the background appears to be transparent (no opacity).
</p>
<p>
The default value for Transparent in the LCL is <b>True</b>, which differs from the default value in the Delphi VCL.
</p>
<p>
Values in Color, Transparent, and ParentColor are inter-dependent; changing the value in one property affects the values in the other properties. Use ParentColor to toggle values in Color and Transparent. Use Color to set an explicit background color for the control and toggle values in Transparent and ParentColor.
</p>
</descr>
<seealso>
<link id="TCustomLabel.Color"/>
<link id="#lcl.controls.TControl.ParentColor">TControl.ParentColor</link>
</seealso>
</element>
<element name="TCustomLabel.WordWrap">
<short>
Allows the caption to wrap to multiple lines when it is longer than the available Width.
</short>
<descr>
<p>
<var>WordWrap</var> is a <var>Boolean</var> property which indicates if the caption in the control can be wrapped to multiple lines when its length exceeds the value in <var>Width</var>. The default value for the property is <b>False</b>.
</p>
<p>
When a new value is assigned to the property, the <var>Invalidate</var> and <var>UpdateSize</var> methods are called to auto-size and repaint the control.
</p>
<p>
When WordWrap is <b>False</b>, the text is truncated at the right boundary when it is too long for the control Width. When WordWrap is <b>True</b> and <var>AutoSize</var> is <b>True</b>, the maximum <var>Width</var> is determined by anchoring the left and right sides for the control to its Parent.
</p>
</descr>
<seealso>
<link id="TCustomLabel.AutoSize"/>
<link id="TCustomLabel.UpdateSize"/>
<link id="#lcl.controls.TControl.Width">TControl.Width</link>
<link id="#lcl.controls.TControl.Invalidate">TControl.Invalidate</link>
</seealso>
</element>
<element name="TLabel">
<short>Control used to display static text, possibly in multiple lines.</short>
<descr>
<p>
<var>TLabel</var> is a <var>TCustomLabel</var> descendant which implements a control to display static text on a form. The value in the control is not editable visually, and can be used to label or describe another control on the form or a container. Since it cannot be edited, it is not allowed to receive the input focus. It can, however, be used to set focus to an associated control using an accelerator key defined in the Caption for the control.
</p>
<p>
Use <var>TStaticText</var> to display static text and respond to keyboard input directly in the control.
</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
<link id="TStaticText"/>
</seealso>
</element>
<element name="TLabel.Align" link="#lcl.controls.TControl.Align"/>
<element name="TLabel.Alignment" link="#lcl.stdctrls.TCustomLabel.Alignment"/>
<element name="TLabel.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TLabel.AutoSize" link="#lcl.stdctrls.TCustomLabel.AutoSize"/>
<element name="TLabel.BidiMode" link="#lcl.controls.TControl.BiDiMode"/>
<element name="TLabel.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TLabel.Caption" link="#lcl.controls.TControl.Caption"/>
<element name="TLabel.Color" link="#lcl.stdctrls.TCustomLabel.Color"/>
<element name="TLabel.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TLabel.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TLabel.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TLabel.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TLabel.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TLabel.FocusControl" link="#lcl.stdctrls.TCustomLabel.FocusControl"/>
<element name="TLabel.Font" link="#lcl.controls.TControl.Font"/>
<element name="TLabel.Layout" link="#lcl.stdctrls.TCustomLabel.Layout"/>
<element name="TLabel.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TLabel.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TLabel.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TLabel.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TLabel.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TLabel.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TLabel.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TLabel.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TLabel.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TLabel.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TLabel.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TLabel.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TLabel.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TLabel.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TLabel.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TLabel.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TLabel.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TLabel.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TLabel.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TLabel.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TLabel.OptimalFill" link="#lcl.stdctrls.TCustomLabel.OptimalFill"/>
<element name="TLabel.ParentBidiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TLabel.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
<element name="TLabel.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TLabel.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TLabel.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TLabel.ShowAccelChar" link="#lcl.stdctrls.TCustomLabel.ShowAccelChar"/>
<element name="TLabel.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TLabel.Transparent" link="#lcl.stdctrls.TCustomLabel.Transparent"/>
<element name="TLabel.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TLabel.WordWrap" link="#lcl.stdctrls.TCustomLabel.WordWrap"/>
<element name="CreateEmulatedTextHintFont">
<short>Gets the font instance used for an emulated TextHint display.</short>
<descr>
<p>
<var>CreateEmulatedTextHintFont</var> is a <var>TFont</var> function which gets the font instance used to display an emulated TextHint in the control. It is retrieved by calling the <var>CreateEmulatedTextHintFont</var> method in the widgetset class. Widgetset classes use the font assigned to the control, but change the font color to <b>clGrayText</b>.
</p>
<p>
CreateEmulatedTextHintFont is called from <var>FontChanged</var>, and the private <var>ShowEmulatedTextHint</var> method.
</p>
</descr>
<seealso>
<link id="TCustomEdit.FontChanged"/>
<link id="TCustomEdit.TextHint"/>
</seealso>
</element>
<element name="CreateEmulatedTextHintFont.Result">
<short>TFont instance used for the emulated TextHint.</short>
</element>
<element name="Register">
<short>Registers components declared in the unit.</short>
<descr>
<p>
<var>Register</var> is a procedure used to register components in the <file>stdctrls.pp</file> unit for use in the Lazarus IDE.
</p>
<p>
Register calls <var>RegisterComponents</var> to add the following components to the <b>Standard</b> tab in the IDE:
</p>
<ul>
<li>TButton</li>
<li>TLabel</li>
<li>TEdit</li>
<li>TMemo</li>
<li>TToggleBox</li>
<li>TCheckBox</li>
<li>TRadioButton</li>
<li>TListBox</li>
<li>TComboBox</li>
<li>TScrollBar</li>
<li>TGroupBox</li>
</ul>
<p>
Register calls RegisterComponents to add the following components to the <b>Additional</b> tab in the IDE:
</p>
<ul>
<li>TStaticText</li>
</ul>
</descr>
</element>
<topic name="HowToUseStdCtrls">
<short>
How to use <var>StdCtrls</var>, <var>ComCtrls</var> or <var>ExtCtrls</var>.
</short>
<descr>
<p>
The Units <var>StdCtrls</var>, <var>ComCtrls</var> and <var>ExtCtrls</var> contain definitions and descriptions of many of the most commonly used controls for constructing Forms and other objects in Lazarus GUI applications.
</p>
<p>
Most controls are split into a final class, such as <var>TButton</var>, <var>TMemo</var>, <var>TScrollBar</var> etc., and a corresponding ancestor class such as <var>TCustomButton</var>, <var>TCustomMemo</var> or <var>TCustomScrollBar</var>. The final class is designed for immediate use, it almost only publishes the properties of the control. The corresponding custom ancestor class (<var>TCustomXXX</var>) can be used to derive controls with special (customized) appearance or behavior.
</p>
<p>
If you drop a component from the component palette on the form editor you don't need to add code explicitly to create it. The component is automatically created by the IDE together with the form, and destroyed when the form is destroyed.
</p>
<p>
However, if you create the component yourself by code, and don't specify an Owner for it (Create(Nil)), you are responsible for freeing the component when it is no longer needed. You better construct it with Create(Self), where Self means the containing Form or Parent control.
</p>
<p>
A control also must have a Parent control, maybe the Form, so that it can become visible within the client area of its Parent. The Top and Left properties specify the placement of the control within its <b>Parent</b>. The Object Tree reflects the Parent-Client relationships of all controls on the form.
</p>
<p>
Unlike controls, mere <var>components</var> are invisible at run-time (Open Dialogs...). Controls can be made invisible at run-time as well, by setting their Visible property to <b>False</b>.
</p>
<p>
If you place a component on the Form Designer and look at the Object Inspector, you can observe the Top and Left properties change as you move the component around. The same for the Width and Height properties, when you resize a control by dragging it's size grips.
</p>
<p>
When you modify the properties in the Object Inspector, the control on the form will reflect the changes as well.
</p>
<p>
You can also explicitly change the properties of the object in code by typing (in the appropriate Implementation section of the Source editor), for example
</p>
<code>Form1.Button1.Height := 48;</code>
<p>
In summary, there are usually about three different ways to determine each property of a component:
</p>
<ul>
<li>by using the mouse,</li>
<li>by setting the values in the Object Inspector,</li>
<li>or explicitly by writing code.</li>
</ul>
<p>
The components defined in these Units have several properties that are common to most of them, and other properties that are specific to the individual components. We shall describe the most common ones here. Unusual or control-specific properties will be described for the individual controls.
</p>
<p>
Additional Help can always be obtained by selecting a property or keyword, in either the Object Inspector or the Source Editor, and pressing <b>F1</b>. You will be taken by your Help browser to the appropriate page in the documentation.
</p>
<p>
If the description of a property on that page is insufficient, you can navigate to the corresponding description in the ancestor classes, by selecting the links in the Inheritance listing or by selecting the ancestor Type in the declaration of the object.
</p>
<p>
<b>Some commonly listed properties</b>
</p>
<table>
<th>
<td>Property</td>
<td>Meaning</td>
</th>
<tr>
<td>Action</td>
<td>
Use Action when e.g. a button and a menu entry shall perform the same task, e.g. the <var>Close</var> action.
</td>
</tr>
<tr>
<td>Align</td>
<td>
Defines how a control is lined up within its parent control. Possible values are alTop, alBottom (stacked at the top or bottom, using the full available width), alLeft, alRight (placed at the left or right, using the full available height), alNone (place anywhere on parent control) or alClient (takes all available space left over by other controls).
</td>
</tr>
<tr>
<td>Anchor</td>
<td>
Used to keep a control at a fixed distance from the edges of its Parent control, when the Parent is resized. For example <b>[akBottom, akRight]</b> will keep the control a fixed distance from the bottom right corner. Anchoring both [akLeft, akRight] will make the control extend or shrink in Width, together with its Parent.
</td>
</tr>
<tr>
<td>AutoSelect</td>
<td>
When <b>True</b>, a text control will select all its text when it receives focus or when the Enter key is pressed.
</td>
</tr>
<tr>
<td>AutoSelected</td>
<td>
<b>True</b> indicate that the edit or combo-box control has performed an AutoSelect operation, so that subsequent mouse-clicks and keystrokes proceed normally without selecting the text.
</td>
</tr>
<tr>
<td>BorderSpacing</td>
<td>The space around the edge between an control and its siblings.</td>
</tr>
<tr>
<td>Caption</td>
<td>
The text that is displayed on the control; it should preferably give some clue as to the function of the control, or an instruction such as 'Close' or 'Execute'. By default Caption is set to be the same as the 'Name' property, and the application designer should substitute meaningful text instead of the default values.
</td>
</tr>
<tr>
<td>CharCase</td>
<td>
Indicates how text is displayed in a text editing control: Normal (retaining the case of the letters typed by the user), converted to uppercase, or converted to lowercase
</td>
</tr>
<tr>
<td>Constraints</td>
<td>
Sets the minimum and maximum sizes for a control. If a control is resized the new dimensions are always within the ranges given here. You should take care when setting these options that they do not conflict with the Anchors and Align settings.
</td>
</tr>
<tr>
<td>Color</td>
<td>The Color to be used to draw the control's background.
</td>
</tr>
<tr>
<td>Enabled</td>
<td>
Determines whether a control can be selected or perform an action. If it is not <var>Enabled</var>, it is often <b>Grayed</b> out on the Form.
</td>
</tr>
<tr>
<td>Font</td>
<td>
The Font to be used for writing the text associated with the control - either the caption or label, or the text-strings contained within the control. The entry on the Object Inspector usually has a (+) box on the left, and selecting this box reveals further options such as character set, color and size.
</td>
</tr>
<tr>
<td>Hint</td>
<td>A short informative pop-up text that appears when the mouse-cursor moves over the control.</td>
</tr>
<tr>
<td>Items</td>
<td>
The list of 'Things' that the object contains, such as a group of images, a series of lines of text, a number of actions in an actionlist, etc.
</td>
</tr>
<tr>
<td>Lines</td>
<td>
An array of strings, containing the paragraph texts in Memo controls. The array index is zero-based, i.e. the lines are numbered 0..numLines-1.
</td>
</tr>
<tr>
<td>Name</td>
<td>
The identifier by which the control is known in the program. The IDE gives it a default name based on the underlying type, for example successive instances of TBitButton would be named Form1.BitButton1 and Form1.BitButton2; it is up to the application programmer to give them more meaningful names such as ExitButton or OKButton. By default the Name of the control is applied to the Caption for the control, but the text of the Caption may be changed separately.
</td>
</tr>
<tr>
<td>PopUpMenu</td>
<td>
A window containing context-sensitive menu entries, that pops up when the right mouse button is clicked on the object.
</td>
</tr>
<tr>
<td>Position (or Top, Left)</td>
<td>Determines where the control is located on the parent form or control.</td>
</tr>
<tr>
<td>ReadOnly</td>
<td>If <b>True</b>, the user cannot change the text in the control.</td>
</tr>
<tr>
<td>ShowHint</td>
<td>Allows to enable or suppress <var>Hints</var>.</td>
</tr>
<tr>
<td>Size (or Height and Width)</td>
<td>The dimensions of the control</td>
</tr>
<tr>
<td>Style</td>
<td>
The options available for Style depend upon the sort of Control being considered: for instance the Style may be defined by TFormStyle, TBorderStyle, TButtonStyle etc.
</td>
</tr>
<tr>
<td>TabOrder</td>
<td>
Specifies the sequence of controls, that are entered when the user presses the Tab key.
</td>
</tr>
<tr>
<td>TabStop</td>
<td>Specifies whether the control can be reached (or is skipped) by pressing the Tab key.</td>
</tr>
<tr>
<td>Text</td>
<td>
Like Caption, the <b>user editable</b> text that appears in the control. Applies particularly to Edit, Memo and Combo-Box types of controls. Most of the editing operations (such as <var>Select</var>, <var>Clear</var>, <var>Cut</var>, <var>Copy</var>) are performed in this property. If the control contains more than a single line of text, then the textual elements are arranged as a zero-based array of strings in <var>Lines</var> (<var>TMemo</var>) or <var>Items</var> (<var>TListBox</var>, <var>TComboBox</var>).
</td>
</tr>
<tr>
<td>Visible</td>
<td>If <b>True</b>, the control can be seen on the Form; if <b>False</b>, it is hidden.</td>
</tr>
<tr>
<td>WordWrap</td>
<td>
Allows wrapping the Text into multiple lines. When <b>False</b>, the text is clipped at the right margin of the control, but it still can be inspected by moving the caret within the text.
</td>
</tr>
</table>
<p>
The 'Events' tab in the Object Inspector contains a list with events, which can occur for this control. If you select an entry in the list, a combo-box appears with a drop-down list showing any event handlers that have already been defined, and allowing you to choose one for this event. Alternatively you can select the ellipsis (three dots ...) and you will be taken to the Source Editor, where the Object Inspector created an new event handler method for you. You also can type the name of your handler in the Object Inspector and press Enter, to create a new handler method.
</p>
<p>
While a large number of events is available for any given control, in practice it is only necessary to populate a few of them. For most controls, it is sufficient to provide coding for 'OnClick'; for more complex controls it may be necessary also to provide for 'OnEntry' (when the control receives the focus) and 'OnExit' (when the control looses the focus); or you may need to write an event handler for 'OnChange' or 'OnScroll', depending on the nature of the particular control with which you are dealing.
</p>
<p>
Many controls have a default event, usually OnClick, for which an handler is created with a double click on the control. Or right click on the control, and select the first entry: 'Create default event'.
</p>
<p>
A common strategy in Object-Oriented programming is to provide an <link id="#lcl.ActnList.TActionList">ActionList</link> with the facility for entering, removing or editing a number of predefined actions, from which the most appropriate can be selected to use in any particular instance.
</p>
<p>
<b>Some commonly listed Actions</b>
</p>
<table>
<th>
<td>Event</td>
<td>Meaning</td>
</th>
<tr>
<td>OnChange</td>
<td>
Action to be taken if any change is detected (e.g. by mouse click, key press, edit text, etc).
</td>
</tr>
<tr>
<td>OnClick</td>
<td>
Action to be taken when the (left) mouse button is clicked. This is usually the main or default action of the control; for example clicking on a button or check box initiates the action associated with the check box. It may alternatively initiate a process of selection, for instance in a TextBox or Memo.
</td>
</tr>
<tr>
<td>Click</td>
<td>
A method to emulate in code the effect of clicking on a control. This method is most often found in Button-type controls (TButton, TBitBtn, TSpeedButton etc). A procedure can be written that calls the same code as the OnClick action. This facility can be particularly useful if the activation of one control by clicking causes a cascade of other controls to be activated, and the Click method can be used to initiate the action rather than having the user explicitly click on a lot of controls.
</td>
</tr>
<tr>
<td>OnDragDrop</td>
<td>
Action to be taken when a dragged control has been dropped onto this control.
</td>
</tr>
<tr>
<td>OnEntry</td>
<td>
Action to be taken when the control receives the focus. This might include changes in the appearance of the object such as highlighting or raising the border.
</td>
</tr>
<tr>
<td>OnExit</td>
<td>
Action to be taken when control is about to loose the focus. This is the right place for validity checks of user input, with a chance to disallow moving to a different control when the input is invalid.
</td>
</tr>
<tr>
<td>OnKeyPress</td>
<td>Action to be taken on an entered character. Checks...???</td>
</tr>
<tr>
<td>OnKeyDown</td>
<td>
Action to be taken if a key is down while focus is in this control. This allows one to filter or process control characters in a special way.
</td>
</tr>
<tr>
<td>OnKeyUp</td>
<td>
Action to be taken if a key goes up. This event occurs only once, while auto-repeated keystrokes trigger multiple OnKeyDown or OnKeyPress events.
</td>
</tr>
<tr>
<td>OnMouseMove</td>
<td>
Action to be taken if the mouse cursor moves over the control. This event fires with every small move, while OnMouseEnter and OnMouseLeave occur only when the mouse enters or leaves the control.
</td>
</tr>
<tr>
<td>OnMouseDown</td>
<td>Action to be taken when a mouse button is pressed over the control.</td>
</tr>
<tr>
<td>OnMouseUp</td>
<td>Action to be taken if a mouse button goes up over the control.
</td>
</tr>
<tr>
<td>OnResize</td>
<td>
Action to be taken when the control is resized. Might include re-alignment of text or selection of a different font size etc. Do not mix up with AutoSize, or you ask for trouble!
</td>
</tr>
</table>
<p>
<var>Constructors</var> such as <var>Create</var> allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.
</p>
<p>
<var>Destructors</var> remove the object and de-allocate memory and other resources. If you call <var>Destroy</var> for an object which hasn't being initialized yet it will generate an error. Always use the <var>Free</var> method to deallocate objects, because it checks whether an object's value is <b>nil</b> before invoking <var>Destroy</var>.
</p>
<p>
Take the following precautions when creating your own <var>Destroy</var> method:
</p>
<ul>
<li>
Declare <var>Destroy</var> with the <b>override</b> directive, because it is a <b>virtual</b> method.
</li>
<li>
Always call the inherited Destroy method as the last action in the destructor code.
</li>
<li>
Be aware that an <var>exception</var> may be raised by the <var>constructor</var> when there is not enough memory to create an object, or something else goes wrong. If the <var>exception</var> is not handled inside the constructor, the object will be destroyed immediately. In this case <var>Destroy</var> will be called with a partially initialized object, so your destructor must check if the resources were really allocated before disposing of them.
</li>
<li>Remember to call <var>Free</var> for all objects created on the constructor.</li>
</ul>
</descr>
</topic>
</module>
<!-- StdCtrls -->
</package>
</fpdoc-descriptions>
|