paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-05-30 18:02:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - descriptions added and links fixed in the following .xml files of LCL: actnlist, arrow, buttonpanel, buttons, calendar, chart, checklst, clipbrd, colorbox, customtimer

Browse Source 
git-svn-id: trunk@16608 -
This commit is contained in:
kirkpatc 2008-09-16 16:02:34 +00:00
parent 8647538c8e
commit 93bff7659c
10 changed files with 804 additions and 1012 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

178
docs/xml/lcl/actnlist.xml
View File

@ -47,7 +47,8 @@
</element>
<!-- object Visibility: default -->
<element name="TContainedAction">
<short/>
<short>
<var>TContainedAction</var> - parent class for <var>TCustomAction</var>; defines some properties especially relationships with parents</short>
<descr/>
<errors/>
<seealso/>
@ -120,7 +121,7 @@
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TContainedAction.ReadState">
<element name="TContainedAction.ReadState" link="#rtl.Classes.TComponent.ReadState">
<short/>
<descr/>
<errors/>
@ -131,7 +132,7 @@
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TContainedAction.SetParentComponent">
<element name="TContainedAction.SetParentComponent" link="#rtl.Classes.TComponent.SetParentComponent">
<short/>
<descr/>
<errors/>
@ -149,8 +150,7 @@
<seealso/>
</element>
<!-- destructor Visibility: public -->
<element name="TContainedAction.Destroy">
<short>Deallocates an object</short>
<element name="TContainedAction.Destroy" link="#rtl.Classes.TBasicAction.Destroy">
<descr>If you call Destroy for an object witch hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
Take the following precautions when creating your own Destroy method:
@ -161,12 +161,13 @@ Take the following precautions when creating your own Destroy method:
* An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them.
* Remember to call Free for all objects created on the constructor.</descr>
* Remember to call Free for all objects created on the constructor.
</descr>
<errors/>
<seealso/>
</element>
<!-- function Visibility: public -->
<element name="TContainedAction.Execute">
<element name="TContainedAction.Execute" link="#rtl.Classes.TBasicAction.Execute">
<short/>
<descr/>
<errors/>
@ -177,7 +178,7 @@ Take the following precautions when creating your own Destroy method:
<short/>
</element>
<!-- function Visibility: public -->
<element name="TContainedAction.GetParentComponent">
<element name="TContainedAction.GetParentComponent" link="#rtl.Classes.TComponent.GetParentComponent">
<short/>
<descr/>
<errors/>
@ -188,7 +189,7 @@ Take the following precautions when creating your own Destroy method:
<short/>
</element>
<!-- function Visibility: public -->
<element name="TContainedAction.HasParent">
<element name="TContainedAction.HasParent" link="#rtl.Classes.TComponent.HasParent">
<short/>
<descr/>
<errors/>
@ -199,7 +200,7 @@ Take the following precautions when creating your own Destroy method:
<short/>
</element>
<!-- function Visibility: public -->
<element name="TContainedAction.Update">
<element name="TContainedAction.Update" link="#rtl.Classes.TBasicAction.Update">
<short/>
<descr/>
<errors/>
@ -211,19 +212,19 @@ Take the following precautions when creating your own Destroy method:
</element>
<!-- property Visibility: public -->
<element name="TContainedAction.ActionList">
<short/>
<short>The <var>ActionList</var> in which this action is contained</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TContainedAction.Index">
<short/>
<short>The <var>Index</var> of this action in the list of actions</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TContainedAction.Category">
<short/>
<short>The <var>Category</var> of this action</short>
<descr/>
<seealso/>
</element>
@ -389,7 +390,8 @@ Take the following precautions when creating your own Destroy method:
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.AddAction">
<short/>
<short>
<var>AddAction</var> - adds an action to the list</short>
<descr/>
<errors/>
<seealso/>
@ -400,7 +402,8 @@ Take the following precautions when creating your own Destroy method:
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.RemoveAction">
<short/>
<short>
<var>RemoveAction</var> - removes an action from the list</short>
<descr/>
<errors/>
<seealso/>
@ -411,13 +414,14 @@ Take the following precautions when creating your own Destroy method:
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.Change">
<short/>
<short>
<var>Change</var> the action</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.GetChildren">
<element name="TCustomActionList.GetChildren" link="#rtl.Classes.TComponent.GetChildren">
<short/>
<descr/>
<errors/>
@ -432,7 +436,7 @@ Take the following precautions when creating your own Destroy method:
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.Notification">
<element name="TCustomActionList.Notification" link="#rtl.Classes.TComponent.Notification">
<short/>
<descr/>
<errors/>
@ -447,7 +451,7 @@ Take the following precautions when creating your own Destroy method:
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.SetChildOrder">
<element name="TCustomActionList.SetChildOrder" link="#rtl.Classes.TComponent.SetChildOrder">
<short/>
<descr/>
<errors/>
@ -463,7 +467,8 @@ Take the following precautions when creating your own Destroy method:
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.SetImages">
<short/>
<short>
<var>SetImages</var> - stores a list of images</short>
<descr/>
<errors/>
<seealso/>
@ -474,34 +479,33 @@ Take the following precautions when creating your own Destroy method:
</element>
<!-- property Visibility: protected -->
<element name="TCustomActionList.OnChange">
<short/>
<short>
<var>OnChange</var> - event handler for a change in the action</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: protected -->
<element name="TCustomActionList.OnExecute">
<short/>
<short>
<var>OnExecute</var> - event handler for execution of the action</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: protected -->
<element name="TCustomActionList.OnUpdate">
<short/>
<short>
<var>OnUpdate</var> - event handler for updating the action</short>
<descr/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomActionList.Create">
<short>
<var>Create </var>a new instance of the <var>TCustomActionList </var>class</short>
</element>
<element name="TCustomActionList.Create" link="#rtl.Classes.TComponent.Create"/>
<!-- argument Visibility: default -->
<element name="TCustomActionList.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomActionList.Destroy">
<short>Destroys the instance of the component.</short>
<element name="TCustomActionList.Destroy" link="#rtl.Classes.TComponent.Destroy">
<descr>
<var>Destroy</var> sends a <var>opRemove</var> notification to all components
in the free-notification list. After that, all owned components are
@ -512,8 +516,7 @@ After that, the parent's destroy method is called.
</descr>
</element>
<!-- function Visibility: public -->
<element name="TCustomActionList.ExecuteAction">
<short>Standard action execution method.</short>
<element name="TCustomActionList.ExecuteAction" link="#rtl.Classes.TComponent.ExecuteAction">
<descr>
<var>ExecuteAction</var> checks whether <var>Action</var> handles the
current component, and if yes, calls the <var>ExecuteAction</var> method,
@ -532,8 +535,7 @@ action handles the current component.
<short/>
</element>
<!-- function Visibility: public -->
<element name="TCustomActionList.UpdateAction">
<short>Updates the state of an action.</short>
<element name="TCustomActionList.UpdateAction" link="#rtl.Classes.TComponent.UpdateAction">
<descr>
<var>UpdateAction</var> checks whether <var>Action</var> handles the
current component, and if yes, calls the <var>UpdateTarget</var> method,
@ -626,32 +628,27 @@ action handles the current component.
</descr>
</element>
<!-- property Visibility: published -->
<element name="TActionList.Images">
<short>The <var>Images</var> from an <var>ImageList</var> to be associated with the actions, eg in a Menu display</short>
<element name="TActionList.Images" link="#LCL.ActnList.TCustomActionList.Images">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TActionList.State">
<short>State of the action : Normal, Suspended or SuspendedEnabled</short>
<element name="TActionList.State" link="#LCL.ActnList.TCustomActionList.State">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TActionList.OnChange">
<short>Event handler for change in action list</short>
<element name="TActionList.OnChange" link="#LCL.ActnList.TCustomActionList.OnChange">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TActionList.OnExecute">
<short>Event handler for executing action</short>
<element name="TActionList.OnExecute" link="#LCL.ActnList.TCustomActionList.OnExecute">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TActionList.OnUpdate">
<short>Event handler for updating action list</short>
<element name="TActionList.OnUpdate" link="#LCL.ActnList.TCustomActionList.OnUpdate">
<descr/>
<seealso/>
</element>
@ -679,7 +676,7 @@ action handles the current component.
</element>
<!-- function Visibility: public -->
<element name="TShortCutList.Add">
<short>Add a shortcut to the list</short>
<short>Add a shortcut to the list; implements the <link id="TStrings.Add"/> function</short>
<descr/>
<errors/>
<seealso/>
@ -1025,8 +1022,7 @@ action handles the current component.
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomAction.AssignTo">
<short>Generic assignment function.</short>
<element name="TCustomAction.AssignTo" link="#rtl.Classes.TPersistent.AssignTo">
<descr>
<p>
<var>AssignTo</var> is the generic function to assign the class' contents to
@ -1057,7 +1053,7 @@ execution will end up at the <var>TPersistent</var> implementation of
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomAction.SetName">
<element name="TCustomAction.SetName" link="#rtl.Classes.TComponent.SetName">
<short/>
<descr/>
<errors/>
@ -1069,7 +1065,8 @@ execution will end up at the <var>TPersistent</var> implementation of
</element>
<!-- function Visibility: protected -->
<element name="TCustomAction.HandleShortCut">
<short/>
<short>
<var>HandleShortCut</var> - returns True if there is a short cut associated with the handle</short>
<descr/>
<errors/>
<seealso/>
@ -1080,24 +1077,19 @@ execution will end up at the <var>TPersistent</var> implementation of
</element>
<!-- property Visibility: protected -->
<element name="TCustomAction.SavedEnabledState">
<short/>
<short>
<var>SavedEnabledState</var> - if True, the Enabled state has been saved</short>
<descr/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomAction.Create">
<short>
<var>Create</var> a new instance of the <var>TCustomAction</var> class</short>
</element>
<element name="TCustomAction.Create" link="#rtl.Classes.TBasicAction.Create"/>
<!-- argument Visibility: default -->
<element name="TCustomAction.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomAction.Destroy">
<short>
<var>Destroy </var>- Deallocates an object</short>
</element>
<element name="TCustomAction.Destroy" link="#rtl.Classes.TBasicAction.Destroy"/>
<!-- function Visibility: public -->
<element name="TCustomAction.DoHint">
<short>
@ -1113,10 +1105,7 @@ execution will end up at the <var>TPersistent</var> implementation of
<var>HintStr</var> - the text-string for display as a hint</short>
</element>
<!-- function Visibility: public -->
<element name="TCustomAction.Execute">
<short>
<var>Execute</var> - method to determine if action is to be performed</short>
</element>
<element name="TCustomAction.Execute" link="#rtl.Classes.TBasicAction.Execute"/>
<!-- function result Visibility: default -->
<element name="TCustomAction.Execute.Result">
<short>True if action is to be performed</short>
@ -1209,85 +1198,63 @@ execution will end up at the <var>TPersistent</var> implementation of
</seealso>
</element>
<!-- constructor Visibility: public -->
<element name="TAction.Create">
<short>
<var>Create</var> a new instance of the <var>TCustomAction</var> class</short>
</element>
<element name="TAction.Create" link="#rtl.Classes.TBasicAction.Create"/>
<!-- argument Visibility: default -->
<element name="TAction.Create.AOwner">
<short/>
</element>
<!-- property Visibility: published -->
<element name="TAction.AutoCheck">
<short>
<var>AutoCheck</var> - whether the control (eg a CheckBox) is to be automatically checked</short>
<element name="TAction.AutoCheck" link="#LCL.ActnList.TCustomAction.AutoCheck">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Caption">
<short>The <var>Caption</var> to be used if this action is associated with a visible component</short>
<element name="TAction.Caption" link="#LCL.ActnList.TCustomAction.Caption">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Checked">
<short>Whether the CheckBox associated with the action is <var>Checked</var> (default False)</short>
<element name="TAction.Checked" link="#LCL.ActnList.TCustomAction.Checked">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Enabled">
<short>
<var>Enabled</var> - whether this action is able to be used (default True)</short>
<element name="TAction.Enabled" link="#LCL.ActnList.TCustomAction.Enabled">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.GroupIndex">
<short>
<var>GroupIndex </var>- Index of the action within its group</short>
<element name="TAction.GroupIndex" link="#LCL.ActnList.TCustomAction.GroupIndex">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.HelpContext">
<short>
<var>HelpContext </var>- the index for a context-based help message</short>
<element name="TAction.HelpContext" link="#LCL.ActnList.TCustomAction.HelpContext">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.HelpKeyword">
<short>
<var>HelpKeyWord </var>- the keyword of a context-based help message</short>
<element name="TAction.HelpKeyword" link="#LCL.ActnList.TCustomAction.HelpKeyword">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.HelpType">
<short>
<var>HelpType</var> - the sort of help message to be offered: default Context-based</short>
<element name="TAction.HelpType" link="#LCL.ActnList.TCustomAction.HelpType">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Hint">
<short>
<var>Hint</var> - a pop-up message that appears when the mouse hovers over an object</short>
<element name="TAction.Hint" link="#LCL.ActnList.TCustomAction.Hint">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.ImageIndex">
<short>
<var>ImageIndex </var>- the index number of the image to be associated with this action</short>
<element name="TAction.ImageIndex" link="#LCL.ActnList.TCustomAction.ImageIndex">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.OnExecute">
<short>Event triggered when the action executes.</short>
<element name="TAction.OnExecute" link="#rtl.Classes.TBasicAction.OnExecute">
<descr>
<p>
<var>OnExecute</var> is the event triggered when the action is activated
@ -1306,15 +1273,12 @@ normal task if the <var>OnExecute</var> handler was called.
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.OnHint">
<short>
<var>OnHint</var> - action to be taken when a hint is required</short>
<element name="TAction.OnHint" link="#LCL.ActnList.TCustomAction.OnHint">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.OnUpdate">
<short>Event trigged when the application is idle.</short>
<element name="TAction.OnUpdate" link="#rtl.Classes.TBasicAction.OnUpdate">
<descr>
<var>OnUpdate</var> is the event triggered when the application is idle, and
the action is being updated. The <var>OnUpdate</var> event can be used to
@ -1324,22 +1288,18 @@ executed at this point in time.
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.SecondaryShortCuts">
<short>
<var>SecondaryShortCuts</var> - a stringlist containing shortcuts</short>
<element name="TAction.SecondaryShortCuts" link="#LCL.ActnList.TCustomAction.SecondaryShortCuts">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.ShortCut">
<element name="TAction.ShortCut" link="#LCL.ActnList.TCustomAction.ShortCut">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TAction.Visible">
<short>
<var>Visible</var> - is this action visible? (default True)</short>
<element name="TAction.Visible" link="#LCL.ActnList.TCustomAction.Visible">
<descr/>
<seealso/>
</element>
@ -1753,9 +1713,7 @@ executed at this point in time.
<element name="TCustomActionList.IsShortCut">
<short>This action is associated with a shortcut</short>
</element>
<element name="TAction.DisableIfNoHandler">
<short>Disable this action if no handler is found</short>
</element>
<element name="TAction.DisableIfNoHandler" link="#LCL.ActnList.TCustomAction.DisableIfNoHandler"/>
</module>
<!-- ActnList -->
</package>

