paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-09 19:56:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL. Fixes missing punctuation in short descriptions (partial).

Browse Source 
git-svn-id: trunk@65262 -
This commit is contained in:
dsiders 2021-06-18 01:08:35 +00:00
parent 9883a587f5
commit 884951e97c
14 changed files with 3163 additions and 3175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,7 +7,7 @@
====================================================================
-->
<module name="ActnList">
<short>Defines classes for Actions and lists of Actions for use in LCL components</short>
<short>Defines classes for Actions and lists of Actions for use in LCL components.</short>
<descr>
<p>
<file>actnlist.pas</file> contains classes which implements actions used in LCL components.
@ -41,7 +41,8 @@
<!-- object Visibility: default -->
<element name="TContainedAction">
<short>
<var>TContainedAction</var> - parent class for <var>TCustomAction</var>; defines some properties especially relationships with parents</short>
<var>TContainedAction</var> - parent class for <var>TCustomAction</var>; defines some properties especially relationships with parents.
</short>
<descr/>
<seealso/>
</element>
@ -193,19 +194,19 @@
</element>
<!-- property Visibility: public -->
<element name="TContainedAction.ActionList">
<short>The <var>ActionList</var> in which this action is contained</short>
<short>The <var>ActionList</var> in which this action is contained.</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TContainedAction.Index">
<short>The <var>Index</var> of this action in the list of actions</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>The <var>Category</var> of this action</short>
<short>The <var>Category</var> of this action.</short>
<descr/>
<seealso/>
</element>
@ -250,7 +251,7 @@
<!-- object Visibility: default -->
<element name="TCustomActionList">
<short>
<var>TCustomActionList</var> - the ancestor class for <var>TActionList</var>
<var>TCustomActionList</var> - the ancestor class for <var>TActionList</var>.
</short>
<descr>
<p>
@ -332,8 +333,7 @@
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.AddAction">
<short>
<var>AddAction</var> - adds an action to the list</short>
<short><var>AddAction</var> - adds an action to the list.</short>
<descr/>
<seealso/>
</element>
@ -343,8 +343,7 @@
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.RemoveAction">
<short>
<var>RemoveAction</var> - removes an action from the list</short>
<short><var>RemoveAction</var> - removes an action from the list.</short>
<descr/>
<seealso/>
</element>
@ -354,9 +353,7 @@
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.Change">
<short>
<var>Change</var> the action</short>
<descr/>
<short><var>Change</var> the action.</short>.<descr/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
@ -403,8 +400,7 @@
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomActionList.SetImages">
<short>
<var>SetImages</var> - stores a list of images</short>
<short><var>SetImages</var> - stores a list of images.</short>
<descr/>
<seealso/>
</element>
@ -414,28 +410,25 @@
</element>
<!-- property Visibility: protected -->
<element name="TCustomActionList.OnChange">
<short>
<var>OnChange</var> - event handler for a change in the action</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>
<var>OnExecute</var> - event handler for execution of the action</short>
<short><var>OnExecute</var> - event handler for execution of the action.</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: protected -->
<element name="TCustomActionList.OnUpdate">
<short>
<var>OnUpdate</var> - event handler for updating the action</short>
<short><var>OnUpdate</var> - event handler for updating the action.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomActionList.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for <var>TCustomActionList</var>, and calls the inherited constructor.
@ -458,7 +451,7 @@
</element>
<element name="TCustomActionList.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the destructor for <var>TCustomActionList</var>. It frees the internal TChangeLink instance used in the class, frees any class instance and resources allocated to the <var>Actions</var> property.
@ -475,7 +468,7 @@
</element>
<element name="TCustomActionList.ExecuteAction" link="#rtl.Classes.TComponent.ExecuteAction">
<short>Examines and executes the specified Action</short>
<short>Examines and executes the specified Action.</short>
<descr>
<p>
<var>ExecuteAction</var> checks whether <var>Action</var> handles the current component, and if yes, calls the <var>ExecuteAction</var> method, passing itself as a parameter. The function returns <var>True</var> if the action handles the current component.
@ -491,7 +484,7 @@
</element>
<element name="TCustomActionList.UpdateAction" link="#rtl.Classes.TComponent.UpdateAction">
<short>Examines and updates the target for the specified Action</short>
<short>Examines and updates the target for the specified Action.</short>
<descr>
<p>
<var>UpdateAction</var> checks whether <var>Action</var> handles the current component, and if yes, calls the <var>UpdateTarget</var> method, passing itself as a parameter. The function returns <var>True</var> if the action handles the current component.
@ -507,7 +500,7 @@
</element>
<element name="TCustomActionList.IndexOfName">
<short>The Index value of the name of this action in the ActionList</short>
<short>The Index value of the name of this action in the ActionList.</short>
<descr/>
<seealso/>
</element>
@ -521,7 +514,7 @@
</element>
<element name="TCustomActionList.IsShortCut">
<short>This action is associated with a shortcut</short>
<short>This action is associated with a shortcut.</short>
</element>
<element name="TCustomActionList.IsShortCut.Result">
<short></short>
@ -529,7 +522,7 @@
<!-- function Visibility: public -->
<element name="TCustomActionList.ActionByName">
<short>Returns an action identified by its name (as a string)</short>
<short>Returns an action identified by its name (as a string).</short>
<descr/>
<seealso/>
</element>
@ -543,7 +536,7 @@
</element>
<!-- property Visibility: public -->
<element name="TCustomActionList.Actions">
<short>The indexed list of actions</short>
<short>The indexed list of actions.</short>
<descr/>
<seealso/>
</element>
@ -553,27 +546,27 @@
</element>
<!-- property Visibility: public -->
<element name="TCustomActionList.ActionCount">
<short>The total number of actions in the actionlist</short>
<short>The total number of actions in the actionlist.</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomActionList.Images">
<short>Image list with images for the actions</short>
<short>Image list with images for the actions.</short>
<descr>
<var>ImageList</var> with the <var>Images</var> that can be associated with the actions in the list., e.g. in a Menu display.
</descr>
</element>
<!-- property Visibility: public -->
<element name="TCustomActionList.State">
<short>State of the action : Normal, Suspended or SuspendedEnabled</short>
<short>State of the action : Normal, Suspended or SuspendedEnabled.</short>
<descr/>
<seealso/>
</element>
<element name="TActionList">
<short>
<var>TActionList</var> - The basic actions list class</short>
<var>TActionList</var> - The basic actions list class.</short>
<descr>
<p>
<var>TActionList</var> - The basic actions list class. <var>TActionList</var> is the last component on the "Standard" component palette on the Lazarus IDE.
@ -606,19 +599,19 @@
<element name="TActionList.OnUpdate" link="#LCL.ActnList.TCustomActionList.OnUpdate"/>
<element name="TShortCutList">
<short>TShortCutList - a list of shortcuts for actions in an ActionList</short>
<short>TShortCutList - a list of shortcuts for actions in an ActionList.</short>
<descr/>
<seealso/>
</element>
<!-- function Visibility: private -->
<element name="TShortCutList.GetShortCuts">
<short>Gets the value for the indexed Shortcuts property</short>
<short>Gets the value for the indexed Shortcuts property.</short>
<descr/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TShortCutList.GetShortCuts.Result">
<short>Value for the indexed property</short>
<short>Value for the indexed property.</short>
</element>
<!-- argument Visibility: default -->
<element name="TShortCutList.GetShortCuts.Index">
@ -626,21 +619,21 @@
</element>
<!-- function Visibility: public -->
<element name="TShortCutList.Add">
<short>Add a shortcut with the specified text to the list</short>
<short>Add a shortcut with the specified text to the list.</short>
<descr/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TShortCutList.Add.Result">
<short>TShortcut instance added in the method</short>
<short>TShortcut instance added in the method.</short>
</element>
<!-- argument Visibility: default -->
<element name="TShortCutList.Add.S">
<short>Text for the shortcut</short>
<short>Text for the shortcut.</short>
</element>
<!-- function Visibility: public -->
<element name="TShortCutList.IndexOfShortCut">
<short>The index number of the shortcut in the list</short>
<short>The index number of the shortcut in the list.</short>
<descr/>
<seealso/>
</element>
@ -654,7 +647,7 @@
</element>
<!-- property Visibility: public -->
<element name="TShortCutList.ShortCuts">
<short>The indexed list of short cuts</short>
<short>The indexed list of short cuts.</short>
<descr/>
<seealso/>
</element>
@ -679,7 +672,7 @@
<!-- object Visibility: default -->
<element name="TCustomAction">
<short>
<var>TCustomAction</var> is the ancestor class for <var>TAction</var>
<var>TCustomAction</var> is the ancestor class for <var>TAction</var>.
</short>
<descr>
<p>
@ -898,7 +891,8 @@
<!-- function Visibility: protected -->
<element name="TCustomAction.HandleShortCut">
<short>
<var>HandleShortCut</var> - returns True if there is a short cut associated with the handle</short>
<var>HandleShortCut</var> - returns True if there is a short cut associated with the handle.
</short>
<descr/>
<seealso/>
</element>
@ -908,15 +902,18 @@
</element>
<!-- property Visibility: protected -->
<element name="TCustomAction.SavedEnabledState">
<short>
<var>SavedEnabledState</var> - if True, the Enabled state has been saved</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> - constructor for <var>TCustomAction</var>: calls inherited <var>Create</var> then initializes some local variables</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for <var>TCustomAction</var>, and calls the inherited <var>Create</var> method. It initializes local variables in the class instance.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TBasicAction.Create">TBasicAction.Create</link>
</seealso>
@ -928,7 +925,7 @@
<!-- destructor Visibility: public -->
<element name="TCustomAction.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TCustomAction</var>: frees various lists and images, then calls inherited <var>Destroy</var>
<var>Destroy</var> - destructor for <var>TCustomAction</var>: frees various lists and images, then calls inherited <var>Destroy</var>.
</short>
<seealso>
<link id="#rtl.classes.TBasicAction.Destroy">TBasicAction.Destroy</link>
@ -937,95 +934,95 @@
<!-- function Visibility: public -->
<element name="TCustomAction.DoHint">
<short>
<var>DoHint</var> - method for displaying the hint contained in <var>HintStr</var> if True value is returned</short>
<var>DoHint</var> - method for displaying the hint contained in <var>HintStr</var> if True value is returned.</short>
</element>
<!-- function result Visibility: default -->
<element name="TCustomAction.DoHint.Result">
<short>True if hint is to be displayed</short>
<short>True if hint is to be displayed.</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomAction.DoHint.HintStr">
<short>
<var>HintStr</var> - the text-string for display as a hint</short>
<var>HintStr</var> - the text-string for display as a hint.</short>
</element>
<!-- function Visibility: public -->
<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>
<short>True if action is to be performed.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.AutoCheck">
<short>
<var>AutoCheck</var> - whether the control (e.g. a CheckBox) is to be automatically checked</short>
<var>AutoCheck</var> - whether the control (e.g. a CheckBox) is to be automatically checked.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Caption">
<short>The <var>Caption</var> to be used if this action is associated with a visible component</short>
<short>The <var>Caption</var> to be used if this action is associated with a visible component.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Checked">
<short>Whether the CheckBox associated with the action is <var>Checked</var> (default False)</short>
<short>Whether the CheckBox associated with the action is <var>Checked</var> (default False).</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.DisableIfNoHandler">
<short>
<var>DisableIfNoHandler </var>- don't use this action if no Handler has been provided</short>
<var>DisableIfNoHandler </var>- don't use this action if no Handler has been provided.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Enabled">
<short>
<var>Enabled</var> - whether this action is able to be used (default True)</short>
<var>Enabled</var> - whether this action is able to be used (default True).</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.GroupIndex">
<short>
<var>GroupIndex </var>- Index of the action within its group</short>
<var>GroupIndex </var>- Index of the action within its group.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.HelpContext">
<short>
<var>HelpContext </var>- the index for a context-based help message</short>
<var>HelpContext </var>- the index for a context-based help message.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.HelpKeyword">
<short>
<var>HelpKeyWord </var>- the keyword of a context-based help message</short>
<var>HelpKeyWord </var>- the keyword of a context-based help message.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.HelpType">
<short>
<var>HelpType</var> - the sort of help message to be offered: default Context-based</short>
<var>HelpType</var> - the sort of help message to be offered: default Context-based.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Hint">
<short>
<var>Hint</var> - a pop-up message that appears when the mouse hovers over an object</short>
<var>Hint</var> - a pop-up message that appears when the mouse hovers over an object.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.ImageIndex">
<short>
<var>ImageIndex </var>- the index number of the image to be associated with this action</short>
<var>ImageIndex </var>- the index number of the image to be associated with this action.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.ShortCut">
<short>
<var>ShortCut </var>- an index to a shortcut list</short>
<var>ShortCut </var>- an index to a shortcut list.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.SecondaryShortCuts">
<short>
<var>SecondaryShortCuts</var> - a stringlist containing shortcuts</short>
<var>SecondaryShortCuts</var> - a stringlist containing shortcuts.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.Visible">
<short>
<var>Visible</var> - is this action visible? (default True)</short>
<var>Visible</var> - is this action visible? (default True).</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomAction.OnHint">
<short>
<var>OnHint</var> - action to be taken when a hint is required</short>
<var>OnHint</var> - action to be taken when a hint is required.</short>
</element>
<!-- object Visibility: default -->
@ -1109,7 +1106,7 @@
</element>
<!-- property Visibility: published -->
<element name="TAction.OnExecute" link="#rtl.Classes.TBasicAction.OnExecute">
<short>Event called when action is executed</short>
<short>Event called when action is executed.</short>
<descr>
<p>
<var>OnExecute</var> is the event triggered when the action is activated (executed). The event is triggered e.g. when the user clicks e.g. on a menu item or a button associated to the action. The application programmer should provide a <var>OnExecute</var> event handler to execute whatever code is necessary when the button is pressed or the menu item is chosen.
@ -1158,7 +1155,7 @@
</element>
<!-- object Visibility: default -->
<element name="TActionLink">
<short>A link between an action and a client class</short>
<short>A link between an action and a client class.</short>
<descr>
<p>
The class definition includes a number of protected procedures for setting properties for the action (as defined in <link id="TCustomAction"/>), and a number of public boolean functions to indicate which part of the action is linked to the client.
@ -1169,7 +1166,8 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetAutoCheck">
<short>
<var>SetAutoCheck</var> - specifies the value of AutoCheck, whether True or False</short>
<var>SetAutoCheck</var> - specifies the value of AutoCheck, whether True or False.
</short>
<descr/>
<seealso/>
</element>
@ -1179,7 +1177,7 @@
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetCaption">
<short><var>SetCaption</var> - specifies the string to be used as caption</short>
<short><var>SetCaption</var> - specifies the string to be used as caption.</short>
<descr/>
<seealso/>
</element>
@ -1190,7 +1188,8 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetChecked">
<short>
<var>SetChecked</var> - specifies the value of the Checked property: True or False</short>
<var>SetChecked</var> - specifies the value of the Checked property: True or False.
</short>
<descr/>
<seealso/>
</element>
@ -1201,7 +1200,8 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetEnabled">
<short>
<var>SetEnabled</var> - specifies the value of the <var>Enabled</var> property: True or False</short>
<var>SetEnabled</var> - specifies the value of the <var>Enabled</var> property: True or False.
</short>
<descr/>
<seealso/>
</element>
@ -1212,7 +1212,8 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetGroupIndex">
<short>
<var>SetGroupIndex</var> - specifies the value for the Group Index</short>
<var>SetGroupIndex</var> - specifies the value for the Group Index.
</short>
<descr/>
<seealso/>
</element>
@ -1223,7 +1224,8 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetHelpContext">
<short>
<var>SetHelpContext</var> - specifies the value to be used for context-sensitive Help</short>
<var>SetHelpContext</var> - specifies the value to be used for context-sensitive Help.
</short>
<descr/>
<seealso/>
</element>
@ -1234,7 +1236,8 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetHelpKeyword">
<short>
<var>SetHelpKeyword</var> - specifies the keyword to be used for Help</short>
<var>SetHelpKeyword</var> - specifies the keyword to be used for Help.
</short>
<descr/>
<seealso/>
</element>
@ -1244,8 +1247,7 @@
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetHelpType">
<short>
<var>SetHelpType</var> - specifies the type of Help to be used</short>
<short><var>SetHelpType</var> - specifies the type of Help to be used.</short>
<descr/>
<seealso/>
</element>
@ -1255,8 +1257,7 @@
</element>
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetHint">
<short>
<var>SetHint</var> - specifies the string to be used for Hints</short>
<short><var>SetHint</var> - specifies the string to be used for Hints.</short>
<descr/>
<seealso/>
</element>
@ -1267,7 +1268,8 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetImageIndex">
<short>
<var>SetImageIndex</var> - specifies the index value for the image associated with the action</short>
<var>SetImageIndex</var> - specifies the index value for the image associated with the action.
</short>
<descr/>
<seealso/>
</element>
@ -1278,7 +1280,7 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetShortCut">
<short>
<var>SetShortCut</var> - specifies the shortcut for the action</short>
<var>SetShortCut</var> - specifies the shortcut for the action.</short>
<descr/>
<seealso/>
</element>
@ -1289,7 +1291,7 @@
<!-- procedure Visibility: protected -->
<element name="TActionLink.SetVisible">
<short>
<var>SetVisible</var> - specifies whether or not the control for the action is <var>Visible</var>
<var>SetVisible</var> - specifies whether or not the control for the action is <var>Visible</var>.
</short>
<descr/>
<seealso/>
@ -1401,7 +1403,7 @@
<!-- "class of" type Visibility: default -->
<element name="TActionLinkClass">
<short>
<var>TActionLinkClass</var> - class of <var>TActionLink</var>
<var>TActionLinkClass</var> - class of <var>TActionLink</var>.
</short>
<descr/>
<seealso/>
@ -1549,7 +1551,7 @@
<!-- procedure Visibility: default -->
<element name="Register">
<short>Registers components for use in the Lazarus IDE</short>
<short>Registers components for use in the Lazarus IDE.</short>
<descr>
<p>
Register is the procedure used to register components in the unit for use in the Lazarus IDE. The following components are added to the Lazarus IDE component palette:

