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
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazcontrols">
<!--
===============================================================================
laznumedit
===============================================================================
-->
<module name="laznumedit">
<short>
Implements an edit control specialized for Integer values which can be
displayed with a specific numeric base (radix).
</short>
<descr/>
<!-- unresolved external references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Math"/>
<element name="StdCtrls"/>
<element name="LCLType"/>
<element name="Controls"/>
<element name="Clipbrd"/>
<element name="StrUtils"/>
<element name="TLazIntegerEditBaseChangeEvent">
<short>
Specifies an event handler signalled when the numeric base (radix) for an
Integer edit control is changed.
</short>
<descr>
<p>
TLazIntegerEditBaseChangeEvent is the type used for the OnBaseChange property
in TLazIntegerEditGen and TLazIntegerEdit. It allows actions to be performed
when the numeric base (radix) for an integer edit control is changed.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.OnBaseChange"/>
<link id="TLazIntegerEdit.OnBaseChange"/>
</seealso>
</element>
<element name="TLazIntegerEditBaseChangeEvent.ASender">
<short>
Control for the event notification.
</short>
</element>
<element name="TLazIntegerEditBaseChangeEvent.ACurrentBase">
<short>
Current numeric base for the notification.
</short>
</element>
<element name="TLazIntegerEditBaseChangeEvent.ANewBase">
<short>
New numeric base for the notification.
</short>
</element>
<element name="TLazIntegerEditBaseChangeEvent.APrefix">
<short>
Optional prefix for the new numeric base.
</short>
</element>
<element name="TLazIntegerEditGen.T">
<short>
Generic type. makeskel generated it... so it is included here. It doesn't
appear to be used at all.
</short>
</element>
<element name="TLazIntegerEditGen">
<short>
Defines the base class for an Integer edit control using a specified numeric
base.
</short>
<descr>
<p>
TLazIntegerEditGen is the generic base class for an edit control which can
display and edit a 64-bit integer value using a specified numeric base or
radix. TLazIntegerEditGen is the ancestor for the TLazIntegerEdit type which
specializes the ancestor for the TCustomEdit type.
</p>
<p>
TLazIntegerEditGen introduces properties which determine the appearance and
editing behavior for the control, including: Value, MinValue, MaxValue, and
DisplayBase.
</p>
<p>
Value contains the decimal (base-10) value for the control as an Int64 type.
MinValue and MaxValue control the lower and upper limits for the value in the
control. DisplayBase determines the numeric base (base-2, base-8, base-16,
etc.) used to display and edit the text for for the control.
</p>
<p>
Changing the value in DisplayBase causes the Value to be converted to the
specified numeric base and the control is updated. A prefix is displayed for
some numeric base values like base-2 (binary), base-8 (octal) and base-16
(hexadecimal). Other numeric base values do not use a prefix.
</p>
<p>
The edit control supports changing the numeric base using DisplayBase, or using
key presses which force the radix to be changed. See ToggleBinKeys,
ToggleOctKeys, ToggleHexKeys for more information.
</p>
<p>
Use the OnBasechange event handler to perform actions needed when DisplayBase is changed for the control.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
</element>
<!-- protected -->
<element name="TLazIntegerEditGen.Min_limit">
<short>
Lower limit for the Int64 value in the control.
</short>
<descr/>
<seealso>
<link id="TLazIntegerEditGen.Max_limit"/>
<link id="TLazIntegerEditGen.MinValue"/>
<link id="TLazIntegerEditGen.Value"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.Max_limit">
<short>
Upper limit for the Int64 value in the control.
</short>
<descr/>
<seealso>
<link id="TLazIntegerEditGen.Min_limit"/>
<link id="TLazIntegerEditGen.MaxValue"/>
<link id="TLazIntegerEditGen.Value"/>
</seealso>
</element>
<!-- private -->
<element name="TLazIntegerEditGen.FAllowMinus"/>
<element name="TLazIntegerEditGen.FAllowPlus"/>
<element name="TLazIntegerEditGen.FOnBaseChange"/>
<element name="TLazIntegerEditGen.FDisplayBase"/>
<element name="TLazIntegerEditGen.FBinIndicator"/>
<element name="TLazIntegerEditGen.FHexIndicator"/>
<element name="TLazIntegerEditGen.FOctIndicator"/>
<element name="TLazIntegerEditGen.FSetBinKeys"/>
<element name="TLazIntegerEditGen.FSetDecimalKeys"/>
<element name="TLazIntegerEditGen.FSetHexKeys"/>
<element name="TLazIntegerEditGen.FSetOctKeys"/>
<element name="TLazIntegerEditGen.FToggleBinKeys"/>
<element name="TLazIntegerEditGen.FToggleHexKeys"/>
<element name="TLazIntegerEditGen.FToggleOctKeys"/>
<element name="TLazIntegerEditGen.FValue"/>
<element name="TLazIntegerEditGen.FMinValue"/>
<element name="TLazIntegerEditGen.FMaxValue"/>
<element name="TLazIntegerEditGen.FCurrentBasePrefix"/>
<element name="TLazIntegerEditGen.FCurrentPrefix"/>
<element name="TLazIntegerEditGen.FLastDecodeWasEmpty"/>
<element name="TLazIntegerEditGen.GetCurrentValue"/>
<element name="TLazIntegerEditGen.GetCurrentValue.Result"/>
<element name="TLazIntegerEditGen.GetValid"/>
<element name="TLazIntegerEditGen.GetValid.Result"/>
<element name="TLazIntegerEditGen.SetBinIndicator"/>
<element name="TLazIntegerEditGen.SetBinIndicator.AValue"/>
<element name="TLazIntegerEditGen.SetDisplayBase"/>
<element name="TLazIntegerEditGen.SetDisplayBase.AValue"/>
<element name="TLazIntegerEditGen.SetHexIndicator"/>
<element name="TLazIntegerEditGen.SetHexIndicator.AValue"/>
<element name="TLazIntegerEditGen.SetMaxValue"/>
<element name="TLazIntegerEditGen.SetMaxValue.AValue"/>
<element name="TLazIntegerEditGen.SetMinValue"/>
<element name="TLazIntegerEditGen.SetMinValue.AValue"/>
<element name="TLazIntegerEditGen.SetOctIndicator"/>
<element name="TLazIntegerEditGen.SetOctIndicator.AValue"/>
<element name="TLazIntegerEditGen.SetSetDecimalKeys"/>
<element name="TLazIntegerEditGen.SetSetDecimalKeys.AValue"/>
<element name="TLazIntegerEditGen.SetValue"/>
<element name="TLazIntegerEditGen.SetValue.AValue"/>
<element name="TLazIntegerEditGen.UpdateText"/>
<element name="TLazIntegerEditGen.UpdateText.ANewText"/>
<element name="TLazIntegerEditGen.UpdateText.AnAdjustPos"/>
<element name="TLazIntegerEditGen.UpdateText.AnAdjustOffset"/>
<element name="TLazIntegerEditGen.UpdateText.AWasEmpty"/>
<element name="TLazIntegerEditGen.ReEncodeText"/>
<element name="TLazIntegerEditGen.ReEncodeText.Result"/>
<element name="TLazIntegerEditGen.ReEncodeText.ACheckLimit"/>
<element name="TLazIntegerEditGen.ReEncodeText.ANewBase"/>
<element name="TLazIntegerEditGen.ReEncodeText.ANewPrefix"/>
<element name="TLazIntegerEditGen.DecodeText"/>
<element name="TLazIntegerEditGen.DecodeText.Result"/>
<element name="TLazIntegerEditGen.DecodeText.APrefix"/>
<element name="TLazIntegerEditGen.DecodeText.AVal"/>
<element name="TLazIntegerEditGen.DecodeText.ACheckLimit"/>
<element name="TLazIntegerEditGen.EncodeText"/>
<element name="TLazIntegerEditGen.EncodeText.Result"/>
<element name="TLazIntegerEditGen.EncodeText.APrefix"/>
<element name="TLazIntegerEditGen.EncodeText.AVal"/>
<element name="TLazIntegerEditGen.EncodeText.APrefixOnly"/>
<!-- protected -->
<element name="TLazIntegerEditGen._KeyDown">
<short>
Implements an alternate KeyDown method for the generic base class.
</short>
<descr>
<p>
_KeyDown is an implementation of the KeyDown method specific to the generic
base class. It allows an alternate implementation without use of the override
directive - which is not allowed in the generic class.
</p>
<p>
Key contains the virtual key code examined in the method. Shift contains the
Alt, Ctrl, Shift, or Meta modifiers for the virtual key code.
</p>
<p>
_KeyDown calls the KeyDown method in the ancestor class on entry to signal an
assigned OnKeyDown event handler, or any control handlers using the
chtOnKeyDown handler type.
</p>
<p>
_KeyDown ensures that the following key codes are applied to the Text for the
edit control:
</p>
<ul>
<li>VK_BACK</li>
<li>VK_DELETE</li>
</ul>
<p>
For both key codes, a visible sign (+ or -) or prefix for the DisplayBase in
use on the the control is preserved.
</p>
<p>
_KeyDown is called from the overridden KeyDown method in the TLazIntegerEdit
descendant.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit.KeyDown"/>
<link id="#lcl.controls.TWinControl.KeyDown">TWinControl.KeyDown</link>
<link id="#lcl.controls.TWinControl.OnKeyDown">TWinControl.OnKeyDown</link>
<link id="#lcl.controls.TControl.DoCallKeyEventHandler">TControl.DoCallKeyEventHandler</link>
<link id="#lcl.controls.TControlHandlerType">TControlHandlerType</link>
</seealso>
</element>
<element name="TLazIntegerEditGen._KeyDown.Key">
<short>
Virtual key code for the key down notification.
</short>
</element>
<element name="TLazIntegerEditGen._KeyDown.Shift">
<short>
Shift, Ctrl, Alt, or Meta modifier(s) for the key code.
</short>
</element>
<element name="TLazIntegerEditGen._KeyPress">
<short>
Implements an alternate KeyPress method used in the control.
</short>
<descr>
<p>
_KeyPress is an implementation of the KeyPress method specific to the generic
base class. It allows an alternate implementation without use of the override
directive - which is not allowed in the generic class.
</p>
<p>
Key contains the character examined in the method.
</p>
<p>
_KeyPress calls the KeyPress method in the ancestor class on entry to signal
an assigned OnKeyPress event handler.
</p>
<p>
_KeyDown ensures that the value in Key is not one of the allowed control
characters used in the control, including:
</p>
<ul>
<li>#8 (Backspace)</li>
<li>#9 (Tab)</li>
<li>^A (Line Feed)</li>
<li>^C (Carriage Return)</li>
<li>^Z (Undo)</li>
</ul>
<p>
No actions are performed in the method if Key contains one of these values.
</p>
<p>
_KeyPress ensures that other characters or control characters in Key are
properly applied to the Text in the control, including:
</p>
<dl>
<dt>'-'</dt>
<dd>
Toggles the sign when AllowMinus is enabled, and re-selects the Text displayed
for the control.
</dd>
<dt>'+'</dt>
<dd>
Toggles the sign when AllowPlus is enabled, and re-selects the Text displayed
for the control.
</dd>
<dt>^X (Cut)</dt>
<dd>
Copies the selected text on the control to the clipboard and removes the
selected text from the display value for the control.
</dd>
<dt>^V (Insert)</dt>
<dd>
Copies the contents of the clipboard, converts it to the DIsplayBase in use,
and inserts the value into the Text for the control. If text is selected on
the control, only the selected text is replaced.
</dd>
<dt>ToggleBinKeys</dt>
<dd>
If Key contains one of he values in ToggleBinKeys, DisplayBase is toggled
between 2 (Binary) and 10 (Decimal).
</dd>
<dt>ToggleOctKeys</dt>
<dd>
If Key contains one of he values in ToggleOctKeys, DisplayBase is toggled
between 8 (Octal) and 10 (Decimal).
</dd>
<dt>ToggleHexKeys</dt>
<dd>
If Key contains one of he values in ToggleHexKeys, DisplayBase is toggled
between 16 (Hexadecimal) and 10 (Decimal).
</dd>
<dt>SetDecimalKeys</dt>
<dd>
If Key contains one of he values in SetDecimalKeys, DisplayBase is switched
to 10 (Decimal).
</dd>
<dt>SetBinKeys</dt>
<dd>
If Key contains one of he values in SetBinKeys, DisplayBase is switched to 2 (
Binary).
</dd>
<dt>SetOctKeys</dt>
<dd>
If Key contains one of he values in SetOctKeys, DisplayBase is switched to 8 (
Octal).
</dd>
<dt>SetHexKeys</dt>
<dd>
If Key contains one of he values in SetHexKeys, DisplayBase is switched to 16 (
Hexadecimal).
</dd>
</dl>
<p>
Key is set to #0 if it is handled in the method.
</p>
<p>
_KeyPress is called from the overridden KeyPress method in the TLazIntegerEdit
descendant.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.AllowMinus"/>
<link id="TLazIntegerEditGen.AllowPlus"/>
<link id="TLazIntegerEditGen.ToggleBinKeys"/>
<link id="TLazIntegerEditGen.ToggleHexKeys"/>
<link id="TLazIntegerEditGen.ToggleOctKeys"/>
<link id="TLazIntegerEditGen.SetBinKeys"/>
<link id="TLazIntegerEditGen.SetDecimalKeys"/>
<link id="TLazIntegerEditGen.SetOctKeys"/>
<link id="TLazIntegerEditGen.SetHexKeys"/>
<link id="TLazIntegerEditGen.CurrentValue"/>
<link id="TLazIntegerEdit.KeyPress"/>
<link id="#lcl.controls.TWinControl.KeyPress">TWinControl.KeyPress</link>
<link id="#lcl.controls.TWinControl.OnKeyPress">TWinControl.OnKeyPress</link>
</seealso>
</element>
<element name="TLazIntegerEditGen._KeyPress.Key">
<short>
Character value for the key press notification. Set to #0 when handled in the
method.
</short>
</element>
<element name="TLazIntegerEditGen._Utf8KeyPress">
<short>
Implements an alternate UTF8KeyPress method used in the control.
</short>
<descr>
<p>
_Utf8KeyPress is an implementation of the Utf8KeyPress method specific to the
generic base class. It allows an alternate implementation without use of the
override directive - which is not allowed in the generic class.
</p>
<p>
_Utf8KeyPress calls the Utf8KeyPress method from the ancestor class on entry
to signal an assigned OnUtf8KeyPress event handler for the class instance. The
handler inspects the value in UTF8Key to determine whether it can be applied
to the control. Any bytes values in UTF8Key not handled in the ancestor method
are discarded. Essentially, this limits the input value for the control to the
single byte characters in the UTF-8 encoding.
</p>
<p>
_Utf8KeyPress is called from the UTF8KeyPress method in the TLazIntegerEdit
descendant.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit.UTF8KeyPress"/>
<link id="#lcl.controls.TWinControl.OnUTF8KeyPress">TCustomEdit.OnUTF8KeyPress</link>
<link id="#lcl.controls.TCustomEdit.OnUTF8KeyPress">TCustomEdit.OnUTF8KeyPress</link>
</seealso>
</element>
<element name="TLazIntegerEditGen._Utf8KeyPress.UTF8Key">
<short>
UTF-8-encoded character value for the key press notification.
</short>
</element>
<element name="TLazIntegerEditGen._InitializeWnd">
<short>
Implements an alternate InitializeWnd method used in the control.
</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntegerEditGen._RealGetText">
<short>
Implements an alternate RealGetText method used to get the text for the
control.
</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntegerEditGen._RealGetText.Result">
<short>
Caption text displayed in the edit box for the control.
</short>
</element>
<element name="TLazIntegerEditGen._FinalizeWnd">
<short>
Implements an alternate FinalizeWnd method used in the control.
</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntegerEditGen._DoExit">
<short>
Implements an alternate DoExit method used in the control.
</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntegerEditGen._EditingDone">
<short>
Implements an alternate EditingDone method used in the control.
</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntegerEditGen._Init">
<short>
Implements an initialization routine used for new instances of the control.
</short>
<descr>
<p>
_Init acts as a constructor for instances of the generic base class. It is
called from the constructor in TLazIntegerEdit to ensure that default values
are assigned to members, including:
</p>
<ul>
<li>MinValue (Low(Int64))</li>
<li>MaxValue (High(Int64))</li>
<li>DisplayBase (10)</li>
<li>BinIndicator ('%')</li>
<li>HexIndicator ('$')</li>
<li>OctIndicator ('&')</li>
<li>SetDecimalKeys ('#')</li>
<li>ToggleBinKeys ('%')</li>
<li>ToggleHexKeys ('$x')</li>
<li>ToggleOctKeys ('&)</li>
<li>AllowMinus (<b>True</b>)</li>
<li>AllowPlus (<b>True</b>)</li>
</ul>
</descr>
<seealso>
<link id="TLazIntegerEditGen.MinValue"/>
<link id="TLazIntegerEditGen.MaxValue"/>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen.BinIndicator"/>
<link id="TLazIntegerEditGen.HexIndicator"/>
<link id="TLazIntegerEditGen.OctIndicator"/>
<link id="TLazIntegerEditGen.SetDecimalKeys"/>
<link id="TLazIntegerEditGen.ToggleBinKeys"/>
<link id="TLazIntegerEditGen.ToggleHexKeys"/>
<link id="TLazIntegerEditGen.ToggleOctKeys"/>
<link id="TLazIntegerEditGen.AllowMinus"/>
<link id="TLazIntegerEditGen.AllowPlus"/>
<link id="TLazIntegerEdit.Create"/>
</seealso>
</element>
<!-- public -->
<element name="TLazIntegerEditGen.Value">
<short>
Value for the control as an Int64 type.
</short>
<descr>
<p>
<var>Value</var> is an <var>Int64</var> property which contains the decimal
(base-10) value for the control. Changing the property value causes the
display Text in the control to be updated and displayed. DisplayBase
determines the numeric base (radix) for the converted control Value. An
optional prefix is used for numeric base values in DisplayBase like base-2
(binary), base-8 (octal), and base-16 (hexadecimal).
</p>
<p>
Use MinValue and MaxValue to set lower and upper limits for the control Value.
Changing the Value property causes the new value to be normalized for the
limits in MinValue and MaxValue; if the new value is not in the specified
range, it is changed to the corresponding lower or upper limit.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.MaxValue"/>
<link id="TLazIntegerEditGen.MinValue"/>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen.BinIndicator"/>
<link id="TLazIntegerEditGen.HexIndicator"/>
<link id="TLazIntegerEditGen.OctIndicator"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.CurrentValue">
<short>
Value for the control before EditingDone is called or the control loses focus.
</short>
<descr>
<p>
CurrentValue is a read-only Int64 property which contains the control value
while editing is active and before the control loses focus. The property value
is derived by reading the Text in the edit box and converting it from the
selected DisplayBase back to a decimal (base-10) value. If a handle has not
been allocated for the control, the Value property is used instead.
</p>
<p>
Use Valid to determine if the edit box contains a valid value for the
specified DisplayBase.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen.Valid"/>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEdit.Text"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.Valid">
<short>
Indicates whether the value in the CurrentValue property is valid for the
setting in DisplayBase.
</short>
<descr>
<p>
Valid is a read-only Boolean property which indicates whether the text
displayed on the control is a valid numeric value for the setting in
DisplayBase. Valid converts the edit text to an Int64 value, and checks
whether the value is within the limits specified in MinValue and MaxValue.
This includes comparing the prefix in the edit text (if any) to the prefix
needed for the DisplayBase setting.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen.CurrentValue"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.MinValue">
<short>
Sets the lower limit for the Value property.
</short>
<descr>
<p>
MinValue is an Int64 property which specifies the smallest Base-10 (decimal)
value allowed for the control. Changing the value in MinValue causes any
existing text on the edit control to be converted back to decimal (if needed)
and normalized to the limits specified in MinValue and MinValue.
</p>
<p>
The default value for the property is set in the _Init method to the value in
the Min_Limit constant.
</p>
<p>
Use MaxValue to specify the largest Base-10 Value allowed for the control.
</p>
<p>
MinValue and MaxValue are used when the Value property is updated, and ensure
that the limits for the control are applied to Value before the display text
is converted / displayed for the specified DisplayBase.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen.MaxValue"/>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEditGen._Init"/>
<link id="TLazIntegerEditGen.Min_limit"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.MaxValue">
<short>
Sets the upper limit for the Value property.
</short>
<descr>
<p>
MaxValue is an Int64 property which specifies the largest Base-10 (decimal)
value allowed for the control. Changing the value in MaxValue causes any
existing text on the edit control to be converted back to decimal (if needed)
and normalized to the limits specified in MinValue and MinValue.
</p>
<p>
The default value for the property is set in the _Init method to the value in
the Max_Limit constant.
</p>
<p>
Use MinValue to specify the smallest Base-10 Value allowed for the control.
</p>
<p>
MinValue and MaxValue are used when the Value property is updated, and ensure
that the limits for the control are applied to Value before the display text
is converted / displayed for the specified DisplayBase.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen.MinValue"/>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEditGen._Init"/>
<link id="TLazIntegerEditGen.Min_limit"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.DisplayBase">
<short>
Contains the numeric base (radix) for the value displayed in the control.
</short>
<descr>
<p>
DisplayBase is an Integer property which contains the numeric base (or radix)
for the value displayed and maintained in the edit control.
</p>
<p>
DisplayBase determines the number of digits needed to represent the base-n
text displayed on the control, and controls the conversion performed to get
the display value. The default value for the property is 10 and indicates that
the control displays its Value using base-10 or decimal notation.
</p>
<p>
DisplayBase must be in the range 2..35; a value outside this range is
normalized to the lower or upper limit.
</p>
<p>
Changing the value for the property causes the OnBaseChange event handler to
be signalled (when assigned) using the old and new values for the property and
the optional prefix for the new numeric base (radix).
</p>
<p>
The Text for control is updated by converting Value to the specified radix and
applying the prefix for the DisplayBase. See BinIndicator, OctIndicator, and
HexIndicator for more information about common prefixes used for selected
DisplayBase values.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEditGen.OnBaseChange"/>
<link id="TLazIntegerEditGen.BinIndicator"/>
<link id="TLazIntegerEditGen.HexIndicator"/>
<link id="TLazIntegerEditGen.OctIndicator"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.SetDecimalKeys">
<short>
Contains the characters which cause the edit control to be displayed using the
decimal (base-10) radix.
</short>
<descr>
<p>
SetDecimalKeys is a String property which contains the character(s) used to
switch the edit controls to the decimal (base-10) radix when a key press is
handled for the control. SetDecimals is used in the _KeyPress handler, and
causes the DisplayBase property to be set to 10.
</p>
<p>
The default value for the property is '#' as assigned in the _Init method.
</p>
<remark>
Please note that SetDecimalKeys is not like the toggles in the ToggleBinKeys,
ToggleOctKeys, and ToggleHexKeys properties. It does not toggle between
base-10 and another radix value. It selects base-10 only.
</remark>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._Init"/>
<link id="TLazIntegerEditGen._KeyPress"/>
<link id="TLazIntegerEditGen.ToggleBinKeys"/>
<link id="TLazIntegerEditGen.ToggleOctKeys"/>
<link id="TLazIntegerEditGen.ToggleHexKeys"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.HexIndicator">
<short>
Contains the prefix displayed in the control when the value is displayed in
hexadecimal representation (DisplayBase = 16).
</short>
<descr>
<p>
HexIndicator contains the prefix displayed in the edit control when
DisplayBase is set to 16 for hexadecimal format. The default value for the
property is '$' as assigned in the _Init method. Changing the value for the
property causes the text displayed on the control to be converted and
re-encoded when DisplayBase is 16.
</p>
<p>
Use BinIndicator or OctIndicator for the prefix used for base-2 and base-8
respectively.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._Init"/>
<link id="TLazIntegerEditGen.BinIndicator"/>
<link id="TLazIntegerEditGen.OctIndicator"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.SetHexKeys">
<short>
Contains the character(s) which cause the edit control to be displayed using
the hexadecimal (base-16) radix.
</short>
<descr>
<p>
A default value is not assigned for the property. The ToggleHexKeys property
is used to toggle between Hexadecimal (base-16) and Decimal (base-10). When a
value is assigned to ToggleHexKeys, those keys take precedence over the keys
in SetHexKey. The value in SetHexKeys is used, when applicable, in the
_KeyPress handler for the control.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.ToggleHexKeys"/>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._KeyPress"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.ToggleHexKeys">
<short>
Contains key(s) which cause the DisplayBase to be toggled between decimal
(base-10) and hexadecimal (base-16) display formats.
</short>
<descr>
<p>
ToggleHexKeys is a String property which contains one or more characters which
cause the DisplayBase for the control to be toggled between decimal (base-10)
and hexadecimal (base-16). The default value for the property is '$x' as
assigned in the _Init method. If either of the keys is entered when the
control has focus, the DisplayBase property is updated accordingly and the
display Text for the control is updated to to reflect the numeric
representation using the radix.
</p>
<p>
Values in ToggleHexKeys are used in the _KeyPress method when a key value is
applied to the edit control.
</p>
<p>
Use ToggleBinKeys or ToggleOctKeys to specify the key characters which cause
the control to toggle between Binary or Octal, and Decimal representations for
the control Value.
</p>
<p>
Use SetDecimalKeys, SetBinKeys, SetOctKeys, or SetHexKeys to switch to a
specific base-n representation rather than toggle between a base-n
representation and decimal (base-10).
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.ToggleBinKeys"/>
<link id="TLazIntegerEditGen.ToggleOctKeys"/>
<link id="TLazIntegerEditGen.SetDecimalKeys"/>
<link id="TLazIntegerEditGen.SetBinKeys"/>
<link id="TLazIntegerEditGen.SetOctKeys"/>
<link id="TLazIntegerEditGen.SetHexKeys"/>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._KeyPress"/>
<link id="TLazIntegerEdit.KeyPress"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.OctIndicator">
<short>
Contains the prefix displayed in the control when the value is displayed in
octal representation (DisplayBase = 8).
</short>
<descr>
<p>
OctIndicator contains the prefix displayed in the edit control when
DisplayBase is set to 8 for octal format. The default value for the
property is '&' as assigned in the _Init method. Changing the value for
the property causes the text displayed on the control to be converted and
re-encoded when DisplayBase is 8.
</p>
<p>
Use BinIndicator or HexIndicator for the prefix used for base-2 and base-16
respectively.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._Init"/>
<link id="TLazIntegerEditGen.BinIndicator"/>
<link id="TLazIntegerEditGen.HexIndicator"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.SetOctKeys">
<short>
Contains the character(s) which cause the edit control to be displayed using
the octal (base-8) radix.
</short>
<descr>
<p>
A default value is not assigned for the property. The ToggleOctKeys property
is used to toggle between Hexadecimal (base-16) and Decimal (base-10). When a
value is assigned to ToggleHexKeys, those keys take precedence over the keys
in SetOctKeys. The value in SetOctKeys is used, when applicable, in the
_KeyPress handler for the control.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.ToggleOctKeys"/>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._KeyPress"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.ToggleOctKeys">
<short>
Contains key(s) which cause the DisplayBase to be toggled between decimal (10)
and octal (8) display formats.
</short>
<descr>
<p>
ToggleOctKeys is a String property which contains one or more characters which
cause the DisplayBase for the control to be toggled between decimal (base-10)
and octal (base-8). The default value for the property is '&' as
assigned in the _Init method. If the key is entered when the control has
focus, the DisplayBase property is updated accordingly and the display Text
for the control is updated to to reflect the numeric representation using the
radix.
</p>
<p>
Values in ToggleOctKeys are used in the _KeyPress method when a key value is
applied to the edit control.
</p>
<p>
Use ToggleBinKeys or ToggleHexKeys to specify the key characters which cause
the control to toggle between Binary or Hexadecimal, and Decimal
representations for the control Value.
</p>
<p>
Use SetDecimalKeys, SetBinKeys, SetOctKeys, or SetHexKeys to switch to a
specific base-n representation rather than toggle between a base-n
representation and decimal (base-10).
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.ToggleBinKeys"/>
<link id="TLazIntegerEditGen.ToggleHexKeys"/>
<link id="TLazIntegerEditGen.SetDecimalKeys"/>
<link id="TLazIntegerEditGen.SetBinKeys"/>
<link id="TLazIntegerEditGen.SetOctKeys"/>
<link id="TLazIntegerEditGen.SetHexKeys"/>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._KeyPress"/>
<link id="TLazIntegerEdit.KeyPress"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.BinIndicator">
<short>
Contains the prefix displayed in the control when the value is displayed in
binary representation (DisplayBase = 2).
</short>
<descr>
<p>
BinIndicator contains the prefix displayed in the edit control when
DisplayBase is set to 2 for octal format. The default value for the property
is '%' as assigned in the _Init method. Changing the value for the property
causes the text displayed on the control to be converted and re-encoded when
DisplayBase is 2.
</p>
<p>
Use OctIndicator or HexIndicator for the prefix used for base-8 and base-16
respectively.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._Init"/>
<link id="TLazIntegerEditGen.OctIndicator"/>
<link id="TLazIntegerEditGen.HexIndicator"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.SetBinKeys">
<short>
Contains the character(s) which cause the edit control to be displayed using
the binary (base-2) radix.
</short>
<descr>
<p>
A default value is not assigned for the property. The ToggleBinKeys property
is used to toggle between Binary (base-2) and Decimal (base-10). When a
value is assigned to ToggleBinKeys, those keys take precedence over the keys
in SetBinKeys. The value in SetBinKeys is used, when applicable, in the
_KeyPress handler for the control.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.ToggleBinKeys"/>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._KeyPress"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.ToggleBinKeys">
<short>
Contains key(s) which cause the DisplayBase to be toggled between decimal (10)
and binary (2) display formats.
</short>
<descr>
<p>
ToggleBinKeys is a String property which contains one or more characters which
cause the DisplayBase for the control to be toggled between decimal (base-10)
and binary (base-2). The default value for the property is '%' as assigned in
the _Init method. If the key is entered when the control has focus, the
DisplayBase property is updated accordingly and the display Text for the
control is updated to to reflect the numeric representation using the radix.
</p>
<p>
Values in ToggleBinKeys are used in the _KeyPress method when a key value is
applied to the edit control.
</p>
<p>
Use ToggleOctKeys or ToggleHexKeys to specify the key characters which cause
the control to toggle between Octal or Hexadecimal, and Decimal
representations for the control Value.
</p>
<p>
Use SetDecimalKeys, SetBinKeys, SetOctKeys, or SetHexKeys to switch to a
specific base-n representation rather than toggle between a base-n
representation and decimal (base-10).
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.ToggleOctKeys"/>
<link id="TLazIntegerEditGen.ToggleHexKeys"/>
<link id="TLazIntegerEditGen.SetDecimalKeys"/>
<link id="TLazIntegerEditGen.SetBinKeys"/>
<link id="TLazIntegerEditGen.SetOctKeys"/>
<link id="TLazIntegerEditGen.SetHexKeys"/>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEditGen._KeyPress"/>
<link id="TLazIntegerEdit.KeyPress"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.OnBaseChange">
<short>
Event handler signalled when the value in DisplayBase is changed.
</short>
<descr>
<p>
OnBaseChange allows the control to perform actions needed when the value for
the DisplayBase property is changed. It is signalled (when assigned) after the
value in DisplayBase has been updated but before the Text in control is
converted and displayed using the new radix. It allows the application to
override the new numeric base or radix and prefix in the event handler.
</p>
<p>
See TLazIntegerEditBaseChangeEvent for more information about the handler type
and its arguments.
</p>
<p>
OnBaseChange is a public property in TLazIntegerEditGen, but it is published
in the TLazIntegerEdit descendant.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.DisplayBase"/>
<link id="TLazIntegerEdit.Text"/>
<link id="TLazIntegerEditBaseChangeEvent"/>
<link id="TLazIntegerEdit.OnBaseChange"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.AllowMinus">
<short>
Indicates whether the '-' key can be used to negate the control Value.
</short>
<descr>
<p>
AllowMinus is a Boolean property which enables or disables use of the '-' key
to change the sign for the value in the control. When enabled, the
CurrentValue for the control is negated when the '-' key is pressed. A second
press of the key causes the CurrentValue to become positive. The default value
for the AllowMinus property is <b>True</b>. AllowMinus does enable direct
entry of the sign; it reverses its state.
</p>
<p>
When editing is completed in the control, or it loses focus, the CurrentValue
for the control is validated using the MinValue and MaxValue properties. If
MinValue is not set to a value less than 0 (zero), a negative Value cannot be
stored for the control and it defaults to MinValue.
</p>
<p>
AllowMinus and AllowPlus are used when key press events are applied in the
_KeyPress handler.
</p>
<p>
Use AllowPlus to enable or disable use of the '+' key to force the control
Value to become positive.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.AllowPlus"/>
<link id="TLazIntegerEditGen.CurrentValue"/>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEditGen.MaxValue"/>
<link id="TLazIntegerEditGen.MinValue"/>
<link id="TLazIntegerEditGen._KeyPress"/>
<link id="TLazIntegerEditGen._EditingDone"/>
</seealso>
</element>
<element name="TLazIntegerEditGen.AllowPlus">
<short>
Indicates whether the '+' key can be used to switch a negative control value
to a positive one.
</short>
<descr>
<p>
AllowPlus is a Boolean property which enables or disables use of the '+' key
to change the sign for the Value in the control to a positive one. When
enabled, the CurrentValue for the control is negated when the '+' key is
pressed. and the control value is negative. No actions are performed if the
CurrentValue is already positive. AllowPlus does enable direct entry of the
sign; it simply forces a positive sign for the value.
</p>
<p>
When editing is completed in the control, or it loses focus, the CurrentValue
for the control is validated using the MinValue and MaxValue properties.
</p>
<p>
AllowMinus and AllowPlus are used when key press events are applied in the
_KeyPress handler.
</p>
<p>
Use AllowMinus to enable or disable use of the '-' key to toggle the sign for
the control Value.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen.AllowMinus"/>
<link id="TLazIntegerEditGen.Value"/>
<link id="TLazIntegerEditGen.CurrentValue"/>
<link id="TLazIntegerEditGen.MaxValue"/>
<link id="TLazIntegerEditGen.MinValue"/>
<link id="TLazIntegerEditGen._KeyPress"/>
<link id="TLazIntegerEditGen._EditingDone"/>
</seealso>
</element>
<!--
Commented out in source code too.
<element name="TLazIntegerEditGen.DisplayQWord">
<short/>
<descr/>
<seealso/>
</element>
-->
<element name="TLazIntegerEdit">
<short>
Implements an edit control for Integer values displayed and maintained using a
specified numeric base or radix.
</short>
<descr>
<p>
TLazIntegerEdit is a TLazIntegerEdit descendant which specializes the generic base class for the TCustomEdit type. It implements an edit control which can
display and edit a 64-bit integer value using a specified numeric base or
radix.
</p>
<p>
TLazIntegerEdit introduces properties which determine the appearance and
editing behavior for the control, including: Value, MinValue, MaxValue, and
DisplayBase.
</p>
<p>
Value contains the decimal (base-10) value for the control as an Int64 type.
MinValue and MaxValue control the lower and upper limits for the value in the
control. DisplayBase determines the numeric base (base-2, base-8, base-10,
base-16, etc.) used to display and edit the text for for the control.
</p>
<p>
Changing the value in DisplayBase causes the Value to be converted to the
specified numeric base and the control is updated. A prefix is displayed for
some numeric base values like base-2 (binary), base-8 (octal) and base-16
(hexadecimal). Other numeric base values do not use a prefix.
</p>
<p>
The edit control supports changing the numeric base using DisplayBase, or using
key presses which force the radix to be changed. See ToggleBinKeys,
ToggleOctKeys, ToggleHexKeys for more information.
</p>
<p>
Use the OnBasechange event handler to perform actions needed when DisplayBase is changed for the control.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
</element>
<!-- protected -->
<element name="TLazIntegerEdit.KeyDown">
<short>
Handles key down events for the control.
</short>
<descr>
<p>
KeyDown is an overridden method in TLazIntegerEdit. It ensures that key down
events which affect the current selection in the control are properly applied.
</p>
<p>
KeyDown calls the alternate handler in the ancestor class (_KeyDown) to signal
assigned OnKeyDown event handler attached to the control. It updates the
values in SelStart and SelLength as needed when VK_BACK or VK_DELETE key down
events are received and applied to the edit box.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen._KeyDown"/>
</seealso>
</element>
<element name="TLazIntegerEdit.KeyDown.Key">
<short>
Virtual key code for the key down event.
</short>
</element>
<element name="TLazIntegerEdit.KeyDown.Shift">
<short>
Shift, Ctrl, Alt, or Meta modifiers for the key down event.
</short>
</element>
<element name="TLazIntegerEdit.KeyPress">
<short>
Handles key press events for the control.
</short>
<descr>
<p>
KeyPress is an overridden method in TLazIntegerEdit. It calls the alternate
_KeyPress handler in TLazIntegerEditGen to signal OnKeyPress (when assigned)
and apply the specified character to the control. No actions are performed
when ReadOnly is set to <b>True</b>.
</p>
<p>
KeyPress ensures that keys specific to the control or its DisplayBase are
detected and applied to the control. This includes control characters like:
</p>
<ul>
<li>#8 (BS) (Backspace)</li>
<li>#9 (HT) (Tab)</li>
<li>#33 (^A) (Select All)</li>
<li>#35 (^C) (Copy)</li>
<li>#58 (^Z) (Undo)</li>
</ul>
<p>
Values in SelStart and SelLength are updated as needed when the Text in the
control has been updated.
</p>
</descr>
<seealso/>
</element>
<element name="TLazIntegerEdit.KeyPress.Key">
<short>
Character for the key press notification.
</short>
</element>
<element name="TLazIntegerEdit.Utf8KeyPress">
<short>
Handles UTF-8 key press events for the control.
</short>
<descr>
<p>
Utf8KeyPress is an overridden method in TLazIntegerEdit. It calls the
alternate handler routine in _Utf8KeyPress (implemented in TLazIntegerEditGen)
to examine, handle, or preprocess the UTF-8 character. The OnUTF8KeyPress
event handler is signalled (when assigned). The alternate handler ensures that
that multi-byte UTF-8 characters are ignored for the control; the value in
Utf8Char is set to an empty string ('') if it contains more than 1 byte value.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen._Utf8KeyPress"/>
<link id="#lcl.controls.TWinControl.Utf8KeyPress">TWinControl.Utf8KeyPress</link>
<link id="#lcl.controls.TWinControl.OnUtf8KeyPress">TWinControl.OnUtf8KeyPress</link>
</seealso>
</element>
<element name="TLazIntegerEdit.Utf8KeyPress.UTF8Key">
<short>
UTF-8-encoded character for the key press notification.
</short>
</element>
<element name="TLazIntegerEdit.RealGetText">
<short>
Gets the text displayed for the control.
</short>
<descr>
<p>
RealGetText is an overridden TCaption function in TLazIntegerEdit used to get
the value for the control Caption. It calls the alternate handler routine
(_RealGetText) in TLazIntegerEditGen to get the return value. If the control
handle has been allocated, the inherited RealGetText method in ancestor
classes is called to get the return value. It the handle has not been
allocated, the Value property is converted to a string which includes the
optional prefix for the radix.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit.Value"/>
<link id="TLazIntegerEdit.Text"/>
<link id="TLazIntegerEdit.DisplayBase"/>
<link id="TLazIntegerEditGen._RealGetText"/>
<link id="#lcl.stdctrls.TCustomEdit.Text">TCustomEdit.Text</link>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
</seealso>
</element>
<element name="TLazIntegerEdit.RealGetText.Result">
<short>
Value used for the Text property.
</short>
</element>
<element name="TLazIntegerEdit.InitializeWnd">
<short>
Updates the value in Text when the window handle is created.
</short>
<descr>
<p>
InitializeWnd is an overridden method in TLazIntegerEdit. It calls the
alternate routine in the generic base class (_InitializeWnd) on entry. The
inherited method (in TCustomEdit) is called to initialize members in the
widget instance including its Handle and control flag values.
</p>
<p>
InitializeWnd ensures that the Text displayed for the control is updated to
reflect the Value property converted to the selected DisplayBase with the
corresponding prefix.
</p>
</descr>
<seealso>
<link id="TLazIntegerEditGen._InitializeWnd"/>
<link id="#lcl.stdctrls.TCustomEdit.InitializeWnd">TCustomEdit.InitializeWnd</link>
</seealso>
</element>
<element name="TLazIntegerEdit.FinalizeWnd">
<short>
Updates the Value for the control prior to freeing the window handle for the
control.
</short>
<descr>
<p>
FinalizeWnd is an overridden method in TLazIntegerEdit. It ensures that the
control Value is updated using the Text for the control after conversion back
to a Decimal (base-10) value. This action is performed prior to calling the
inherited FinalizeWnd method (in TWinControl) to update the control Caption
and free its Handle.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit.Text"/>
<link id="TLazIntegerEdit.InitializeWnd"/>
<link id="TLazIntegerEditGen._FinalizeWnd"/>
<link id="#lcl.controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
</seealso>
</element>
<element name="TLazIntegerEdit.DoExit">
<short>
Updates Value with the contents in Text when the control loses input focus.
</short>
<descr>
<p>
DoExit is an overridden method in TLazIntegerEdit. It ensures that the Value
for the control is updated when the control loses input focus. DoExit calls
the alternate handler (_DoExit) in TLazIntegerEditGen to perform the actions
needed.
</p>
<p>
The Value property is updated by converting the Text for control back to its
Decimal (base-10) representation. Values in MinValue and MaxValue are enforced
when Value is updated.
</p>
<p>
DoExit calls the inherited method (in TCustomEdit) to reset the AutoSelected
property, and to signal the OnExit event handler (when assigned).
</p>
<p>
DoExit is called when the CM_EXIT control message is handled for the control.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit.OnExit"/>
<link id="TLazIntegerEdit.Text"/>
<link id="TLazIntegerEdit.Value"/>
<link id="TLazIntegerEdit.MinValue"/>
<link id="TLazIntegerEdit.MaxValue"/>
<link id="TLazIntegerEditGen._DoExit"/>
<link id="#lcl.stdctrls.TCustomEdit.DoExit">TCustomEdit.DoExit</link>
<link id="#lcl.controls.TWinControl.DoExit">TWinControl.DoExit</link>
<link id="#lcl.controls.TWinControl.OnExit">TWinControl.OnExit</link>
</seealso>
</element>
<element name="TLazIntegerEdit.EditingDone">
<short>
Updates the control Value when editing has been completed for the control.
</short>
<descr>
<p>
EditingDone is an overridden method in TLazIntegerEdit. It ensures that the
Value property is updated when editing has been completed for the control. The
alternate handler routine (_EditingDone) in the generic base class
(TLazIntegerEditGen) is called to perform the actions needed.
</p>
<p>
Value is updated by converting the control Text back to its Decimal (base-10)
representation. Values in the MinValue and MaxValue properties are enforced
when Value is updated.
</p>
<p>
EditingDone in an ancestor class (TControl) is called when the ReadOnly
property is set to <b>False</b>, and the OnEditingDone event handler is
signalled (when assigned).
</p>
<p>
Editing is called when the VK_RETURN key is handled for the control.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit.Text"/>
<link id="TLazIntegerEdit.Value"/>
<link id="TLazIntegerEdit.MinValue"/>
<link id="TLazIntegerEdit.MaxValue"/>
<link id="TLazIntegerEditGen._EditingDone"/>
<link id="#lcl.controls.TControl.EditingDone">TControl.EditingDone</link>
<link id="#lcl.controls.TControl.OnEditingDone">TControl.OnEditingDone</link>
</seealso>
</element>
<!--
Commented out in source code too.
<element name="TLazIntegerEdit.DoEnter">
<short/>
<descr/>
<seealso/>
</element>
-->
<!-- public -->
<element name="TLazIntegerEdit.Create">
<short>
Constructor for the class instance.
</short>
<descr>
<p>
Create is the overridden constructor for the class instance. It calls the
_Init method in the base class to set the default values for members in the
class instance. It calls the inherited constructor (in TCustomEdit) to set the
default values for members in ancestor class.
</p>
</descr>
<seealso/>
</element>
<element name="TLazIntegerEdit.Create.AOwner">
<short>
Owner of the class instance.
</short>
</element>
<!-- published -->
<element name="TLazIntegerEdit.Value"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.Value"/>
<element name="TLazIntegerEdit.MinValue"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.MinValue"/>
<element name="TLazIntegerEdit.MaxValue"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.MaxValue"/>
<element name="TLazIntegerEdit.DisplayBase"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.DisplayBase"/>
<element name="TLazIntegerEdit.SetDecimalKeys"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.SetDecimalKeys"/>
<element name="TLazIntegerEdit.HexIndicator">
<short>
Contains the prefix displayed in the control when the value is displayed in hexadecimal format (DisplayBase = 16).
</short>
<descr>
<p>
HexIndicator contains the prefix displayed in the edit control when
DisplayBase is set to 16 for hexadecimal format. The default value for the
property is '$' as assigned in the _Init method in the base class. Changing
the value for the property causes the text displayed on the control to be
converted and re-encoded when DisplayBase is 16.
</p>
<p>
Use BinIndicator or OctIndicator for the prefix used for base-2 and base-8
respectively.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit.DisplayBase"/>
<link id="TLazIntegerEdit.BinIndicator"/>
<link id="TLazIntegerEdit.OctIndicator"/>
<link id="TLazIntegerEdit.Create"/>
<link id="TLazIntegerEditGen._Init"/>
</seealso>
</element>
<element name="TLazIntegerEdit.SetHexKeys">
<short>
Contains the character(s) which cause the edit control to be displayed using
the hexadecimal (base-16) radix.
</short>
<descr>
<p>
A default value is not assigned for the property. The ToggleHexKeys property
is used to toggle between Hexadecimal (base-16) and Decimal (base-10)
instead. When a value is assigned to ToggleHexKeys, those keys take precedence
over the keys in SetHexKey. The value is used, when applicable, in the
_KeyPress handler for the control.
</p>
</descr>
<seealso>
<link id="TLazIntegerEdit.ToggleHexKeys"/>
<link id="TLazIntegerEdit.DisplayBase"/>
<link id="TLazIntegerEditGen._KeyPress"/>
<link id="TLazIntegerEditGen.SetHexKeys"/>
</seealso>
</element>
<!-- topics linked to the generic base class -->
<element name="TLazIntegerEdit.ToggleHexKeys"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.ToggleHexKeys"/>
<element name="TLazIntegerEdit.OctIndicator"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.OctIndicator"/>
<element name="TLazIntegerEdit.SetOctKeys"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.SetOctKeys"/>
<element name="TLazIntegerEdit.ToggleOctKeys"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.ToggleOctKeys"/>
<element name="TLazIntegerEdit.BinIndicator"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.BinIndicator"/>
<element name="TLazIntegerEdit.SetBinKeys"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.SetBinKeys"/>
<element name="TLazIntegerEdit.ToggleBinKeys"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.ToggleBinKeys"/>
<element name="TLazIntegerEdit.OnBaseChange"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.OnBaseChange"/>
<element name="TLazIntegerEdit.AllowMinus"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.AllowMinus"/>
<element name="TLazIntegerEdit.AllowPlus"
link="#lazcontrols.laznumedit.TLazIntegerEditGen.AllowPlus"/>
<!-- topics linked to inherited topics -->
<!-- public -->
<element name="TLazIntegerEdit.AutoSelected"
link="#lcl.stdctrls.TCustomEdit.AutoSelected"/>
<!-- published -->
<element name="TLazIntegerEdit.Align" link="#lcl.controls.TControl.Align"/>
<element name="TLazIntegerEdit.Alignment"
link="#lcl.stdctrls.TCustomEdit.Alignment"/>
<element name="TLazIntegerEdit.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TLazIntegerEdit.AutoSize"
link="#lcl.stdctrls.TCustomEdit.AutoSize"/>
<element name="TLazIntegerEdit.AutoSelect"
link="#lcl.stdctrls.TCustomEdit.AutoSelect"/>
<element name="TLazIntegerEdit.BidiMode"
link="#lcl.controls.TControl.BidiMode"/>
<element name="TLazIntegerEdit.BorderSpacing"
link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TLazIntegerEdit.BorderStyle"
link="#lcl.stdctrls.TCustomEdit.BorderStyle"/>
<element name="TLazIntegerEdit.CharCase"
link="#lcl.stdctrls.TCustomEdit.CharCase"/>
<element name="TLazIntegerEdit.Color"
link="#lcl.controls.TControl.Color"/>
<element name="TLazIntegerEdit.Constraints"
link="#lcl.controls.TControl.Constraints"/>
<element name="TLazIntegerEdit.DoubleBuffered"
link="#lcl.controls.TWinControl.DoubleBuffered"/>
<element name="TLazIntegerEdit.DragCursor"
link="#lcl.controls.TControl.DragCursor"/>
<element name="TLazIntegerEdit.DragKind"
link="#lcl.controls.TControl.DragKind"/>
<element name="TLazIntegerEdit.DragMode"
link="#lcl.controls.TControl.DragMode"/>
<element name="TLazIntegerEdit.EchoMode"
link="#lcl.stdctrls.TCustomEdit.EchoMode"/>
<element name="TLazIntegerEdit.Enabled"
link="#lcl.controls.TControl.Enabled"/>
<element name="TLazIntegerEdit.Font" link="#lcl.controls.TControl.Font"/>
<element name="TLazIntegerEdit.HideSelection"
link="#lcl.stdctrls.TCustomEdit.HideSelection"/>
<element name="TLazIntegerEdit.MaxLength"
link="#lcl.stdctrls.TCustomEdit.MaxLength"/>
<element name="TLazIntegerEdit.NumbersOnly"
link="#lcl.stdctrls.TCustomEdit.NumbersOnly"/>
<element name="TLazIntegerEdit.ParentBidiMode"
link="#lcl.controls.TControl.ParentBidiMode"/>
<element name="TLazIntegerEdit.ParentColor"
link="#lcl.stdctrls.TCustomEdit.ParentColor"/>
<element name="TLazIntegerEdit.ParentDoubleBuffered"
link="#lcl.controls.TWinControl.ParentDoubleBuffered"/>
<element name="TLazIntegerEdit.ParentFont"
link="#lcl.controls.TControl.ParentFont"/>
<element name="TLazIntegerEdit.ParentShowHint"
link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TLazIntegerEdit.PasswordChar"
link="#lcl.stdctrls.TCustomEdit.PasswordChar"/>
<element name="TLazIntegerEdit.PopupMenu"
link="#lcl.stdctrls.TCustomEdit.PopupMenu"/>
<element name="TLazIntegerEdit.ReadOnly"
link="#lcl.stdctrls.TCustomEdit.ReadOnly"/>
<element name="TLazIntegerEdit.ShowHint"
link="#lcl.controls.TControl.ShowHint"/>
<element name="TLazIntegerEdit.TabStop"
link="#lcl.stdctrls.TCustomEdit.TabStop"/>
<element name="TLazIntegerEdit.TabOrder"
link="#lcl.stdctrls.TCustomEdit.TabOrder"/>
<element name="TLazIntegerEdit.Text"
link="#lcl.stdctrls.TCustomEdit.Text"/>
<element name="TLazIntegerEdit.TextHint"
link="#lcl.stdctrls.TCustomEdit.TextHint"/>
<element name="TLazIntegerEdit.Visible"
link="#lcl.controls.TControl.Visible"/>
<element name="TLazIntegerEdit.OnChange"
link="#lcl.stdctrls.TCustomEdit.OnChange"/>
<element name="TLazIntegerEdit.OnChangeBounds"
link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TLazIntegerEdit.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TLazIntegerEdit.OnContextPopup"
link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TLazIntegerEdit.OnDblClick"
link="#lcl.controls.TControl.OnDblClick"/>
<element name="TLazIntegerEdit.OnDragDrop"
link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TLazIntegerEdit.OnDragOver"
link="#lcl.controls.TControl.OnDragOver"/>
<element name="TLazIntegerEdit.OnEditingDone"
link="#lcl.controls.TControl.OnEditingDone"/>
<element name="TLazIntegerEdit.OnEndDrag"
link="#lcl.controls.TControl.OnEndDrag"/>
<element name="TLazIntegerEdit.OnEnter"
link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TLazIntegerEdit.OnExit"
link="#lcl.controls.TWinControl.OnExit"/>
<element name="TLazIntegerEdit.OnKeyDown"
link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TLazIntegerEdit.OnKeyPress"
link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TLazIntegerEdit.OnKeyUp"
link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TLazIntegerEdit.OnMouseDown"
link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TLazIntegerEdit.OnMouseEnter"
link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TLazIntegerEdit.OnMouseLeave"
link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TLazIntegerEdit.OnMouseMove"
link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TLazIntegerEdit.OnMouseUp"
link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TLazIntegerEdit.OnMouseWheel"
link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TLazIntegerEdit.OnMouseWheelDown"
link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TLazIntegerEdit.OnMouseWheelUp"
link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TLazIntegerEdit.OnResize"
link="#lcl.controls.TControl.OnResize"/>
<element name="TLazIntegerEdit.OnStartDrag"
link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TLazIntegerEdit.OnUTF8KeyPress"
link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="Str2QWord">
<short>
Converts the specified string to a QWord value using the specified numeric base.
</short>
<descr/>
<seealso/>
</element>
<element name="Str2QWord.Result">
<short>
Value for the specified string as a QWord type.
</short>
</element>
<element name="Str2QWord.S">
<short>
String with the value converted in the routine.
</short>
</element>
<element name="Str2QWord.Base">
<short>
Numeric base (or radix) for the QWord value in the result.
</short>
</element>
<element name="QWord2Str">
<short>
Converts a QWord value using the specified numeric base to its string
representation.
</short>
<descr/>
<seealso/>
</element>
<element name="QWord2Str.Result">
<short>
String representation for the converted numeric value.
</short>
</element>
<element name="QWord2Str.N">
<short>
QWord value converted to a string in the routine.
</short>
</element>
<element name="QWord2Str.Base">
<short>
Numeric base (or radix) for the specified QWord value.
</short>
</element>
</module>
<!-- laznumedit -->
</package>
</fpdoc-descriptions>
|