712
docs/xml/lcl/arrow.xml
View File

@ -1,426 +1,298 @@
<?xml version="1.0" encoding="ISO8859-1"?>
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
<package name="lcl">
<!--
====================================================================
Arrow
====================================================================
-->
<module name="Arrow">
<short></short>
<descr>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Controls">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="lMessages">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration type Visibility: default -->
<element name="TArrowType">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TArrowType.atUp">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TArrowType.atDown">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TArrowType.atLeft">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TArrowType.atRight">
<short></short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TShadowType">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stNone">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stIn">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stOut">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stEtchedIn">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stEtchedOut">
<short></short>
</element>
<!-- object Visibility: default -->
<element name="TArrow">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TArrow.FArrowType">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TArrow.FShadowType">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- function Visibility: private -->
<element name="TArrow.GetShadowType">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TArrow.GetShadowType.Result">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TArrow.SetShadowType">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TArrow.SetShadowType.AValue">
<short></short>
</element>
<!-- function Visibility: private -->
<element name="TArrow.GetArrowType">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TArrow.GetArrowType.Result">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TArrow.SetArrowType">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TArrow.SetArrowType.AValue">
<short></short>
</element>
<!-- procedure Visibility: private -->
<element name="TArrow.SetProps">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TArrow.Paint">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- constructor Visibility: public -->
<element name="TArrow.Create">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TArrow.Create.AOwner">
<short></short>
</element>
<!-- destructor Visibility: public -->
<element name="TArrow.Destroy">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TArrow.Loaded">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TArrow.InitializeWnd">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.Align">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.Anchors">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.ArrowType">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.BorderSpacing">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.ShadowType">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.Visible">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnClick">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnMouseMove">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnMouseDown">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnMouseUp">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnChangeBounds">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnResize">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnContextPopup">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TArrow.PopupMenu">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="Register">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
</module> <!-- Arrow -->
</package>
<module name="Arrow">
<short>Defines the Arrow symbol widely used in Forms</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Controls">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="lMessages">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TArrowType">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TArrowType.atUp">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TArrowType.atDown">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TArrowType.atLeft">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TArrowType.atRight">
<short/>
</element>
<!-- enumeration type Visibility: default -->
<element name="TShadowType">
<short/>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stNone">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stIn">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stOut">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stEtchedIn">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TShadowType.stEtchedOut">
<short/>
</element>
<!-- object Visibility: default -->
<element name="TArrow">
<short>
<var>TArrow</var> - an arrow symbol widely used in forms</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TArrow.FArrowType">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TArrow.FShadowType">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TArrow.GetShadowType">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TArrow.GetShadowType.Result">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TArrow.SetShadowType">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TArrow.SetShadowType.AValue">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TArrow.GetArrowType">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TArrow.GetArrowType.Result">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TArrow.SetArrowType">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TArrow.SetArrowType.AValue">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TArrow.SetProps">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TArrow.Paint" link="#LCL.Controls.TCustomControl.Paint">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TArrow.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TArrow.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TArrow.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TArrow.Loaded" link="#rtl.Classes.TComponent.Loaded">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TArrow.InitializeWnd" link="#LCL.Controls.TWinControl.InitializeWnd">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.Align" link="#LCL.Controls.TControl.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.Anchors" link="#LCL.Controls.TControl.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.ArrowType">
<short>
<var>ArrowType</var> - pointing up, down, left or right</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.ShadowType">
<short>
<var>ShadowType</var> - the type of shadowing: None, In, Out, EtchedIn, EtchedOut</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.Visible" link="#LCL.Controls.TControl.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnClick" link="#LCL.Controls.TControl.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnResize" link="#LCL.Controls.TControl.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TArrow.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: default -->
<element name="Register">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<element name="TArrow.GetControlClassDefaultSize" link="#LCL.Controls.TControl.GetControlClassDefaultSize"/>
<element name="TArrow.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
</module>
<!-- Arrow -->
</package>
</fpdoc-descriptions>

67
docs/xml/lcl/buttonpanel.xml
View File