2
docs/xml/lcl/alllclunits.xml
View File

@ -9,7 +9,7 @@
-->
<module name="AllLCLUnits">
<short><var>AllLCLUnits</var> - a dummy unit containing a <var>Uses</var> clause listing all the units in the Lazarus Component Library - probably used as a checklist for building Lazarus</short>
<short><var>AllLCLUnits</var> - a dummy unit containing a <var>Uses</var> clause listing all the units in the Lazarus Component Library - probably used as a checklist for building Lazarus.</short>
<descr>
</descr>

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

@ -7,7 +7,7 @@
====================================================================
-->
<module name="Arrow">
<short>Defines an Arrow symbol widely used in forms</short>
<short>Defines an Arrow symbol widely used in forms.</short>
<descr>
<p>
<file>arrow.pp</file> implements a control used to draw an arrow. Its size, direction, color and shadow can be adjusted. It is part of the Lazarus Component Library (<b>LCL</b>).
@ -81,8 +81,7 @@
</element>
<!-- object Visibility: default -->
<element name="TArrow">
<short>
<var>TArrow</var> - an arrow symbol widely used in forms</short>
<short><var>TArrow</var> - an arrow symbol widely used in forms.</short>
<descr/>
<errors/>
<seealso/>
@ -206,8 +205,7 @@
</element>
<!-- property Visibility: published -->
<element name="TArrow.ArrowType">
<short>
<var>ArrowType</var> - pointing up, down, left or right</short>
<short><var>ArrowType</var> - pointing up, down, left or right.</short>
<descr/>
<seealso/>
</element>
@ -220,7 +218,8 @@
<!-- property Visibility: published -->
<element name="TArrow.ShadowType">
<short>
<var>ShadowType</var> - the type of shadowing: None, In, Out, EtchedIn, EtchedOut</short>
<var>ShadowType</var> - the type of shadowing: None, In, Out, EtchedIn, EtchedOut.
</short>
<descr/>
<seealso/>
</element>
@ -284,7 +283,7 @@
<!-- procedure Visibility: default -->
<element name="Register">
<short>Registers components for use in the Lazarus IDE</short>
<short>Registers components for use in the Lazarus IDE.</short>
<descr>
<p>
The following components are added to the Lazarus IDE component palette:

38
docs/xml/lcl/asyncprocess.xml
View File

@ -8,7 +8,7 @@
-->
<module name="AsyncProcess">
<short>
Implements a process with asynchronous event notifications
Implements a process with asynchronous event notifications.
</short>
<descr>
<p>
@ -32,7 +32,7 @@
<element name="TAsyncProcess">
<short>
Implements a process with asynchronous notifications for data and termination
Implements a process with asynchronous notifications for data and termination.
</short>
<descr>
<p>
@ -54,7 +54,7 @@
<element name="TAsyncProcess.GetNumBytesAvailable">
<short>
Gets the value for the NumBytesAvailable property
Gets the value for the NumBytesAvailable property.
</short>
<descr>
<p>
@ -74,12 +74,12 @@
</seealso>
</element>
<element name="TAsyncProcess.GetNumBytesAvailable.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TAsyncProcess.HandlePipeInput">
<short>
Implements asynchronous notifications during execution of the process
Implements asynchronous notifications during execution of the process.
</short>
<descr>
<p>
@ -98,15 +98,15 @@
</seealso>
</element>
<element name="TAsyncProcess.HandlePipeInput.AData">
<short>Data available on the input handle</short>
<short>Data available on the input handle.</short>
</element>
<element name="TAsyncProcess.HandlePipeInput.AReasons">
<short>Reason the data was written for the handler</short>
<short>Reason the data was written for the handler.</short>
</element>
<element name="TAsyncProcess.HandleProcessTermination">
<short>
Performs actions needed when the process is terminated
Performs actions needed when the process is terminated.
</short>
<descr>
<p>
@ -124,18 +124,18 @@
</seealso>
</element>
<element name="TAsyncProcess.HandleProcessTermination.AData">
<short>Data for the process notification</short>
<short>Data for the process notification.</short>
</element>
<element name="TAsyncProcess.HandleProcessTermination.AReason">
<short>Reason(s) for the process notification</short>
<short>Reason(s) for the process notification.</short>
</element>
<element name="TAsyncProcess.HandleProcessTermination.AInfo">
<short>Process exit code</short>
<short>Process exit code.</short>
</element>
<element name="TAsyncProcess.UnhookPipeHandle">
<short>
Removes the pipe handler assigned for the process
Removes the pipe handler assigned for the process.
</short>
<descr>
<p>
@ -153,7 +153,7 @@
<element name="TAsyncProcess.UnhookProcessHandle">
<short>
Removes the process handler assigned for the process
Removes the process handler assigned for the process.
</short>
<descr>
<p>
@ -172,7 +172,7 @@
<element name="TAsyncProcess.Execute">
<short>
Executes the process
Executes the process.
</short>
<descr>
<p>
@ -194,7 +194,7 @@
<element name="TAsyncProcess.Destroy">
<short>
Destructor for the class instance
Destructor for the class instance.
</short>
<descr>
<p>
@ -210,7 +210,7 @@
<element name="TAsyncProcess.NumBytesAvailable">
<short>
Number of output bytes available from the process
Number of output bytes available from the process.
</short>
<descr>
<p>
@ -233,7 +233,7 @@
<element name="TAsyncProcess.OnReadData">
<short>
Event handler signalled when output data is available for the process
Event handler signalled when output data is available for the process.
</short>
<descr>
<p>
@ -253,7 +253,7 @@
<element name="TAsyncProcess.OnTerminate">
<short>
Event handler signalled when the process is terminated
Event handler signalled when the process is terminated.
</short>
<descr>
<p>
@ -270,7 +270,7 @@
</element>
<element name="Register">
<short>Registers components for use in the Lazarus IDE</short>
<short>Registers components for use in the Lazarus IDE.</short>
<descr>
<p>
<var>Register</var> is the procedure used to register components for use in the Lazarus IDE.

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

