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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
Documentation for LCL (Lazarus Component Library) and LazUtils (Lazarus
Utilities) are published under the Creative Commons Attribution-ShareAlike 4.0
International public license.
https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt
https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/docs/cc-by-sa-4-0.txt
Copyright (c) 1997-2025, by the Lazarus Development Team.
-->
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
Spin
====================================================================
-->
<module name="Spin">
<short>This unit contains classes for spin edit controls.</short>
<descr>
<p>
<file>spin.pp</file> contains classes which implement spin edit controls.
<file>spin.pp</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p>
<p>
The following components are added to the Lazarus IDE component palette:
</p>
<p>
<b>Misc</b> Tab
</p>
<ul>
<li>TSpinEdit</li>
<li>TFloatSpinEdit</li>
</ul>
<p>
Original author: Shane Miller.
</p>
<p>
Modified by: Bart Broersma.
</p>
</descr>
<!-- unresolved external references -->
<element name="Types"/>
<element name="Classes"/>
<element name="Controls"/>
<element name="SysUtils"/>
<element name="LCLType"/>
<element name="LCLProc"/>
<element name="StdCtrls"/>
<element name="Math"/>
<element name="TCustomFloatSpinEdit">
<short>
The base class for a spin edit control using a floating point value.
</short>
<descr>
<p>
<var>TCustomFloatSpinEdit</var> is a <var>TCustomEdit</var> descendant which
implements the base class for the float-based spin edit control. It provides
an edit control where the Float value can be entered directly, and up / down
buttons which can be used to increment or decrement the value for the control.
</p>
<p>
Use the Value property to assign a floating point value to the control as a
Double type. Value is a 64-bit real type in the range 5.0E-324 .. 1.7E308
(inclusive), and allows up to 15-16 digits of precision (15 digits for a
negative value).
</p>
<p>
At run-time, setting Value to a number outside of the range for the real type
causes Value to be updated. When neither MinValue nor MaxValue have been
assigned, either -Inf or +Inf is displayed as the value for the control. If
either MinValue or MaxValue has been given an explicit non-default value, the
Value property is updated with corresponding range limit.
</p>
<p>
In LCL version 3.0, the floating point property editor will not allow an
invalid value to be stored in the Value property at design-time. An error is
raised (and handled) with the message 'Property value out of range', and the
Value property is not updated.
</p>
<p>
LCL versions prior to 3.0 allowed the values +Inf, -Inf, and NaN to be
assigned as the property value. These values are no longer supported in LCL
version 3.0 and later.
</p>
<p>
Use the MinValue and MaxValue properties to define the lower and upper limits
for the Value in the control. Like Value, they are implemented as a Double
type with the same range limits. An invalid value causes the property to be
set to the corresponding range limit for the real type.
</p>
<p>
Use the DecimalPlaces property to specify the number of decimal digits
displayed for a value not represented using the radix/precision/exponent
format for the IEE 754 value.
</p>
<p>
Use the Increment property to set the value added to or subtracted from the
control Value when the up or down buttons are clicked.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.Value"/>
<link id="TCustomFloatSpinEdit.MinValue"/>
<link id="TCustomFloatSpinEdit.MaxValue"/>
<link id="TCustomFloatSpinEdit.DecimalPlaces"/>
<link id="TCustomFloatSpinEdit.Increment"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
<version>
Modified in LCL version 3.0 to implement range checking with floating point property editor support.
</version>
</element>
<element name="TCustomFloatSpinEdit.DefIncrement">
<short>
Default increment value for the control. Used to determine if an explicit
increment value has been assigned to the control.
</short>
</element>
<element name="TCustomFloatSpinEdit.DefDecimals">
<short>
Default number of decimal places displayed for the control. Used to determine
if an explicit value has been assigned to the DecimalPlaces property.
</short>
</element>
<element name="TCustomFloatSpinEdit.DefMaxValue">
<short>
Default value for the MaxValue property. Used to determine if an explicit
value has been assigned to the MaxValue property.
</short>
</element>
<element name="TCustomFloatSpinEdit.FIncrement">
<short>Stores the increment for the control.</short>
</element>
<element name="TCustomFloatSpinEdit.FDecimals">
<short>Stores the decimal places displayed for the control.</short>
</element>
<element name="TCustomFloatSpinEdit.FEditorEnabled">
<short>Stores the value for the EditorEnabled property.</short>
</element>
<element name="TCustomFloatSpinEdit.FMaxValue">
<short>Stores the value for the MaxValue property.</short>
</element>
<element name="TCustomFloatSpinEdit.FMinValue">
<short>Stores the value for the MinValue property.</short>
</element>
<element name="TCustomFloatSpinEdit.FForceModifiedIsFalseInOnChange">
<short>
Internal flag which controls the value for Modified in the OnChange event
handler.
</short>
</element>
<element name="TCustomFloatSpinEdit.FValue">
<short>Stores the value for the Value property.</short>
</element>
<element name="TCustomFloatSpinEdit.FValueEmpty">
<short>Stores the value for the ValueEmpty property.</short>
</element>
<element name="TCustomFloatSpinEdit.FUpdatePending">
<short>Internal flag used in the control.</short>
</element>
<element name="TCustomFloatSpinEdit.FValueChanged">
<short>Internal flag used in the control.</short>
</element>
<element name="TCustomFloatSpinEdit.GetValue">
<short>Gets the value for the Value property.</short>
</element>
<element name="TCustomFloatSpinEdit.GetValue.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetEditorEnabled">
<short>Sets the value for the EditorEnabled property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.EditorEnabled"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetEditorEnabled.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.UpdateControl">
<short>
Normalizes the Value for the control and notifies the widgetset class.
</short>
</element>
<element name="TCustomFloatSpinEdit.MaxValueStored">
<short>Implements the storage specifier for the MaxValue property.</short>
</element>
<element name="TCustomFloatSpinEdit.MaxValueStored.Result">
<short><b>True</b> if an explicit value has been assigned to MaxValue.</short>
</element>
<element name="TCustomFloatSpinEdit.IncrementStored">
<short>Implements the storage specifier for the Increment property.</short>
</element>
<element name="TCustomFloatSpinEdit.IncrementStored.Result">
<short>
<b>True</b> if an explicit value has been assigned to Increment.
</short>
</element>
<element name="TCustomFloatSpinEdit.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomFloatSpinEdit.Change">
<short>
Updates Modified prior to sending control messages and signalling OnChange
handler(s).
</short>
<descr>
<p>
<var>Change</var> is an overridden method in <var>TCustomFloatSpinEdit</var>.
It ensures that the value in <var>Modified</var> is updated when the
widgetset class applies a new value for the control. An internal flag is used
to determine if Modified is set to <b>False</b> prior to calling the
inherited Change method. The flag is set when a new value is applied to the
Value property in program code (instead of using the UI elements for the
control). This is performed here because the widgetset class calls Changed
and not TextChanged.
</p>
<p>
Change calls the inherited method where the CM_CHANGED control message is
posted, and assigned OnChange handlers are signalled for the control.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.Modified">TCustomEdit.Modified</link>
<link id="#lcl.stdctrls.TCustomEdit.Change">TCustomEdit.Change</link>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.EditingDone">
<short>
Performs actions when editing has been completed for the control.
</short>
<descr>
<p>
EditingDone is an overridden method in TCustomFloatSpinEdit. It ensures that
the control is updated when editing has been completed.
</p>
<p>
EditingDone calls the UpdateControl method to normalize and validate the
control Value using the assigned range in MinValue and MaxValue. This
includes calling GetLimitedValue to update the control Value when both
MinValue and MaxValue contain a valid range. The value in the widgetset class
is updated when component streaming is not active, and the control is not
being freed.
</p>
<p>
EditingDone calls the inherited method to signal the OnEditingDone event
handler (when assigned) when ReadOnly is <b>False</b>.
</p>
<p>
EditingDone is called from the KeyUpAfterInterface method in TCustomEdit when
the Enter (VK_RETURN) key code is handled for the control. It also occurs
when the focused control has been changed.
</p>
</descr>
<version>
The method override was added in LCL version 2.2.1.
</version>
<seealso>
<link id="TCustomFloatSpinEdit.GetLimitedValue"/>
<link id="TCustomFloatSpinEdit.Value"/>
<link id="TCustomFloatSpinEdit.MinValue"/>
<link id="TCustomFloatSpinEdit.MaxValue"/>
<link id="#lcl.stdctrls.TCustomEdit.EditingDone">TCustomEdit.EditingDone</link>
<link id="#lcl.controls.TControl.OnEditingDone">TControl.OnEditingDone</link>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.RealGetText">
<short>Gets the value for the text in the control.</short>
<descr>
<p>
<var>RealGetText</var> is an overridden method in
<var>TCustomFloatSpinEdit</var>, and calls the inherited method to get the
return value when the <var>Handle</var> has been allocated for the control.
If the Handle has not been assigned, <var>ValueToStr</var> is called to get
the return value for the method.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.ValueToStr"/>
<link id="#lcl.stdctrls.TCustomEdit.RealGetText">TCustomEdit.RealGetText</link>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.RealGetText.Result" link="#lcl.stdctrls.TCustomEdit.RealGetText.Result"/>
<element name="TCustomFloatSpinEdit.RealSetText" link="#lcl.stdctrls.TCustomEdit.RealSetText"/>
<element name="TCustomFloatSpinEdit.RealSetText.AValue"/>
<element name="TCustomFloatSpinEdit.TextChanged">
<short>
Updates the control state when the value in Text has been changed.
</short>
<descr>
<p>
<var>TextChanged</var> is an overridden method in
<var>TCustomFloatSpinEdit</var>. It ensures that internal flags are updated
to track the value and state for the control when it has been changed. It
calls the inherited method to validate the content in Text and update the
caret position for the control.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.TextChanged">TCustomEdit.TextChanged</link>
<link id="#lcl.stdctrls.TCustomEdit.CaretPos">TCustomEdit.CaretPos</link>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetDecimals">
<short>Sets the value for the DecimalPlaces property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.DecimalPlaces"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetDecimals.ADecimals">
<short>New value for the DecimalPlaces property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetValue">
<short>Sets the value for the Value property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.Value"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetValue.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetMaxValue">
<short>Sets the value for the MaxValue property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.MaxValue"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetMaxValue.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetMinValue">
<short>Sets the value for the MinValue property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.MinValue"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetMinValue.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetValueEmpty">
<short>Sets the value for the ValueEmpty property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.ValueEmpty"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetValueEmpty.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetIncrement">
<short>Sets the value for the Increment property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.Increment"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetIncrement.AIncrement">
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.InitializeWnd">
<short>Creates or re-creates the handle for the windowed control.</short>
<descr/>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.InitializeWnd">TCustomEdit.InitializeWnd</link>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.FinalizeWnd">
<short>Frees the handle for the windowed control.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.Loaded">
<short>Performs actions when LCL component streaming is completed.</short>
<descr>
<p>
<var>Loaded</var> calls the inherited method on entry to determine the size
for the control (and its children) and to apply property values inherited
from the parent control (when assigned). Loaded calls the private
<var>UpdateControl</var> method when the internal update flag has been set
for the control.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TWinControl.Loaded">TWinControl.Loaded</link>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.KeyPress">
<short>Handles key press events for the control.</short>
<descr>
<p>
<var>KeyPress</var> is an overridden method used to handle key press events
for the control. KeyPress calls the inherited method on entry. If the
character in <var>Key</var> is not handled in the ancestor class, the
argument is examined to determine if it is valid for the control. If Key is
not a valid character, it is set to <b>#0</b> to ignore the key press event.
</p>
<p>
KeyPress disallows any value in Key that is not a numeric digit, sign
character ('+' or '-'), scientific exponentiation symbol ('E' or 'e'), or
decimal point character ('.' or ','). The decimal point is automatically
converted to the value used in the <var>DefaultFormatSettings</var> variable
from the RTL. The decimal point is not allowed when <var>Decimals</var> is
set to <b>0</b> (<b>zero</b>).
</p>
<p>
KeyPress does not ensure that the value in Key is valid for a specific
position in the control value. It does not guarantee that sign indicators are
used only at the start of the control value. Nor does it guarantee that a
decimal point character is not used more than once in the entered value. This
is implemented in a manner that is Delphi compatible.
</p>
<p>
Tab (<b>#9</b>), BackSpace (<b>#8</b>), Cut (<b>^X</b>), Paste (<b>^V</b>),
Copy (<b>^C</b>), and Undo (<b>^Z</b>) characters are allowed in Key so that
they may be applied in inherited methods for the control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.KeyPress.Key">
<short>Character value for the key press event.</short>
</element>
<element name="TCustomFloatSpinEdit.GetControlClassDefaultSize">
<short>Gets the default size for new instances of the class.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.GetControlClassDefaultSize.Result">
<short>Default size for the new class instance.</short>
</element>
<element name="TCustomFloatSpinEdit.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. Create sets the style flags needed for
the spin edit control, and sets the default values for properties in the
class instance. The <var>GetControlClassDefaultSize</var> method is called
and the return value is used to set the initial size for the control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomFloatSpinEdit.GetLimitedValue">
<short>
Limits the specified value to the minimum and maximum values for the control.
</short>
<descr>
<p>
The return value is set to AValue and limited to the range in the MinValue
and MaxValue properties. This occurs when MaxValue has a value that is larger
than MinValue. No constraints are applied when MinValue and MaxValue have the
the same value, or when MaxValue is smaller than MinValue.
</p>
<remark>
Delphi does not constrain the value when MinValue and MaxValue are the same,
but does if MaxValue is smaller than MinValue.
</remark>
<p>
Called from the UpdateControl, StrToValue, and ValueToStr methods.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.GetLimitedValue.Result">
<short>
Value for the control limited to the range in MinValue and MaxValue.
</short>
</element>
<element name="TCustomFloatSpinEdit.GetLimitedValue.AValue">
<short>Value examined in the method.</short>
</element>
<element name="TCustomFloatSpinEdit.ValueToStr">
<short>
Converts the specified value to a String type using the spin edit settings.
</short>
<descr>
<p>
Calls <var>GetLimitedValue</var> to range limit the value in
<var>AValue</var>. Calls <var>FloatToStrF</var> to format the return value
using 20 digits of precision and the number of decimals in the
<var>DecimalPlaces</var> property.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.ValueToStr.Result">
<short>String representation for the float value.</short>
</element>
<element name="TCustomFloatSpinEdit.ValueToStr.AValue">
<short>Float value converted to a string in the method.</short>
</element>
<element name="TCustomFloatSpinEdit.StrToValue">
<short>
Converts the specified string to a float value according to spin edit
settings.
</short>
<descr>
<p>
Calls <var>StrToFloatF</var> to convert the value in <var>S</var> to a Double
data type. If S contains an invalid representation for a float value,
<var>Value</var> is used as the return value for the method.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.StrToValue.Result">
<short>Float value for the specified string.</short>
</element>
<element name="TCustomFloatSpinEdit.StrToValue.S">
<short>String examined and converted to a float value in the method.</short>
</element>
<element name="TCustomFloatSpinEdit.DecimalPlaces">
<short>
Number of the decimal places displayed in the spin edit control.
</short>
<descr>
<p>
<var>DecimalPlaces</var> is used in the <var>ValueToStr</var> method, and
determines the decimal precision for the value displayed in the spin edit
control.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.EditorEnabled">
<short>
Indicates whether the value for the control can be entered directly into its
edit box.
</short>
<descr>
<p>
<var>EditorEnabled</var> is a <var>Boolean</var> property which indicates if
the <var>Value</var> for the control can be input directly. When set to
<b>True</b>, the edit box is enabled. When set To <b>False</b>, only the up
and down arrow buttons can be used to change the Value for the control.
</p>
<p>
The default value for the property is <b>True</b>. Changing the value for the
property causes the widgetset class to be notified when the Handle for the
control has been allocated.
</p>
<p>
EditorEnabled is independent of the settings in the <var>ReadOnly</var> and
<var>Enabled</var> properties. When ReadOnly is set to <b>True</b>, the Value
for the control cannot be modified using either the edit box or the up / down
buttons. When Enabled is set to <b>False</b>, the control cannot be given
focus or modified.
</p>
<remark>
Disabling the edit box requires support from the underlying widgetset class.
It may not be supported or implemented for all widgetsets / platforms. In
the current LCL version, it is implemented for the Windows and Windows CE
platforms.
</remark>
</descr>
<version>
Added in LCL version 2.1.
</version>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.Increment">
<short>
Amount applied to the control value when the up or down arrow button is
pushed.
</short>
<descr>
<p>
The default value for the property is defined in the <var>DefIncrement</var>
constant (1). Changing the value for the property causes the
<var>UpdateControl</var> method to be called.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.MinValue">
<short>
Minimum value allowed in the spin edit control.
</short>
<descr>
<p>
<var>MinValue</var> is a <var>Double</var> property which contains the
minimum value allowed for the spin edit control. It is used, along with
MaxValue, to determine the range of values allowed in the Value property.
</p>
<p>
When MinValue and MaxValue have the same value, or MaxValue is smaller than
MinValue, the range limit is not enforced. This allows any value to be
assigned to the control.
</p>
<p>
Changing the value for the property causes the range limits to be re-applied
to Value by calling the GetLimitedValue method. A pending update is also
applied to the widgetset class instance.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.MaxValue"/>
<link id="TCustomFloatSpinEdit.Value"/>
<link id="TCustomFloatSpinEdit.GetLimitedValue"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.MaxValue">
<short>
Maximum value allowed in the spin edit control.
</short>
<descr>
<p>
MaxValue is a Double property which contains the maximum value allowed for
the spin edit control. It is used, along with MinValue, to determine the
range of values allowed in the Value property.
</p>
<p>
When MinValue and MaxValue have the same value, or MaxValue is smaller than
MinValue, the range limit is not enforced. This allows any value to be
assigned to the control.
</p>
<p>
Changing the value for the property causes the range limits to be re-applied
to Value by calling the GetLimitedValue method. A pending update is also
applied to the widgetset class instance.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.MinValue"/>
<link id="TCustomFloatSpinEdit.Value"/>
<link id="TCustomFloatSpinEdit.GetLimitedValue"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.Value">
<short>
The floating point value for the spin edit control.
</short>
<descr>
<p>
<var>Value</var> is a Double property which contains the floating point value
for the spin edit control. It can be modified using the UI elements for the
control (up and down buttons, up and down cursor keys, or the edit box for
the control). It can also be assigned directly in program code.
</p>
<p>
Value is a 64-bit real type in the range 5.0E-324 .. 1.7E308 (inclusive), and
allows up to 15-16 digits of precision (15 digits for a negative value).
</p>
<p>
Changing the value for the property causes the <var>Text</var> for the
control to be checked for a valid numeric representation for the property. If
the new property value is the same as the existing value, no actions are
performed.
</p>
<p>
When the property value has been stored, internal flags are set to ensure
that <var>Modified</var> is updated accordingly and the private
<var>UpdateControl</var> method is called. If the handle for the control has
been allocated, the <var>Change</var> method is called to post a
<b>CM_CHANGED</b> control message and signal <var>OnChange</var> handler(s)
assigned for the control.
</p>
<p>
When changed, Value is constrained to the range defined in the
<var>MinValue</var> and <var>MaxValue</var> properties (when assigned). The
range limits are not enforced when MinValue and MaxValue have the same value,
or when MaxValue is smaller than MinValue. When neither MinValue nor MaxValue
have been assigned, either -Inf or +Inf is displayed as the value for the
control. If either MinValue or MaxValue has been given an explicit
non-default value, the Value property is updated with corresponding range
limit.
</p>
<p>
In LCL version 3.0, the floating point property editor will not allow an
invalid value to be stored in the Value property at design-time. An error is
raised (and handled) with the message 'Property value out of range', and the
Value property is not updated.
</p>
<p>
LCL versions prior to 3.0 allowed the values +Inf, -Inf, and NaN to be
assigned as the property value. These values are no longer supported in LCL
version 3.0 and later.
</p>
<p>
Use the MinValue and MaxValue properties to define the lower and upper limits
for the Value in the control. Like Value, they are implemented as a Double
type with the same range limits. An invalid value causes the property to be
set to the corresponding range limit for the real type.
</p>
<p>
Use the DecimalPlaces property to specify the number of decimal digits
displayed for a value not represented using the radix/precision/exponent
format for the IEE 754 value.
</p>
<p>
Use the Increment property to set the value added to or subtracted from the
control Value when the up or down buttons are clicked.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.MinValue"/>
<link id="TCustomFloatSpinEdit.MaxValue"/>
<link id="TCustomFloatSpinEdit.GetLimitedValue"/>
<link id="TCustomFloatSpinEdit.Change"/>
<link id="TCustomFloatSpinEdit.Increment"/>
<link id="#lcl.stdctrls.TCustomEdit.Modified">TCustomEdit.Modified</link>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.ValueEmpty">
<short>
Indicates that a value has not been assigned for the control.
</short>
<descr>
<p>
<var>ValueEmpty</var> is a <var>Boolean</var> property which indicates
whether or not an explicit numeric value has been assigned to the Value
property. ValueEmpty is updated in the <var>TextChanged</var> method when a
new value in Text is handled for the control. When set to <b>True</b>, an
explicit value has <b>not</b> been assigned.
</p>
<p>
The default value for the property is <b>False</b>.
</p>
<p>
Changing the value for the property causes the <var>UpdateControl</var>
method to be called. This re-applies the range limits in MinValue and
MaxValue (when assigned and needed) and posts the update the widgetset class.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.TextChanged"/>
<link id="TCustomFloatSpinEdit.Value"/>
<link id="TCustomFloatSpinEdit.MinValue"/>
<link id="TCustomFloatSpinEdit.MaxValue"/>
<link id="#lcl.stdctrls.TCustomEdit.Text">TCustomEdit.Text</link>
</seealso>
</element>
<element name="TFloatSpinEdit">
<short>
Implements a spin edit control using a floating point value.
</short>
<descr>
<p>
<var>TFloatSpinEdit</var> is a <var>TCustomFloatSpinEdit</var> descendant
which implements a float-based spin edit control. It provides an edit control
where the Float value can be entered directly, and up / down buttons which
can be used to increment or decrement the <var>Value</var> for the control.
</p>
<p>
Use the Value property to assign a floating point value to the control as a
Double type. Value is a 64-bit real type in the range 5.0E-324 .. 1.7E308
(inclusive), and allows up to 15-16 digits of precision (15 digits for a
negative value).
</p>
<p>
At run-time, setting Value to a number outside of the range for the real type
causes Value to be updated. When neither MinValue nor MaxValue have been
assigned, either -Inf or +Inf is displayed as the value for the control. If
either MinValue or MaxValue has been given an explicit non-default value, the
Value property is updated with corresponding range limit.
</p>
<p>
In LCL version 3.0, the floating point property editor will not allow an
invalid value to be stored in the Value property at design-time. An error is
raised (and handled) with the message 'Property value out of range'. The
Value property is reset to 0.
</p>
<p>
LCL versions prior to 3.0 allowed the values +Inf, -Inf, and NaN to be
assigned to the Value property. These values are no longer supported in LCL
version 3.0 and later.
</p>
<p>
Use the MinValue and MaxValue properties to define the lower and upper limits
for the Value in the control. Like Value, they are implemented as a Double
type with the same range limits. An invalid value causes the property to be
set to the corresponding range limit for the real type.
</p>
<p>
Use the DecimalPlaces property to specify the number of decimal digits
displayed for a value not represented using the radix/precision/exponent
format for the IEE 754 value.
</p>
<p>
Use the Increment property to set the value added to or subtracted from the
control Value when the up or down buttons are clicked.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit"/>
<link id="TSpinEdit"/>
</seealso>
<version>
Modified in LCL version 3.0 to implement range checking with floating point
property editor support.
</version>
</element>
<element name="TFloatSpinEdit.AutoSelected">
<short>
Indicates whether the selected content in the control has been automatically
selected.
</short>
<descr>
<p>
<var>AutoSelected</var> is updated in methods which handle focus change
actions for the control, including: MouseDown, MouseUp, DoEnter, and DoExit.
In general, it indicates when the Text and SelText properties have the same
value.
</p>
<p>
The visibility for the property is public, and does not appear in the Object
Inspector at design-time. It is, however, available in code at run-time. It
is not declared as a read-only property, but there is no obvious reason to
assign a value that does not result from calling the SelectAll method.
</p>
<p>
Use AutoSelect to control whether auto-selection is enabled for the control.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.AutoSelected">TCustomEdit.AutoSelected</link>
</seealso>
</element>
<element name="TFloatSpinEdit.Align" link="#lcl.controls.TControl.Align"/>
<element name="TFloatSpinEdit.Alignment" link="#lcl.stdctrls.TCustomEdit.Alignment"/>
<element name="TFloatSpinEdit.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TFloatSpinEdit.AutoSelect" link="#lcl.stdctrls.TCustomEdit.AutoSelect"/>
<element name="TFloatSpinEdit.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TFloatSpinEdit.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TFloatSpinEdit.Color" link="#lcl.controls.TControl.Color"/>
<element name="TFloatSpinEdit.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TFloatSpinEdit.DecimalPlaces" link="#lcl.spin.TCustomFloatSpinEdit.DecimalPlaces"/>
<element name="TFloatSpinEdit.EditorEnabled" link="#lcl.spin.TCustomFloatSpinEdit.EditorEnabled"/>
<element name="TFloatSpinEdit.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TFloatSpinEdit.Font" link="#lcl.controls.TControl.Font"/>
<element name="TFloatSpinEdit.Increment" link="#lcl.spin.TCustomFloatSpinEdit.Increment"/>
<element name="TFloatSpinEdit.MaxValue" link="#lcl.spin.TCustomFloatSpinEdit.MaxValue"/>
<element name="TFloatSpinEdit.MinValue" link="#lcl.spin.TCustomFloatSpinEdit.MinValue"/>
<element name="TFloatSpinEdit.ParentColor" link="#lcl.stdctrls.TCustomEdit.ParentColor"/>
<element name="TFloatSpinEdit.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TFloatSpinEdit.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TFloatSpinEdit.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TFloatSpinEdit.ReadOnly" link="#lcl.stdctrls.TCustomEdit.ReadOnly"/>
<element name="TFloatSpinEdit.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TFloatSpinEdit.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TFloatSpinEdit.TabStop" link="#lcl.stdctrls.TCustomEdit.TabStop"/>
<element name="TFloatSpinEdit.Value" link="#lcl.spin.TCustomFloatSpinEdit.Value"/>
<element name="TFloatSpinEdit.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TFloatSpinEdit.OnChange">
<short>
The OnChange event is fired when the value for the spin edit has changed.
</short>
<descr>
<p>
<var>OnChange</var> event is similar to <var>TCustomEdit.OnChange</var>, and
is signalled for changes made by the user and for changes made in code. A
change is a modification which will cause the text displayed on the screen by
the control to be altered. This corresponds to a change in the Value property
for the control. The event is called after the change takes place, so Value
will already have the new property value.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.OnChange">TCustomEdit.OnChange</link>
<link id="#lcl.spin.TSpinEdit.OnChange">TSpinEdit.OnChange</link>
</seealso>
</element>
<element name="TFloatSpinEdit.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TFloatSpinEdit.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TFloatSpinEdit.OnEditingDone" link="#lcl.controls.TControl.OnEditingDone"/>
<element name="TFloatSpinEdit.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TFloatSpinEdit.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TFloatSpinEdit.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TFloatSpinEdit.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TFloatSpinEdit.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TFloatSpinEdit.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TFloatSpinEdit.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TFloatSpinEdit.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TFloatSpinEdit.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TFloatSpinEdit.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TFloatSpinEdit.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TFloatSpinEdit.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TFloatSpinEdit.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TFloatSpinEdit.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TFloatSpinEdit.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TFloatSpinEdit.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TFloatSpinEdit.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TFloatSpinEdit.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="TCustomSpinEdit">
<short>The base class for an integer-based spin edit control.</short>
<descr>
<p>
<var>TCustomSpinEdit</var> is a <var>TCustomFloatSpinEdit</var> descendant
which implements a control used to edit, increment, and decrement an Integer
value. It has arrow buttons to allow the user to increment / decrement the
value and an edit box used to enter a value directly.
</p>
<p>
Properties like <var>Value</var>, <var>MinValue</var>, <var>MaxValue</var>,
and <var>Increment</var> are re-declared as an <var>Integer</var> type. It
provides overridden or overloaded methods which use the Integer values needed
for the implementation.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetIncrement">
<short>Gets the value for the Increment property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.Increment"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetIncrement.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomSpinEdit.GetMaxValue">
<short>Gets the value for the MaxValue property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MaxValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetMaxValue.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomSpinEdit.GetMinValue">
<short>Gets the value for the MinValue property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MinValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetMinValue.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomSpinEdit.GetValue">
<short>Gets the value for the Value property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.Value"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetValue.Result">
<short>Value for the property.</short>
</element>
<element name="TCustomSpinEdit.SetIncrement">
<short>Sets the value for the Increment property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.Increment"/>
</seealso>
</element>
<element name="TCustomSpinEdit.SetIncrement.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomSpinEdit.SetMaxValue">
<short>Sets the value for the MaxValue property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MaxValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.SetMaxValue.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomSpinEdit.SetMinValue">
<short>Sets the value for the MinValue property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MinValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.SetMinValue.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomSpinEdit.SetValue">
<short>Sets the value for the Value property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.Value"/>
</seealso>
</element>
<element name="TCustomSpinEdit.SetValue.AValue">
<short>New value for the property.</short>
</element>
<element name="TCustomSpinEdit.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
<var>DecimalPlaces</var> is set to <b>0</b> (<b>zero</b>) for the
<var>Integer</var> type used in the <var>Value</var> property.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.DecimalPlaces"/>
<link id="TCustomSpinEdit.Value"/>
<link id="TCustomSpinEdit.MinValue"/>
<link id="TCustomSpinEdit.MaxValue"/>
<link id="TCustomSpinEdit.Increment"/>
</seealso>
</element>
<element name="TCustomSpinEdit.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCustomSpinEdit.GetLimitedValue">
<short>
Gets the value for the control limited the range in MinValue and MaxValue.
</short>
<descr>
<remark>
<var>GetLimitedValue</var> is implemented to return a <var>Double</var>
value. This remains because the method is called from widgetset classes for
both TFloatSpinEdit and TSpinEdit, and the method signature cannot be changed
to use the <var>Integer</var> type desired for the implementation.
</remark>
<p>
Calls the inherited method on entry. GetLimitedValue also ensures that the
return value is valid for the <var>MinInt</var> and <var>MaxInt</var>
constants defined in RTL for the platform / CPU architecture.
</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.GetLimitedValue"/>
<link id="#rtl.system.MaxInt">MaxInt</link>
</seealso>
</element>
<element name="TCustomSpinEdit.GetLimitedValue.Result">
<short>Range-limited value for the control.</short>
</element>
<element name="TCustomSpinEdit.GetLimitedValue.AValue">
<short>Value normalized to the range in MinValue and MaxValue.</short>
</element>
<element name="TCustomSpinEdit.Value">
<short>The value for the spin edit control.</short>
<descr>
<p>
<var>Value</var> contains the value for the spin edit control. Its content
can be modified using the UI elements for the control (up and down buttons,
up and down cursor keys, edit box for the control). It can also be directly
assigned in program code.
</p>
<p>
Changing the value for the property causes the <var>Text</var> for the
control to be checked for a valid numeric representation in the property. If
the new property value is the same as the existing value, no actions are
performed.
</p>
<p>
When the property value has been stored, internal flags are set to ensure
that <var>Modified</var> is updated accordingly and the private
<var>UpdateControl</var> method in the ancestor is called. If the handle for
the control has been allocated, the <var>Change</var> method in the ancestor
is called to post a <b>CM_CHANGED</b> control message and signal
<var>OnChange</var> handler(s) assigned for the control.
</p>
<p>
When changed, Value is constrained to the range defined in the
<var>MinValue</var> and <var>MaxValue</var> properties (when assigned). The
range limit is not enforced when MinValue and MaxValue have the same value,
or when MaxValue is smaller than MinValue.
</p>
</descr>
<seealso>
<link id="TCustomSpinEdit.MinValue"/>
<link id="TCustomSpinEdit.MaxValue"/>
<link id="TCustomSpinEdit.Increment"/>
<link id="TCustomSpinEdit.GetLimitedValue"/>
<link id="#lcl.stdctrls.TCustomEdit.Modified">TCustomEdit.Modified</link>
</seealso>
</element>
<element name="TCustomSpinEdit.MinValue">
<short>Minimum value allowed for the spin edit control.</short>
<descr>
<p>
MinValue contains the minimum value allowed for the spin edit control. It is
used, along with MaxValue, to determine the range of values allowed in the
Value property.
</p>
<p>
When MinValue and MaxValue have the same value, or MaxValue is smaller than
MinValue, the range limit is not enforced. This allows any value to be
assigned to the control.
</p>
</descr>
<seealso>
<link id="TCustomSpinEdit.MaxValue"/>
<link id="TCustomSpinEdit.Value"/>
<link id="TCustomSpinEdit.Increment"/>
<link id="TCustomSpinEdit.GetLimitedValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.MaxValue">
<short>Maximum value allowed for the spin edit control.</short>
<descr>
<p>
MaxValue contains the maximum value allowed for the spin edit control. It is
used, along with MinValue, to determine the range of values allowed in the
Value property.
</p>
<p>
When MinValue and MaxValue have the same value, or MaxValue is smaller than
MinValue, the range limit is not enforced. This allows any value to be
assigned to the control.
</p>
</descr>
<seealso>
<link id="TCustomSpinEdit.MinValue"/>
<link id="TCustomSpinEdit.Value"/>
<link id="TCustomSpinEdit.Increment"/>
<link id="TCustomSpinEdit.GetLimitedValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.Increment">
<short>
The value by which the value of the control should be increased/decreased
when the user clicks one of the arrows or one of the keyboard up/down arrows.
</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MinValue"/>
<link id="TCustomSpinEdit.MaxValue"/>
<link id="TCustomSpinEdit.Value"/>
</seealso>
</element>
<element name="TSpinEdit">
<short>Implements an integer-based spin edit control.</short>
<descr>
<p>
<var>TSpinEdit</var> is a <var>TCustomSpinEdit</var> descendant which
implements an integer-based spin edit control. It provides an edit control
where the Integer value can be entered directly, and has arrow buttons to
allow the user to increment / decrement the value for the control.
</p>
<p>
TSpinEdit sets the visibility for properties introduced in ancestor classes.
</p>
<p>
Use TFloatSpinEdit to edit a float value in a spin edit control.
</p>
</descr>
<seealso>
<link id="TCustomSpinEdit"/>
<link id="TFloatSpinEdit"/>
</seealso>
</element>
<element name="TSpinEdit.AutoSelected" link="#lcl.stdctrls.TCustomEdit.AutoSelected"/>
<element name="TSpinEdit.Align" link="#lcl.controls.TControl.Align"/>
<element name="TSpinEdit.Alignment" link="#lcl.stdctrls.TCustomEdit.Alignment"/>
<element name="TSpinEdit.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TSpinEdit.AutoSelect" link="#lcl.stdctrls.TCustomEdit.AutoSelect"/>
<element name="TSpinEdit.AutoSize" link="#lcl.stdctrls.TCustomEdit.AutoSize"/>
<element name="TSpinEdit.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TSpinEdit.Color" link="#lcl.controls.TControl.Color"/>
<element name="TSpinEdit.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TSpinEdit.EditorEnabled" link="#lcl.spin.TCustomFloatSpinEdit.EditorEnabled"/>
<element name="TSpinEdit.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TSpinEdit.Font" link="#lcl.controls.TControl.Font"/>
<element name="TSpinEdit.Increment" link="#lcl.spin.TCustomSpinEdit.Increment"/>
<element name="TSpinEdit.MaxValue" link="#lcl.spin.TCustomSpinEdit.MaxValue"/>
<element name="TSpinEdit.MinValue" link="#lcl.spin.TCustomSpinEdit.MinValue"/>
<element name="TSpinEdit.ParentColor" link="#lcl.stdctrls.TCustomEdit.ParentColor"/>
<element name="TSpinEdit.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TSpinEdit.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TSpinEdit.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TSpinEdit.ReadOnly" link="#lcl.stdctrls.TCustomEdit.ReadOnly"/>
<element name="TSpinEdit.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TSpinEdit.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TSpinEdit.TabStop" link="#lcl.stdctrls.TCustomEdit.TabStop"/>
<element name="TSpinEdit.Value" link="#lcl.spin.TCustomSpinEdit.Value"/>
<element name="TSpinEdit.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TSpinEdit.OnChange">
<short>
The OnChange event is fired when the spin edit value has changed.
</short>
<descr>
<p>
This OnChange event is based on <var>TCustomEdit.OnChange</var>, so it is
fired both on changes made by the user and also for changes made by code. A
change is defined as a modification which will cause the text displayed on
the screen by the control to change. This corresponds to a change in the
property Value in the control. The event is called after the change takes
place, so the Value property will contain the new value.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.OnChange">TCustomEdit.OnChange</link>
<link id="#lcl.spin.TFloatSpinEdit.OnChange">TFloatSpinEdit.OnChange</link>
</seealso>
</element>
<element name="TSpinEdit.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TSpinEdit.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TSpinEdit.OnEditingDone" link="#lcl.controls.TControl.OnEditingDone"/>
<element name="TSpinEdit.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TSpinEdit.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TSpinEdit.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown"/>
<element name="TSpinEdit.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress"/>
<element name="TSpinEdit.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp"/>
<element name="TSpinEdit.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
<element name="TSpinEdit.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
<element name="TSpinEdit.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
<element name="TSpinEdit.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
<element name="TSpinEdit.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TSpinEdit.OnMouseWheel" link="#lcl.controls.TControl.OnMouseWheel"/>
<element name="TSpinEdit.OnMouseWheelDown" link="#lcl.controls.TControl.OnMouseWheelDown"/>
<element name="TSpinEdit.OnMouseWheelUp" link="#lcl.controls.TControl.OnMouseWheelUp"/>
<element name="TSpinEdit.OnMouseWheelHorz" link="#lcl.controls.TControl.OnMouseWheelHorz"/>
<element name="TSpinEdit.OnMouseWheelLeft" link="#lcl.controls.TControl.OnMouseWheelLeft"/>
<element name="TSpinEdit.OnMouseWheelRight" link="#lcl.controls.TControl.OnMouseWheelRight"/>
<element name="TSpinEdit.OnResize" link="#lcl.controls.TControl.OnResize"/>
<element name="TSpinEdit.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="Register">
<short>Registers components for use in the Lazarus IDE.</short>
<descr>
<p>
The following components are added to the Lazarus IDE component palette:
</p>
<p>
<b>Misc</b> Tab
</p>
<ul>
<li>TSpinEdit</li>
<li>TFloatSpinEdit</li>
</ul>
</descr>
<seealso/>
</element>
</module>
<!-- Spin -->
</package>
</fpdoc-descriptions>
|