@ -124,7 +124,7 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TPanelBitBtn.Create">
<element name="TPanelBitBtn.Create" link="#LCL.Buttons.TCustomBitBtn.Create">
<short/>
<descr/>
<errors/>
@ -135,31 +135,31 @@
<short/>
</element>
<!-- property Visibility: published -->
<element name="TPanelBitBtn.Caption">
<element name="TPanelBitBtn.Caption" link="#LCL.Controls.TControl.Caption">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPanelBitBtn.Enabled">
<element name="TPanelBitBtn.Enabled" link="#LCL.Controls.TControl.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPanelBitBtn.Font">
<element name="TPanelBitBtn.Font" link="#LCL.Controls.TControl.Font">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPanelBitBtn.Glyph">
<element name="TPanelBitBtn.Glyph" link="#LCL.Buttons.TCustomBitBtn.Glyph">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPanelBitBtn.OnClick">
<element name="TPanelBitBtn.OnClick" link="#LCL.Controls.TControl.OnClick">
<short/>
<descr/>
<seealso/>
@ -337,7 +337,7 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomButtonPanel.Create">
<element name="TCustomButtonPanel.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<descr/>
<errors/>
@ -348,7 +348,7 @@
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomButtonPanel.Destroy">
<element name="TCustomButtonPanel.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<descr/>
<errors/>
@ -497,139 +497,139 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.Align">
<element name="TButtonPanel.Align" link="#LCL.Controls.TControl.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.Anchors">
<element name="TButtonPanel.Anchors" link="#LCL.Controls.TControl.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OKButton">
<element name="TButtonPanel.OKButton" link="#LCL.ButtonPanel.TCustomButtonPanel.OKButton">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.HelpButton">
<element name="TButtonPanel.HelpButton" link="#LCL.ButtonPanel.TCustomButtonPanel.HelpButton">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.CloseButton">
<element name="TButtonPanel.CloseButton" link="#LCL.ButtonPanel.TCustomButtonPanel.CloseButton">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.CancelButton">
<element name="TButtonPanel.CancelButton" link="#LCL.ButtonPanel.TCustomButtonPanel.CancelButton">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.ButtonOrder">
<element name="TButtonPanel.ButtonOrder" link="#LCL.ButtonPanel.TCustomButtonPanel.ButtonOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.TabOrder">
<element name="TButtonPanel.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.DefaultButton">
<element name="TButtonPanel.DefaultButton" link="#LCL.ButtonPanel.TCustomButtonPanel.DefaultButton">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnClick">
<element name="TButtonPanel.OnClick" link="#LCL.Controls.TControl.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnDblClick">
<element name="TButtonPanel.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnDragDrop">
<element name="TButtonPanel.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnEnter">
<element name="TButtonPanel.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnExit">
<element name="TButtonPanel.OnExit" link="#LCL.Controls.TWinControl.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnKeyDown">
<element name="TButtonPanel.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnKeyPress">
<element name="TButtonPanel.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnKeyUp">
<element name="TButtonPanel.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnMouseDown">
<element name="TButtonPanel.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnMouseMove">
<element name="TButtonPanel.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnMouseUp">
<element name="TButtonPanel.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.OnResize">
<element name="TButtonPanel.OnResize" link="#LCL.Controls.TControl.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.ShowButtons">
<element name="TButtonPanel.ShowButtons" link="#LCL.ButtonPanel.TCustomButtonPanel.ShowButtons">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TButtonPanel.ShowGlyphs">
<element name="TButtonPanel.ShowGlyphs" link="#LCL.ButtonPanel.TCustomButtonPanel.ShowGlyphs">
<short/>
<descr/>
<seealso/>
@ -641,6 +641,11 @@
<errors/>
<seealso/>
</element>
<element name="TCustomButtonPanel.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
<element name="TCustomButtonPanel.Notification" link="#rtl.Classes.TComponent.Notification"/>
<element name="TButtonPanel.AutoSize" link="#LCL.Controls.TControl.AutoSize"/>
<element name="TButtonPanel.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="TButtonPanel.Visible" link="#LCL.Controls.TControl.Visible"/>
</module>
<!-- ButtonPanel -->
</package>

315
docs/xml/lcl/buttons.xml
View File

