Docs: LazControls/spinex. Adds topics for overloaded SameValue() methods in TCustomFloatSpinEditEx and TCustomSpinEditEx.

* Depends on 182cc8b8e6, 7f45938388, 5523c58bc9 0e5fdc884a, c301731931.

(cherry picked from commit 15e62fda4d)
This commit is contained in:
dsiders 2021-11-28 04:45:51 +00:00 committed by Maxim Ganetsky
parent 69e9028c85
commit 5e67b02e81

View File

@ -529,16 +529,24 @@
<short>Determines whether the specified arguments have the same value.</short>
<descr>
<p>
<var>SameValue</var> is a <var>Boolean</var> function used to compare the values in <var>AValue1</var> and <var>AValue2</var> to determine if they have the same value. SameValue calls the overloaded SameValue routine in the <file>math.pp</file> unit to get the return value for the method. The return value is <b>True</b> when both AValue1 and AValue2 have the same value.
<var>SameValue</var> is a <var>Boolean</var> function used to compare the values in <var>AValue1</var> and <var>AValue2</var> to determine if they have the same value. The return value is <b>True</b> when both AValue1 and AValue2 have the same value. It is defined as an abstract virtual method in <var>TSpinEditExBase</var>, and must be implemented in descendent classes to compare the data type for the specialization.
</p>
<p>
This method was introduced to ensure that the type specialization for the class instance is used when value comparisons are performed. Specifically, it allows the 64-bit compiler on Windows to determine which of the overloads in Math.SameValue is called for the <var>Currency</var> type.
SameValue is used in the implementation of storage specifiers for the <var>Increment</var>, <var>MinValue</var>, and <var>MaxValue</var> properties.
</p>
<p>
SameValue is defined when using FPC compiler version 3.2.2 on the Windows 64-bit platform. This method was introduced to ensure that the type specialization for the class instance is used when value comparisons are performed. Specifically, it allows the 64-bit compiler on Windows to determine which of the overloads in <var>Math.SameValue</var> is called for the <var>Currency</var> type.
</p>
</descr>
<version>
Introduced in version 2.2.0.
</version>
<seealso>
<link id="TSpinEditExBase.Increment"/>
<link id="TSpinEditExBase.MinValue"/>
<link id="TSpinEditExBase.MaxValue"/>
<link id="TCustomFloatSpinEditEx"/>
<link id="TCustomSpinEditEx"/>
<link id="#rtl.math.SameValue">Math.SameValue</link>
</seealso>
</element>
@ -1298,6 +1306,34 @@
<short>Numeric value decremented in the method.</short>
</element>
<element name="TCustomFloatSpinEditEx.SameValue">
<short>Determines whether the specified arguments have the same value.</short>
<descr>
<p>
<var>SameValue</var> is an overridden <var>Boolean</var> function used to compare the values in <var>AValue1</var> and <var>AValue2</var> to determine if they have the same value. The return value is <b>True</b> when both AValue1 and AValue2 have the same value. The arguments are implemented using the Double type in TCustomFloatSpinEditEx. The overloaded SameValue routine in the <file>math.pp</file> unit is called to get the return value for the method.
</p>
<p>
SameValue is defined when using FPC compiler version 3.2.2 on the Windows 64-bit platform. This method was introduced to ensure that the type specialization for the class instance is used when value comparisons are performed. Specifically, it allows the 64-bit compiler on Windows to determine which of the overloads in <var>Math.SameValue</var> is called for the <var>Currency</var> type.
</p>
</descr>
<version>
Introduced in version 2.2.0.
</version>
<seealso>
<link id="TSpinEditExBase.SameValue"/>
<link id="#rtl.math.SameValue">Math.SameValue</link>
</seealso>
</element>
<element name="TCustomFloatSpinEditEx.SameValue.Result">
<short>True if both arguments have the same value.</short>
</element>
<element name="TCustomFloatSpinEditEx.SameValue.AValue1">
<short>First value for the comparison.</short>
</element>
<element name="TCustomFloatSpinEditEx.SameValue.AValue2">
<short>Second value for the comparison.</short>
</element>
<element name="TCustomFloatSpinEditEx.SetDecimals">
<short>Sets the value for the DecimalPlaces property.</short>
<descr/>
@ -1756,6 +1792,34 @@
<short>Numeric value decremented in the method.</short>
</element>
<element name="TCustomSpinEditEx.SameValue">
<short>Determines whether the specified arguments have the same value.</short>
<descr>
<p>
<var>SameValue</var> is an overridden <var>Boolean</var> function used to compare the values in <var>AValue1</var> and <var>AValue2</var> to determine if they have the same value. The return value is <b>True</b> when both AValue1 and AValue2 have the same value. The arguments are implemented using the Int64 type in TCustomSpinEditEx.
</p>
<p>
SameValue is defined when using FPC compiler version 3.2.2 on the Windows 64-bit platform. This method was introduced to ensure that the type specialization for the class instance is used when value comparisons are performed.
</p>
</descr>
<version>
Introduced in version 2.2.0.
</version>
<seealso>
<link id="TSpinEditExBase.SameValue"/>
<link id="#rtl.math.SameValue">Math.SameValue</link>
</seealso>
</element>
<element name="TCustomSpinEditEx.SameValue.Result">
<short>True if both arguments have the same value.</short>
</element>
<element name="TCustomSpinEditEx.SameValue.AValue1">
<short>First value for the comparison.</short>
</element>
<element name="TCustomSpinEditEx.SameValue.AValue2">
<short>Second value for the comparison.</short>
</element>
<element name="TCustomSpinEditEx.TextIsNumber">
<short>Indicates if the specified String contains a valid Int64 data type.</short>
<descr>