@ -7,7 +7,7 @@
====================================================================
-->
<module name="ButtonPanel">
<short>Provides a panel with buttons using glyph images</short>
<short>Provides a panel with buttons using glyph images.</short>
<descr>
<p>
<file>buttonpanel.pas</file> contains classes and types used to implement <var>TButtonPanel</var>, a panel which contains common buttons used in an application form. It is part of the Lazarus Component Library (<b>LCL</b>).
@ -41,7 +41,7 @@
<element name="TButtonOrder">
<short>
Enumerated type with the display order used for buttons on TButtonPanel
Enumerated type with the display order used for buttons on TButtonPanel.
</short>
<descr>
<p>
@ -69,18 +69,18 @@
</seealso>
</element>
<element name="TButtonOrder.boDefault">
<short>Uses the common button order for the platform or operating system</short>
<short>Uses the common button order for the platform or operating system.</short>
</element>
<element name="TButtonOrder.boCloseCancelOK">
<short>Use the button order Close, Cancel, OK, Help</short>
<short>Use the button order Close, Cancel, OK, Help.</short>
</element>
<element name="TButtonOrder.boCloseOKCancel">
<short>Use the button order Close, OK, Cancel, Help</short>
<short>Use the button order Close, OK, Cancel, Help.</short>
</element>
<element name="TPanelButton">
<short>
Enumeration with values that represent the button types used on TButtonPanel
Enumeration with values that represent the button types used on TButtonPanel.
</short>
<descr>
<p>
@ -92,20 +92,20 @@
</seealso>
</element>
<element name="TPanelButton.pbOK">
<short>Represents the OK button on the panel</short>
<short>Represents the OK button on the panel.</short>
</element>
<element name="TPanelButton.pbCancel">
<short>Represents the Cancel button on the panel</short>
<short>Represents the Cancel button on the panel.</short>
</element>
<element name="TPanelButton.pbClose">
<short>Represents the Close button on the panel</short>
<short>Represents the Close button on the panel.</short>
</element>
<element name="TPanelButton.pbHelp">
<short>Represents the Help button on the panel</short>
<short>Represents the Help button on the panel.</short>
</element>
<element name="TPanelButtons">
<short>Set type used to store TPanelButton values</short>
<short>Set type used to store TPanelButton values.</short>
<descr>
<p>
<var>TPanelButtons</var> is a set type used to store enumeration values from <var>TPanelButton</var>. <var>TPanelButtons</var> is the type used to implement the <var>ShowButtons</var> and <var>ShowGlyphs</var> properties in <var>TButtonPanel</var>.
@ -119,7 +119,7 @@
</element>
<element name="TPanelBitBtn">
<short>Implements the buttons displayed for TButtonPanel</short>
<short>Implements the buttons displayed for TButtonPanel.</short>
<descr>
<p>
<var>TPanelBitBtn</var> is a TCustomBitBtn descendant used to implement the buttons displayed for <var>TButtonPanel</var>. <var>TPanelBitBtn</var> is the type used to implement the <var>OKButton</var>, <var>HelpButton</var>, <var>CloseButton</var>, and <var>CancelButton</var> properties in <var>TButtonPanel</var>.
@ -138,7 +138,7 @@
</element>
<element name="TPanelBitBtn.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constuctor for the class instance. <var>Create</var> calls the inherited method, and calls <var>SetSubComponent</var> to indicate that the component is used as a sub-component in the parent control.
@ -149,13 +149,13 @@
</seealso>
</element>
<element name="TPanelBitBtn.Create.AOwner">
<short>Owner for the class instance</short>
<short>Owner for the class instance.</short>
</element>
<element name="TPanelBitBtn.Caption" link="#LCL.Controls.TControl.Caption"/>
<element name="TPanelBitBtn.DefaultCaption">
<short>Indicates if the Caption for the button contains a default value</short>
<short>Indicates if the Caption for the button contains a default value.</short>
<descr>
<p>
<var>DefaultCaption</var> determines if the value in <var>Caption</var> is included in the LCL component streaming mechanism; <var>Caption</var> is stored for the component when <var>DefaultCaption</var> is <b>False</b>.
@ -167,7 +167,7 @@
</element>
<element name="TPanelBitBtn.Left">
<short>Contains the Left pixel coordinate for the button</short>
<short>Contains the Left pixel coordinate for the button.</short>
<descr>
<p>
<var>Left</var> is not a stored property value in the LCL component streaming mechanism. Its value it always calculated the button position relative to the parent control for the component.
@ -177,7 +177,7 @@
</element>
<element name="TPanelBitBtn.Top">
<short>Contains the Top pixel coordinate for the button</short>
<short>Contains the Top pixel coordinate for the button.</short>
<descr>
<p>
<var>Top</var> is not a stored property value in the LCL component streaming mechanism. Its value it always calculated the button position relative to the parent control for the component.
@ -187,7 +187,7 @@
</element>
<element name="TPanelBitBtn.Width">
<short>Contains the Width in pixels for the button</short>
<short>Contains the Width in pixels for the button.</short>
<descr>
<p>
<var>Width</var> is not a stored property value in the LCL component streaming mechanism. Its value it always calculated the button position relative to the parent control for the component.
@ -197,7 +197,7 @@
</element>
<element name="TPanelBitBtn.Height">
<short>Contains the Height in pixels for the button</short>
<short>Contains the Height in pixels for the button.</short>
<descr>
<p>
<var>Height</var> is not a stored property value in the LCL component streaming mechanism. Its value it always calculated the button position relative to the parent control for the component.
@ -211,7 +211,7 @@
<element name="TPanelBitBtn.Glyph" link="#LCL.Buttons.TCustomBitBtn.Glyph"/>
<element name="TPanelBitBtn.Name">
<short>Name or identifier assigned for the button</short>
<short>Name or identifier assigned for the button.</short>
<descr>
<p>
<var>Name</var> is a String property with the identifier assigned to the button to indicates its usage in <var>TButtonPanel</var>. <var>Name</var> contains a constant value like 'OKButton', 'CancelButton', 'CloseButton', or 'HelpButton'. The value in <var>Name</var> is assigned when the button is created in the <var>CreateButton</var> method in <var>TCustomButtonPanel</var>.
@ -221,14 +221,14 @@
</element>
<element name="TPanelBitBtn.PopupMenu">
<short>Popup menu displayed when the button is pressed or clicked</short>
<short>Popup menu displayed when the button is pressed or clicked.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TPanelBitBtn.ShowHint" link="#LCL.Controls.TControl.ShowHint">
<short>
Indicates if the Hint is displayed when the control has mouse or keyboard focus
Indicates if the Hint is displayed when the control has mouse or keyboard focus.
</short>
<descr></descr>
<seealso></seealso>
@ -237,7 +237,7 @@
<element name="TPanelBitBtn.OnClick" link="#LCL.Controls.TControl.OnClick"/>
<element name="TCustomButtonPanel">
<short>Defines the base class for TButtonPanel</short>
<short>Defines the base class for TButtonPanel.</short>
<descr>
<p>
<var>TCustomButtonPanel</var> is a <var>TCustomPanel</var> descendant which defines the base class for <var>TButtonPanel</var>, a panel containing buttons with glyph images. Buttons are provided for <b>OK</b>, <b>Help</b>, <b>Close</b>, and <b>Cancel</b> operations. Other properties are provided to control the display order for the buttons, the default button for the panel, visibility of the available buttons, and the use of glyphs.
@ -288,11 +288,11 @@
</seealso>
</element>
<element name="TCustomButtonPanel.CreateButton.AButton">
<short>TPanelButton value which identifies the button created in the method</short>
<short>TPanelButton value which identifies the button created in the method.</short>
</element>
<element name="TCustomButtonPanel.DoDefaultButton">
<short>Updates the buttons on the panel to match the DefaultButton property</short>
<short>Updates the buttons on the panel to match the DefaultButton property.</short>
<descr>
<p>
<var>DoDefaultButton</var> is a procedure used to update the buttons on the panel to identify the default button. Values from the <var>TPanelButton</var> enumeration are used to access the buttons present on the panel. The <var>Default</var> property in each button is updated to indicate if the button instance is the value stored in the <var>DefaultButton</var> property.
@ -310,7 +310,7 @@
<element name="TCustomButtonPanel.DoShowButtons">
<short>
Performs actions needed to create and/or configure buttons displayed on the panel
Performs actions needed to create and/or configure buttons displayed on the panel.
</short>
<descr>
<p>
@ -335,7 +335,7 @@
</element>
<element name="TCustomButtonPanel.DoShowGlyphs">
<short>Assigns the bitmaps used as glyphs for the buttons on the panel</short>
<short>Assigns the bitmaps used as glyphs for the buttons on the panel.</short>
<descr>
<p>
<var>DoShowGlyphs</var> is a procedure used to assign the bitmaps used as glyphs for the buttons on the panel. DoShowGlyphs iterates over the buttons displayed on the panel, and uses the values in the <var>ShowGlyphs</var> property to set or reset the glyph used in the button instance.
@ -353,7 +353,7 @@
</element>
<element name="TCustomButtonPanel.SetButtonOrder">
<short>Sets the value for the ButtonOrder property</short>
<short>Sets the value for the ButtonOrder property.</short>
<descr>
<p>
Calls UpdateButtonOrder to refresh the display order for buttons on the panel.
@ -365,11 +365,11 @@
</seealso>
</element>
<element name="TCustomButtonPanel.SetButtonOrder.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomButtonPanel.SetDefaultButton">
<short>Sets the value for the DefaultButton property</short>
<short>Sets the value for the DefaultButton property.</short>
<descr>
<p>
Calls the <var>DoDefaultButton</var> method.
@ -380,11 +380,11 @@
</seealso>
</element>
<element name="TCustomButtonPanel.SetDefaultButton.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomButtonPanel.SetShowBevel">
<short>Sets the value for the ShowBevel property</short>
<short>Sets the value for the ShowBevel property.</short>
<descr>
<p>
Calls the <var>UpdateBevel</var> method.
@ -395,11 +395,11 @@
</seealso>
</element>
<element name="TCustomButtonPanel.SetShowBevel.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomButtonPanel.SetShowButtons">
<short>Sets the value for the ShowButtons property</short>
<short>Sets the value for the ShowButtons property.</short>
<descr>
<p>
Calls the <var>InvalidatePreferredSize</var> and <var>DoShowButtons</var> methods.
@ -410,11 +410,11 @@
</seealso>
</element>
<element name="TCustomButtonPanel.SetShowButtons.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomButtonPanel.SetShowGlyphs">
<short>Sets the value for the ShowGlyphs property</short>
<short>Sets the value for the ShowGlyphs property.</short>
<descr>
<p>
Calls the <var>InvalidatePreferredSize</var> and <var>DoShowGlyphs</var> methods.
@ -425,11 +425,11 @@
</seealso>
</element>
<element name="TCustomButtonPanel.SetShowGlyphs.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomButtonPanel.SetSpacing">
<short>Sets the value for the Spacing property</short>
<short>Sets the value for the Spacing property.</short>
<descr>
<p>
Calls the <var>InvalidatePreferredSize</var> and <var>ReAlign</var> methods.
@ -440,11 +440,11 @@
</seealso>
</element>
<element name="TCustomButtonPanel.SetSpacing.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomButtonPanel.UpdateBevel">
<short>Configures the shape and alignment for the bevel displayed on the panel</short>
<short>Configures the shape and alignment for the bevel displayed on the panel.</short>
<descr>
<p>
<bar>UpdateBevel</bar> is a procedure used to set the shape and alignment for the bevel displayed on the panel. It sets the values in the <var>Align</var> and <var>Shape</var> properties for the <var>TBevel</var> instance based on the content in the <var>Align</var> property for the panel. For instance:
@ -494,7 +494,7 @@
</element>
<element name="TCustomButtonPanel.UpdateButtonOrder">
<short>Sets the Tab order for visible buttons on the panel</short>
<short>Sets the Tab order for visible buttons on the panel.</short>
<descr>
<p>
<var>UpdateButtonOrder</var> is a procedure used to set the tab order for visible buttons on the panel. It sets the <var>TabOrder</var> property in each of the <var>TPanelBitBtn</var> instances using the <var>ButtonOrder</var> for the panel.
@ -514,7 +514,7 @@
</element>
<element name="TCustomButtonPanel.UpdateSizes">
<short>Calculates the size for button controls displayed on the panel</short>
<short>Calculates the size for button controls displayed on the panel.</short>
<descr>
<p>
<var>UpdateSizes</var> is a procedure used to calculate the size for button controls displayed on the panel. UpdateSizes gets the button size using <var>GetElementDetails</var> in <var>ThemeServices</var>, and stores the values in the internal members used in the panel class.
@ -536,7 +536,7 @@
</element>
<element name="TCustomButtonPanel.UpdateButtonLayout">
<short>Updates the alignment for visible buttons on the panel</short>
<short>Updates the alignment for visible buttons on the panel.</short>
<descr>
<p>
<var>UpdateButtonLayout</var> is a procedure used to update the alignment for the visible buttons on the panel. UpdateButtonLayout uses the enumeration values from <var>ShowButtons</var> to determine the button instances updated in the method.
@ -559,7 +559,7 @@
</element>
<element name="TCustomButtonPanel.UpdateButtonSize">
<short>Applies button sizes when the visibiity for the panel is changed</short>
<short>Applies button sizes when the visibiity for the panel is changed.</short>
<descr>
<p>
<var>UpdateButtonSize</var> is a method used to adjust the size for the visible buttons on the panel when the value in the <var>Visible</var> property has been changed.
@ -589,7 +589,7 @@
<element name="TCustomButtonPanel.IsLastButton">
<short>
Indicates if the specified button is the last one defined in the button order
Indicates if the specified button is the last one defined in the button order.
</short>
<descr>
<p>
@ -603,10 +603,10 @@
</seealso>
</element>
<element name="TCustomButtonPanel.IsLastButton.Result">
<short>True when the specified button is the last in the button order</short>
<short>True when the specified button is the last in the button order.</short>
</element>
<element name="TCustomButtonPanel.IsLastButton.AControl">
<short>Control compared to the buttons on the panel</short>
<short>Control compared to the buttons on the panel.</short>
</element>
<element name="TCustomButtonPanel.CreateControlBorderSpacing" link="#lcl.controls.TControl.CreateControlBorderSpacing"/>
@ -661,7 +661,7 @@
<element name="TCustomButtonPanel.Loaded">
<short>
Performs actions after the component has finished loading during LCL streaming
Performs actions after the component has finished loading during LCL streaming.
</short>
<descr>
<p>
@ -682,7 +682,9 @@
</element>
<element name="TCustomButtonPanel.Notification">
<short>Called by components that are freed and which received a FreeNotification</short>
<short>
Called by components that are freed and which received a FreeNotification.
</short>
<descr>
<p>
<var>Notification</var> is called whenever a child component is destroyed, inserted or removed from the list of owned components. Components that were requested to send a notification when they are freed (with FreeNotification) will also call Notification when they are freed.
@ -700,14 +702,14 @@
</seealso>
</element>
<element name="TCustomButtonPanel.Notification.AComponent">
<short>Component for the notification</short>
<short>Component for the notification.</short>
</element>
<element name="TCustomButtonPanel.Notification.Operation">
<short>Operation performed for the component</short>
<short>Operation performed for the component.</short>
</element>
<element name="TCustomButtonPanel.SetAlign">
<short>Sets the value for the Align property</short>
<short>Sets the value for the Align property.</short>
<descr>
Calls the UpdateButtonLayout, UpdateBevel, and UpdateSizes methods.
</descr>
@ -716,31 +718,31 @@
</seealso>
</element>
<element name="TCustomButtonPanel.SetAlign.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomButtonPanel.CMAppShowBtnGlyphChanged">
<short>
Performs the control message needed when the visibility for a button glpyh has changed
Performs the control message needed when the visibility for a button glpyh has changed.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCustomButtonPanel.CMAppShowBtnGlyphChanged.Message">
<short>Control message passed in the method</short>
<short>Control message passed in the method.</short>
</element>
<element name="TCustomButtonPanel.CMShowingChanged">
<short>Performs the Lazarus control message when a button visibility is changed</short>
<short>Performs the Lazarus control message when a button visibility is changed.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCustomButtonPanel.CMShowingChanged.Message">
<short>Control message passed in the method</short>
<short>Control message passed in the method.</short>
</element>
<element name="TCustomButtonPanel.Create" link="#rtl.Classes.TComponent.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. Create calls the inherited constructor, and sets the default values for properties in the panel to the following:
@ -781,11 +783,11 @@
</seealso>
</element>
<element name="TCustomButtonPanel.Create.AOwner">
<short>Owner for the class instance</short>
<short>Owner for the class instance.</short>
</element>
<element name="TCustomButtonPanel.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy ensures that <var>TBitmap</var> instances created for button glyphs in the panel are freed. Destroy calls the inherited destructor prior to exiting from the method.
@ -798,7 +800,7 @@
<element name="TCustomButtonPanel.Align">
<short>
Indicates the alignment used for the panel relative to the owner for the panel
Indicates the alignment used for the panel relative to the owner for the panel.
</short>
<descr>
<p>
@ -817,7 +819,7 @@
</element>
<element name="TCustomButtonPanel.AutoSize">
<short>Indicates if the panel can automatically adjust its size</short>
<short>Indicates if the panel can automatically adjust its size.</short>
<descr>
<p>
<var>AutoSize</var> is a <var>Boolean</var> property which indicates if the button panel can automatically adjust its size. The default value for the property is <b>True</b>.
@ -835,7 +837,7 @@
<element name="TCustomButtonPanel.OKButton">
<short>
<var>OKButton</var> - a button with the caption 'OK' signifying acceptance by the user
<var>OKButton</var> - a button with the caption 'OK' signifying acceptance by the user.
</short>
<descr>
<p>
@ -866,7 +868,7 @@
<element name="TCustomButtonPanel.HelpButton">
<short>
<var>HelpButton</var> - a button with the 'Help' caption, for requesting help
<var>HelpButton</var> - a button with the 'Help' caption, for requesting help.
</short>
<descr>
<p>
@ -897,7 +899,7 @@
<element name="TCustomButtonPanel.CloseButton">
<short>
<var>CloseButton</var> - a button with the 'Close' caption for terminating the Form or panel
<var>CloseButton</var> - a button with the 'Close' caption for terminating the Form or panel.
</short>
<descr>
<p>
@ -928,7 +930,7 @@
<element name="TCustomButtonPanel.CancelButton">
<short>
<var>CancelButton</var> - a button with the 'Cancel' caption for cancelling the operation
<var>CancelButton</var> - a button with the 'Cancel' caption for cancelling the operation.
</short>
<descr>
<p>
@ -959,7 +961,7 @@
<element name="TCustomButtonPanel.ButtonOrder">
<short>
<var>ButtonOrder</var> - the order in which the series of buttons will appear on the panel
<var>ButtonOrder</var> - the order in which the series of buttons will appear on the panel.
</short>
<descr>
<p>
@ -988,7 +990,7 @@
<element name="TCustomButtonPanel.DefaultButton">
<short>
The default button executed when pressing <b>Enter</b> or <b>Return</b>
The default button executed when pressing <b>Enter</b> or <b>Return</b>.
</short>
<descr>
<p>
@ -1000,7 +1002,7 @@
</element>
<element name="TCustomButtonPanel.ShowButtons">
<short>Indicates the buttons displayed on the panel</short>
<short>Indicates the buttons displayed on the panel.</short>
<descr>
<p>
<var>ShowButtons</var> is a <var>TPanelButtons</var> property which contains the set of buttons displayed on the panel. The default value for the property is defined in the <var>DefShowButtons</var> constant.
@ -1025,7 +1027,7 @@ AButtonPanel.ShowGlyphs := [pbOk, pbCancel];
</element>
<element name="TCustomButtonPanel.ShowGlyphs">
<short>Indicates the panel buttons displayed with Glyphs (small images)</short>
<short>Indicates the panel buttons displayed with Glyphs (small images).</short>
<descr>
<p>
<var>ShowGlyphs</var> contains values from the <var>TPanelButton</var> enumeration, and defines which panel buttons in <var>ShowButtons</var> are displayed with glyph images. The default value for the property is defined in the <var>DefShowGlyphs</var> constant.
@ -1058,7 +1060,7 @@ AButtonPanel.ShowGlyphs := [pbOk, pbCancel];
</element>
<element name="TCustomButtonPanel.ShowBevel">
<short>Indicates if a bevel is displayed for the button panel</short>
<short>Indicates if a bevel is displayed for the button panel.</short>
<descr>
<p>
<var>ShowBevel</var> is a <var>Boolean</var> property which indicates if a <var>TBevel</var> is displayed on the edge opposite of the alignment for the panel. Changing the value for the property causes a TBevel instance to be created (or re-created). The private <var>UpdateBevel</var> method is called to apply the size, shape, and alignment needed for the bevel.
@ -1070,7 +1072,7 @@ AButtonPanel.ShowGlyphs := [pbOk, pbCancel];
</element>
<element name="TCustomButtonPanel.Spacing">
<short>Contains the spacing around buttons and bevels on the panel</short>
<short>Contains the spacing around buttons and bevels on the panel.</short>
<descr>
<p>
<var>Spacing</var> is a <var>TSpacingSize</var> property which indicates the number of pixels reserved between buttons and bezels displayed on the panel. The default value for the property is <b>6</b>. Changing the value in <var>Spacing</var> causes the <var>InvalidatePreferredSize</var> and <var>ReAlign</var> methods to be called.
@ -1087,7 +1089,7 @@ AButtonPanel.ShowGlyphs := [pbOk, pbCancel];
</element>
<element name="TButtonPanel">
<short>Implements a panel with Bitmap Button instances</short>
<short>Implements a panel with Bitmap Button instances.</short>
<descr>
<p>
<var>TButtonPanel</var> is a <var>TCustomButtonPanel</var> descendant which implements a panel containing buttons with glyph images. Buttons are provided for <b>OK</b>, <b>Help</b>, <b>Close</b>, and <b>Cancel</b> operations. Other properties are provided to control the display order for the buttons, the default button for the panel, visibility of the available buttons, and the use of glyphs.
@ -1137,7 +1139,7 @@ AButtonPanel.ShowGlyphs := [pbOk, pbCancel];
<element name="TButtonPanel.Visible" link="#LCL.Controls.TControl.Visible"/>
<element name="Register">
<short>Registers the TButtonPanel class in the Lazarus IDE</short>
<short>Registers the TButtonPanel class in the Lazarus IDE.</short>
<descr>
<p>
<var>Register</var> is the procedure used to register components for use in the Lazarus IDE. The following components are added to the Lazarus IDE:

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

File diff suppressed because it is too large Load Diff