@ -203,19 +203,18 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TButtonGlyph.Create">
<short>Creates a new instance of the TButtonGlyph class</short>
<element name="TButtonGlyph.Create" link="#rtl.System.TObject.Create">
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
However, if you create the component by code don´t forget to free it when it is no longer needed.
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</descr>
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.
</descr>
<errors/>
<seealso/>
</element>
<!-- destructor Visibility: public -->
<element name="TButtonGlyph.Destroy">
<short>Deallocates an object</short>
<element name="TButtonGlyph.Destroy" link="#rtl.System.TObject.Destroy">
<descr>If you call Destroy for an object which hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
Take the following precautions when creating your own Destroy method:
@ -226,7 +225,8 @@ Take the following precautions when creating your own Destroy method:
* An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them.
* Remember to call Free for all objects created on the constructor.</descr>
* Remember to call Free for all objects created on the constructor.
</descr>
<errors/>
<seealso/>
</element>
@ -513,9 +513,7 @@ Take the following precautions when creating your own Destroy method:
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomBitBtn.Click">
<short>
<var>Click </var>- the procedure which allows programmatic simulation of a mouse click</short>
<element name="TCustomBitBtn.Click" link="#LCL.Controls.TControl.Click">
<descr>
<p>
<var>Click </var>
@ -540,20 +538,19 @@ Take the following precautions when creating your own Destroy method:
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomBitBtn.InitializeWnd">
<short>Initialise the window</short>
<element name="TCustomBitBtn.InitializeWnd" link="#LCL.Controls.TWinControl.InitializeWnd">
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomBitBtn.Create">
<short>Creates a new instance of the TCustomBitBtn class</short>
<element name="TCustomBitBtn.Create" link="#rtl.Classes.TComponent.Create">
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
However, if you create the component by code don´t forget to free it when it is no longer needed.
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</descr>
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.
</descr>
<errors/>
<seealso/>
</element>
@ -562,8 +559,7 @@ Constructors allocate memory and system resources needed by the object. They als
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomBitBtn.Destroy">
<short>Deallocates an object</short>
<element name="TCustomBitBtn.Destroy" link="#rtl.Classes.TComponent.Destroy">
<descr>If you call Destroy for an object which hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
Take the following precautions when creating your own Destroy method:
@ -574,7 +570,8 @@ Take the following precautions when creating your own Destroy method:
* An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them.
* Remember to call Free for all objects created on the constructor.</descr>
* Remember to call Free for all objects created on the constructor.
</descr>
<errors/>
<seealso/>
</element>
@ -623,8 +620,7 @@ Take the following precautions when creating your own Destroy method:
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Action">
<short>The action to be associated with this control</short>
<element name="TBitBtn.Action" link="#LCL.Controls.TControl.Action">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>The (default) action to be associated with this control</p>
@ -632,8 +628,7 @@ Take the following precautions when creating your own Destroy method:
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Align">
<short>Used to align the control in one of four directions.</short>
<element name="TBitBtn.Align" link="#LCL.Controls.TControl.Align">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
@ -641,8 +636,7 @@ Take the following precautions when creating your own Destroy method:
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Anchors">
<short>The set of anchor definitions for this control</short>
<element name="TBitBtn.Anchors" link="#LCL.Controls.TControl.Anchors">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determines how the control is to be anchored to its client or parent conrol</p>
@ -651,8 +645,7 @@ Take the following precautions when creating your own Destroy method:
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.BorderSpacing">
<short>Determines the border spacing for this control</short>
<element name="TBitBtn.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determines the border spacing for this control</p>
@ -663,16 +656,13 @@ Take the following precautions when creating your own Destroy method:
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Cancel">
<short>Is this the Cancel button? (default setting is False)</short>
<element name="TBitBtn.Cancel" link="#LCL.StdCtrls.TCustomButton.Cancel">
<descr>
<p>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Caption">
<short>
<var>Caption</var> - the text-string appearing on the Control, usually used to identify its function</short>
<element name="TBitBtn.Caption" link="#LCL.Controls.TControl.Caption">
<descr>
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
@ -685,23 +675,20 @@ introduced. These functions interface with the LCLInterface. </p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Constraints">
<short>Determine <var>Constraints</var> (max and min height and width) for this control</short>
<element name="TBitBtn.Constraints" link="#LCL.Controls.TControl.Constraints">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Default">
<short>Is this the Default button? (default setting is False)</short>
<element name="TBitBtn.Default" link="#LCL.StdCtrls.TCustomButton.Default">
<descr>
<p>Defines if a button is the <var>Default</var> on a form. That is, pressing ENTER will execute its onClick method, whether the control has focus or not!</p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Enabled">
<short>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</short>
<element name="TBitBtn.Enabled" link="#LCL.Controls.TControl.Enabled">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
@ -709,8 +696,7 @@ introduced. These functions interface with the LCLInterface. </p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Font">
<short>The <var>Font</var> to be used for text in this control</short>
<element name="TBitBtn.Font" link="#LCL.Controls.TControl.Font">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
@ -720,38 +706,32 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Glyph">
<short>The BitMap Glyph to be displayed on the button</short>
<element name="TBitBtn.Glyph" link="#LCL.Buttons.TCustomBitBtn.Glyph">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Kind">
<short>What kind of BitButton? Custom, OK, Cancel, Yes, No etc</short>
<element name="TBitBtn.Kind" link="#LCL.Buttons.TCustomBitBtn.Kind">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Layout">
<short>Layout of button - Glyph at top, bottom, left or right</short>
<element name="TBitBtn.Layout" link="#LCL.Buttons.TCustomBitBtn.Layout">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Margin">
<short>The margin to be left around glyphs</short>
<element name="TBitBtn.Margin" link="#LCL.Buttons.TCustomBitBtn.Margin">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.ModalResult">
<short>Is a Modal Result awaited? (default is false)</short>
<element name="TBitBtn.ModalResult" link="#LCL.StdCtrls.TCustomButton.ModalResult">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnChangeBounds">
<short>Event handler for a change in bounds of the control</short>
<element name="TBitBtn.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Reads or Writes flag if bounds are changed</p>
@ -759,8 +739,7 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnClick">
<short>Event Handler for mouse click</short>
<element name="TBitBtn.OnClick" link="#LCL.Controls.TControl.OnClick">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <var>ActionList</var>
@ -770,23 +749,17 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnEnter">
<short>
<var>OnEnter</var> - event handler for when the mouse enters the control, and the control receives focus</short>
<element name="TBitBtn.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnExit">
<short>
<var>OnExit</var> - event handler for when the mouse leaves the control and it loses focus</short>
<element name="TBitBtn.OnExit" link="#LCL.Controls.TWinControl.OnExit">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnKeyDown">
<short>
<var>OnKeyDown</var> - event handler for instance when key is down while control has focus</short>
<element name="TBitBtn.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
<descr>
<p>
<var>OnKeyDown</var>
@ -796,8 +769,7 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnKeyPress">
<short>OnKeyPress - event controller for a key being pressed while the control has focus</short>
<element name="TBitBtn.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
<descr>
<p>
<var>OnKeyPress</var>
@ -807,9 +779,7 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnKeyUp">
<short>
<var>OnKeyUp</var> - event handler for instance when a key is up (not pressed) while the control has focus</short>
<element name="TBitBtn.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
<descr>
<p>
<var>OnKeyUp</var>
@ -819,41 +789,35 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnMouseDown">
<short>Event handler for when a mouse button is pressed down</short>
<element name="TBitBtn.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnMouseMove">
<short>Event handler for mouse movement within the current control</short>
<element name="TBitBtn.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnMouseUp">
<element name="TBitBtn.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.OnResize">
<short>Event Handler for resize of control</short>
<element name="TBitBtn.OnResize" link="#LCL.Controls.TControl.OnResize">
<descr>// standard properties, which should be supported by all descendants<br/>
Reads or Writes flag if control is re-sized.
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.ParentShowHint">
<short>
<var>ParentShowHint </var>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
<element name="TBitBtn.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.PopupMenu">
<short>PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control</short>
<element name="TBitBtn.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
<descr>// standard properties, which should be supported by all descendants<br/>
Reads the details of the pop-up menu, or stores them.<br/>
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
@ -861,36 +825,30 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.ShowHint">
<short>Flag to determine: Is hint to be displayed for this control?</short>
<element name="TBitBtn.ShowHint" link="#LCL.Controls.TControl.ShowHint">
<descr>// standard properties, which should be supported by all descendants<br/>
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Spacing">
<short>The spacing around the BitButton</short>
<element name="TBitBtn.Spacing" link="#LCL.Buttons.TCustomBitBtn.Spacing">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.TabOrder">
<short>The place this control occupies in the list of tabs</short>
<element name="TBitBtn.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
<descr>Reads or writes information in flag; default is -1
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.TabStop">
<short>Is the Button included in the TabStop list? (default setting is True)</short>
<element name="TBitBtn.TabStop" link="#LCL.Controls.TWinControl.TabStop">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBitBtn.Visible">
<short>
<var>Visible</var> - can the control be seen?</short>
<element name="TBitBtn.Visible" link="#LCL.Controls.TControl.Visible">
<descr>
<pre>The Visible property represents the ability to see a visual control.
If Visible is True the control is shown, otherwise it is hidden.
@ -905,7 +863,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short>Links a TSpeedButton with an action.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TSpeedButtonActionLink.AssignClient">
<element name="TSpeedButtonActionLink.AssignClient" link="#rtl.Classes.TBasicActionLink.AssignClient">
<short/>
<descr/>
<errors/>
@ -916,7 +874,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TSpeedButtonActionLink.IsCheckedLinked">
<element name="TSpeedButtonActionLink.IsCheckedLinked" link="#LCL.ActnList.TActionLink.IsCheckedLinked">
<short/>
<descr/>
<errors/>
@ -927,7 +885,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TSpeedButtonActionLink.IsGroupIndexLinked">
<element name="TSpeedButtonActionLink.IsGroupIndexLinked" link="#LCL.ActnList.TActionLink.IsGroupIndexLinked">
<short/>
<descr/>
<errors/>
@ -939,7 +897,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TSpeedButtonActionLink.SetGroupIndex">
<short/>
<short>
<var>SetGroupIndex</var> - stores the value of the index within the list of links</short>
<descr/>
<errors/>
<seealso/>
@ -950,7 +909,8 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
</element>
<!-- procedure Visibility: protected -->
<element name="TSpeedButtonActionLink.SetChecked">
<short/>
<short>
<var>SetChecked</var> - stores the Checked status (True or False)</short>
<descr/>
<errors/>
<seealso/>
@ -1129,14 +1089,14 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomSpeedButton.MouseEnter">
<element name="TCustomSpeedButton.MouseEnter" link="#LCL.Controls.TControl.MouseEnter">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomSpeedButton.MouseLeave">
<element name="TCustomSpeedButton.MouseLeave" link="#LCL.Controls.TControl.MouseLeave">
<short/>
<descr/>
<errors/>
@ -1182,7 +1142,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.MouseDown">
<element name="TCustomSpeedButton.MouseDown" link="#LCL.Controls.TControl.MouseDown">
<short/>
<descr/>
<errors/>
@ -1205,7 +1165,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.MouseMove">
<element name="TCustomSpeedButton.MouseMove" link="#LCL.Controls.TControl.MouseMove">
<short/>
<descr/>
<errors/>
@ -1224,7 +1184,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.MouseUp">
<element name="TCustomSpeedButton.MouseUp" link="#LCL.Controls.TControl.MouseUp">
<short/>
<descr/>
<errors/>
@ -1247,8 +1207,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.Paint">
<short>Paint the Glyph</short>
<element name="TCustomSpeedButton.Paint" link="#LCL.Controls.TGraphicControl.Paint">
<descr/>
<errors/>
<seealso/>
@ -1320,8 +1279,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.RealSetText">
<short>Procedure to store text associated with the control in a string</short>
<element name="TCustomSpeedButton.RealSetText" link="#LCL.Controls.TControl.RealSetText">
<descr>This is the procedure that is actually used by SetTextBuf, and stores text as a string rather than performing read-write to a PChar buffer
</descr>
<errors/>
@ -1386,8 +1344,7 @@ Reads flag or writes one to determine if a hint is to be shown when mouse hovers
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomSpeedButton.Loaded">
<short>Called when the component has finished loading.</short>
<element name="TCustomSpeedButton.Loaded" link="#rtl.Classes.TComponent.Loaded">
<descr>
<p>
<var>Loaded</var> is called by the streaming system when a root
@ -1405,13 +1362,13 @@ is done automatically by the streaming system.
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomSpeedButton.Create">
<short>Creates a new instance of the TCustomSpeedButton class</short>
<element name="TCustomSpeedButton.Create" link="#rtl.Classes.TComponent.Create">
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
However, if you create the component by code don´t forget to free it when it is no longer needed.
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</descr>
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.
</descr>
<errors/>
<seealso/>
</element>
@ -1420,16 +1377,14 @@ Constructors allocate memory and system resources needed by the object. They als
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomSpeedButton.Destroy">
<element name="TCustomSpeedButton.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short>Destroy this instance of a graphic control and return its resources</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomSpeedButton.Click">
<short>
<var>Click</var> - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same <var>Action</var> as that associated with the <var>OnClick</var> event</short>
<element name="TCustomSpeedButton.Click" link="#LCL.Controls.TControl.Click">
<descr/>
<errors/>
<seealso/>
@ -1448,7 +1403,7 @@ Constructors allocate memory and system resources needed by the object. They als
</element>
<!-- property Visibility: public -->
<element name="TCustomSpeedButton.Flat">
<short/>
<short>Whether the button is to be displayed <var>Flat</var> or in relief</short>
<descr/>
<seealso/>
</element>
@ -1505,8 +1460,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Action">
<short>The action to be associated with this control</short>
<element name="TSpeedButton.Action" link="#LCL.Controls.TControl.Action">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>The (default) action to be associated with this control</p>
@ -1514,8 +1468,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
</descr>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Align">
<short>Used to align the control in one of four directions.</short>
<element name="TSpeedButton.Align" link="#LCL.Controls.TControl.Align">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
@ -1523,8 +1476,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
</descr>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Anchors">
<short>The set of anchor definitions for this control</short>
<element name="TSpeedButton.Anchors" link="#LCL.Controls.TControl.Anchors">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determines how the control is to be anchored to its client or parent conrol</p>
@ -1534,13 +1486,11 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.AllowAllUp">
<short>Boolean flag to determine whether all buttons are allowed to be Up (default false)</short>
<element name="TSpeedButton.AllowAllUp" link="#LCL.Buttons.TCustomSpeedButton.AllowAllUp">
<descr/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.BorderSpacing">
<short>Determines the border spacing for this control</short>
<element name="TSpeedButton.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determines the border spacing for this control</p>
@ -1551,8 +1501,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Constraints">
<short>Determine <var>Constraints</var> (max and min height and width) for this control</short>
<element name="TSpeedButton.Constraints" link="#LCL.Controls.TControl.Constraints">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
@ -1560,9 +1509,7 @@ When a user clicks on a SpeedButton focus is not shifted; a Speed Button never g
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Caption">
<short>
<var>Caption</var> - the text-string appearing on the Control, usually used to identify its function</short>
<element name="TSpeedButton.Caption" link="#LCL.Controls.TControl.Caption">
<descr>
<p>Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).</p>
<p>By default, the <var>Caption</var> appears the same as the control <var>Name</var> in the Object Inspector,
@ -1575,13 +1522,11 @@ introduced. These functions interface with the LCLInterface. </p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Down">
<short>The button has been set in the Down state</short>
<element name="TSpeedButton.Down" link="#LCL.Buttons.TCustomSpeedButton.Down">
<descr/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Enabled">
<short>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</short>
<element name="TSpeedButton.Enabled" link="#LCL.Controls.TControl.Enabled">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'</p>
@ -1589,53 +1534,43 @@ introduced. These functions interface with the LCLInterface. </p>
</descr>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Flat">
<element name="TSpeedButton.Flat" link="#LCL.Buttons.TCustomSpeedButton.Flat">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Glyph">
<short>The Bitmap glyph to be used on this button</short>
</element>
<element name="TSpeedButton.Glyph" link="#LCL.Buttons.TCustomSpeedButton.Glyph"/>
<!-- property Visibility: published -->
<element name="TSpeedButton.GroupIndex">
<short>The Index within the group of speedbuttons</short>
<element name="TSpeedButton.GroupIndex" link="#LCL.Buttons.TCustomSpeedButton.GroupIndex">
<descr/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Layout">
<short>The button layout - Glyph at top, bottom, left or right</short>
<element name="TSpeedButton.Layout" link="#LCL.Buttons.TCustomSpeedButton.Layout">
<descr/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Margin">
<short>Margin - the space around glyphs</short>
<element name="TSpeedButton.Margin" link="#LCL.Buttons.TCustomSpeedButton.Margin">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.NumGlyphs">
<short>The number of Glyphs available</short>
<element name="TSpeedButton.NumGlyphs" link="#LCL.Buttons.TCustomSpeedButton.NumGlyphs">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Spacing">
<short>Spacing around button</short>
<element name="TSpeedButton.Spacing" link="#LCL.Buttons.TCustomSpeedButton.Spacing">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Transparent">
<short>Whether button is transparent</short>
<element name="TSpeedButton.Transparent" link="#LCL.Buttons.TCustomSpeedButton.Transparent">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.Visible">
<short>
<var>Visible</var> - can the control be seen?</short>
<element name="TSpeedButton.Visible" link="#LCL.Controls.TControl.Visible">
<descr>
<pre>The Visible property represents the ability to see a visual control.
If Visible is True the control is shown, otherwise it is hidden.
@ -1646,8 +1581,7 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.OnClick">
<short>Event Handler for mouse click</short>
<element name="TSpeedButton.OnClick" link="#LCL.Controls.TControl.OnClick">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be spcified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <var>ActionList</var>
@ -1657,16 +1591,14 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.OnDblClick">
<short>Event Handle for mouse double-click</short>
<element name="TSpeedButton.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
<descr>
<p>Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate.</p>
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.OnMouseDown">
<short>Event handler for when a mouse button is pressed down</short>
<element name="TSpeedButton.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<descr/>
<seealso/>
</element>
@ -1677,29 +1609,24 @@ introduced. These functions interface with the LCLInterface. </p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.OnMouseUp">
<short>Event handler for when the mouse button is released, ie "up"</short>
<element name="TSpeedButton.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.OnPaint">
<short>
<var>OnPaint</var> - event handler for request to paint canvas</short>
<element name="TSpeedButton.OnPaint" link="#LCL.Controls.TGraphicControl.OnPaint">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.OnResize">
<short>Event Handler for resize of control</short>
<element name="TSpeedButton.OnResize" link="#LCL.Controls.TControl.OnResize">
<descr>// standard properties, which should be supported by all descendants<br/>
Reads or Writes flag if control is re-sized.
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.OnChangeBounds">
<short>Event handler for a change in bounds of the control</short>
<element name="TSpeedButton.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Reads or Writes flag if bounds are changed</p>
@ -1707,30 +1634,24 @@ Reads or Writes flag if control is re-sized.
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.ShowHint">
<short>Flag to determine: Is hint to be displayed for this control?</short>
<element name="TSpeedButton.ShowHint" link="#LCL.Controls.TControl.ShowHint">
<descr>// standard properties, which should be supported by all descendants<br/>
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.ParentFont">
<short>
<var>ParentFont </var>- should the control use the same font as the parent? Default is true</short>
<element name="TSpeedButton.ParentFont" link="#LCL.Controls.TControl.ParentFont">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.ParentShowHint">
<short>
<var>ParentShowHint </var>- does the control adopt the same hinting behaviour as its parent? Default is true</short>
<element name="TSpeedButton.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TSpeedButton.PopupMenu">
<short>PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control</short>
<element name="TSpeedButton.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
<descr>// standard properties, which should be supported by all descendants<br/>
Reads the details of the pop-up menu, or stores them.<br/>
Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
@ -1757,18 +1678,10 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<element name="TButtonGlyph.Height">
<short>The height of the glyph image</short>
</element>
<element name="TCustomBitBtn.TextChanged">
<short>What to do if the text of the Bitbutton has ben changed</short>
</element>
<element name="TCustomBitBtn.GetControlClassDefaultSize">
<short>Find the default size for this class of controls (by reference to parents)</short>
</element>
<element name="TBitBtn.Color">
<short>What Colour is the button? (default is the same as all other button faces)</short>
</element>
<element name="TBitBtn.NumGlyphs">
<short>The number of glyphs for display</short>
</element>
<element name="TCustomBitBtn.TextChanged" link="#LCL.Controls.TControl.TextChanged"/>
<element name="TCustomBitBtn.GetControlClassDefaultSize" link="#LCL.Controls.TControl.GetControlClassDefaultSize"/>
<element name="TBitBtn.Color" link="#LCL.Controls.TControl.Color"/>
<element name="TBitBtn.NumGlyphs" link="#LCL.Buttons.TCustomBitBtn.NumGlyphs"/>
<element name="TCustomSpeedButton.PaintBackground">
<short>Paint the background</short>
</element>
@ -1784,16 +1697,14 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<element name="TCustomSpeedButton.ShowCaption">
<short>Should caption be displayed?</short>
</element>
<element name="TSpeedButton.Color">
<short>Determine the colour for the current control</short>
<element name="TSpeedButton.Color" link="#LCL.Controls.TControl.Color">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Reads the value for colour, or stores the value, and sets a flag if the colour is stored.</p>
<p>The default colour is the same as the window in which the control is located.</p>
</descr>
</element>
<element name="TSpeedButton.Font">
<short>The <var>Font</var> to be used for text in this control</short>
<element name="TSpeedButton.Font" link="#LCL.Controls.TControl.Font">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so</p>
@ -1801,15 +1712,17 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
</p>
</descr>
</element>
<element name="TSpeedButton.OnMouseEnter">
<short>Event handler for when the mouse enters the area of the current control</short>
</element>
<element name="TSpeedButton.OnMouseLeave">
<short>Event handler for when the mouse leaves the area of the current control</short>
</element>
<element name="TSpeedButton.ShowCaption">
<short>Should caption be displayed?</short>
</element>
<element name="TSpeedButton.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter"/>
<element name="TSpeedButton.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave"/>
<element name="TSpeedButton.ShowCaption" link="#LCL.Buttons.TCustomSpeedButton.ShowCaption"/>
<element name="TBitBtn.AutoSize" link="#LCL.Controls.TControl.AutoSize"/>
<element name="TBitBtn.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="TBitBtn.ParentFont" link="#LCL.Controls.TControl.ParentFont"/>
<element name="TCustomSpeedButton.DialogChar" link="#LCL.Controls.TControl.DialogChar"/>
<element name="TCustomSpeedButton.SetEnabled" link="#LCL.Controls.TControl.SetEnabled"/>
<element name="TCustomSpeedButton.GetDrawDetails"/>
<element name="TCustomSpeedButton.GetControlClassDefaultSize" link="#LCL.Controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomSpeedButton.LoadGlyphFromLazarusResource"/>
</module>
</package>
</fpdoc-descriptions>

