lazarus/docs/xml/lcl/spin.xml
sekelsenmat 117ae6777c Minor english correction
git-svn-id: trunk@31816 -
2011-07-28 11:43:12 +00:00

909 lines
27 KiB
XML

<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
Spin
====================================================================
-->
<module name="Spin">
<short>This unit contains classes for spin edit controls.</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Controls">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLProc">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LMessages">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="ClipBrd">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="StdCtrls">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomFloatSpinEdit">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomFloatSpinEdit.FIncrement">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomFloatSpinEdit.FDecimals">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomFloatSpinEdit.FMaxValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomFloatSpinEdit.FMinValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomFloatSpinEdit.FValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomFloatSpinEdit.FValueEmpty">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomFloatSpinEdit.FUpdatePending">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomFloatSpinEdit.FValueChanged">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomFloatSpinEdit.SetMaxValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.SetMaxValue.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomFloatSpinEdit.SetMinValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.SetMinValue.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomFloatSpinEdit.SetValueEmpty">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.SetValueEmpty.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomFloatSpinEdit.UpdateControl">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TCustomFloatSpinEdit.IsStored">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomFloatSpinEdit.IsStored.Result">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TCustomFloatSpinEdit.RealGetText">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomFloatSpinEdit.RealGetText.Result">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFloatSpinEdit.TextChanged">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFloatSpinEdit.SetDecimals">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.SetDecimals.ADecimals">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TCustomFloatSpinEdit.GetValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomFloatSpinEdit.GetValue.Result">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFloatSpinEdit.SetValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.SetValue.AValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFloatSpinEdit.SetIncrement">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.SetIncrement.AIncrement">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFloatSpinEdit.InitializeWnd">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFloatSpinEdit.FinalizeWnd">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFloatSpinEdit.Loaded">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomFloatSpinEdit.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.Create.TheOwner">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TCustomFloatSpinEdit.GetLimitedValue">
<short>Limits the passed value according to spin edit minimum and maximum.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomFloatSpinEdit.GetLimitedValue.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.GetLimitedValue.AValue">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TCustomFloatSpinEdit.ValueToStr">
<short>Converts the passed value to string according to spin edit settings.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomFloatSpinEdit.ValueToStr.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.ValueToStr.AValue">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TCustomFloatSpinEdit.StrToValue">
<short>Converts the passed string to value according to spin edit settings.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomFloatSpinEdit.StrToValue.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFloatSpinEdit.StrToValue.S">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFloatSpinEdit.DecimalPlaces">
<short>Number of the decimal places shown in spin edit.</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFloatSpinEdit.Increment">
<short>An amount to be incremented/decremented to the value when spin edit up/down arrow button is pushed.</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFloatSpinEdit.MinValue">
<short>Minimal value of spin edit.</short>
<descr>
<p>Minimal value of spin edit. Set the MinValue property equal to MaxValue for unlimited spin edit value.</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.MaxValue"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TCustomFloatSpinEdit.MaxValue">
<short>Maximal value of spin edit.</short>
<descr>
<p>Maximal value of spin edit. Set the MinValue property equal to MaxValue for unlimited spin edit value.</p>
</descr>
<seealso>
<link id="TCustomFloatSpinEdit.MinValue"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TCustomFloatSpinEdit.Value">
<short>Value of spin edit.</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFloatSpinEdit.ValueEmpty">
<short>If the Value property is assigned.</short>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TFloatSpinEdit">
<short>The class for float spin edit control.</short>
<descr>
<p>The class for float spin edit control. Use TFloatSpinEdit to allow user to pick float value.</p>
</descr>
<errors/>
<seealso>
<link id="TSpinEdit"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TFloatSpinEdit.AutoSelected">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.AutoSelect">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.AutoSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.Constraints">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.DecimalPlaces">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.Increment">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.MaxValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.MinValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnChange">
<short>The OnChange event is fired when spin edit value has changed.</short>
<descr>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 of the control. The event is called after the change takes place, so the Value property will contain the new value.</descr>
<seealso>
<link id="#LCL.StdCtrls.TCustomEdit.OnChange">TCustomEdit.OnChange</link>
<link id="#LCL.Spin.TSpinEdit.OnChange">TSpinEdit.OnChange</link>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnChangeBounds">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnEditingDone">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnKeyDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnKeyPress">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnKeyUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.ReadOnly">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.Value">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TFloatSpinEdit.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomSpinEdit">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TCustomSpinEdit.GetIncrement">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomSpinEdit.GetIncrement.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TCustomSpinEdit.GetMaxValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomSpinEdit.GetMaxValue.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TCustomSpinEdit.GetMinValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomSpinEdit.GetMinValue.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TCustomSpinEdit.GetValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomSpinEdit.GetValue.Result">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomSpinEdit.SetIncrement">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomSpinEdit.SetIncrement.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomSpinEdit.SetMaxValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomSpinEdit.SetMaxValue.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomSpinEdit.SetMinValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomSpinEdit.SetMinValue.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomSpinEdit.SetValue">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomSpinEdit.SetValue.AValue">
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomSpinEdit.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomSpinEdit.Create.TheOwner">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TCustomSpinEdit.Value">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomSpinEdit.MinValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomSpinEdit.MaxValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomSpinEdit.Increment">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TSpinEdit">
<short>The class for spin edit control.</short>
<descr>
<p>The class for spin edit control. Use TSpinEdit to allow user to pick integer value.</p>
</descr>
<errors/>
<seealso>
<link id="TFloatSpinEdit"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TSpinEdit.AutoSelected">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.AutoSelect">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.AutoSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.Constraints">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.Increment">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.MaxValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.MinValue">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnChange">
<short>The OnChange event is fired when the spin edit value has changed.</short>
<descr>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 of the control. The event is called after the change takes place, so the Value property will contain the new value.</descr>
<seealso>
<link id="#LCL.StdCtrls.TCustomEdit.OnChange">TCustomEdit.OnChange</link>
<link id="#LCL.Spin.TFloatSpinEdit.OnChange">TFloatSpinEdit.OnChange</link>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnChangeBounds">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnEditingDone">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnKeyDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnKeyPress">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnKeyUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.ReadOnly">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.Value">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpinEdit.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="Register">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
</module>
<!-- Spin -->
</package>
</fpdoc-descriptions>