172
docs/xml/lcl/calcform.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="CalcForm">
<short>Contains classes and types used in TCalculatorForm</short>
<short>Contains classes and types used in TCalculatorForm.</short>
<descr>
<p>
<file>calcform.pas</file> contains classes and types used in <var>TCalculatorForm</var>, a dialog form used to display a calculator. It is part of the Lazarus Component Library (<b>LCL</b>).
@ -31,7 +31,7 @@
<element name="CalcDefPrecision">
<short>
Defines the default number of digits of precision used for values in TCalculatorForm
Defines the default number of digits of precision used for values in TCalculatorForm.
</short>
<descr/>
<seealso/>
@ -39,18 +39,18 @@
<element name="TCalculatorCalcKeyEvent">
<short>
Specifies an event handler signalled for Key events occurring in TCalculatorForm
Specifies an event handler signalled for Key events occurring in TCalculatorForm.
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorCalcKeyEvent.Key">
<short>Key value examined in the event handler</short>
<short>Key value examined in the event handler.</short>
</element>
<element name="TCalculatorDispChangeEvent">
<short>
Specifies an event handler signalled when the display in TCalculatorForm is changed
Specifies an event handler signalled when the display in TCalculatorForm is changed.
</short>
<descr/>
<seealso/>
@ -68,13 +68,13 @@
</seealso>
</element>
<element name="TCalculatorState.csFirst">
<short>Value on the First key press</short>
<short>Value on the First key press.</short>
</element>
<element name="TCalculatorState.csValid">
<short>Value after the oepration for the key has been applied successfully</short>
<short>Value after the oepration for the key has been applied successfully.</short>
</element>
<element name="TCalculatorState.csError">
<short>Value when the operation resulted in an error</short>
<short>Value when the operation resulted in an error.</short>
</element>
<element name="TCalculatorLayout">
@ -91,15 +91,15 @@
</seealso>
</element>
<element name="TCalculatorLayout.clNormal">
<short>The default layout with larger button sizes and more whitespace</short>
<short>The default layout with larger button sizes and more whitespace.</short>
</element>
<element name="TCalculatorLayout.clSimple">
<short>The compact layout with smaller button sizes</short>
<short>The compact layout with smaller button sizes.</short>
</element>
<element name="TCalculatorPanel">
<short>
Implements a panel used for buttons and the value display in a calculator form
Implements a panel used for buttons and the value display in a calculator form.
</short>
<descr/>
<seealso/>
@ -124,25 +124,25 @@
<element name="TCalculatorPanel.FControl"/>
<element name="TCalculatorPanel.SetCalcText">
<short>Sets the value for the text property</short>
<short>Sets the value for the text property.</short>
<descr/>
<seealso>
<link id="TCalculatorPanel.Text"/>
</seealso>
</element>
<element name="TCalculatorPanel.SetCalcText.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCalculatorPanel.CheckFirst">
<short>Ensures that Text is updated and displayed when Status is csFirst</short>
<short>Ensures that Text is updated and displayed when Status is csFirst.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.CalcKey">
<short>
Performs actions for a key press not handled by a button in the calculator panel
Performs actions for a key press not handled by a button in the calculator panel.
</short>
<descr/>
<seealso/>
@ -152,14 +152,14 @@
</element>
<element name="TCalculatorPanel.Clear">
<short>Clears the display and operator in the calculator panel</short>
<short>Clears the display and operator in the calculator panel.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Error">
<short>
Updates the calculator panel to reflect an error condition, and signals OnError
Updates the calculator panel to reflect an error condition, and signals OnError.
</short>
<descr/>
<seealso/>
@ -167,17 +167,17 @@
<element name="TCalculatorPanel.SetDisplay">
<short>
Sets the Text in the calculator panel to the specified value, and signals OnDisplayChange
Sets the Text in the calculator panel to the specified value, and signals OnDisplayChange.
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.SetDisplay.R">
<short>Double value formatted and assigned to the Text property</short>
<short>Double value formatted and assigned to the Text property.</short>
</element>
<element name="TCalculatorPanel.GetDisplay">
<short>Gets the Double value represented in the Text property</short>
<short>Gets the Double value represented in the Text property.</short>
<descr/>
<seealso/>
</element>
@ -186,7 +186,7 @@
</element>
<element name="TCalculatorPanel.FindButton">
<short>Finds the calculator button which handles the specified key character</short>
<short>Finds the calculator button which handles the specified key character.</short>
<descr>
<p>
<var>Key</var> contains a character value to locate in the button captions on the panel. Keys which are not represented by buttons, like <b>Enter</b> (#13) and <b>Escape</b> (#27), are translated to the value used for the target button. In addition, when ',' is used as the decimal separator on the system, it is translated into the '.' decimal notation.
@ -199,20 +199,20 @@
</element>
<element name="TCalculatorPanel.FindButton.Result">
<short>
Button which handles the Key, or Nil when no button is available for Key
Button which handles the Key, or Nil when no button is available for Key.
</short>
</element>
<element name="TCalculatorPanel.FindButton.Key">
<short>Key character to locate in the buttons for the calculator panel</short>
<short>Key character to locate in the buttons for the calculator panel.</short>
</element>
<element name="TCalculatorPanel.BtnClick">
<short>Translates a mouse click on a button to the character key used in CalcKey</short>
<short>Translates a mouse click on a button to the character key used in CalcKey.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.BtnClick.Sender">
<short>Calculator button for the button click notification</short>
<short>Calculator button for the button click notification.</short>
</element>
<element name="TCalculatorPanel.ErrorBeep">
@ -224,14 +224,14 @@
</element>
<element name="TCalculatorPanel.TextChange">
<short>Sets the display text for the associated control and signals OnTextChange</short>
<short>Sets the display text for the associated control and signals OnTextChange.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.CreateLayout">
<short>
Initializes and configures the calculator panel using the specified layout
Initializes and configures the calculator panel using the specified layout.
</short>
<descr/>
<seealso/>
@ -244,35 +244,35 @@
</element>
<element name="TCalculatorPanel.CalcKeyPress">
<short>Locates the button using the specified Key and perform its Click method</short>
<short>Locates the button using the specified Key and perform its Click method.</short>
<descr>
CalcKey is called when a button is located using the specified Key.
</descr>
<seealso/>
</element>
<element name="TCalculatorPanel.CalcKeyPress.Sender">
<short>Object for the KeyPress event</short>
<short>Object for the KeyPress event.</short>
</element>
<element name="TCalculatorPanel.CalcKeyPress.Key">
<short>Key value captured in the panel</short>
<short>Key value captured in the panel.</short>
</element>
<element name="TCalculatorPanel.Copy">
<short>Loads the value in Text into the Clipboard as a text value</short>
<short>Loads the value in Text into the Clipboard as a text value.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Paste">
<short>
Pastes text from the Clipboard into the text display for the calculator panel
Pastes text from the Clipboard into the text display for the calculator panel.
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.WorkingPrecision">
<short>Gets the minumum number of precision digits allowable for the panel</short>
<short>Gets the minumum number of precision digits allowable for the panel.</short>
<descr/>
<seealso/>
</element>
@ -282,27 +282,27 @@
<element name="TCalculatorPanel.UpdateMemoryLabel">
<short>
Updates the Memory indicator to reflect a non-zero value in the Memory property
Updates the Memory indicator to reflect a non-zero value in the Memory property.
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.DisplayValue">
<short>Contains the Double value representing the Text in the panel</short>
<short>Contains the Double value representing the Text in the panel.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Memory">
<short>Contains the Double value stored in the memory fopr the calculator</short>
<short>Contains the Double value stored in the memory fopr the calculator.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Precision">
<short>
Maximum number of digits of precision allowed for the Double value in the calculator
Maximum number of digits of precision allowed for the Double value in the calculator.
</short>
<descr/>
<seealso/>
@ -310,7 +310,7 @@
<element name="TCalculatorPanel.BeepOnError">
<short>
Indicates if a beep occurs when an error condition is detected in the calculator panel
Indicates if a beep occurs when an error condition is detected in the calculator panel.
</short>
<descr/>
<seealso/>
@ -318,7 +318,7 @@
<element name="TCalculatorPanel.Status">
<short>
Contains the status or state for the calculator panel
Contains the status or state for the calculator panel.
</short>
<descr>
</descr>
@ -326,13 +326,13 @@
</element>
<element name="TCalculatorPanel.OperatorChar">
<short>Character representing the last operator entered in the calculator panel</short>
<short>Character representing the last operator entered in the calculator panel.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Text">
<short>Text representation for the Double value in the calculator</short>
<short>Text representation for the Double value in the calculator.</short>
<descr/>
<seealso/>
</element>
@ -380,14 +380,14 @@
</element>
<element name="TCalculatorPanel.Color">
<short>Color for the calculator panel</short>
<short>Color for the calculator panel.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm">
<short>
Implements the form used to display a calculator in a TCalculatorDialog
Implements the form used to display a calculator in a TCalculatorDialog.
</short>
<descr/>
<seealso/>
@ -403,38 +403,38 @@
<element name="TCalculatorForm.FormKeyPress">
<short>
Performs actions needed to handle OnKeyPress events in the calculator form
Performs actions needed to handle OnKeyPress events in the calculator form.
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.FormKeyPress.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorForm.FormKeyPress.Key">
<short>Key handled in the event handler</short>
<short>Key handled in the event handler.</short>
</element>
<element name="TCalculatorForm.CopyItemClick">
<short>Implements a copy menu item in the pop-up menu for the form</short>
<short>Implements a copy menu item in the pop-up menu for the form.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.CopyItemClick.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorForm.GetValue">
<short>Gets the value for the Value property</short>
<short>Gets the value for the Value property.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.GetValue.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCalculatorForm.PasteItemClick">
<short>Implements a paste menu item in the pop-up menu for the form</short>
<short>Implements a paste menu item in the pop-up menu for the form.</short>
<descr/>
<seealso/>
</element>
@ -443,16 +443,16 @@
</element>
<element name="TCalculatorForm.SetValue">
<short>Sets the value for the Value property</short>
<short>Sets the value for the Value property.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.SetValue.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCalculatorForm.OkClick">
<short>Performs actions needed when the OK button is clicked</short>
<short>Performs actions needed when the OK button is clicked.</short>
<descr/>
<seealso/>
</element>
@ -461,58 +461,58 @@
</element>
<element name="TCalculatorForm.CancelClick">
<short>Performs actions needed when the Cancel button is clicked</short>
<short>Performs actions needed when the Cancel button is clicked.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.CancelClick.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorForm.CalcKey">
<short>Performs actions needed for a key received in the calculator form</short>
<short>Performs actions needed for a key received in the calculator form.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.CalcKey.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorForm.CalcKey.Key">
<short>Key examined in the method</short>
<short>Key examined in the method.</short>
</element>
<element name="TCalculatorForm.DisplayChange">
<short>Performs actions needed when the calculator display is changed</short>
<short>Performs actions needed when the calculator display is changed.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.DisplayChange.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorForm.InitForm">
<short>Initializes the calculator form using the specified layout</short>
<short>Initializes the calculator form using the specified layout.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.InitForm.ALayout">
<short>Layout applied to the calculator form instance</short>
<short>Layout applied to the calculator form instance.</short>
</element>
<element name="TCalculatorForm.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.Create.AOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TCalculatorForm.Create.ALayout">
<short>TCalculatorLayout used for the form instance</short>
<short>TCalculatorLayout used for the form instance.</short>
</element>
<element name="TCalculatorForm.Value">
<short>Value displayed or returned from the calculator</short>
<short>Value displayed or returned from the calculator.</short>
<descr/>
<seealso/>
</element>
@ -530,31 +530,31 @@
</element>
<element name="TCalculatorForm.DisplayPanel">
<short>Panel for the display area on the calculator form</short>
<short>Panel for the display area on the calculator form.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.DisplayLabel">
<short>Label used to display the value in the panel</short>
<short>Label used to display the value in the panel.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.OnCalcKey">
<short>Event handler signalled to handle keys press on the calculator form</short>
<short>Event handler signalled to handle keys press on the calculator form.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.OnDisplayChange">
<short>Event handler signalled when the calculator display has been changed</short>
<short>Event handler signalled when the calculator display has been changed.</short>
<descr/>
<seealso/>
</element>
<element name="CreateCalculatorForm">
<short>Creates and configures a new TCalculatorForm instance</short>
<short>Creates and configures a new TCalculatorForm instance.</short>
<descr/>
<seealso>
<link id="TCalculatorForm"/>
@ -562,13 +562,13 @@
</seealso>
</element>
<element name="CreateCalculatorForm.Result">
<short>Form instance created in the method</short>
<short>Form instance created in the method.</short>
</element>
<element name="CreateCalculatorForm.AOwner">
<short>Owner for the new form instance</short>
<short>Owner for the new form instance.</short>
</element>
<element name="CreateCalculatorForm.ALayout">
<short>Layout for the calculator panel in the form instance</short>
<short>Layout for the calculator panel in the form instance.</short>
</element>
<element name="CreateCalculatorForm.AHelpContext">
@ -576,67 +576,67 @@
</element>
<element name="cColorBtnDigits">
<short>Color for the numeric digit buttons in a calculator</short>
<short>Color for the numeric digit buttons in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnMemory">
<short>Color for the Memory button in a calculator</short>
<short>Color for the Memory button in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnClear">
<short>Color for the Clear button in a calculator</short>
<short>Color for the Clear button in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnOk">
<short>Color for the OK button in a calculator</short>
<short>Color for the OK button in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnCancel">
<short>Color for the Cancel button in a calculator</short>
<short>Color for the Cancel button in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnOthers">
<short>Color for miscellaneous "other" buttons in a calculator</short>
<short>Color for miscellaneous "other" buttons in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cColorDisplayText">
<short>Color for text on the display area for a calculator</short>
<short>Color for text on the display area for a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cColorDisplayBack">
<short>Color for the background of the display area in a calculator</short>
<short>Color for the background of the display area in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cCalculatorFontName">
<short>Font name used for buttons and displays in a calculator</short>
<short>Font name used for buttons and displays in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cCalculatorFontSize">
<short>Font size used for buttons and displays in a calculator</short>
<short>Font size used for buttons and displays in a calculator.</short>
<descr/>
<seealso/>
</element>
<element name="cCalculatorFontStyle">
<short>Font style used for buttons and displays in a calculator</short>
<short>Font style used for buttons and displays in a calculator.</short>
<descr/>
<seealso/>
</element>

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

@ -8,7 +8,7 @@
-->
<module name="Calendar">
<short>
Classes and types used to implement TCalendar, a graphic control allowing selection of a date from a calendar display
Classes and types used to implement TCalendar, a graphic control allowing selection of a date from a calendar display.
</short>
<descr>
<p>
@ -39,7 +39,7 @@
<!-- enumeration type Visibility: default -->
<element name="TDisplaySetting">
<short>
Enumerated type with values that control display settings in TCalendar
Enumerated type with values that control display settings in TCalendar.
</short>
<descr>
<p>
@ -56,24 +56,24 @@
</element>
<!-- enumeration value Visibility: default -->
<element name="TDisplaySetting.dsShowHeadings">
<short>Displays a month/year heading</short>
<short>Displays a month/year heading.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDisplaySetting.dsShowDayNames">
<short>Displays day names</short>
<short>Displays day names.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDisplaySetting.dsNoMonthChange">
<short>Prevents changing the current month</short>
<short>Prevents changing the current month.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TDisplaySetting.dsShowWeekNumbers">
<short>Displays week numbers</short>
<short>Displays week numbers.</short>
</element>
<!-- set type Visibility: default -->
<element name="TDisplaySettings">
<short>Set type for TDisplaySetting values</short>
<short>Set type for TDisplaySetting values.</short>
<descr>
<p>
<var>TDisplaySettings</var> is a set type used to store enumerations values from TDisplaySetting. It is the type used for the <var>DisplaySettings</var> property in <var>TCustomCalendar</var>.
@ -87,7 +87,7 @@
<element name="DefaultDisplaySettings">
<short>
Default display settings used in TCalendar
Default display settings used in TCalendar.
</short>
<descr>
<p>
@ -106,7 +106,7 @@
<!-- enumeration type Visibility: default -->
<element name="TCalendarPart">
<short>
Indicates where a mouse click occurred in a calendar control
Indicates where a mouse click occurred in a calendar control.
</short>
<descr>
<p>
@ -119,41 +119,41 @@
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarPart.cpNoWhere">
<short>Mouse click cannot be applied to the control; no handle available</short>
<short>Mouse click cannot be applied to the control; no handle available.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarPart.cpDate">
<short>Mouse click occurred on a date in the calendar control</short>
<short>Mouse click occurred on a date in the calendar control.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarPart.cpWeekNumber">
<short>Mouse click occurred on a week number in the calendar control</short>
<short>Mouse click occurred on a week number in the calendar control.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarPart.cpTitle">
<short>Mouse click occurred on a day heading in the calendar control</short>
<short>Mouse click occurred on a day heading in the calendar control.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarPart.cpTitleBtn">
<short>Mouse click occurred on a navigation button in a calendar control</short>
<short>Mouse click occurred on a navigation button in a calendar control.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarPart.cpTitleMonth">
<short>
Mouse click occurred on the month name heading in the calendar control
Mouse click occurred on the month name heading in the calendar control.
</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarPart.cpTitleYear">
<short>
Mouse click occurred on the year number heading in the calendar control
Mouse click occurred on the year number heading in the calendar control.
</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TCalendarView">
<short>
Defines the view for a calendar
Defines the view for a calendar.
</short>
<descr>
<p>
@ -166,23 +166,23 @@
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarView.cvMonth">
<short>Grid has days for one month</short>
<short>Grid has days for one month.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarView.cvYear">
<short>Grid has months in one year</short>
<short>Grid has months in one year.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarView.cvDecade">
<short>Grid has years from one decade</short>
<short>Grid has years from one decade.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TCalendarView.cvCentury">
<short>Grid has decades for one century</short>
<short>Grid has decades for one century.</short>
</element>
<element name="TCalDayOfWeek">
<short>Represents days of the week used in TCalendar</short>
<short>Represents days of the week used in TCalendar.</short>
<descr>
<p>
<var>TCalDayOfWeek</var> is an enumerated type with values which represent the day used as the first day of the week in <var>TCustomCalendar</var> and descendants.
@ -222,7 +222,7 @@
<!-- object Visibility: default -->
<element name="EInvalidDate">
<short>
<var>EInvalidDate</var> is an exception raised for an invalid date
<var>EInvalidDate</var> is an exception raised for an invalid date.
</short>
<descr>
<p>
@ -236,7 +236,7 @@
<!-- object Visibility: default -->
<element name="TCustomCalendar" link="#lcl.Controls.TWinControl">
<short>
<var>TCustomCalendar</var> - base class for <var>TCalendar</var>
<var>TCustomCalendar</var> - base class for <var>TCalendar</var>.
</short>
<descr>
<p>
@ -282,31 +282,31 @@
<!-- function Visibility: private -->
<element name="TCustomCalendar.GetDateTime">
<short>Gets the value for the DateTime property</short>
<short>Gets the value for the DateTime property.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<!-- function result Visibility: default -->
<element name="TCustomCalendar.GetDateTime.Result">
<short>Value for the DateTime property</short>
<short>Value for the DateTime property.</short>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomCalendar.SetDateTime">
<short>Sets the value for the DateTime property</short>
<short>Sets the value for the DateTime property.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.SetDateTime.AValue">
<short>New value for the DateTime property</short>
<short>New value for the DateTime property.</short>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomCalendar.GetProps">
<short>Gets values for properties in the calendar control</short>
<short>Gets values for properties in the calendar control.</short>
<descr></descr>
<errors/>
<seealso></seealso>
@ -314,14 +314,14 @@
<!-- procedure Visibility: private -->
<element name="TCustomCalendar.SetProps">
<short>Sets values for properties in the calendar control</short>
<short>Sets values for properties in the calendar control.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<!-- function Visibility: private -->
<element name="TCustomCalendar.GetDisplaySettings">
<short>Gets the value for the DisplaySettings property</short>
<short>Gets the value for the DisplaySettings property.</short>
<descr>
<link id="TCustomCalendar.DisplaySettings"/>
<link id="TDisplaySettings"/>
@ -332,12 +332,12 @@
</element>
<!-- function result Visibility: default -->
<element name="TCustomCalendar.GetDisplaySettings.Result">
<short>Value for the DisplaySettings property</short>
<short>Value for the DisplaySettings property.</short>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomCalendar.SetDisplaySettings">
<short>Sets the value for the DisplaySettings property</short>
<short>Sets the value for the DisplaySettings property.</short>
<descr></descr>
<seealso>
<link id="TCustomCalendar.DisplaySettings"/>
@ -347,31 +347,31 @@
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.SetDisplaySettings.AValue">
<short>New value for the DisplaySettings property</short>
<short>New value for the DisplaySettings property.</short>
</element>
<!-- function Visibility: private -->
<element name="TCustomCalendar.GetDate">
<short>Gets the value for the Date property</short>
<short>Gets the value for the Date property.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<!-- function result Visibility: default -->
<element name="TCustomCalendar.GetDate.Result">
<short>Value for the Date property</short>
<short>Value for the Date property.</short>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomCalendar.SetDate">
<short>Sets the value for the Date property</short>
<short>Sets the value for the Date property.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.SetDate.AValue">
<short>New value for the Date property</short>
<short>New value for the Date property.</short>
</element>
<!-- class procedure Visibility: protected -->
@ -382,7 +382,7 @@
<!-- procedure Visibility: protected -->
<element name="TCustomCalendar.LMChanged">
<short>
<var>LMChanged</var> - LCL Message method to deal with changes in the control
<var>LMChanged</var> - LCL Message method to deal with changes in the control.
</short>
<descr></descr>
</element>
@ -394,7 +394,7 @@
<!-- procedure Visibility: protected -->
<element name="TCustomCalendar.LMMonthChanged">
<short>
<var>LMMonthChanged</var> - LCL Message method for change in Month
<var>LMMonthChanged</var> - LCL Message method for change in Month.
</short>
<descr></descr>
<errors/>
@ -407,7 +407,7 @@
<!-- procedure Visibility: protected -->
<element name="TCustomCalendar.LMYearChanged">
<short>
<var>LMYearChanged</var> - LCL Message method for change in Year
<var>LMYearChanged</var> - LCL Message method for change in Year.
</short>
<descr></descr>
<errors/>
@ -421,7 +421,7 @@
<!-- procedure Visibility: protected -->
<element name="TCustomCalendar.LMDayChanged">
<short>
<var>LMDayChanged</var> - LCL Message method for change in Day
<var>LMDayChanged</var> - LCL Message method for change in Day.
</short>
<descr></descr>
<errors/>
@ -452,7 +452,7 @@
<!-- constructor Visibility: public -->
<element name="TCustomCalendar.Create">
<short>
<var>Create</var> - constructor for <var>TCustomCalendar</var>
<var>Create</var> - constructor for <var>TCustomCalendar</var>.
</short>
<descr>
<p>
@ -465,13 +465,13 @@
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<!-- function Visibility: public -->
<element name="TCustomCalendar.HitTest">
<short>
Indicates where a mouse click occurred in the calendar control
Indicates where a mouse click occurred in the calendar control.
</short>
<descr>
<p>
@ -481,23 +481,23 @@
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.HitTest.APoint">
<short>Coordinates where the mouse click occurred</short>
<short>Coordinates where the mouse click occurred.</short>
</element>
<!-- function Visibility: public -->
<element name="TCustomCalendar.GetCalendarView">
<short>Gets the current view for the Calendar</short>
<short>Gets the current view for the Calendar.</short>
<descr></descr>
</element>
<!-- function result Visibility: default -->
<element name="TCustomCalendar.GetCalendarView.Result">
<short>Current view for the Calendar</short>
<short>Current view for the Calendar.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomCalendar.Date">
<short>
<var>Date</var> is a string representation of the DateTime value
<var>Date</var> is a string representation of the DateTime value.
</short>
<descr>
<p>
@ -515,7 +515,7 @@
<!-- property Visibility: public -->
<element name="TCustomCalendar.DateTime">
<short>
Native data type used for a date in the calendar control
Native data type used for a date in the calendar control.
</short>
<descr>
<p>
@ -539,7 +539,7 @@
<!-- property Visibility: public -->
<element name="TCustomCalendar.DisplaySettings">
<short>
<var>DisplaySettings</var> contains options which control the appearance of the calendar
<var>DisplaySettings</var> contains options which control the appearance of the calendar.
</short>
<descr>
<p>
@ -568,7 +568,7 @@
<element name="TCustomCalendar.FirstDayOfWeek">
<short>
Indicates the day of the week displayed as the first column in the calendar grid
Indicates the day of the week displayed as the first column in the calendar grid.
</short>
<descr>
<p>
@ -581,7 +581,7 @@
<!-- property Visibility: public -->
<element name="TCustomCalendar.OnChange">
<short>
<var>OnChange</var> - event handler for any change in Calendar
<var>OnChange</var> - event handler for any change in Calendar.
</short>
<descr>
<p>
@ -594,7 +594,7 @@
<!-- property Visibility: public -->
<element name="TCustomCalendar.OnDayChanged">
<short>
<var>OnDayChanged</var> - event handler for a change in Day selected
<var>OnDayChanged</var> - event handler for a change in Day selected.
</short>
<descr>
<p>
@ -607,7 +607,7 @@
<!-- property Visibility: public -->
<element name="TCustomCalendar.OnMonthChanged">
<short>
<var>OnMonthChanged</var> - event handler for a change in month selected
<var>OnMonthChanged</var> - event handler for a change in month selected.
</short>
<descr>
<p>
@ -620,7 +620,7 @@
<!-- property Visibility: public -->
<element name="TCustomCalendar.OnYearChanged">
<short>
<var>OnYearChanged</var> - event handler for a change in the year selected
<var>OnYearChanged</var> - event handler for a change in the year selected.
</short>
<descr>
<p>
@ -633,7 +633,7 @@
<!-- object Visibility: default -->
<element name="TCalendar">
<short>
<var>TCalendar</var> allows selection of a date from a calendar display
<var>TCalendar</var> allows selection of a date from a calendar display.
</short>
<descr>
<p>
@ -795,7 +795,7 @@
<!-- procedure Visibility: default -->
<element name="Register">
<short>Registers components for use in the Lazarus IDE</short>
<short>Registers components for use in the Lazarus IDE.</short>
<descr>
<p>
Register is the procedure used to register components for use in the Lazarus IDE. The following components are added to the Lazarus IDE component palette:

64
docs/xml/lcl/calendarpopup.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="CalendarPopup">
<short>Implements a pop-up form with a TCalendar control for TDateEdit</short>
<short>Implements a pop-up form with a TCalendar control for TDateEdit.</short>
<descr>
<p>
<file>calendarpopup.pas</file> implements a non-modal calendar popup for a TDateEdit control. It includes a ShowCalendarPopup routine to configure, display, and capture the return value for the pop-up form.
@ -31,7 +31,7 @@
<element name="TReturnDateEvent">
<short>
Specifies an event handler signalled when a date is selected on a pop-up calendar form
Specifies an event handler signalled when a date is selected on a pop-up calendar form.
</short>
<descr>
<p>
@ -43,15 +43,15 @@
</seealso>
</element>
<element name="TReturnDateEvent.Sender">
<short>Object for the event notification; normally the pop-up calendar form</short>
<short>Object for the event notification; normally the pop-up calendar form.</short>
</element>
<element name="TReturnDateEvent.Date">
<short>TDateTime value for the date selected on the calendar form</short>
<short>TDateTime value for the date selected on the calendar form.</short>
</element>
<element name="TCalendarPopupForm">
<short>
Implements a non-modal pop-up form used to select a date from a TCalendar control
Implements a non-modal pop-up form used to select a date from a TCalendar control.
</short>
<descr>
<p>
@ -71,7 +71,7 @@
</element>
<element name="TCalendarPopupForm.Calendar">
<short>TCalendar control used to select a date on the form</short>
<short>TCalendar control used to select a date on the form.</short>
<descr>
<p>
<var>Calendar</var> is a <var>TCalendar</var> member which contains the calendar control displayed on the form. It allows selection of date, and calls the <var>ReturnDate</var> method when the Month, Day, or Year in the control is changed using either the mouse or the keyboard. Calendar is configured in the <var>Initialize</var> method using the <var>TDateTime</var> and <var>TDisplaySettings</var> provided as arguments.
@ -89,7 +89,7 @@
<element name="TCalendarPopupForm.CalendarDblClick">
<short>
Performs actions needed when a double click mouse event occurs in the Calendar control
Performs actions needed when a double click mouse event occurs in the Calendar control.
</short>
<descr>
<p>
@ -102,11 +102,11 @@
</seealso>
</element>
<element name="TCalendarPopupForm.CalendarDblClick.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalendarPopupForm.CalendarKeyDown">
<short>Implements the OnKeyDown event handler for the Calendar control</short>
<short>Implements the OnKeyDown event handler for the Calendar control.</short>
<descr>
<p>
<var>CalendarKeyDown</var> is a procedure which implements the <var>OnKeyDown</var> event handler for the <var>Calendar</var> control. The method ensures that the key down virtual key code represented by <var>Key</var> and <var>Shift</var> is applied to the Calendar control, and includes:
@ -128,17 +128,17 @@
</seealso>
</element>
<element name="TCalendarPopupForm.CalendarKeyDown.Sender">
<short>Object for the event notification; the Calendar control in this case</short>
<short>Object for the event notification; the Calendar control in this case.</short>
</element>
<element name="TCalendarPopupForm.CalendarKeyDown.Key">
<short>Virtual key code examined in the method</short>
<short>Virtual key code examined in the method.</short>
</element>
<element name="TCalendarPopupForm.CalendarKeyDown.Shift">
<short>Virtual key modifier examined in the method</short>
<short>Virtual key modifier examined in the method.</short>
</element>
<element name="TCalendarPopupForm.FormClose">
<short>Implements the OnClose event handler for the form</short>
<short>Implements the OnClose event handler for the form.</short>
<descr>
<p>
Ensures that the <var>FormDeactivate</var> method is removed from the registered OnDeactivate handlers in <var>Application</var>. The value in <var>CloseAction</var> is set to <var>caFree</var> in the method.
@ -147,23 +147,23 @@
<seealso></seealso>
</element>
<element name="TCalendarPopupForm.FormClose.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalendarPopupForm.FormClose.CloseAction">
<short>Close action to perform on exit from the event handler</short>
<short>Close action to perform on exit from the event handler.</short>
</element>
<element name="TCalendarPopupForm.FormCreate">
<short>Implements the OnCreate event handler for the form</short>
<short>Implements the OnCreate event handler for the form.</short>
<descr/>
<seealso/>
</element>
<element name="TCalendarPopupForm.FormCreate.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalendarPopupForm.FormDeactivate">
<short>Implements the OnDeactivate event handler for the form</short>
<short>Implements the OnDeactivate event handler for the form.</short>
<descr>
<p>
Ensures that the <var>FormDeactivate</var> method is added to the OnDeactivate handlers in <var>Application</var>.
@ -172,7 +172,7 @@
<seealso></seealso>
</element>
<element name="TCalendarPopupForm.FormDeactivate.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalendarPopupForm.FCaller"/>
@ -180,7 +180,7 @@
<element name="TCalendarPopupForm.FOnReturnDate"/>
<element name="TCalendarPopupForm.Initialize">
<short>Configures the Calendar control in the pop-up form</short>
<short>Configures the Calendar control in the pop-up form.</short>
<descr>
<p>
Applies the values in the <var>ADate</var> and <var>DisplaySettings</var> arguments to the <var>Calendar</var> control.
@ -189,26 +189,26 @@
<seealso></seealso>
</element>
<element name="TCalendarPopupForm.Initialize.ADate">
<short>Date value assigned to the Calendar control</short>
<short>Date value assigned to the Calendar control.</short>
</element>
<element name="TCalendarPopupForm.Initialize.DisplaySettings">
<short>Display settings applied to the Calendar control</short>
<short>Display settings applied to the Calendar control.</short>
</element>
<element name="TCalendarPopupForm.KeepInView">
<short>
Ensures that the form and the calling control are visible on the current monitor
Ensures that the form and the calling control are visible on the current monitor.
</short>
<descr/>
<seealso/>
</element>
<element name="TCalendarPopupForm.KeepInView.PopupOrigin">
<short>Coordinates where the pop-up form is displayed</short>
<short>Coordinates where the pop-up form is displayed.</short>
</element>
<element name="TCalendarPopupForm.ReturnDate">
<short>
Signals the OnReturnDate event handler using the DateTime value in the Calendar control
Signals the OnReturnDate event handler using the DateTime value in the Calendar control.
</short>
<descr>
<p>
@ -219,7 +219,7 @@
</element>
<element name="ShowCalendarPopup">
<short>Creates, configures, and displays a TCalendarPopupForm instance</short>
<short>Creates, configures, and displays a TCalendarPopupForm instance.</short>
<descr>
<p>
<var>ShowCalendarPopup</var> is a procedure used to create, configure, and display a <var>TCalendarPopupForm</var> instance. ShowCalendarPopup stores arguments to the routine in properties for the pop-up calendar form, and calls its <var>Initialize</var> method to configure the <var>Calendar</var> control.
@ -235,22 +235,22 @@
</seealso>
</element>
<element name="ShowCalendarPopup.APosition">
<short>Coordinates where the pop-up calendar form is displayed</short>
<short>Coordinates where the pop-up calendar form is displayed.</short>
</element>
<element name="ShowCalendarPopup.ADate">
<short>Initial date displayed in the Calendar for the form</short>
<short>Initial date displayed in the Calendar for the form.</short>
</element>
<element name="ShowCalendarPopup.CalendarDisplaySettings">
<short>Display settings applied to the Calendar control</short>
<short>Display settings applied to the Calendar control.</short>
</element>
<element name="ShowCalendarPopup.OnReturnDate">
<short>Event handler signalled when a new date value is selected</short>
<short>Event handler signalled when a new date value is selected.</short>
</element>
<element name="ShowCalendarPopup.OnShowHide">
<short>Event handler signalled when the pop-up form is shown or hidden</short>
<short>Event handler signalled when the pop-up form is shown or hidden.</short>
</element>
<element name="ShowCalendarPopup.ACaller">
<short>The control which creates the pop-up and captures its return value</short>
<short>The control which creates the pop-up and captures its return value.</short>
</element>
</module>

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

@ -7,7 +7,7 @@
====================================================================
-->
<module name="CheckLst">
<short>Classes defining TCheckListBox - a List Box with Check Box items</short>
<short>Classes defining TCheckListBox - a List Box with Check Box items.</short>
<descr>
<p>
<file>checklst.pas</file> implements the TCheckListBox conttrol which displays a list with check box items. The following components are added to the Lazarus IDE component palette:
@ -35,7 +35,7 @@
<element name="TCheckListClicked">
<short>
Defines an object procedure signalled when an item in TCheckListBox is clicked
Defines an object procedure signalled when an item in TCheckListBox is clicked.
</short>
<descr>
<p>
@ -47,15 +47,15 @@
</seealso>
</element>
<element name="TCheckListClicked.Sender">
<short>TObject instance for the event notification</short>
<short>TObject instance for the event notification.</short>
</element>
<element name="TCheckListClicked.Index">
<short>Ordinal position for the item clicked in the control</short>
<short>Ordinal position for the item clicked in the control.</short>
</element>
<element name="TCustomCheckListBox">
<short>
The base class for TCheckListBox, a list box with check box items
The base class for TCheckListBox, a list box with check box items.
</short>
<descr>
<p>
@ -74,78 +74,78 @@
<element name="TCustomCheckListBox.FOnItemClick"/>
<element name="TCustomCheckListBox.GetChecked">
<short>Gets the value for the indexed Checked property</short>
<short>Gets the value for the indexed Checked property.</short>
<descr/>
<seealso>
<link id="TCustomCheckListBox.Checked"/>
</seealso>
</element>
<element name="TCustomCheckListBox.GetChecked.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomCheckListBox.GetChecked.AIndex">
<short>Ordinal position in Items for the affected entry</short>
<short>Ordinal position in Items for the affected entry.</short>
</element>
<element name="TCustomCheckListBox.GetHeader">
<short>Gets value for the indexed Header property</short>
<short>Gets value for the indexed Header property.</short>
<descr/>
<seealso>
<link id="TCustomCheckListBox.Header"/>
</seealso>
</element>
<element name="TCustomCheckListBox.GetHeader.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomCheckListBox.GetHeader.AIndex">
<short>Ordinal position in Items for the affected entry</short>
<short>Ordinal position in Items for the affected entry.</short>
</element>
<element name="TCustomCheckListBox.GetItemEnabled">
<short>Gets the value for the indexed ItemEnabled property</short>
<short>Gets the value for the indexed ItemEnabled property.</short>
<descr/>
<seealso>
<link id="TCustomCheckListBox.ItemEnabled"/>
</seealso>
</element>
<element name="TCustomCheckListBox.GetItemEnabled.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomCheckListBox.GetItemEnabled.AIndex">
<short>Ordinal position in Items for the affected entry</short>
<short>Ordinal position in Items for the affected entry.</short>
</element>
<element name="TCustomCheckListBox.GetState">
<short>Gets the value for the indexed State property</short>
<short>Gets the value for the indexed State property.</short>
<descr/>
<seealso>
<link id="TCustomCheckListBox.State"/>
</seealso>
</element>
<element name="TCustomCheckListBox.GetState.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomCheckListBox.GetState.AIndex">
<short>Ordinal position in Items for the affected entry</short>
<short>Ordinal position in Items for the affected entry.</short>
</element>
<element name="TCustomCheckListBox.SetChecked">
<short>Sets the value for the indexed Checked property</short>
<short>Sets the value for the indexed Checked property.</short>
<descr/>
<seealso>
<link id="TCustomCheckListBox.Checked"/>
</seealso>
</element>
<element name="TCustomCheckListBox.SetChecked.AIndex">
<short>Ordinal position in Items for the check box updated in the method</short>
<short>Ordinal position in Items for the check box updated in the method.</short>
</element>
<element name="TCustomCheckListBox.SetChecked.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomCheckListBox.SendItemState">
<short>
Notifies the widget set class when the state for the specified item has been changed
Notifies the widget set class when the state for the specified item has been changed.
</short>
<descr>
<remark>
@ -158,15 +158,15 @@
</seealso>
</element>
<element name="TCustomCheckListBox.SendItemState.AIndex">
<short>Ordinal position in Items for the affected entry</short>
<short>Ordinal position in Items for the affected entry.</short>
</element>
<element name="TCustomCheckListBox.SendItemState.AState">
<short>Check box state applied to the item</short>
<short>Check box state applied to the item.</short>
</element>
<element name="TCustomCheckListBox.SendItemEnabled">
<short>
Notifies the widget set class when the Enabled state for the specified item has been changed
Notifies the widget set class when the Enabled state for the specified item has been changed.
</short>
<descr>
<remark>
@ -179,15 +179,15 @@
</seealso>
</element>
<element name="TCustomCheckListBox.SendItemEnabled.AIndex">
<short>Ordinal position in Items for the affected entry</short>
<short>Ordinal position in Items for the affected entry.</short>
</element>
<element name="TCustomCheckListBox.SendItemEnabled.AEnabled">
<short>Enabled state applied to the item</short>
<short>Enabled state applied to the item.</short>
</element>
<element name="TCustomCheckListBox.SendItemHeader">
<short>
Notifies the widget set class when the specified item should be drawn as a header instead of a check box
Notifies the widget set class when the specified item should be drawn as a header instead of a check box.
</short>
<descr>
<remark>
@ -200,15 +200,15 @@
</seealso>
</element>
<element name="TCustomCheckListBox.SendItemHeader.AIndex">
<short>Ordinal position in Items for the affected entry</short>
<short>Ordinal position in Items for the affected entry.</short>
</element>
<element name="TCustomCheckListBox.SendItemHeader.AHeader">
<short>True when the item is a header; False when it is a check box</short>
<short>True when the item is a header; False when it is a check box.</short>
</element>
<element name="TCustomCheckListBox.DoChange">
<short>
Performs actions needed when an entry in Items is changed using the keyboard or mouse
Performs actions needed when an entry in Items is changed using the keyboard or mouse.
</short>
<descr>
<p>
@ -223,89 +223,87 @@
</seealso>
</element>
<element name="TCustomCheckListBox.DoChange.Msg">
<short>LCL message processed and applied in the method</short>
<short>LCL message processed and applied in the method.</short>
</element>
<element name="TCustomCheckListBox.SetHeader">
<short>Sets the value for the indexed Header property</short>
<short>Sets the value for the indexed Header property.</short>
<descr/>
<seealso>
<link id="TCustomCheckListBox.Header"/>
</seealso>
</element>
<element name="TCustomCheckListBox.SetHeader.AIndex">
<short>Ordinal position in Items for the property value</short>
<short>Ordinal position in Items for the property value.</short>
</element>
<element name="TCustomCheckListBox.SetHeader.AValue">
<short>
Value for the property; True indicates a header, and False indicates a check box
Value for the property; True indicates a header, and False indicates a check box.
</short>
</element>
<element name="TCustomCheckListBox.SetItemEnabled">
<short>Sets the value for the indexed ItemEnabled property</short>
<short>Sets the value for the indexed ItemEnabled property.</short>
<descr/>
<seealso>
<link id="TCustomCheckListBox.ItemEnabled"/>
</seealso>
</element>
<element name="TCustomCheckListBox.SetItemEnabled.AIndex">
<short>Ordinal position in Items for the property value</short>
<short>Ordinal position in Items for the property value.</short>
</element>
<element name="TCustomCheckListBox.SetItemEnabled.AValue">
<short>
New value for the property; True indicates a header, and False indicates a check box
New value for the property; True indicates a header, and False indicates a check box.
</short>
</element>
<element name="TCustomCheckListBox.SetState">
<short>Sets the value for the indexed State property</short>
<short>Sets the value for the indexed State property.</short>
<descr/>
<seealso>
<link id="TCustomCheckListBox.State"/>
</seealso>
</element>
<element name="TCustomCheckListBox.SetState.AIndex">
<short>Ordinal position in Items for the new property value</short>
<short>Ordinal position in Items for the new property value.</short>
</element>
<element name="TCustomCheckListBox.SetState.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomCheckListBox.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomCheckListBox.AssignItemDataToCache">
<short>
Stores the data for an item at the specified position in the cache for item data
Stores the data for an item at the specified position in the cache for item data.
</short>
<descr/>
<seealso></seealso>
</element>
<element name="TCustomCheckListBox.AssignItemDataToCache.AIndex">
<short>Ordinal position for the entry in Items stored in the method</short>
<short>Ordinal position for the entry in Items stored in the method.</short>
</element>
<element name="TCustomCheckListBox.AssignItemDataToCache.AData">
<short>Pointer to the item data stored in the cache</short>
<short>Pointer to the item data stored in the cache.</short>
</element>
<element name="TCustomCheckListBox.AssignCacheToItemData">
<short>
Retrieves data for an item at the specified position from the cache for item data
Retrieves data for an item at the specified position from the cache for item data.
</short>
<descr/>
<seealso></seealso>
</element>
<element name="TCustomCheckListBox.AssignCacheToItemData.AIndex">
<short>Ordinal position for the item updated from the item data cache</short>
<short>Ordinal position for the item updated from the item data cache.</short>
</element>
<element name="TCustomCheckListBox.AssignCacheToItemData.AData">
<short>Pointer to the data retrieved in the method</short>
<short>Pointer to the data retrieved in the method.</short>
</element>
<element name="TCustomCheckListBox.CreateParams">
<short>
Sets the creation parameters for the control handle
</short>
<short>Sets the creation parameters for the control handle.</short>
<descr>
<p>
<var>CreateParams</var> is an overridden procedure used to set the creation parameters for the class instance. It calls the inherited method on entry, and sets the list box drawing style flag for the class instance.
@ -316,12 +314,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.CreateParams.Params">
<short>Parameters applied to the control, including the Owner drawing style</short>
<short>Parameters applied to the control, including the Owner drawing style.</short>
</element>
<element name="TCustomCheckListBox.DrawItem">
<short>
Adjusts the drawing area for the specified item, and renders it on the control
Adjusts the drawing area for the specified item, and renders it on the control.
</short>
<descr>
<p>
@ -340,17 +338,17 @@
</seealso>
</element>
<element name="TCustomCheckListBox.DrawItem.AIndex">
<short>Ordinal position in Items for the entry drawn in the method</short>
<short>Ordinal position in Items for the entry drawn in the method.</short>
</element>
<element name="TCustomCheckListBox.DrawItem.ARect">
<short>TRectangle with the drawing area for the item</short>
<short>TRectangle with the drawing area for the item.</short>
</element>
<element name="TCustomCheckListBox.DrawItem.State">
<short>TOwnerDrawState for Items in the control</short>
<short>TOwnerDrawState for Items in the control.</short>
</element>
<element name="TCustomCheckListBox.GetCachedDataSize">
<short>Gets the data size for a TCachedItemData entry in the item cache</short>
<short>Gets the data size for a TCachedItemData entry in the item cache.</short>
<descr>
<p>
<var>GetCachedDataSize</var> is an overridden <var>Integer</var> function used to get the data size for a <var>TCachedItemData</var> entry in the item data cache. The return value contains the number of bytes needed for the <var>TCachedItemData</var> entry including the offset in the cache.
@ -359,16 +357,16 @@
<seealso></seealso>
</element>
<element name="TCustomCheckListBox.GetCachedDataSize.Result">
<short>Number of bytes required for cached item data</short>
<short>Number of bytes required for cached item data.</short>
</element>
<element name="TCustomCheckListBox.GetCheckWidth">
<short>Gets the width required for the check box drawn for Items on the control</short>
<short>Gets the width required for the check box drawn for Items on the control.</short>
<descr/>
<seealso></seealso>
</element>
<element name="TCustomCheckListBox.GetCheckWidth.Result">
<short>Width needed to draw a check box</short>
<short>Width needed to draw a check box.</short>
</element>
<element name="TCustomCheckListBox.DefineProperties" link="#rtl.classes.TComponent.DefineProperties"/>
@ -378,7 +376,7 @@
<element name="TCustomCheckListBox.ReadData">
<short>
Reads the data for the control from the specified stream
Reads the data for the control from the specified stream.
</short>
<descr>
<p>
@ -390,12 +388,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.ReadData.Stream">
<short>TStream instance with the data read in the method</short>
<short>TStream instance with the data read in the method.</short>
</element>
<element name="TCustomCheckListBox.WriteData">
<short>
Writes data for the control to the specified stream
Writes data for the control to the specified stream.
</short>
<descr>
<p>
@ -406,12 +404,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.WriteData.Stream">
<short>TStream instance where data for the control is written in the method</short>
<short>TStream instance where data for the control is written in the method.</short>
</element>
<element name="TCustomCheckListBox.ClickCheck">
<short>
Performs actions needed when a value in the control is about to change
Performs actions needed when a value in the control is about to change.
</short>
<descr>
<p>
@ -439,7 +437,7 @@
<element name="TCustomCheckListBox.ItemClick">
<short>
Performs actions when the specified check box has been changed using the mouse or the keyboard
Performs actions when the specified check box has been changed using the mouse or the keyboard.
</short>
<descr>
<p>
@ -462,11 +460,11 @@
</seealso>
</element>
<element name="TCustomCheckListBox.ItemClick.AIndex">
<short>Ordinal position for the check box</short>
<short>Ordinal position for the check box.</short>
</element>
<element name="TCustomCheckListBox.KeyDown">
<short>Handles key down messages for the control</short>
<short>Handles key down messages for the control.</short>
<descr>
<p>
<var>KeyDown</var> is an overridden method in <var>TCustomCheckListBox</var> used to handle key down messages for the control. KeyDown ensures that the value for the current check box is toggled when the <b>Space</b> key is pressed while the control has focus.
@ -491,15 +489,15 @@
</seealso>
</element>
<element name="TCustomCheckListBox.KeyDown.Key">
<short>Keystroke examined in the method</short>
<short>Keystroke examined in the method.</short>
</element>
<element name="TCustomCheckListBox.KeyDown.Shift">
<short>Shift, Control, or Alt modifier for the keystroke</short>
<short>Shift, Control, or Alt modifier for the keystroke.</short>
</element>
<element name="TCustomCheckListBox.FontChanged">
<short>
Recalculates the height for check box Items in the control when the Font is changed
Recalculates the height for check box Items in the control when the Font is changed.
</short>
<descr>
<p>
@ -514,11 +512,11 @@
</seealso>
</element>
<element name="TCustomCheckListBox.FontChanged.Sender">
<short>TObject instance for the change notification</short>
<short>TObject instance for the change notification.</short>
</element>
<element name="TCustomCheckListBox.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for <var>TCustomCheckListBox</var>. It calls the inherited <var>Create</var> method, and sets the component style flag for the control. It also calls the inherited <var>GetCachedDataSize</var> method to determine the storage size needed for each cached item in the control.
@ -530,12 +528,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.Create.AOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TCustomCheckListBox.MeasureItem">
<short>
Calculates the height for an item displayed in the check list control
Calculates the height for an item displayed in the check list control.
</short>
<descr>
<p>
@ -557,15 +555,15 @@
</seealso>
</element>
<element name="TCustomCheckListBox.MeasureItem.Index">
<short>Ordinal position for the check box item measured in the method</short>
<short>Ordinal position for the check box item measured in the method.</short>
</element>
<element name="TCustomCheckListBox.MeasureItem.TheHeight">
<short>Returns the calculated height for the check box item</short>
<short>Returns the calculated height for the check box item.</short>
</element>
<element name="TCustomCheckListBox.Toggle">
<short>
Toggles the Checked, Unchecked, Grayed state for the specified item in the control
Toggles the Checked, Unchecked, Grayed state for the specified item in the control.
</short>
<descr>
<p>
@ -602,12 +600,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.Toggle.AIndex">
<short>Ordinal position of the item state toggled in the method</short>
<short>Ordinal position of the item state toggled in the method.</short>
</element>
<element name="TCustomCheckListBox.CheckAll">
<short>
Sets the specified values for State, AllowGrayed, and ItemEnabled for all Items in Control
Sets the specified values for State, AllowGrayed, and ItemEnabled for all Items in Control.
</short>
<descr>
<p>
@ -630,29 +628,29 @@
<short>Check box state applied to Items in the control`</short>
</element>
<element name="TCustomCheckListBox.CheckAll.aAllowGrayed">
<short>AllowGrayed property value applied to Items in the control</short>
<short>AllowGrayed property value applied to Items in the control.</short>
</element>
<element name="TCustomCheckListBox.CheckAll.aAllowDisabled">
<short>ItemEnabled property value applied to Items in the control</short>
<short>ItemEnabled property value applied to Items in the control.</short>
</element>
<element name="TCustomCheckListBox.Exchange">
<short>
Swaps the values for the State properties in the Items at the specified ordinal positions
Swaps the values for the State properties in the Items at the specified ordinal positions.
</short>
<descr/>
<seealso/>
</element>
<element name="TCustomCheckListBox.Exchange.AIndex1">
<short>Ordinal position for the first item affected in the method</short>
<short>Ordinal position for the first item affected in the method.</short>
</element>
<element name="TCustomCheckListBox.Exchange.AIndex2">
<short>Ordinal position for the second item affected in the method</short>
<short>Ordinal position for the second item affected in the method.</short>
</element>
<element name="TCustomCheckListBox.AllowGrayed">
<short>
Indicates if the item can use the "grayed" (or unselectable) check box state
Indicates if the item can use the "grayed" (or unselectable) check box state.
</short>
<descr>
<p>
@ -667,7 +665,7 @@
<element name="TCustomCheckListBox.Checked">
<short>
Provides indexed access to the Boolean Checked or Unchecked state for Items in the control
Provides indexed access to the Boolean Checked or Unchecked state for Items in the control.
</short>
<descr>
<p>
@ -680,12 +678,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.Checked.AIndex">
<short>Ordinal position for the entry in Items affected in the method</short>
<short>Ordinal position for the entry in Items affected in the method.</short>
</element>
<element name="TCustomCheckListBox.Header">
<short>
Provides indexed access to header usage status for Items in the control
Provides indexed access to header usage status for Items in the control.
</short>
<descr>
<p>
@ -705,12 +703,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.Header.Index">
<short>Ordinal position for the item affected in the method</short>
<short>Ordinal position for the item affected in the method.</short>
</element>
<element name="TCustomCheckListBox.ItemEnabled">
<short>
Provides indexed access to the enabled state for Items in the control
Provides indexed access to the enabled state for Items in the control.
</short>
<descr>
<p>
@ -733,12 +731,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.ItemEnabled.AIndex">
<short>Ordinal position for the item affected in the method</short>
<short>Ordinal position for the item affected in the method.</short>
</element>
<element name="TCustomCheckListBox.State">
<short>
Provides indexed access to the TCheckBoxState for Items in the control
Provides indexed access to the TCheckBoxState for Items in the control.
</short>
<descr>
<p>
@ -763,12 +761,12 @@
</seealso>
</element>
<element name="TCustomCheckListBox.State.AIndex">
<short>Ordinal position for the Item examined in the property</short>
<short>Ordinal position for the Item examined in the property.</short>
</element>
<element name="TCustomCheckListBox.OnClickCheck">
<short>
Event handler signalled when a check box in the control has been changed
Event handler signalled when a check box in the control has been changed.
</short>
<descr>
<p>
@ -802,7 +800,7 @@
<element name="TCustomCheckListBox.OnItemClick">
<short>
Event handler signalled when the check box state for a specific item has been changed
Event handler signalled when the check box state for a specific item has been changed.
</short>
<descr>
<p>
@ -841,7 +839,7 @@
<element name="TCheckListBox">
<short>
<var>TCheckListBox</var> implements a list box with check boxes for its items
<var>TCheckListBox</var> implements a list box with check boxes for its items.
</short>
<descr>
<p>
@ -938,7 +936,7 @@
<element name="TCheckListBox.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="Register">
<short>Adds TCheckListBox to the Lazarus IDE</short>
<short>Adds TCheckListBox to the Lazarus IDE.</short>
<descr>
<var>Register</var> is a procedure used to add the <var>TCheckListBox</var> class to the <b>Additional</b> tab in the Lazarus IDE.
</descr>

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

@ -7,7 +7,7 @@
====================================================================
-->
<module name="Clipbrd">
<short>Definitions for the Clipboard to hold Cut or Copied data for Pasting</short>
<short>Definitions for the Clipboard to hold Cut or Copied data for Pasting.</short>
<descr>
<p>
<file>clipbrd.pp</file> contains classes, types, and routines used to implement TClipboard. TClipboard encapsulates the system clipboard for supported platforms. This file is part of the Lazarus Component Library (<b>LCL</b>).
@ -107,7 +107,7 @@
<!-- object Visibility: default -->
<element name="TClipboard">
<short>
<var>TClipboard</var> - area for holding information that has been cut or copied, ready for pasting
<var>TClipboard</var> - area for holding information that has been cut or copied, ready for pasting.
</short>
<descr>
<p>
@ -366,11 +366,11 @@ If the format already exists it replaces the old content otherwise it is added.
The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions instead.</descr>
<errors/>
<seealso/>
<short>Acquires ownership of the Clipboard and adds a format</short>
<short>Acquires ownership of the Clipboard and adds a format.</short>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.AddFormat.Result">
<short>True if format added correctly</short>
<short>True if format added correctly.</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AddFormat.FormatID">
@ -411,7 +411,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- procedure Visibility: public -->
<element name="TClipboard.Clear">
<short>
<var>Clear</var> the clipboard</short>
<var>Clear</var> the clipboard.</short>
<descr/>
<errors/>
<seealso/>
@ -419,7 +419,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- procedure Visibility: public -->
<element name="TClipboard.Close">
<short>
<var>Close</var> down the clipboard</short>
<var>Close</var> down the clipboard.</short>
<descr/>
<errors/>
<seealso/>
@ -427,7 +427,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- constructor Visibility: public -->
<element name="TClipboard.Create">
<short>
<var>Create</var> - Constructor: make a new instance of a clipboard</short>
<var>Create</var> - Constructor: make a new instance of a clipboard.</short>
<descr/>
<errors/>
<seealso/>
@ -435,7 +435,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- argument Visibility: default -->
<element name="TClipboard.Create.AClipboardType">
<short>
<var>AClipboardType</var> - optional argument specifying type of clipboard to be created</short>
<var>AClipboardType</var> - optional argument specifying type of clipboard to be created.</short>
</element>
<!-- destructor Visibility: public -->
<element name="TClipboard.Destroy" link="#rtl.Classes.TPersistent.Destroy">
@ -446,26 +446,26 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- function Visibility: public -->
<element name="TClipboard.FindPictureFormatID">
<short>
<var>FindPictureFormatID</var> - search for the first format ID that is a graphic</short>
<var>FindPictureFormatID</var> - search for the first format ID that is a graphic.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.FindPictureFormatID.Result">
<short>Returns a Clipboard format</short>
<short>Returns a Clipboard format.</short>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.FindFormatID">
<short>
<var>FindFormatID</var> - find a Format ID that has the specified name</short>
<var>FindFormatID</var> - find a Format ID that has the specified name.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.FindFormatID.Result">
<short>Returns a Clipboard format</short>
<short>Returns a Clipboard format.</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.FindFormatID.FormatName">
@ -474,7 +474,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- function Visibility: public -->
<element name="TClipboard.GetComponent">
<short>
<var>GetComponent</var> - read a component from the clipboard</short>
<var>GetComponent</var> - read a component from the clipboard.</short>
<descr/>
<errors/>
<seealso/>
@ -494,14 +494,14 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- function Visibility: public -->
<element name="TClipboard.GetFormat">
<short>
<var>GetFormat</var> - read information on format from the clipboard</short>
<var>GetFormat</var> - read information on format from the clipboard.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetFormat.Result">
<short>True if Format found</short>
<short>True if Format found.</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetFormat.FormatID">
@ -514,7 +514,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- procedure Visibility: public -->
<element name="TClipboard.SupportedFormats">
<short>
<var>SupportedFormats</var> - fills a stringlist with the names of the supported MIME types</short>
<var>SupportedFormats</var> - fills a stringlist with the names of the supported MIME types.</short>
<descr/>
<errors/>
<seealso/>
@ -534,14 +534,14 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- function Visibility: public -->
<element name="TClipboard.GetTextBuf">
<short>
<var>GetTextBuf</var> - reads text from the clipboard and returns the number of characters</short>
<var>GetTextBuf</var> - reads text from the clipboard and returns the number of characters.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetTextBuf.Result">
<short>Number of characters in text buffer</short>
<short>Number of characters in text buffer.</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetTextBuf.Buffer">
@ -561,7 +561,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.HasFormat.Result">
<short>True if format is supported</short>
<short>True if format is supported.</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.HasFormat.FormatID">
@ -570,14 +570,14 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- function Visibility: public -->
<element name="TClipboard.HasFormatName">
<short>
<var>HasFormatName</var> - checks if data have format with specified name</short>
<var>HasFormatName</var> - checks if data have format with specified name.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.HasFormatName.Result">
<short>True if named format found</short>
<short>True if named format found.</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.HasFormatName.FormatName">
@ -586,26 +586,26 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- function Visibility: public -->
<element name="TClipboard.HasPictureFormat">
<short>
<var>HasPictureFormat</var> - checks whether data are formatted as a picture</short>
<var>HasPictureFormat</var> - checks whether data are formatted as a picture.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.HasPictureFormat.Result">
<short>True if formatted as picture</short>
<short>True if formatted as picture.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.Open">
<short>
<var>Open</var> the clipboard to receive and transmit data</short>
<var>Open</var> the clipboard to receive and transmit data.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SetComponent">
<short>Write specified component to the Clipboard</short>
<short>Write specified component to the Clipboard.</short>
<descr/>
<errors/>
<seealso/>
@ -632,7 +632,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- procedure Visibility: public -->
<element name="TClipboard.SetSupportedFormats">
<short>
<var>SetSupportedFormats</var> - set all supported formats at once</short>
<var>SetSupportedFormats</var> - set all supported formats at once.</short>
<descr>
<p>
<var>SetSupportedFormats</var> - set all supported formats at once </p>
@ -676,7 +676,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- property Visibility: public -->
<element name="TClipboard.AsText">
<short>
<var>AsText</var> - holds the textual data in the clipboard as a string</short>
<var>AsText</var> - holds the textual data in the clipboard as a string.</short>
<descr/>
<seealso/>
</element>
@ -692,10 +692,10 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetAsHtml.HTML">
<short>The HTML string that shall be put on the ClipBoard</short>
<short>The HTML string that shall be put on the ClipBoard.</short>
</element>
<element name="TClipboard.SetAsHtml.PlainText">
<short>Optional plain text (string) representation of the HTML</short>
<short>Optional plain text (string) representation of the HTML.</short>
<descr>The optional string parameter PlainText is meant to be a plain text representation
of the HTML string. The user is responsible for the contents of this variable.
The value of PlainText can later be retrieved via the
@ -705,7 +705,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
</element>
<!-- function Visibility: public -->
<element name="TClipboard.GetAsHtml">
<short>Retrieves the HTML content of the clipboard (if available)</short>
<short>Retrieves the HTML content of the clipboard (if available).</short>
<descr>Retrieves the HTML content of the clipboard (if available).
On Windows it will automatically remove the clipboard header that Windows inserts.
The resulting HTML string will be UTF-8 encoded.</descr>
@ -719,21 +719,21 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- property Visibility: public -->
<element name="TClipboard.ClipboardType">
<short>
<var>ClipboardType</var> - ctPrimarySelection, ctSecondarySelection, ctClipboard</short>
<var>ClipboardType</var> - ctPrimarySelection, ctSecondarySelection, ctClipboard.</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TClipboard.FormatCount">
<short>
<var>FormatCount</var> - the number of formats available</short>
<var>FormatCount</var> - the number of formats available.</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TClipboard.Formats">
<short>
<var>Formats</var> - the formats being used in the current clipboard</short>
<var>Formats</var> - the formats being used in the current clipboard.</short>
<descr>
<p>
<var>Formats</var> - the formats being used in the current clipboard</p>
@ -749,7 +749,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- property Visibility: public -->
<element name="TClipboard.OnRequest">
<short>
<var>OnRequest</var> - event handler for a request for clipboard data
<var>OnRequest</var> - event handler for a request for clipboard data.
</short>
<descr>
<p>
@ -771,7 +771,7 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- function Visibility: default -->
<element name="PrimarySelection">
<short>
<var>PrimarySelection</var> - the first selection if multiple clipboards exist
<var>PrimarySelection</var> - the first selection if multiple clipboards exist.
</short>
<descr>
<p>
@ -783,12 +783,12 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
</element>
<!-- function result Visibility: default -->
<element name="PrimarySelection.Result">
<short>Returns a variable of type TClipboard</short>
<short>Returns a variable of type TClipboard.</short>
</element>
<!-- function Visibility: default -->
<element name="SecondarySelection">
<short>
<var>SecondarySelection</var> - the second selection if multiple clipboards exist
<var>SecondarySelection</var> - the second selection if multiple clipboards exist.
</short>
<descr>
<p>
@ -800,12 +800,12 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
</element>
<!-- function result Visibility: default -->
<element name="SecondarySelection.Result">
<short>Returns a variable of type TClipboard</short>
<short>Returns a variable of type TClipboard.</short>
</element>
<!-- function Visibility: default -->
<element name="Clipboard">
<short>
<var>Clipboard</var> the function called to access the clipboard with an optional type specifier
<var>Clipboard</var> the function called to access the clipboard with an optional type specifier.
</short>
<descr>
<p>
@ -817,39 +817,39 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
</element>
<!-- function result Visibility: default -->
<element name="Clipboard.Result">
<short>Returns a variable of type TClipboard</short>
<short>Returns a variable of type TClipboard.</short>
</element>
<!-- argument Visibility: default -->
<element name="Clipboard.ClipboardType">
<short>
<var>ClipboardType</var> - optional argument to specify type of clipboard</short>
<var>ClipboardType</var> - optional argument to specify type of clipboard.</short>
</element>
<!-- function Visibility: default -->
<element name="SetClipboard">
<short>
<var>SetClipboard</var> - sets up and returns a <var>NewClipboard</var>, with an optional type specifier</short>
<var>SetClipboard</var> - sets up and returns a <var>NewClipboard</var>, with an optional type specifier.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="SetClipboard.Result">
<short>Returns a variable of type TClipboard</short>
<short>Returns a variable of type TClipboard.</short>
</element>
<!-- argument Visibility: default -->
<element name="SetClipboard.ClipboardType">
<short>
<var>ClipboardType</var> - optional argument to specify type of clipboard</short>
<var>ClipboardType</var> - optional argument to specify type of clipboard.</short>
</element>
<!-- argument Visibility: default -->
<element name="SetClipboard.NewClipboard">
<short>
<var>NewClipboard</var> - the new clipboard to be set up</short>
<var>NewClipboard</var> - the new clipboard to be set up.</short>
</element>
<!-- procedure Visibility: default -->
<element name="FreeAllClipboards">
<short>
<var>FreeAllClipboards</var> - frees all existing clipboards, releasing their resources</short>
<var>FreeAllClipboards</var> - frees all existing clipboards, releasing their resources.</short>
<descr/>
<errors/>
<seealso/>
@ -857,22 +857,22 @@ The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions inst
<!-- function Visibility: default -->
<element name="RegisterClipboardFormat">
<short>
<var>RegisterClipboardFormat</var> add the supplied format name to the register of clipboard formats</short>
<var>RegisterClipboardFormat</var> add the supplied format name to the register of clipboard formats.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="RegisterClipboardFormat.Result">
<short>Returns the registered clipboard format</short>
<short>Returns the registered clipboard format.</short>
</element>
<!-- argument Visibility: default -->
<element name="RegisterClipboardFormat.Format">
<short>The name of the required format as a string</short>
<short>The name of the required format as a string.</short>
</element>
<element name="TClipboard.GetComponentAsText">
<short>
<var>GetComponentAsText</var> - read the component as text, if supported</short>
<var>GetComponentAsText</var> - read the component as text, if supported.</short>
</element>
</module>
<!-- Clipbrd -->

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

@ -7,7 +7,7 @@
====================================================================
-->
<module name="ColorBox">
<short>Defines classes for selecting a color from a combo-box or a list box</short>
<short>Defines classes for selecting a color from a combo-box or a list box.</short>
<descr>
<p>
<file>colorbox.pas</file> contains <var>TColorBox</var> and <var>TColorListBox</var>. TColorBox is a component that displays colors in a combo-box control. TColorListBox is a component that displays colors in a list box control. This file is part of the Lazarus Component Library (<b>LCL</b>).
@ -40,7 +40,7 @@
<element name="LazStringUtils"/>
<element name="cDefaultColorRectWidth">
<short>Default width for the color sample (swatch) in a color combo-box or list box</short>
<short>Default width for the color sample (swatch) in a color combo-box or list box.</short>
<descr/>
<seealso>
<link id="TCustomColorBox.ColorRectWidth"/>
@ -52,7 +52,7 @@
<element name="cDefaultColorRectOffset">
<short>
Default spacing between the color sample (swatch) and the color name in a combo-box or list box
Default spacing between the color sample (swatch) and the color name in a combo-box or list box.
</short>
<descr/>
<seealso>
@ -64,7 +64,7 @@
</element>
<element name="TColorBoxStyles">
<short>Represents the available colors and the name display style used in color controls</short>
<short>Represents the available colors and the name display style used in color controls.</short>
<descr>
<p>
<var>TColorBoxStyles</var> is an enumerated type with values that represent the available colors and the display style used in color controls like <var>TColorBox</var> and <var>TColorListBox</var>. Values from TColorBoxStyles are stored in the <var>TColorBoxStyle</var> set type.
@ -79,34 +79,34 @@
</seealso>
</element>
<element name="TColorBoxStyles.cbStandardColors">
<short>16 standard colors (as defined in graphics.pp)</short>
<short>16 standard colors (as defined in graphics.pp).</short>
</element>
<element name="TColorBoxStyles.cbExtendedColors">
<short>16 standard colors and 4 extended colors (as defined in graphics.pp)</short>
<short>16 standard colors and 4 extended colors (as defined in graphics.pp).</short>
</element>
<element name="TColorBoxStyles.cbSystemColors">
<short>System colors (as defined in graphics.pp)</short>
<short>System colors (as defined in graphics.pp).</short>
</element>
<element name="TColorBoxStyles.cbIncludeNone">
<short>Includes clNone in the list of colors</short>
<short>Includes clNone in the list of colors.</short>
</element>
<element name="TColorBoxStyles.cbIncludeDefault">
<short>Includes clDefault in the list of colors</short>
<short>Includes clDefault in the list of colors.</short>
</element>
<element name="TColorBoxStyles.cbCustomColor">
<short>The first color is customizable</short>
<short>The first color is customizable.</short>
</element>
<element name="TColorBoxStyles.cbPrettyNames">
<short>
Uses "pretty" names in the color names instead of the color value; like Red for clRed
Uses "pretty" names in the color names instead of the color value; like Red for clRed.
</short>
</element>
<element name="TColorBoxStyles.cbCustomColors">
<short>Uses the OnGetColors event handler to get the list of colors</short>
<short>Uses the OnGetColors event handler to get the list of colors.</short>
</element>
<element name="TColorBoxStyle">
<short>Set type used to store values from the TColorBoxStyles enumeration</short>
<short>Set type used to store values from the TColorBoxStyles enumeration.</short>
<descr>
<p>
<var>TColorBoxStyle</var> is a <var>Set</var> type used to store zero or more values from the <var>TColorBoxStyles</var> enumeration. TColorBoxStyle is the type used to implement the <var>TColorBox.Style</var> and <var>TColorListBox.Style</var> properties.
@ -122,7 +122,7 @@
</element>
<element name="TGetColorsEvent">
<short>Specifies an event handler used to get the colors in a color control</short>
<short>Specifies an event handler used to get the colors in a color control.</short>
<descr>
<p>
<var>TGetColorsEvent</var> is an object procedure type which specifies an event handler used to get the colors names and values used in a color control.
@ -142,14 +142,14 @@
</seealso>
</element>
<element name="TGetColorsEvent.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TGetColorsEvent.Items">
<short>TStrings instance with the color names and values used in the control</short>
<short>TStrings instance with the color names and values used in the control.</short>
</element>
<element name="TCustomColorBox">
<short>The base class for TColorBox</short>
<short>The base class for TColorBox.</short>
<descr>
<p>
<var>TCustomColorBox</var> is a <var>TCustomComboBox</var> descendant which implements the base class for <var>TColorBox</var>. TCustomColorBox displays available colors in a combo-box control. Each item in the control has a small rectangle where the color is displayed (swatch) and the color name.
@ -189,23 +189,23 @@
<element name="TCustomColorBox.FSelected"/>
<element name="TCustomColorBox.GetColor">
<short>Gets the value for the indexed Colors property</short>
<short>Gets the value for the indexed Colors property.</short>
</element>
<element name="TCustomColorBox.GetColor.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomColorBox.GetColor.Index">
<short>Ordinal position in the list for the color value</short>
<short>Ordinal position in the list for the color value.</short>
</element>
<element name="TCustomColorBox.GetColorName">
<short>Gets the value for the indexed ColorNames property</short>
<short>Gets the value for the indexed ColorNames property.</short>
</element>
<element name="TCustomColorBox.GetColorName.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomColorBox.GetColorName.Index">
<short>Ordinal position in the list for the color name</short>
<short>Ordinal position in the list for the color name.</short>
</element>
<element name="TCustomColorBox.GetColorRectWidth"/>
@ -230,18 +230,18 @@
<!-- protected -->
<element name="TCustomColorBox.ColorRectWidthStored">
<short>Implements the storage specifier for the ColorRectWidth property</short>
<short>Implements the storage specifier for the ColorRectWidth property.</short>
<descr/>
<seealso>
<link id="TCustomColorBox.ColorRectWidth"/>
</seealso>
</element>
<element name="TCustomColorBox.ColorRectWidthStored.Result">
<short>True when the property has a value other than the default value</short>
<short>True when the property has a value other than the default value.</short>
</element>
<element name="TCustomColorBox.DrawItem">
<short>Draws an item in the combo-box control</short>
<short>Draws an item in the combo-box control.</short>
<descr>
<p>
DrawItem is an overridden method used to custom draw an item in the ColorBox.
@ -261,17 +261,17 @@
</seealso>
</element>
<element name="TCustomColorBox.DrawItem.Index">
<short>Ordinal position for the item drawn in the method</short>
<short>Ordinal position for the item drawn in the method.</short>
</element>
<element name="TCustomColorBox.DrawItem.Rect">
<short>Rectanlge with the bounds for the item</short>
<short>Rectanlge with the bounds for the item.</short>
</element>
<element name="TCustomColorBox.DrawItem.State">
<short>Owner draw state for the item</short>
<short>Owner draw state for the item.</short>
</element>
<element name="TCustomColorBox.SetColorList">
<short>Loads the list of colors used in the control</short>
<short>Loads the list of colors used in the control.</short>
<descr>
<p>
<var>SetColorList</var> is used to fill the <var>Items</var> in the control with the <var>Colors</var> and <var>ColorNames</var> available in the combo-box.
@ -287,7 +287,7 @@
<element name="TCustomColorBox.Loaded" link="#lcl.controls.TWinControl.Loaded">
<short>
Performs actions needed when LCL component streaming has been completed
Performs actions needed when LCL component streaming has been completed.
</short>
<descr/>
<seealso>
@ -329,7 +329,7 @@
</element>
<element name="TCustomColorBox.DoGetColors">
<short>Signals the OnGetColors event handler (when assigned)</short>
<short>Signals the OnGetColors event handler (when assigned).</short>
<descr>
<p>
Called when the <var>Colors</var> in the control are (re-)loaded after setting a new value in <var>Style</var>. It is called if <var>cbCustomColors</var> has been included in Style.
@ -351,7 +351,7 @@
</element>
<element name="TCustomColorBox.PickCustomColor">
<short>Selects a custom color using a color dialog</short>
<short>Selects a custom color using a color dialog.</short>
<descr>
<p>
PickCustomColor is a Boolean function used to select a custom color rather than one of the standard colors in the Colors property.
@ -372,11 +372,11 @@
</seealso>
</element>
<element name="TCustomColorBox.PickCustomColor.Result">
<short>True when a custom color was selected in the method</short>
<short>True when a custom color was selected in the method.</short>
</element>
<element name="TCustomColorBox.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for <var>TCustomColorBox</var>. It calls the inherited <var>Create</var> method, and sets the Style flags needed for the owner-drawn control. Create sets the default values for properties, including:
@ -399,7 +399,7 @@
</element>
<element name="TCustomColorBox.ColorRectWidth">
<short>Width for the color sample (swatch) displayed for colors in the item list</short>
<short>Width for the color sample (swatch) displayed for colors in the item list.</short>
<descr>
<p>
ColorRectWidth is an Integer property which contains the number of pixels used to draw the color sample (or swatch) for each of the Colors in the combo-box control. The height is determined using the item height for the combo-box control.
@ -418,7 +418,7 @@
</element>
<element name="TCustomColorBox.ColorRectOffset">
<short>Number of pixels between the color sample and the color name</short>
<short>Number of pixels between the color sample and the color name.</short>
<descr>
<p>
ColorRectOffset is an Integer property with the number of pixels used to separate the color sample (or swatch) and the color name displayed for the Items in the control. The default value for the property is cDefaultColorRectOffset.
@ -434,7 +434,7 @@
</element>
<element name="TCustomColorBox.Style">
<short>Settings which determine the colors available in the control and their display style</short>
<short>Settings which determine the colors available in the control and their display style.</short>
<descr>
<p>
Style is a TColorBoxStyle property with settings to determine the colors available in the control and their display style. Include values from the TColorBoxStyles enumeration to enable a particular setting. For instance:
@ -476,7 +476,7 @@
</element>
<element name="TCustomColorBox.Colors">
<short>Provides indexed access to the TColor value for items in the control</short>
<short>Provides indexed access to the TColor value for items in the control.</short>
<descr>
<p>
Colors is an indexed read-only TColor property which provides access to the colors in the control by their ordinal position in the list of Items.
@ -494,7 +494,7 @@
</seealso>
</element>
<element name="TCustomColorBox.Colors.Index">
<short>Ordinal position for the property value in the list of items</short>
<short>Ordinal position for the property value in the list of items.</short>
</element>
<element name="TCustomColorBox.ColorNames">
@ -517,11 +517,11 @@
</seealso>
</element>
<element name="TCustomColorBox.ColorNames.Index">
<short>Ordinal position for the color name accessed in the Items for the control</short>
<short>Ordinal position for the color name accessed in the Items for the control.</short>
</element>
<element name="TCustomColorBox.Selected">
<short>The TColor value for the selected item in the combo-box control</short>
<short>The TColor value for the selected item in the combo-box control.</short>
<descr>
<p>
Selected is a TColor property with the color for the selected item in combo-box control. The default value for the property is clBlack.
@ -543,7 +543,7 @@
</element>
<element name="TCustomColorBox.DefaultColorColor">
<short>TColor used for the clDefault color constant</short>
<short>TColor used for the clDefault color constant.</short>
<descr>
<p>
<var>DefaultColorColor</var> is a <var>TColor</var> property with the value used for the <var>clDefault</var> color constant.
@ -576,7 +576,7 @@
</element>
<element name="TCustomColorBox.NoneColorColor">
<short>TColor used for the clNone color constant</short>
<short>TColor used for the clNone color constant.</short>
<descr>
<p>
<var>NoneColorColor</var> is a <var>TColor</var> property with the color value used for the <var>clNone</var> color constant.
@ -610,7 +610,7 @@
<element name="TCustomColorBox.OnGetColors">
<short>
<var>OnGetColors</var> - event handler for the instruction to get colors
<var>OnGetColors</var> - event handler for the instruction to get colors.
</short>
<descr>
<p>
@ -654,7 +654,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TColorBox">
<short>Implements combo-box control used to select a color name or value</short>
<short>Implements combo-box control used to select a color name or value.</short>
<descr>
<p>
<var>TColorBox</var> is a <var>TCustomColorBox</var> descendant which implements the a combo-box control used to display and select available color names and values. Each item in the control has a small rectangle where the color is displayed (swatch) and the color name.
@ -758,7 +758,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox">
<short>Implements the base class for TColorListBox</short>
<short>Implements the base class for TColorListBox.</short>
<descr>
<p>
<var>TCustomColorListBox</var> is a <var>TCustomListBox</var> descendant which implements a list box control used to display and select color names and values. TCustomColorListBox is the base class for the <var>TColorListBox</var> control. Each item in the control has a small rectangle where the color is displayed (swatch) and the color name.
@ -829,18 +829,18 @@ if iPos &lt;&gt; -1 then
<!-- protected -->
<element name="TCustomColorListBox.ColorRectWidthStored">
<short>Implements the storage specifier for the ColorRectWidth property</short>
<short>Implements the storage specifier for the ColorRectWidth property.</short>
<descr/>
<seealso>
<link id="TCustomColorListBox.ColorRectWidth"/>
</seealso>
</element>
<element name="ColorRectWidthStored.Result">
<short>True when the property has a value other than the default</short>
<short>True when the property has a value other than the default.</short>
</element>
<element name="TCustomColorListBox.DrawItem">
<short>Draws the color preview and name for an item in list box control</short>
<short>Draws the color preview and name for an item in list box control.</short>
<descr>
<p>
DrawItem is an overridden method used to custom draw an item in the control.
@ -861,7 +861,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.SetColorList">
<short>Loads the list of colors used in the control</short>
<short>Loads the list of colors used in the control.</short>
<descr>
<p>
<var>SetColorList</var> is used to fill the <var>Items</var> in the control with the <var>Colors</var> and <var>ColorNames</var> available in the list box.
@ -878,7 +878,7 @@ if iPos &lt;&gt; -1 then
<element name="TCustomColorListBox.Loaded">
<short>
Performs actions needed when LCL component streaming has been completed
Performs actions needed when LCL component streaming has been completed.
</short>
<descr/>
<seealso>
@ -914,7 +914,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.DoGetColors">
<short>Signals the OnGetColors event handler (when assigned)</short>
<short>Signals the OnGetColors event handler (when assigned).</short>
<descr>
<p>
Called when the <var>Colors</var> in the control are (re-)loaded after setting a new value in <var>Style</var>. It is called if <var>cbCustomColors</var> has been included in Style.
@ -924,7 +924,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.DoSelectionChange">
<short>Performs actions needed when the selection in the control is changed</short>
<short>Performs actions needed when the selection in the control is changed.</short>
<descr>
<p>
DoSelectionChange is an overridden method used to perform actions needed when the value in the ItemIndex property is changed.
@ -950,7 +950,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.PickCustomColor">
<short>Selects a custom color using a color dialog</short>
<short>Selects a custom color using a color dialog.</short>
<descr>
<p>
PickCustomColor is a Boolean function used to select a custom color rather than one of the standard colors in the Colors property.
@ -968,11 +968,11 @@ if iPos &lt;&gt; -1 then
<seealso/>
</element>
<element name="TCustomColorListBox.PickCustomColor.Result">
<short>True when a custom color was selected in the color dialog</short>
<short>True when a custom color was selected in the color dialog.</short>
</element>
<element name="TCustomColorListBox.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for <var>TCustomColorListBox</var>. Create calls the inherited Create method, and sets the Style flags needed for the owner-drawn control. It also sets the default values for properties in the class instance, including:
@ -995,7 +995,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.ColorRectWidth">
<short>Width for the color sample (swatch) displayed for colors in the item list</short>
<short>Width for the color sample (swatch) displayed for colors in the item list.</short>
<descr>
<p>
ColorRectWidth is an Integer property which contains the number of pixels used to draw the color sample (or swatch) for each of the Colors in the list box control. The height for the list Item is in the ItemHeight property.
@ -1014,7 +1014,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.ColorRectOffset">
<short>Number of pixels between the color sample and the color name</short>
<short>Number of pixels between the color sample and the color name.</short>
<descr>
<p>
ColorRectOffset is an Integer property with the number of pixels used to separate the color sample (or swatch) and the color name displayed for the Items in the control. The default value for the property is cDefaultColorRectOffset.
@ -1030,7 +1030,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.Style">
<short>Settings which determine the colors available in the control and their display style</short>
<short>Settings which determine the colors available in the control and their display style.</short>
<descr>
<p>
Style is a TColorBoxStyle property with settings to determine the colors available in the control and their display style. Include values from the TColorBoxStyles enumeration to enable a particular setting. For instance:
@ -1070,7 +1070,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.Colors">
<short>Provides indexed access to the TColor value for items in the control</short>
<short>Provides indexed access to the TColor value for items in the control.</short>
<descr>
<p>
Colors is an indexed TColor property which provides access to the colors in the control by their ordinal position in the list of Items. Setting a new TColor value in the indexed property causes the control to be redrawn.
@ -1088,7 +1088,7 @@ if iPos &lt;&gt; -1 then
<seealso/>
</element>
<element name="TCustomColorListBox.Colors.Index">
<short>Ordinal position in Items for the color value</short>
<short>Ordinal position in Items for the color value.</short>
</element>
<element name="TCustomColorListBox.ColorNames">
@ -1110,11 +1110,11 @@ if iPos &lt;&gt; -1 then
<seealso/>
</element>
<element name="TCustomColorListBox.ColorNames.Index">
<short>Ordinal position in Items for the color name</short>
<short>Ordinal position in Items for the color name.</short>
</element>
<element name="TCustomColorListBox.Selected">
<short>The TColor value for the selected item in the list box control</short>
<short>The TColor value for the selected item in the list box control.</short>
<descr>
<p>
Selected is a TColor property with the color for the selected item in list box control. The default value for the property is clBlack.
@ -1132,7 +1132,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.DefaultColorColor">
<short>TColor used for the clDefault color constant</short>
<short>TColor used for the clDefault color constant.</short>
<descr>
<p>
<var>DefaultColorColor</var> is a <var>TColor</var> property with the value used for the <var>clDefault</var> color constant.
@ -1160,7 +1160,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TCustomColorListBox.NoneColorColor">
<short>TColor used for the clNone color constant</short>
<short>TColor used for the clNone color constant.</short>
<descr>
<p>
<var>NoneColorColor</var> is a <var>TColor</var> property with the color value used for the <var>clNone</var> color constant.
@ -1189,7 +1189,7 @@ if iPos &lt;&gt; -1 then
<element name="TCustomColorListBox.OnGetColors">
<short>
<var>OnGetColors</var> - event handler for the instruction to get colors
<var>OnGetColors</var> - event handler for the instruction to get colors.
</short>
<descr>
<p>
@ -1226,7 +1226,7 @@ if iPos &lt;&gt; -1 then
</element>
<element name="TColorListBox">
<short>Implements a list box control used to display and select color names and values</short>
<short>Implements a list box control used to display and select color names and values.</short>
<descr>
<p>
<var>TColorListBox</var> is a <var>TCustomColorListBox</var> descendant which implements a list box control used to display and select color names and values. Each item in the control has a small rectangle where the color is displayed (swatch) and the color name.
@ -1315,7 +1315,7 @@ if iPos &lt;&gt; -1 then
<element name="TColorListBox.Visible" link="#lcl.stdctrls.TCustomListBox.Visible"/>
<element name="Register">
<short>Register components for use in the Lazarus IDE</short>
<short>Register components for use in the Lazarus IDE.</short>
<descr>
<p>
The following components are added to the Lazarus IDE component palette:

538
docs/xml/lcl/comboex.xml
View File

File diff suppressed because it is too large Load Diff

4024
docs/xml/lcl/comctrls.xml
View File

File diff suppressed because it is too large Load Diff