72
docs/xml/lcl/calendar.xml
View File

@ -283,10 +283,7 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomCalendar.Create">
<short>
<var>Create</var> - constructor for a new instance of <var>TCustomCalendar</var>
</short>
<element name="TCustomCalendar.Create" link="#rtl.Classes.TComponent.Create">
<descr/>
<errors/>
<seealso/>
@ -296,21 +293,21 @@
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomCalendar.Destroy">
<element name="TCustomCalendar.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomCalendar.Loaded">
<element name="TCustomCalendar.Loaded" link="#rtl.Classes.TComponent.Loaded">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomCalendar.InitializeWnd">
<element name="TCustomCalendar.InitializeWnd" link="#LCL.Controls.TWinControl.InitializeWnd">
<short/>
<descr/>
<errors/>
@ -324,7 +321,7 @@
</element>
<!-- property Visibility: public -->
<element name="TCustomCalendar.DateTime">
<short>the composite <var>DateTime</var> value returned by the control</short>
<short>The composite <var>DateTime</var> value returned by the control</short>
<descr/>
<seealso/>
</element>
@ -384,169 +381,169 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.Align">
<element name="TCalendar.Align" link="#LCL.Controls.TControl.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.Anchors">
<element name="TCalendar.Anchors" link="#LCL.Controls.TControl.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.BorderSpacing">
<element name="TCalendar.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.Constraints">
<element name="TCalendar.Constraints" link="#LCL.Controls.TControl.Constraints">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.Date">
<element name="TCalendar.Date" link="#LCL.Calendar.TCustomCalendar.Date">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.DateTime">
<element name="TCalendar.DateTime" link="#LCL.Calendar.TCustomCalendar.DateTime">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.DisplaySettings">
<element name="TCalendar.DisplaySettings" link="#LCL.Calendar.TCustomCalendar.DisplaySettings">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnChange">
<element name="TCalendar.OnChange" link="#LCL.Calendar.TCustomCalendar.OnChange">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnChangeBounds">
<element name="TCalendar.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnClick">
<element name="TCalendar.OnClick" link="#LCL.Controls.TControl.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnDayChanged">
<element name="TCalendar.OnDayChanged" link="#LCL.Calendar.TCustomCalendar.OnDayChanged">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnEnter">
<element name="TCalendar.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnExit">
<element name="TCalendar.OnExit" link="#LCL.Controls.TWinControl.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnKeyDown">
<element name="TCalendar.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnKeyPress">
<element name="TCalendar.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnKeyUp">
<element name="TCalendar.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnMonthChanged">
<element name="TCalendar.OnMonthChanged" link="#LCL.Calendar.TCustomCalendar.OnMonthChanged">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnMouseDown">
<element name="TCalendar.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnMouseEnter">
<element name="TCalendar.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnMouseLeave">
<element name="TCalendar.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnMouseMove">
<element name="TCalendar.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnMouseUp">
<element name="TCalendar.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnResize">
<element name="TCalendar.OnResize" link="#LCL.Controls.TControl.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.OnYearChanged">
<element name="TCalendar.OnYearChanged" link="#LCL.Calendar.TCustomCalendar.OnYearChanged">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.PopupMenu">
<element name="TCalendar.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.ReadOnly">
<element name="TCalendar.ReadOnly" link="#LCL.Calendar.TCustomCalendar.ReadOnly">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.Tabstop">
<element name="TCalendar.Tabstop" link="#LCL.Controls.TWinControl.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCalendar.Visible">
<element name="TCalendar.Visible" link="#LCL.Controls.TControl.Visible">
<short/>
<descr/>
<seealso/>
@ -558,6 +555,9 @@
<errors/>
<seealso/>
</element>
<element name="TCustomCalendar.GetControlClassDefaultSize" link="#LCL.Controls.TControl.GetControlClassDefaultSize"/>
<element name="TCalendar.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
<element name="TCalendar.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
</module>
<!-- Calendar -->
</package>

100
docs/xml/lcl/chart.xml
View File

@ -129,7 +129,7 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomBarChart.Create">
<element name="TCustomBarChart.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<descr/>
<errors/>
@ -140,7 +140,7 @@
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomBarChart.Destroy">
<element name="TCustomBarChart.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<descr/>
<errors/>
@ -180,7 +180,8 @@
</element>
<!-- function Visibility: public -->
<element name="TCustomBarChart.GetBar">
<short/>
<short>
<var>GetBar</var> - collect the data for one of the bars</short>
<descr/>
<errors/>
<seealso/>
@ -207,21 +208,23 @@
</element>
<!-- procedure Visibility: public -->
<element name="TCustomBarChart.BeginUpdate">
<short/>
<short>
<var>BeginUpdate</var> - start updating</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TCustomBarChart.EndUpdate">
<short/>
<short>
<var>EndUpdate</var> - finish updating</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomBarChart.Depth">
<short/>
<short>The <var>Depth</var> of the bars in the chart</short>
<descr/>
<seealso/>
</element>
@ -239,91 +242,91 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Align">
<element name="TBarChart.Align" link="#LCL.Controls.TControl.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Alignment">
<element name="TBarChart.Alignment" link="#LCL.ExtCtrls.TCustomPanel.Alignment">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Anchors">
<element name="TBarChart.Anchors" link="#LCL.Controls.TControl.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.AutoSize">
<element name="TBarChart.AutoSize" link="#LCL.Controls.TControl.AutoSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BorderSpacing">
<element name="TBarChart.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BevelInner">
<element name="TBarChart.BevelInner" link="#LCL.ExtCtrls.TCustomPanel.BevelInner">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BevelOuter">
<element name="TBarChart.BevelOuter" link="#LCL.ExtCtrls.TCustomPanel.BevelOuter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BevelWidth">
<element name="TBarChart.BevelWidth" link="#LCL.ExtCtrls.TCustomPanel.BevelWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BorderWidth">
<element name="TBarChart.BorderWidth" link="#LCL.Controls.TWinControl.BorderWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.BorderStyle">
<element name="TBarChart.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Caption">
<element name="TBarChart.Caption" link="#LCL.Controls.TControl.Caption">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ClientHeight">
<element name="TBarChart.ClientHeight" link="#LCL.Controls.TControl.ClientHeight">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ClientWidth">
<element name="TBarChart.ClientWidth" link="#LCL.Controls.TControl.ClientWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Color">
<element name="TBarChart.Color" link="#LCL.Controls.TControl.Color">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Constraints">
<element name="TBarChart.Constraints" link="#LCL.Controls.TControl.Constraints">
<short/>
<descr/>
<seealso/>
@ -335,145 +338,145 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.DragMode">
<element name="TBarChart.DragMode" link="#LCL.Controls.TControl.DragMode">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Enabled">
<element name="TBarChart.Enabled" link="#LCL.Controls.TControl.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Font">
<element name="TBarChart.Font" link="#LCL.Controls.TControl.Font">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.FullRepaint">
<element name="TBarChart.FullRepaint" link="#LCL.ExtCtrls.TCustomPanel.FullRepaint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ParentColor">
<element name="TBarChart.ParentColor" link="#LCL.Controls.TControl.ParentColor">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ParentFont">
<element name="TBarChart.ParentFont" link="#LCL.Controls.TControl.ParentFont">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ParentShowHint">
<element name="TBarChart.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.PopupMenu">
<element name="TBarChart.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.ShowHint">
<element name="TBarChart.ShowHint" link="#LCL.Controls.TControl.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.TabOrder">
<element name="TBarChart.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.TabStop">
<element name="TBarChart.TabStop" link="#LCL.Controls.TWinControl.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.Visible">
<element name="TBarChart.Visible" link="#LCL.Controls.TControl.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnClick">
<element name="TBarChart.OnClick" link="#LCL.Controls.TControl.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnDblClick">
<element name="TBarChart.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnDragDrop">
<element name="TBarChart.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnDragOver">
<element name="TBarChart.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnEndDrag">
<element name="TBarChart.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnEnter">
<element name="TBarChart.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnExit">
<element name="TBarChart.OnExit" link="#LCL.Controls.TWinControl.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnMouseDown">
<element name="TBarChart.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnMouseMove">
<element name="TBarChart.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnMouseUp">
<element name="TBarChart.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnResize">
<element name="TBarChart.OnResize" link="#LCL.Controls.TControl.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBarChart.OnStartDrag">
<element name="TBarChart.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
<short/>
<descr/>
<seealso/>
@ -499,7 +502,7 @@
<short>
<var>TBarChartItems</var> - the collection of items defining the bars in this barchart</short>
</element>
<element name="TBarChartItems.Create"/>
<element name="TBarChartItems.Create" link="#rtl.Classes.TCollection.Create"/>
<element name="TCustomBarChart.Bars">
<short>
<var>Bars</var> - the collection of bars that comprise the BarChart</short>
@ -508,6 +511,11 @@
<short>
<var>LabelPosition</var> - left, centered or right</short>
</element>
<element name="TCustomBarChart.GetControlClassDefaultSize" link="#LCL.Controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomBarChart.UpdateBarChart">
<short>
<var>UpdateBarChart</var> - fill in any new information</short>
</element>
</module>
<!-- Chart -->
</package>

112
docs/xml/lcl/checklst.xml
View File

@ -158,10 +158,7 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomCheckListBox.Create">
<short>
<var>Create</var> a new instance of <var>TCustomCheckListBox</var>
</short>
<element name="TCustomCheckListBox.Create" link="#rtl.Classes.TComponent.Create">
<descr/>
<errors/>
<seealso/>
@ -191,176 +188,175 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.Align">
<element name="TCheckListBox.Align" link="#LCL.Controls.TControl.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.Anchors">
<element name="TCheckListBox.Anchors" link="#LCL.Controls.TControl.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.BorderSpacing">
<element name="TCheckListBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.BorderStyle">
<element name="TCheckListBox.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.Constraints">
<element name="TCheckListBox.Constraints" link="#LCL.Controls.TControl.Constraints">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.ExtendedSelect">
<element name="TCheckListBox.ExtendedSelect" link="#LCL.StdCtrls.TCustomListBox.ExtendedSelect">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.Items">
<element name="TCheckListBox.Items" link="#LCL.StdCtrls.TCustomListBox.Items">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.ItemHeight">
<element name="TCheckListBox.ItemHeight" link="#LCL.StdCtrls.TCustomListBox.ItemHeight">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.MultiSelect">
<short>Allows multiple selected list items.</short>
<element name="TCheckListBox.MultiSelect" link="#LCL.StdCtrls.TCustomListBox.MultiSelect">
<seealso>
<link id="StdCtrls"/>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnClick">
<element name="TCheckListBox.OnClick" link="#LCL.Controls.TControl.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnDblClick">
<element name="TCheckListBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnDrawItem">
<element name="TCheckListBox.OnDrawItem" link="#LCL.StdCtrls.TCustomListBox.OnDrawItem">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnEnter">
<element name="TCheckListBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnExit">
<element name="TCheckListBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnKeyPress">
<element name="TCheckListBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnKeyDown">
<element name="TCheckListBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnKeyUp">
<element name="TCheckListBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnMouseMove">
<element name="TCheckListBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnMouseDown">
<element name="TCheckListBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnMouseUp">
<element name="TCheckListBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.OnResize">
<element name="TCheckListBox.OnResize" link="#LCL.Controls.TControl.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.ParentShowHint">
<element name="TCheckListBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.ShowHint">
<element name="TCheckListBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.Sorted">
<element name="TCheckListBox.Sorted" link="#LCL.StdCtrls.TCustomListBox.Sorted">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.Style">
<element name="TCheckListBox.Style" link="#LCL.StdCtrls.TCustomListBox.Style">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.TabOrder">
<element name="TCheckListBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.TabStop">
<element name="TCheckListBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.TopIndex">
<element name="TCheckListBox.TopIndex" link="#LCL.StdCtrls.TCustomListBox.TopIndex">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCheckListBox.Visible">
<element name="TCheckListBox.Visible" link="#LCL.Controls.TControl.Visible">
<short/>
<descr/>
<seealso/>
@ -383,7 +379,7 @@
<element name="TCustomCheckListBox.State">
<short>The <var>State</var> of the box with the specified index - checked, unchecked or greyed</short>
</element>
<element name="TCustomCheckListBox.Count"/>
<element name="TCustomCheckListBox.Count" link="#LCL.StdCtrls.TCustomListBox.Count"/>
<element name="TCustomCheckListBox.OnClickCheck">
<short>
<var>OnClickCheck</var> - event handler for a mouse click on the CheckBox</short>
@ -392,6 +388,52 @@
<short>
<var>OnItemClick</var> - event handler for a mouse click on the data item associated with the checkbox</short>
</element>
<element name="TCustomCheckListBox.DefineProperties" link="#rtl.Classes.TComponent.DefineProperties"/>
<element name="TCustomCheckListBox.ReadData">
<short>
<var>ReadData</var> from a stream</short>
</element>
<element name="TCustomCheckListBox.WriteData">
<short>
<var>WriteData</var> to a stream</short>
</element>
<element name="TCustomCheckListBox.ClickCheck">
<short>
<var>ClickCheck</var> - software emulator of <var>OnClickCheck</var> event</short>
</element>
<element name="TCustomCheckListBox.ItemClick">
<short>
<var>ItemClick</var> - software emulation of <var>OnItemClick</var> event</short>
</element>
<element name="TCustomCheckListBox.MeasureItem" link="#LCL.StdCtrls.TCustomListBox.MeasureItem"/>
<element name="TCustomCheckListBox.ItemEnabled"/>
<element name="TCheckListBox.AllowGrayed" link="#LCL.CheckLst.TCustomCheckListBox.AllowGrayed"/>
<element name="TCheckListBox.BidiMode" link="#LCL.Controls.TControl.BiDiMode"/>
<element name="TCheckListBox.Color" link="#LCL.Controls.TControl.Color"/>
<element name="TCheckListBox.Columns" link="#LCL.StdCtrls.TCustomListBox.Columns"/>
<element name="TCheckListBox.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
<element name="TCheckListBox.DragMode" link="#LCL.Controls.TControl.DragMode"/>
<element name="TCheckListBox.Enabled" link="#LCL.Controls.TControl.Enabled"/>
<element name="TCheckListBox.Font" link="#LCL.Controls.TControl.Font"/>
<element name="TCheckListBox.IntegralHeight" link="#LCL.StdCtrls.TCustomListBox.IntegralHeight"/>
<element name="TCheckListBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds"/>
<element name="TCheckListBox.OnClickCheck" link="#LCL.CheckLst.TCustomCheckListBox.OnClickCheck"/>
<element name="TCheckListBox.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
<element name="TCheckListBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
<element name="TCheckListBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>
<element name="TCheckListBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
<element name="TCheckListBox.OnItemClick" link="#LCL.CheckLst.TCustomCheckListBox.OnItemClick"/>
<element name="TCheckListBox.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter"/>
<element name="TCheckListBox.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave"/>
<element name="TCheckListBox.OnMouseWheel" link="#LCL.Controls.TControl.OnMouseWheel"/>
<element name="TCheckListBox.OnMouseWheelDown" link="#LCL.Controls.TControl.OnMouseWheelDown"/>
<element name="TCheckListBox.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp"/>
<element name="TCheckListBox.OnShowHint" link="#LCL.Controls.TControl.OnShowHint"/>
<element name="TCheckListBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag"/>
<element name="TCheckListBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="TCheckListBox.ParentBidiMode" link="#LCL.Controls.TControl.ParentBiDiMode"/>
<element name="TCheckListBox.ParentFont" link="#LCL.Controls.TControl.ParentFont"/>
<element name="TCheckListBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu"/>
</module>
<!-- CheckLst -->
</package>

18
docs/xml/lcl/clipbrd.xml
View File

@ -414,9 +414,7 @@
<short/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.AddFormat">
<short>
<var>AddFormat</var> - add data to the supported formats. Returns True when operation has proceeded correctly</short>
<element name="TClipboard.AddFormat" link="#LCL.Clipbrd.TClipboard.AddFormat">
<descr/>
<errors/>
<seealso/>
@ -457,9 +455,7 @@
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.Assign">
<short>
<var>Assign</var> - add the data from the source to the clipboard with the specified Format ID</short>
<element name="TClipboard.Assign" link="#rtl.Classes.TPersistent.Assign">
<descr/>
<errors/>
<seealso/>
@ -469,9 +465,7 @@
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.AssignTo">
<short>
<var>AssignTo</var> - add the data from the clipboard to the specified destination</short>
<element name="TClipboard.AssignTo" link="#rtl.Classes.TPersistent.AssignTo">
<descr/>
<errors/>
<seealso/>
@ -517,9 +511,7 @@
<var>AClipboardType</var> - optional argument specifying type of clipboard to be created</short>
</element>
<!-- destructor Visibility: public -->
<element name="TClipboard.Destroy">
<short>
<var>Destroy</var> - destructor: remove this instance of clipboard</short>
<element name="TClipboard.Destroy" link="#rtl.Classes.TPersistent.Destroy">
<descr/>
<errors/>
<seealso/>
@ -751,7 +743,7 @@
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SetTextBuf">
<element name="TClipboard.SetTextBuf" link="#rtl.System.SetTextBuf">
<short/>
<descr/>
<errors/>

236
docs/xml/lcl/colorbox.xml
View File

@ -152,9 +152,9 @@
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TColorBox.SetStyle">
<short>Write specifier for the setstyle property</short>
<descr>Use SetStyle to prevent the style to be changed to anything else than csOwnerDrawFixed.</descr>
<element name="TColorBox.SetStyle" link="#LCL.StdCtrls.TCustomComboBox.SetStyle">
<descr>Use SetStyle to prevent the style to be changed to anything else than csOwnerDrawFixed.
</descr>
<errors/>
<seealso/>
</element>
@ -163,8 +163,7 @@
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TColorBox.DrawItem">
<short>Method that draws a color item in the colorbox</short>
<element name="TColorBox.DrawItem" link="#LCL.StdCtrls.TCustomComboBox.DrawItem">
<descr>Use DrawItem to customdraw an item in the ColorBox. A color preview is drawn and the item rectangle is made smaller and given to the inherited method to draw the corresponding text. The Brush color and Pen color where changed and reset to their original values.
</descr>
<errors/>
@ -183,9 +182,9 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TColorBox.Create">
<short>Constructor for colorbox</short>
<descr>Use Create to create an instance of TColorBox and initialize all properties and variables.</descr>
<element name="TColorBox.Create" link="#rtl.Classes.TComponent.Create">
<descr>Use Create to create an instance of TColorBox and initialize all properties and variables.
</descr>
<errors/>
<seealso/>
</element>
@ -220,102 +219,102 @@
<short/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Align">
<element name="TColorBox.Align" link="#LCL.Controls.TControl.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Anchors">
<element name="TColorBox.Anchors" link="#LCL.Controls.TControl.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ArrowKeysTraverseList">
<element name="TColorBox.ArrowKeysTraverseList" link="#LCL.StdCtrls.TCustomComboBox.ArrowKeysTraverseList">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.AutoComplete">
<element name="TColorBox.AutoComplete" link="#LCL.StdCtrls.TCustomComboBox.AutoComplete">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.AutoCompleteText">
<element name="TColorBox.AutoCompleteText" link="#LCL.StdCtrls.TCustomComboBox.AutoCompleteText">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.AutoDropDown">
<element name="TColorBox.AutoDropDown" link="#LCL.StdCtrls.TCustomComboBox.AutoDropDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.AutoSize">
<element name="TColorBox.AutoSize" link="#LCL.Controls.TControl.AutoSize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.BorderSpacing">
<element name="TColorBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Color">
<element name="TColorBox.Color" link="#LCL.Controls.TControl.Color">
<short>
<var>Color</var> - this is the colour for the display of the actual control, not the colour selected from the list</short>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Ctl3D">
<element name="TColorBox.Ctl3D" link="#LCL.Controls.TControl.Ctl3D">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.DragMode">
<element name="TColorBox.DragMode" link="#LCL.Controls.TControl.DragMode">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.DragCursor">
<element name="TColorBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.DropDownCount">
<element name="TColorBox.DropDownCount" link="#LCL.StdCtrls.TCustomComboBox.DropDownCount">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Enabled">
<element name="TColorBox.Enabled" link="#LCL.Controls.TControl.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Font">
<element name="TColorBox.Font" link="#LCL.Controls.TControl.Font">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ItemHeight">
<element name="TColorBox.ItemHeight" link="#LCL.StdCtrls.TCustomComboBox.ItemHeight">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ItemIndex">
<element name="TColorBox.ItemIndex" link="#LCL.StdCtrls.TCustomComboBox.ItemIndex">
<short/>
<descr/>
<seealso/>
@ -327,13 +326,13 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ItemWidth">
<element name="TColorBox.ItemWidth" link="#LCL.StdCtrls.TCustomComboBox.ItemWidth">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.MaxLength">
<element name="TColorBox.MaxLength" link="#LCL.StdCtrls.TCustomComboBox.MaxLength">
<short/>
<descr/>
<seealso/>
@ -345,37 +344,37 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ParentColor">
<element name="TColorBox.ParentColor" link="#LCL.Controls.TControl.ParentColor">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ParentCtl3D">
<element name="TColorBox.ParentCtl3D" link="#LCL.Controls.TWinControl.ParentCtl3D">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ParentFont">
<element name="TColorBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ParentShowHint">
<element name="TColorBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.PopupMenu">
<element name="TColorBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ReadOnly">
<element name="TColorBox.ReadOnly" link="#LCL.StdCtrls.TCustomComboBox.ReadOnly">
<short/>
<descr/>
<seealso/>
@ -385,169 +384,169 @@
<short>The colour that has been <var>Selected</var> from the list</short>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.ShowHint">
<element name="TColorBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Sorted">
<element name="TColorBox.Sorted" link="#LCL.StdCtrls.TCustomComboBox.Sorted">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.TabOrder">
<element name="TColorBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.TabStop">
<element name="TColorBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Text">
<element name="TColorBox.Text" link="#LCL.StdCtrls.TCustomComboBox.Text">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.Visible">
<element name="TColorBox.Visible" link="#LCL.Controls.TControl.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnChange">
<element name="TColorBox.OnChange" link="#LCL.StdCtrls.TCustomComboBox.OnChange">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnChangeBounds">
<element name="TColorBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnClick">
<element name="TColorBox.OnClick" link="#LCL.Controls.TControl.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnCloseUp">
<element name="TColorBox.OnCloseUp" link="#LCL.StdCtrls.TCustomComboBox.OnCloseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnDblClick">
<element name="TColorBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnDragDrop">
<element name="TColorBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnDragOver">
<element name="TColorBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnDrawItem">
<element name="TColorBox.OnDrawItem" link="#LCL.StdCtrls.TCustomComboBox.OnDrawItem">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnDropDown">
<element name="TColorBox.OnDropDown" link="#LCL.StdCtrls.TCustomComboBox.OnDropDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnEditingDone">
<element name="TColorBox.OnEditingDone" link="#LCL.Controls.TControl.OnEditingDone">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnEndDrag">
<element name="TColorBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnEnter">
<element name="TColorBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnExit">
<element name="TColorBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnKeyDown">
<element name="TColorBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnKeyPress">
<element name="TColorBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnKeyUp">
<element name="TColorBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnMeasureItem">
<element name="TColorBox.OnMeasureItem" link="#LCL.StdCtrls.TCustomComboBox.OnMeasureItem">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnMouseDown">
<element name="TColorBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnMouseMove">
<element name="TColorBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnMouseUp">
<element name="TColorBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnStartDrag">
<element name="TColorBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorBox.OnSelect">
<element name="TColorBox.OnSelect" link="#LCL.StdCtrls.TCustomComboBox.OnSelect">
<short/>
<descr/>
<seealso/>
@ -642,7 +641,7 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TColorListBox.Create">
<element name="TColorListBox.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<descr/>
<errors/>
@ -654,7 +653,8 @@
</element>
<!-- procedure Visibility: public -->
<element name="TColorListBox.SetColorList">
<short/>
<short>
<var>SetColorList</var> - stores the list of colours</short>
<descr/>
<errors/>
<seealso/>
@ -673,31 +673,31 @@
<short>The colour that has been <var>Selected</var> from the list</short>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Align">
<element name="TColorListBox.Align" link="#LCL.Controls.TControl.Align">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Anchors">
<element name="TColorListBox.Anchors" link="#LCL.Controls.TControl.Anchors">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.BorderSpacing">
<element name="TColorListBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.BorderStyle">
<element name="TColorListBox.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.ClickOnSelChange">
<element name="TColorListBox.ClickOnSelChange" link="#LCL.StdCtrls.TCustomListBox.ClickOnSelChange">
<short/>
<descr/>
<seealso/>
@ -705,118 +705,118 @@
<!-- property Visibility: published -->
<element name="TColorListBox.Color">
<short>
<var>Color</var> - this is the colour for the display of the actual control, not the colour selected from the list</short>
<var>Color</var> - Determine the colour for the display of the actual control, not the colour selected from the list</short>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Constraints">
<element name="TColorListBox.Constraints" link="#LCL.Controls.TControl.Constraints">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.DragCursor">
<element name="TColorListBox.DragCursor" link="#LCL.Controls.TControl.DragCursor">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.DragMode">
<element name="TColorListBox.DragMode" link="#LCL.Controls.TControl.DragMode">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Enabled">
<element name="TColorListBox.Enabled" link="#LCL.Controls.TControl.Enabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.ExtendedSelect">
<element name="TColorListBox.ExtendedSelect" link="#LCL.StdCtrls.TCustomListBox.ExtendedSelect">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Font">
<element name="TColorListBox.Font" link="#LCL.Controls.TControl.Font">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.IntegralHeight">
<element name="TColorListBox.IntegralHeight" link="#LCL.StdCtrls.TCustomListBox.IntegralHeight">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.ItemHeight">
<element name="TColorListBox.ItemHeight" link="#LCL.StdCtrls.TCustomListBox.ItemHeight">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Items">
<element name="TColorListBox.Items" link="#LCL.StdCtrls.TCustomListBox.Items">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.MultiSelect">
<element name="TColorListBox.MultiSelect" link="#LCL.StdCtrls.TCustomListBox.MultiSelect">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Palette">
<short>The <var>Palette</var> of colours from which selection is to be made</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.ParentColor" link="#LCL.Controls.TControl.ParentColor">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.ParentColor">
<element name="TColorListBox.ParentFont" link="#LCL.Controls.TControl.ParentFont">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.ParentFont">
<element name="TColorListBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.ParentShowHint">
<element name="TColorListBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.PopupMenu">
<element name="TColorListBox.ShowHint" link="#LCL.Controls.TControl.ShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.ShowHint">
<element name="TColorListBox.Sorted" link="#LCL.StdCtrls.TCustomListBox.Sorted">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Sorted">
<element name="TColorListBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.TabOrder">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.TabStop">
<element name="TColorListBox.TabStop" link="#LCL.Controls.TWinControl.TabStop">
<short/>
<descr/>
<seealso/>
@ -828,151 +828,151 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.Visible">
<element name="TColorListBox.Visible" link="#LCL.Controls.TControl.Visible">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnChangeBounds">
<element name="TColorListBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnClick">
<element name="TColorListBox.OnClick" link="#LCL.Controls.TControl.OnClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnDblClick">
<element name="TColorListBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnDragDrop">
<element name="TColorListBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnDragOver">
<element name="TColorListBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnDrawItem">
<element name="TColorListBox.OnDrawItem" link="#LCL.StdCtrls.TCustomListBox.OnDrawItem">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnEndDrag">
<element name="TColorListBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnEnter">
<element name="TColorListBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnExit">
<element name="TColorListBox.OnExit" link="#LCL.Controls.TWinControl.OnExit">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnKeyDown">
<element name="TColorListBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnKeyPress">
<element name="TColorListBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnKeyUp">
<element name="TColorListBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnMouseDown">
<element name="TColorListBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnMouseEnter">
<element name="TColorListBox.OnMouseEnter" link="#LCL.Controls.TControl.OnMouseEnter">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnMouseLeave">
<element name="TColorListBox.OnMouseLeave" link="#LCL.Controls.TControl.OnMouseLeave">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnMouseMove">
<element name="TColorListBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnMouseUp">
<element name="TColorListBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnMouseWheel">
<element name="TColorListBox.OnMouseWheel" link="#LCL.Controls.TControl.OnMouseWheel">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnMouseWheelDown">
<element name="TColorListBox.OnMouseWheelDown" link="#LCL.Controls.TControl.OnMouseWheelDown">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnMouseWheelUp">
<element name="TColorListBox.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnResize">
<element name="TColorListBox.OnResize" link="#LCL.Controls.TControl.OnResize">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnSelectionChange">
<element name="TColorListBox.OnSelectionChange" link="#LCL.StdCtrls.TCustomListBox.OnSelectionChange">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnShowHint">
<element name="TColorListBox.OnShowHint" link="#LCL.Controls.TControl.OnShowHint">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TColorListBox.OnStartDrag">
<element name="TColorListBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag">
<short/>
<descr/>
<seealso/>
@ -984,6 +984,8 @@
<errors/>
<seealso/>
</element>
<element name="TColorBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="TColorListBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
</module>
<!-- ColorBox -->
</package>

6
docs/xml/lcl/customtimer.xml
View File

@ -139,9 +139,9 @@
<var>KillTimer</var> - kills the current timer object</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded"/>
<element name="TCustomTimer.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
<!-- constructor Visibility: public -->
<element name="TCustomTimer.Create">
<element name="TCustomTimer.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<descr/>
<errors/>
@ -152,7 +152,7 @@
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomTimer.Destroy">
<element name="TCustomTimer.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<descr/>
<errors/>