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

Docs (LazControls, RTTIControls): added missing punctuation in short descriptions, patch by Don, bug #39018

Browse Source 
git-svn-id: trunk@65278 -
This commit is contained in:
maxim 2021-06-18 20:55:37 +00:00
parent 8dda499a54
commit 79264e3cc9
13 changed files with 1425 additions and 1411 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitattributes vendored
View File

@ -4425,7 +4425,7 @@ components/rtticontrols/examples/exampleproject3.lpr svneol=native#text/pascal
components/rtticontrols/examples/exampleprojectgrid1.lpi svneol=native#text/plain components/rtticontrols/examples/exampleprojectgrid1.lpi svneol=native#text/plain
components/rtticontrols/examples/exampleprojectgrid1.lpr svneol=native#text/pascal components/rtticontrols/examples/exampleprojectgrid1.lpr svneol=native#text/pascal
components/rtticontrols/fpdoc/rttictrls.xml svneol=native#text/plain components/rtticontrols/fpdoc/rttictrls.xml svneol=native#text/plain
components/rtticontrols/fpdoc/rttigrids.xml -text svneol=native#text/plain components/rtticontrols/fpdoc/rttigrids.xml svneol=native#text/plain
components/rtticontrols/images-copyright.txt svneol=native#text/plain components/rtticontrols/images-copyright.txt svneol=native#text/plain
components/rtticontrols/rttictrls.bat svneol=native#text/x-msdos-program components/rtticontrols/rttictrls.bat svneol=native#text/x-msdos-program
components/rtticontrols/rttictrls.pas svneol=native#text/pascal components/rtticontrols/rttictrls.pas svneol=native#text/pascal

150
components/lazcontrols/docs/checkboxthemed.xml
View File

@ -2,7 +2,7 @@
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="LazControls"> <package name="LazControls">
<module name="CheckBoxThemed"> <module name="CheckBoxThemed">
<short>Implements a custom-drawn check box control drawn using theme services</short> <short>Implements a custom-drawn check box control drawn using theme services.</short>
<descr> <descr>
<p> <p>
<file>checkboxthemed.pas</file> contains classes used to implements a custom-drawn check box control drawn using theme services. <file>checkboxthemed.pas</file> contains classes used to implements a custom-drawn check box control drawn using theme services.
@ -27,7 +27,7 @@
<element name="LazMethodList"/> <element name="LazMethodList"/>
<element name="TCheckBoxThemedActionLink"> <element name="TCheckBoxThemedActionLink">
<short>Provides a link between a themed check box control and its action</short> <short>Provides a link between a themed check box control and its action.</short>
<descr> <descr>
<p> <p>
<var>TCheckBoxThemedActionLink</var> is a <var>TWinControlActionLink</var> descendant which maintains a link between a <var>TCustomCheckBoxThemed</var> class instance and its <var>Action</var>. It provides overridden methods that use TCustomCheckBoxThemed as the internal client for the link, and maintains the checked state for the client control when the Action is linked and executed. <var>TCheckBoxThemedActionLink</var> is a <var>TWinControlActionLink</var> descendant which maintains a link between a <var>TCustomCheckBoxThemed</var> class instance and its <var>Action</var>. It provides overridden methods that use TCustomCheckBoxThemed as the internal client for the link, and maintains the checked state for the client control when the Action is linked and executed.
@ -44,7 +44,7 @@
<element name="TCheckBoxThemedActionLink.FClientCheckBoxThemed"/> <element name="TCheckBoxThemedActionLink.FClientCheckBoxThemed"/>
<element name="TCheckBoxThemedActionLink.AssignClient"> <element name="TCheckBoxThemedActionLink.AssignClient">
<short>Sets the control used as the client in the action link</short> <short>Sets the control used as the client in the action link.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -53,7 +53,7 @@
</element> </element>
<element name="TCheckBoxThemedActionLink.SetChecked"> <element name="TCheckBoxThemedActionLink.SetChecked">
<short>Sets the value in Checked for the client control when linked</short> <short>Sets the value in Checked for the client control when linked.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -64,19 +64,19 @@
<!-- public methods --> <!-- public methods -->
<element name="TCheckBoxThemedActionLink.IsCheckedLinked"> <element name="TCheckBoxThemedActionLink.IsCheckedLinked">
<short> <short>
Determines if an Action is linked to the client control and if the Checked values are in sync Determines if an Action is linked to the client control and if the Checked values are in sync.
</short> </short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCheckBoxThemedActionLink.IsCheckedLinked.Result"> <element name="TCheckBoxThemedActionLink.IsCheckedLinked.Result">
<short> <short>
True when an Action exists for the client control and they share the same Checked value True when an Action exists for the client control and they share the same Checked value.
</short> </short>
</element> </element>
<element name="TCheckBoxThemedActionLinkClass"> <element name="TCheckBoxThemedActionLinkClass">
<short>Class type used to create new instances of TCheckBoxThemedActionLink</short> <short>Class type used to create new instances of TCheckBoxThemedActionLink.</short>
<descr> <descr>
<p> <p>
<var>TCheckBoxThemedActionLinkClass</var> is a <var>TCheckBoxThemedActionLink</var> class type. <var>TCheckBoxThemedActionLinkClass</var> is a <var>TCheckBoxThemedActionLink</var> class type.
@ -88,7 +88,7 @@
</element> </element>
<element name="TCustomCheckBoxThemed"> <element name="TCustomCheckBoxThemed">
<short>Implements the base class for a custom-drawn check box control</short> <short>Implements the base class for a custom-drawn check box control.</short>
<descr> <descr>
<p> <p>
<var>TCustomCheckBoxThemed</var> is a <var>TCustomControl</var> descendant which implements the base class for a custom-drawn check box control. <var>TCustomCheckBoxThemed</var> is a <var>TCustomControl</var> descendant which implements the base class for a custom-drawn check box control.
@ -112,50 +112,50 @@
<element name="TCustomCheckBoxThemed.FState"/> <element name="TCustomCheckBoxThemed.FState"/>
<element name="TCustomCheckBoxThemed.GetChecked"> <element name="TCustomCheckBoxThemed.GetChecked">
<short>Gets the value for the Check property</short> <short>Gets the value for the Check property.</short>
<seealso> <seealso>
<link id="TCustomCheckBoxThemed.Checked"/> <link id="TCustomCheckBoxThemed.Checked"/>
</seealso> </seealso>
</element> </element>
<element name="TCustomCheckBoxThemed.GetChecked.Result"> <element name="TCustomCheckBoxThemed.GetChecked.Result">
<short>Value for the property</short> <short>Value for the property.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.SetAlignment"> <element name="TCustomCheckBoxThemed.SetAlignment">
<short>Sets the value for the Alignment property</short> <short>Sets the value for the Alignment property.</short>
<seealso> <seealso>
<link id="TCustomCheckBoxThemed.Alignment"/> <link id="TCustomCheckBoxThemed.Alignment"/>
</seealso> </seealso>
</element> </element>
<element name="TCustomCheckBoxThemed.SetAlignment.AValue"> <element name="TCustomCheckBoxThemed.SetAlignment.AValue">
<short>New value for the property</short> <short>New value for the property.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.SetCheckBoxHovered"> <element name="TCustomCheckBoxThemed.SetCheckBoxHovered">
<short>Sets an internal flag used to track mouse hover, and redraws the control</short> <short>Sets an internal flag used to track mouse hover, and redraws the control.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.SetCheckBoxHovered.AValue"> <element name="TCustomCheckBoxThemed.SetCheckBoxHovered.AValue">
<short>New value for the internal flag</short> <short>New value for the internal flag.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.SetChecked"> <element name="TCustomCheckBoxThemed.SetChecked">
<short>Sets the value for the Checked property</short> <short>Sets the value for the Checked property.</short>
<seealso> <seealso>
<link id="TCustomCheckBoxThemed.Checked"/> <link id="TCustomCheckBoxThemed.Checked"/>
</seealso> </seealso>
</element> </element>
<element name="TCustomCheckBoxThemed.SetChecked.AValue"> <element name="TCustomCheckBoxThemed.SetChecked.AValue">
<short>New value for the property</short> <short>New value for the property.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.SetState"> <element name="TCustomCheckBoxThemed.SetState">
<short>Sets the value for the State property</short> <short>Sets the value for the State property.</short>
<seealso> <seealso>
<link id="TCustomCheckBoxThemed.State"/> <link id="TCustomCheckBoxThemed.State"/>
</seealso> </seealso>
</element> </element>
<element name="TCustomCheckBoxThemed.SetState.AValue"> <element name="TCustomCheckBoxThemed.SetState.AValue">
<short>New value for the property</short> <short>New value for the property.</short>
</element> </element>
<!-- private class members --> <!-- private class members -->
@ -164,44 +164,44 @@
<!-- protected members, methods, properties, and constants --> <!-- protected members, methods, properties, and constants -->
<element name="TCustomCheckBoxThemed.GetCheckBoxSize"> <element name="TCustomCheckBoxThemed.GetCheckBoxSize">
<short> <short>
Gets the dimensions for the check box in the control scaled to the given display density Gets the dimensions for the check box in the control scaled to the given display density.
</short> </short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.GetCheckBoxSize.Result"> <element name="TCustomCheckBoxThemed.GetCheckBoxSize.Result">
<short>TSize instance with the dimensions for the check box</short> <short>TSize instance with the dimensions for the check box.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.GetCheckBoxSize.PixelsPerInch"> <element name="TCustomCheckBoxThemed.GetCheckBoxSize.PixelsPerInch">
<short>Design-time PPI setting used to scale to the PPI setting for the screen</short> <short>Design-time PPI setting used to scale to the PPI setting for the screen.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.CheckBoxPressed"> <element name="TCustomCheckBoxThemed.CheckBoxPressed">
<short>Internal flag used to track key or mouse state in the control</short> <short>Internal flag used to track key or mouse state in the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.KnobPosUnchecked"> <element name="TCustomCheckBoxThemed.KnobPosUnchecked">
<short>Not used in the current implementation</short> <short>Not used in the current implementation.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.KnobPosChecked"> <element name="TCustomCheckBoxThemed.KnobPosChecked">
<short>Not used in the current implementation</short> <short>Not used in the current implementation.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.KnobPosGrayed"> <element name="TCustomCheckBoxThemed.KnobPosGrayed">
<short>Not used in the current implementation</short> <short>Not used in the current implementation.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.CalculatePreferredSize"> <element name="TCustomCheckBoxThemed.CalculatePreferredSize">
<short>Calculates the preferred height and width for the control</short> <short>Calculates the preferred height and width for the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -216,21 +216,21 @@
</element> </element>
<element name="TCustomCheckBoxThemed.CMBiDiModeChanged"> <element name="TCustomCheckBoxThemed.CMBiDiModeChanged">
<short>Handles the CM_BIDIMODECHANGED control message</short> <short>Handles the CM_BIDIMODECHANGED control message.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.CMBiDiModeChanged.Message"> <element name="TCustomCheckBoxThemed.CMBiDiModeChanged.Message">
<short>Control message examined in the method</short> <short>Control message examined in the method.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.CMEnabledChanged"> <element name="TCustomCheckBoxThemed.CMEnabledChanged">
<short>Handles the CM_ENABLEDCHANGED control message</short> <short>Handles the CM_ENABLEDCHANGED control message.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.CMEnabledChanged.Message"> <element name="TCustomCheckBoxThemed.CMEnabledChanged.Message">
<short>Control message examined in the method</short> <short>Control message examined in the method.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.InitCheckBoxSize"> <element name="TCustomCheckBoxThemed.InitCheckBoxSize">
@ -240,37 +240,37 @@
</element> </element>
<element name="TCustomCheckBoxThemed.DialogChar"> <element name="TCustomCheckBoxThemed.DialogChar">
<short>Handles a message with an accelerator key for the control</short> <short>Handles a message with an accelerator key for the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.DialogChar.Result"> <element name="TCustomCheckBoxThemed.DialogChar.Result">
<short>True when the key is handled in the method</short> <short>True when the key is handled in the method.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.DialogChar.Message"> <element name="TCustomCheckBoxThemed.DialogChar.Message">
<short>Message with the key event examined in the method</short> <short>Message with the key event examined in the method.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.DoClick"> <element name="TCustomCheckBoxThemed.DoClick">
<short>Performs actions needed when the control is clicked</short> <short>Performs actions needed when the control is clicked.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.DoEnter"> <element name="TCustomCheckBoxThemed.DoEnter">
<short>Performs actions needed when the control is entered (receives input focus)</short> <short>Performs actions needed when the control is entered (receives input focus).</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.DoExit"> <element name="TCustomCheckBoxThemed.DoExit">
<short>Performs actions needed when the control is exited (loses input focus)</short> <short>Performs actions needed when the control is exited (loses input focus).</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.GetActionLinkClass"> <element name="TCustomCheckBoxThemed.GetActionLinkClass">
<short>Gets the class reference used to create the action link for the control</short> <short>Gets the class reference used to create the action link for the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -279,31 +279,31 @@
</element> </element>
<element name="TCustomCheckBoxThemed.KeyDown"> <element name="TCustomCheckBoxThemed.KeyDown">
<short>Handles key down events for the control</short> <short>Handles key down events for the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.KeyDown.Key"> <element name="TCustomCheckBoxThemed.KeyDown.Key">
<short>Key code examined in method</short> <short>Key code examined in method.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.KeyDown.Shift"> <element name="TCustomCheckBoxThemed.KeyDown.Shift">
<short>Shift, Alt, or Ctrl modifier for the key</short> <short>Shift, Alt, or Ctrl modifier for the key.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.KeyUp"> <element name="TCustomCheckBoxThemed.KeyUp">
<short>Handles key up events for the control</short> <short>Handles key up events for the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.KeyUp.Key"> <element name="TCustomCheckBoxThemed.KeyUp.Key">
<short>Key code examined in method</short> <short>Key code examined in method.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.KeyUp.Shift"> <element name="TCustomCheckBoxThemed.KeyUp.Shift">
<short>Shift, Alt, or Ctrl modifier for the key</short> <short>Shift, Alt, or Ctrl modifier for the key.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.MouseDown"> <element name="TCustomCheckBoxThemed.MouseDown">
<short>Handles mouse down events for the control</short> <short>Handles mouse down events for the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -321,19 +321,19 @@
</element> </element>
<element name="TCustomCheckBoxThemed.MouseEnter"> <element name="TCustomCheckBoxThemed.MouseEnter">
<short>Handles hover state when the mouse cursor enters the control</short> <short>Handles hover state when the mouse cursor enters the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.MouseLeave"> <element name="TCustomCheckBoxThemed.MouseLeave">
<short>Handles hover state when the mouse cursor leaves the control</short> <short>Handles hover state when the mouse cursor leaves the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.MouseUp"> <element name="TCustomCheckBoxThemed.MouseUp">
<short>Handles mouse up events for the control</short> <short>Handles mouse up events for the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -351,7 +351,7 @@
</element> </element>
<element name="TCustomCheckBoxThemed.Paint"> <element name="TCustomCheckBoxThemed.Paint">
<short>Draws the control</short> <short>Draws the control.</short>
<descr> <descr>
<p> <p>
<var>Paint</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method to signal the default <var>OnPaint</var> event handler (when assigned). It calls <var>PaintSelf</var> which implements the custom drawing method used for the themed check box control. <var>Paint</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method to signal the default <var>OnPaint</var> event handler (when assigned). It calls <var>PaintSelf</var> which implements the custom drawing method used for the themed check box control.
@ -364,7 +364,7 @@
</element> </element>
<element name="TCustomCheckBoxThemed.TextChanged"> <element name="TCustomCheckBoxThemed.TextChanged">
<short>Redraws the control when the caption has been changed</short> <short>Redraws the control when the caption has been changed.</short>
<descr/> <descr/>
<seealso> <seealso>
<link id="TCustomCheckBoxThemed.Invalidate"/> <link id="TCustomCheckBoxThemed.Invalidate"/>
@ -373,45 +373,45 @@
</element> </element>
<element name="TCustomCheckBoxThemed.WMSize"> <element name="TCustomCheckBoxThemed.WMSize">
<short>Handles the WM_SIZE message for the control and redraws the control</short> <short>Handles the WM_SIZE message for the control and redraws the control.</short>
<descr/> <descr/>
<seealso> <seealso>
<link id="#lcl.controls.TWinControl.WMSize">TWinControl.WMSize</link> <link id="#lcl.controls.TWinControl.WMSize">TWinControl.WMSize</link>
</seealso> </seealso>
</element> </element>
<element name="TCustomCheckBoxThemed.WMSize.Message"> <element name="TCustomCheckBoxThemed.WMSize.Message">
<short>Window message examined in the method</short> <short>Window message examined in the method.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.CheckBoxHovered"> <element name="TCustomCheckBoxThemed.CheckBoxHovered">
<short>Protected property used to track mouse hover for the control</short> <short>Protected property used to track mouse hover for the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.CheckFromAction"> <element name="TCustomCheckBoxThemed.CheckFromAction">
<short> <short>
Protected property used to track the Checked state in the ActionLink/Action for the control Protected property used to track the Checked state in the ActionLink/Action for the control.
</short> </short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.cFocusBorder"> <element name="TCustomCheckBoxThemed.cFocusBorder">
<short>Internal constant with the space reserved for the focus border in the control</short> <short>Internal constant with the space reserved for the focus border in the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomCheckBoxThemed.cIndent"> <element name="TCustomCheckBoxThemed.cIndent">
<short>Internal constant with the space reserved for padding in the control</short> <short>Internal constant with the space reserved for padding in the control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- public methods and propeties --> <!-- public methods and propeties -->
<element name="TCustomCheckBoxThemed.PaintSelf"> <element name="TCustomCheckBoxThemed.PaintSelf">
<short>Renders a check box control using the specified parameters</short> <short>Renders a check box control using the specified parameters.</short>
<descr> <descr>
<p> <p>
<var>PaintSelf</var> is a class method used to render a custom-drawn check box control using the parameters passed to the method. <var>PaintSelf</var> is a class method used to render a custom-drawn check box control using the parameters passed to the method.
@ -432,38 +432,38 @@
</seealso> </seealso>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.ACanvas"> <element name="TCustomCheckBoxThemed.PaintSelf.ACanvas">
<short>Canvas for a check box control</short> <short>Canvas for a check box control.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.ACaption"> <element name="TCustomCheckBoxThemed.PaintSelf.ACaption">
<short>Caption text for a check box control</short> <short>Caption text for a check box control.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.ARect"> <element name="TCustomCheckBoxThemed.PaintSelf.ARect">
<short>Rectangle with the coordinates for a check box control</short> <short>Rectangle with the coordinates for a check box control.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.AState"> <element name="TCustomCheckBoxThemed.PaintSelf.AState">
<short>Checked state for a check box control</short> <short>Checked state for a check box control.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.ARightToLeft"> <element name="TCustomCheckBoxThemed.PaintSelf.ARightToLeft">
<short>Alignment for caption in the check box control</short> <short>Alignment for caption in the check box control.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.AHovered"> <element name="TCustomCheckBoxThemed.PaintSelf.AHovered">
<short>True if the mouse is hovered over the check box control</short> <short>True if the mouse is hovered over the check box control.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.APressed"> <element name="TCustomCheckBoxThemed.PaintSelf.APressed">
<short>True if the check box control is in the pressed state (mouse down)</short> <short>True if the check box control is in the pressed state (mouse down).</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.AFocused"> <element name="TCustomCheckBoxThemed.PaintSelf.AFocused">
<short>True if the check box control has input focus</short> <short>True if the check box control has input focus.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.AAlignment"> <element name="TCustomCheckBoxThemed.PaintSelf.AAlignment">
<short>Left-to-Right alignment for the content in the check box control</short> <short>Left-to-Right alignment for the content in the check box control.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.PaintSelf.AEnabled"> <element name="TCustomCheckBoxThemed.PaintSelf.AEnabled">
<short>True if the control is drawn in the enabled state</short> <short>True if the control is drawn in the enabled state.</short>
</element> </element>
<element name="TCustomCheckBoxThemed.Create"> <element name="TCustomCheckBoxThemed.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create sets the accessibility role and control style flags needed for the control. Create also sets the default values for properties, including: <var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create sets the accessibility role and control style flags needed for the control. Create also sets the default values for properties, including:
@ -483,7 +483,7 @@
</element> </element>
<element name="TCustomCheckBoxThemed.Alignment"> <element name="TCustomCheckBoxThemed.Alignment">
<short>Horizontal alignment for the caption text in the control</short> <short>Horizontal alignment for the caption text in the control.</short>
<descr> <descr>
<p> <p>
<var>Alignment</var> is a <var>TLeftRight</var> property which contains the horizontal alignment used for the control. <var>Alignment</var> is a <var>TLeftRight</var> property which contains the horizontal alignment used for the control.
@ -504,7 +504,7 @@
</element> </element>
<element name="TCustomCheckBoxThemed.AllowGrayed"> <element name="TCustomCheckBoxThemed.AllowGrayed">
<short>Indicates if the control can use the "grayed" state</short> <short>Indicates if the control can use the "grayed" state.</short>
<descr> <descr>
<p> <p>
<var>AllowGrayed</var> is a <var>Boolean</var> property which indicates if the control can be displayed using its "grayed" state. This indicates that the control is disabled or has an undetermined state value. The default value for the property is <b>False</b>. <var>AllowGrayed</var> is a <var>Boolean</var> property which indicates if the control can be displayed using its "grayed" state. This indicates that the control is disabled or has an undetermined state value. The default value for the property is <b>False</b>.
@ -522,7 +522,7 @@
</element> </element>
<element name="TCustomCheckBoxThemed.Checked"> <element name="TCustomCheckBoxThemed.Checked">
<short>Provides access to the checked state for the control as a Boolean value</short> <short>Provides access to the checked state for the control as a Boolean value.</short>
<descr> <descr>
<p> <p>
<var>Checked</var> is a <var>Boolean</var> property used to read or write the checked or unchecked state for the control as a Boolean value. <var>Checked</var> is a <var>Boolean</var> property used to read or write the checked or unchecked state for the control as a Boolean value.
@ -544,7 +544,9 @@
</element> </element>
<element name="TCustomCheckBoxThemed.State"> <element name="TCustomCheckBoxThemed.State">
<short>Contains the checked, unchecked, or grayed state for the check box control</short> <short>
Contains the checked, unchecked, or grayed state for the check box control.
</short>
<descr> <descr>
<p> <p>
<var>State</var> is a <var>TCheckBoxState</var> property which contains the checked, unchecked, or grayed state for the check box control. The default value for the property is <var>cbUnchecked</var>. <var>State</var> is a <var>TCheckBoxState</var> property which contains the checked, unchecked, or grayed state for the check box control. The default value for the property is <var>cbUnchecked</var>.
@ -588,7 +590,7 @@
</element> </element>
<element name="TCustomCheckBoxThemed.OnChange"> <element name="TCustomCheckBoxThemed.OnChange">
<short>Event handler signalled when the value for the control is changed</short> <short>Event handler signalled when the value for the control is changed.</short>
<descr> <descr>
<p> <p>
<var>OnChange</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the value for the control is changed. <var>OnChange</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the value for the control is changed.
@ -612,7 +614,7 @@
</element> </element>
<element name="TCheckBoxThemed" link="#lazcontrols.checkboxthemed.TCustomCheckBoxThemed"> <element name="TCheckBoxThemed" link="#lazcontrols.checkboxthemed.TCustomCheckBoxThemed">
<short>Implements a custom-drawn check box control</short> <short>Implements a custom-drawn check box control.</short>
<descr> <descr>
<p> <p>
<var>TCheckBoxThemed</var> is a <var>TCustomCheckBoxThemed</var> descendant which implements a custom-drawn check box control. It implements a custom paint method to render the control using theme services. TCheckBoxThemed is the type used to implement check box controls used in both the Object Inspector and Property editors in the Lazarus IDE. <var>TCheckBoxThemed</var> is a <var>TCustomCheckBoxThemed</var> descendant which implements a custom-drawn check box control. It implements a custom paint method to render the control using theme services. TCheckBoxThemed is the type used to implement check box controls used in both the Object Inspector and Property editors in the Lazarus IDE.

4
components/lazcontrols/docs/dividerbevel.xml
View File

@ -195,7 +195,7 @@
<!-- public methods --> <!-- public methods -->
<element name="TDividerBevel.Create"> <element name="TDividerBevel.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the overridden constructor for the class instance. Create is the overridden constructor for the class instance.
@ -204,7 +204,7 @@
<seealso/> <seealso/>
</element> </element>
<element name="TDividerBevel.Create.AOwner"> <element name="TDividerBevel.Create.AOwner">
<short>Owner of the class instance</short> <short>Owner of the class instance.</short>
</element> </element>
<element name="TDividerBevel.ShouldAutoAdjust"> <element name="TDividerBevel.ShouldAutoAdjust">

2
components/lazcontrols/docs/extendednotebook.xml
View File

@ -329,7 +329,7 @@
<!-- public methods and properties --> <!-- public methods and properties -->
<element name="TExtendedNotebook.Create"> <element name="TExtendedNotebook.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the overridden constructor for the class instance. Create is the overridden constructor for the class instance.

18
components/lazcontrols/docs/extendedtabcontrols.xml
View File

@ -66,7 +66,7 @@
<!-- public methods --> <!-- public methods -->
<element name="TExtendedTabToolbar.Create"> <element name="TExtendedTabToolbar.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the overridden constructor for the class instance. Create is the overridden constructor for the class instance.
@ -390,7 +390,7 @@
<!-- public --> <!-- public -->
<element name="TToolbarWrapper.Create"> <element name="TToolbarWrapper.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
<var>Create</var> is the constructor for the class instance. <var>Create</var> is the constructor for the class instance.
@ -412,7 +412,7 @@
</element> </element>
<element name="TToolbarWrapper.ButtonCount"> <element name="TToolbarWrapper.ButtonCount">
<short>Number of tool buttons in the Buttons property</short> <short>Number of tool buttons in the Buttons property.</short>
<descr> <descr>
<p> <p>
<var>ButtonCount</var> is a read-only <var>Integer</var> property which contains the number of tool buttons available in the Buttons property. <var>ButtonCount</var> is a read-only <var>Integer</var> property which contains the number of tool buttons available in the Buttons property.
@ -434,7 +434,7 @@
<seealso/> <seealso/>
</element> </element>
<element name="TToolbarWrapper.Buttons.Index"> <element name="TToolbarWrapper.Buttons.Index">
<short>Ordinal position for the requested tool button</short> <short>Ordinal position for the requested tool button.</short>
</element> </element>
<element name="TToolbarWrapper.ButtonList"> <element name="TToolbarWrapper.ButtonList">
@ -475,7 +475,7 @@
</element> </element>
<element name="TToolbarWrapper.EdgeInner"> <element name="TToolbarWrapper.EdgeInner">
<short>Drawing styleused for the inner edge of the tool bar</short> <short>Drawing styleused for the inner edge of the tool bar.</short>
<descr> <descr>
<p> <p>
<var>EdgeInner</var> is a <var>TEdgeStyle</var> property which indicates the drawing style used for the inner edge of the tool bar. The default value for the property is <var>esRaised</var>. <var>EdgeInner</var> is a <var>TEdgeStyle</var> property which indicates the drawing style used for the inner edge of the tool bar. The default value for the property is <var>esRaised</var>.
@ -612,7 +612,7 @@
</element> </element>
<element name="TExtendedInternalTabControl"> <element name="TExtendedInternalTabControl">
<short>Internal TabControl used to display tabs</short> <short>Internal TabControl used to display tabs.</short>
<descr> <descr>
<p> <p>
<var>TExtendedInternalTabControl</var> is a <var>TNoteBookStringsTabControl</var> descendant. <var>TExtendedInternalTabControl</var> is a <var>TNoteBookStringsTabControl</var> descendant.
@ -631,7 +631,7 @@
</element> </element>
<element name="TExtendedTabControlNoteBookStrings"> <element name="TExtendedTabControlNoteBookStrings">
<short>List of tabs (and pages) used in TCustomExtendedTabControl</short> <short>List of tabs (and pages) used in TCustomExtendedTabControl.</short>
<descr> <descr>
<p> <p>
<var>TExtendedTabControlNoteBookStrings</var> is a <var>TTabControlNoteBookStrings</var> descendant. <var>TExtendedTabControlNoteBookStrings</var> is a <var>TTabControlNoteBookStrings</var> descendant.
@ -665,7 +665,7 @@
<seealso/> <seealso/>
</element> </element>
<element name="TExtendedTabControlNoteBookStrings.GetInternalTabControllClass.Result"> <element name="TExtendedTabControlNoteBookStrings.GetInternalTabControllClass.Result">
<short>Returns a TExtendedInternalTabControl type</short> <short>Returns a TExtendedInternalTabControl type.</short>
</element> </element>
<element name="TExtendedTabControlNoteBookStrings.SetToolbar"> <element name="TExtendedTabControlNoteBookStrings.SetToolbar">
@ -797,7 +797,7 @@
</element> </element>
<element name="TExtendedTabSheet"> <element name="TExtendedTabSheet">
<short>Class type used for Pages in TCustomExtendedTabControl</short> <short>Class type used for Pages in TCustomExtendedTabControl.</short>
<descr> <descr>
<p> <p>
Implements the class reference used for the <var>PageClass</var> and <var>Pages</var> properties in <var>TCustomExtendedTabControl</var>. Implements the class reference used for the <var>PageClass</var> and <var>Pages</var> properties in <var>TCustomExtendedTabControl</var>.

30
components/lazcontrols/docs/listfilteredit.xml
View File

@ -3,7 +3,7 @@
<package name="LazControls"> <package name="LazControls">
<module name="ListFilterEdit"> <module name="ListFilterEdit">
<short>Implements a control used to filter an associated list box</short> <short>Implements a control used to filter an associated list box.</short>
<descr/> <descr/>
<!-- unresolved external references --> <!-- unresolved external references -->
@ -38,7 +38,7 @@
</element> </element>
<element name="TListFilterEdit"> <element name="TListFilterEdit">
<short>Filter for an associated ListBox</short> <short>Filter for an associated ListBox.</short>
<descr> <descr>
<p> <p>
TListFilterEdit is a TCustomControlFilterEdit descendant which implements a filter for an associated ListBox. TListFilterEdit is a TCustomControlFilterEdit descendant which implements a filter for an associated ListBox.
@ -49,23 +49,23 @@
<!-- private members and methods --> <!-- private members and methods -->
<element name="TListFilterEdit.FFilteredListbox"> <element name="TListFilterEdit.FFilteredListbox">
<short>The control showing the filtered data</short> <short>The control showing the filtered data.</short>
</element> </element>
<element name="TListFilterEdit.FSelectionList"> <element name="TListFilterEdit.FSelectionList">
<short>Stores / restores the selections in the associated control</short> <short>Stores / restores the selections in the associated control.</short>
</element> </element>
<element name="TListFilterEdit.FOriginalData"> <element name="TListFilterEdit.FOriginalData">
<short>The orignal value supplied in the Data property</short> <short>The orignal value supplied in the Data property.</short>
</element> </element>
<element name="TListFilterEdit.FSortedData"> <element name="TListFilterEdit.FSortedData">
<short>Sorted values from the Data property</short> <short>Sorted values from the Data property.</short>
</element> </element>
<element name="TListFilterEdit.FCheckedItems"> <element name="TListFilterEdit.FCheckedItems">
<short>Contains the checked items for TCheckListBox</short> <short>Contains the checked items for TCheckListBox.</short>
</element> </element>
<element name="TListFilterEdit.CompareFNs"> <element name="TListFilterEdit.CompareFNs">
@ -82,10 +82,10 @@
</element> </element>
<element name="TListFilterEdit.SetFilteredListbox"> <element name="TListFilterEdit.SetFilteredListbox">
<short>Sets the value for the FilteredListbox property</short> <short>Sets the value for the FilteredListbox property.</short>
</element> </element>
<element name="TListFilterEdit.SetFilteredListbox.AValue"> <element name="TListFilterEdit.SetFilteredListbox.AValue">
<short>New value for the property</short> <short>New value for the property.</short>
</element> </element>
<!-- protected methods --> <!-- protected methods -->
@ -199,7 +199,7 @@
<!-- public methods --> <!-- public methods -->
<element name="TListFilterEdit.Create"> <element name="TListFilterEdit.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the overridden constructor for the class instance. Create is the overridden constructor for the class instance.
@ -208,11 +208,11 @@
<seealso/> <seealso/>
</element> </element>
<element name="TListFilterEdit.Create.AOwner"> <element name="TListFilterEdit.Create.AOwner">
<short>Owner for the class instance</short> <short>Owner for the class instance.</short>
</element> </element>
<element name="TListFilterEdit.Destroy"> <element name="TListFilterEdit.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
Destroy is the overridden destructor for the class instance. Destroy is the overridden destructor for the class instance.
@ -222,12 +222,12 @@
</element> </element>
<element name="TListFilterEdit.RemoveItem"> <element name="TListFilterEdit.RemoveItem">
<short>Removes the specified item from the Items property</short> <short>Removes the specified item from the Items property.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TListFilterEdit.RemoveItem.AItem"> <element name="TListFilterEdit.RemoveItem.AItem">
<short>Item located and removed in the method</short> <short>Item located and removed in the method.</short>
</element> </element>
<element name="TListFilterEdit.ItemWasClicked"> <element name="TListFilterEdit.ItemWasClicked">
@ -269,7 +269,7 @@
<!-- published properties --> <!-- published properties -->
<element name="TListFilterEdit.FilteredListbox"> <element name="TListFilterEdit.FilteredListbox">
<short>The Listbox associated with the filter edit control</short> <short>The Listbox associated with the filter edit control.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>

30
components/lazcontrols/docs/listviewfilteredit.xml
View File

@ -42,7 +42,9 @@
</element> </element>
<element name="TListViewDataItem.OperatorEqual"> <element name="TListViewDataItem.OperatorEqual">
<short>Implements the Equal (=) comparison operator for TListViewDataItem instances</short> <short>
Implements the Equal (=) comparison operator for TListViewDataItem instances.
</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -57,7 +59,7 @@
</element> </element>
<element name="TListViewDataList"> <element name="TListViewDataList">
<short>List container for TListViewDataItem instances</short> <short>List container for TListViewDataItem instances.</short>
<descr/> <descr/>
<seealso> <seealso>
<link id="#fcl.Fgl.TFPGList"/> <link id="#fcl.Fgl.TFPGList"/>
@ -66,14 +68,14 @@
</element> </element>
<element name="TListViewFilterEdit"> <element name="TListViewFilterEdit">
<short>Implements a control used to filter an associated ListView</short> <short>Implements a control used to filter an associated ListView.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- private members and methods --> <!-- private members and methods -->
<element name="TListViewFilterEdit.FFilteredListview"> <element name="TListViewFilterEdit.FFilteredListview">
<short>A control showing the (filtered) data</short> <short>A control showing the (filtered) data.</short>
</element> </element>
<element name="TListViewFilterEdit.FByAllFields"> <element name="TListViewFilterEdit.FByAllFields">
@ -81,15 +83,15 @@
</element> </element>
<element name="TListViewFilterEdit.FSelectionList"> <element name="TListViewFilterEdit.FSelectionList">
<short>Stores / restores the previous selections in the associated control</short> <short>Stores / restores the previous selections in the associated control.</short>
</element> </element>
<element name="TListViewFilterEdit.FOriginalData"> <element name="TListViewFilterEdit.FOriginalData">
<short>Data supplied by the caller through the Items property</short> <short>Data supplied by the caller through the Items property.</short>
</element> </element>
<element name="TListViewFilterEdit.FFilteredData"> <element name="TListViewFilterEdit.FFilteredData">
<short>Data sorted for viewing</short> <short>Data sorted for viewing.</short>
</element> </element>
<element name="TListViewFilterEdit.MatchesFilter"> <element name="TListViewFilterEdit.MatchesFilter">
@ -229,7 +231,7 @@
<!-- public methods and properties --> <!-- public methods and properties -->
<element name="TListViewFilterEdit.Create"> <element name="TListViewFilterEdit.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the overridden constructor for the class instance. Create is the overridden constructor for the class instance.
@ -238,11 +240,11 @@
<seealso/> <seealso/>
</element> </element>
<element name="TListViewFilterEdit.Create.AOwner"> <element name="TListViewFilterEdit.Create.AOwner">
<short>Owner of the class instance</short> <short>Owner of the class instance.</short>
</element> </element>
<element name="TListViewFilterEdit.Destroy"> <element name="TListViewFilterEdit.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
Destroy is the overridden destructor for the class instance. Destroy is the overridden destructor for the class instance.
@ -264,7 +266,7 @@
</element> </element>
<element name="TListViewFilterEdit.SelectionList"> <element name="TListViewFilterEdit.SelectionList">
<short>Selected items restored after filtering</short> <short>Selected items restored after filtering.</short>
<descr> <descr>
<p> <p>
The list of selected items. They are restored after filtering. The list of selected items. They are restored after filtering.
@ -274,20 +276,20 @@
</element> </element>
<element name="TListViewFilterEdit.Items"> <element name="TListViewFilterEdit.Items">
<short>Maintains the data which is filtered and shown in the ListView</short> <short>Maintains the data which is filtered and shown in the ListView.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- published properties --> <!-- published properties -->
<element name="TListViewFilterEdit.FilteredListview"> <element name="TListViewFilterEdit.FilteredListview">
<short>The associated ListView</short> <short>The associated ListView.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TListViewFilterEdit.ByAllFields"> <element name="TListViewFilterEdit.ByAllFields">
<short>Indicates if all fields are compared using the filter</short> <short>Indicates if all fields are compared using the filter.</short>
<descr> <descr>
<p> <p>
Use all ListView fields when searching filter matches. Otherwise just the first field (ListView caption) is used. Use all ListView fields when searching filter matches. Otherwise just the first field (ListView caption) is used.

94
components/lazcontrols/docs/lvlgraphctrl.xml
View File

@ -3,7 +3,7 @@
<package name="LazControls"> <package name="LazControls">
<!-- LvlGraphCtrl --> <!-- LvlGraphCtrl -->
<module name="LvlGraphCtrl"> <module name="LvlGraphCtrl">
<short>Implements a Level (or Layered) Graph control</short> <short>Implements a Level (or Layered) Graph control.</short>
<descr/> <descr/>
<!-- unresolved external references --> <!-- unresolved external references -->
@ -223,7 +223,7 @@
</element> </element>
<element name="TLvlGraphNode.Create"> <element name="TLvlGraphNode.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the constructor for the class instance. Create is the constructor for the class instance.
@ -242,7 +242,7 @@
</element> </element>
<element name="TLvlGraphNode.Destroy"> <element name="TLvlGraphNode.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -484,7 +484,7 @@
</element> </element>
<element name="TLvlGraphNode.DrawPosition"> <element name="TLvlGraphNode.DrawPosition">
<short>Drawing position for the node at the current Level</short> <short>Drawing position for the node at the current Level.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -522,7 +522,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphNode.DrawnCaptionRect"> <element name="TLvlGraphNode.DrawnCaptionRect">
<short>Last drawing position for the caption, with scrolling</short> <short>Last drawing position for the caption, with scrolling.</short>
<descr> <descr>
<p> <p>
DrawnCaptionRect is a read-only TRect property. DrawnCaptionRect is a read-only TRect property.
@ -532,7 +532,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphNode.InWeight"> <element name="TLvlGraphNode.InWeight">
<short>Total weight for InEdges</short> <short>Total weight for InEdges.</short>
<descr> <descr>
<p> <p>
InWeight is a read-only Single property. InWeight is a read-only Single property.
@ -542,7 +542,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphNode.OutWeight"> <element name="TLvlGraphNode.OutWeight">
<short>Total weight for OutEdges</short> <short>Total weight for OutEdges.</short>
<descr> <descr>
<p> <p>
OutWeight is a read-only Single property. OutWeight is a read-only Single property.
@ -552,12 +552,12 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphNodeClass"> <element name="TLvlGraphNodeClass">
<short>Class reference for the TLvlGrapNode type</short> <short>Class reference for the TLvlGrapNode type.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="PLvlGraphNodeClass"> <element name="PLvlGraphNodeClass">
<short>Pointer to a TLvlGrapNode instance</short> <short>Pointer to a TLvlGrapNode instance.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -573,7 +573,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<element name="TLvlGraphEdge.FNoGapCircle"> <element name="TLvlGraphEdge.FNoGapCircle">
<short> <short>
True when a circular reference exists between 2 nodes, with no levels between; i. e. both edges paint in the same location True when a circular reference exists between 2 nodes, with no levels between; i. e. both edges paint in the same location.
</short> </short>
</element> </element>
@ -606,13 +606,13 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<!-- public --> <!-- public -->
<element name="TLvlGraphEdge.Data"> <element name="TLvlGraphEdge.Data">
<short>Pointer to the user data for the edge</short> <short>Pointer to the user data for the edge.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TLvlGraphEdge.Create"> <element name="TLvlGraphEdge.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the constructor for the class instance. Create is the constructor for the class instance.
@ -628,7 +628,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphEdge.Destroy"> <element name="TLvlGraphEdge.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
Destroy is the overridden destructor for the class instance. Destroy is the overridden destructor for the class instance.
@ -695,7 +695,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphEdge.DrawnAt"> <element name="TLvlGraphEdge.DrawnAt">
<short>Last drawing rectangle, with scrolling</short> <short>Last drawing rectangle, with scrolling.</short>
<descr> <descr>
DrawnAt is a read-only TRect property. DrawnAt is a read-only TRect property.
</descr> </descr>
@ -760,7 +760,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="PLvlGraphEdge"> <element name="PLvlGraphEdge">
<short>Pointer to a TLvlGraphEdge type</short> <short>Pointer to a TLvlGraphEdge type.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -816,7 +816,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphLevel.Create"> <element name="TLvlGraphLevel.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the constructor for the class instance. Create is the constructor for the class instance.
@ -832,7 +832,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphLevel.Destroy"> <element name="TLvlGraphLevel.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
Destroy is the overridden destructor for the class instance. Destroy is the overridden destructor for the class instance.
@ -887,7 +887,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<seealso/> <seealso/>
</element> </element>
<element name="TLvlGraphLevel.GetTotalInOutWeights.Result"> <element name="TLvlGraphLevel.GetTotalInOutWeights.Result">
<short>Sum of the maximum weights for each node: Max(InWeight,OutWeight)</short> <short>Sum of the maximum weights for each node: Max(InWeight,OutWeight).</short>
</element> </element>
<element name="TLvlGraphLevel.Index"> <element name="TLvlGraphLevel.Index">
@ -940,7 +940,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<!-- public --> <!-- public -->
<element name="TLvlGraphSubGraph.Create"> <element name="TLvlGraphSubGraph.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the constructor for the class instance. Create is the constructor for the class instance.
@ -956,7 +956,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphSubGraph.Destroy"> <element name="TLvlGraphSubGraph.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
Destroy is the overridden destructor for the class instance. Destroy is the overridden destructor for the class instance.
@ -1029,16 +1029,16 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<short/> <short/>
</element> </element>
<element name="TLvlGraphEdgeSplitMode.lgesSeparate"> <element name="TLvlGraphEdgeSplitMode.lgesSeparate">
<short>Create separate hidden nodes for each edge; this creates a lot of hidden nodes</short> <short>Create separate hidden nodes for each edge; this creates a lot of hidden nodes.</short>
</element> </element>
<element name="TLvlGraphEdgeSplitMode.lgesMergeSource"> <element name="TLvlGraphEdgeSplitMode.lgesMergeSource">
<short>Combine hidden nodes at source (outgoing edge)</short> <short>Combine hidden nodes at source (outgoing edge).</short>
</element> </element>
<element name="TLvlGraphEdgeSplitMode.lgesMergeTarget"> <element name="TLvlGraphEdgeSplitMode.lgesMergeTarget">
<short>Combine hidden nodes at target (incoming edge)</short> <short>Combine hidden nodes at target (incoming edge).</short>
</element> </element>
<element name="TLvlGraphEdgeSplitMode.lgesMergeHighest"> <element name="TLvlGraphEdgeSplitMode.lgesMergeHighest">
<short>Combine hidden nodes at source or target, whichever has more edges</short> <short>Combine hidden nodes at source or target, whichever has more edges.</short>
</element> </element>
<element name="TLvlGraph"> <element name="TLvlGraph">
@ -1167,7 +1167,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraph.Create"> <element name="TLvlGraph.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the constructor for the class instance. Create is the constructor for the class instance.
@ -1177,7 +1177,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraph.Destroy"> <element name="TLvlGraph.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
Destroy is the overridden destructor for the class instance. Destroy is the overridden destructor for the class instance.
@ -1432,7 +1432,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraph.CreateTopologicalLevels"> <element name="TLvlGraph.CreateTopologicalLevels">
<short>Creates levels using the edges for the Level Graph</short> <short>Creates levels using the edges for the Level Graph.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -1469,7 +1469,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraph.SplitLongEdges"> <element name="TLvlGraph.SplitLongEdges">
<short>Splits long edges by adding hidden nodes</short> <short>Splits long edges by adding hidden nodes.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -1523,13 +1523,13 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraph.MinimizeCrossings"> <element name="TLvlGraph.MinimizeCrossings">
<short>Permutates nodes to minimize crossings</short> <short>Permutates nodes to minimize crossings.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TLvlGraph.MinimizeOverlappings"> <element name="TLvlGraph.MinimizeOverlappings">
<short>Sets the position for all nodes to minimize overlappings</short> <short>Sets the position for all nodes to minimize overlappings.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -1904,7 +1904,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<!-- public --> <!-- public -->
<element name="TLvlGraphNodeStyle.Create"> <element name="TLvlGraphNodeStyle.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
Create is the constructor for the class instance. Create is the constructor for the class instance.
@ -1913,11 +1913,11 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<seealso/> <seealso/>
</element> </element>
<element name="TLvlGraphNodeStyle.Create.AControl"> <element name="TLvlGraphNodeStyle.Create.AControl">
<short>Level Graph control where values in the class instance are used</short> <short>Level Graph control where values in the class instance are used.</short>
</element> </element>
<element name="TLvlGraphNodeStyle.Destroy"> <element name="TLvlGraphNodeStyle.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
Destroy is the overridden destructor for the class instance. Destroy is the overridden destructor for the class instance.
@ -2121,7 +2121,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<!-- public --> <!-- public -->
<element name="TLvlGraphEdgeStyle.Create"> <element name="TLvlGraphEdgeStyle.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
<var>Create</var> is the constructor for the class instance. <var>Create</var> is the constructor for the class instance.
@ -2134,7 +2134,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphEdgeStyle.Destroy"> <element name="TLvlGraphEdgeStyle.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
<var>Destroy</var> is the overridden destructor for the class instance. <var>Destroy</var> is the overridden destructor for the class instance.
@ -2276,7 +2276,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<!-- public --> <!-- public -->
<element name="TLvlGraphLimits.Create"> <element name="TLvlGraphLimits.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
<var>Create</var> is the constructor for the class instance. <var>Create</var> is the constructor for the class instance.
@ -2285,11 +2285,11 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<seealso/> <seealso/>
</element> </element>
<element name="TLvlGraphLimits.Create.AControl"> <element name="TLvlGraphLimits.Create.AControl">
<short>Control where class instance is used</short> <short>Control where class instance is used.</short>
</element> </element>
<element name="TLvlGraphLimits.Destroy"> <element name="TLvlGraphLimits.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
<var>Destroy</var> is the overridden destructor for the class instance. <var>Destroy</var> is the overridden destructor for the class instance.
@ -2331,7 +2331,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<!-- published --> <!-- published -->
<element name="TLvlGraphLimits.MaxLevelHeightAbs"> <element name="TLvlGraphLimits.MaxLevelHeightAbs">
<short>Maximum number of user-specified nodes for a level</short> <short>Maximum number of user-specified nodes for a level.</short>
<descr> <descr>
<p> <p>
MaxLevelHeightAbs is an Integer property with the maximum number of visible (user-specified) nodes in a level. <b>0</b> (<b>zero</b>) indicates that the maximum is ignored. The default value for the property is defined in the <var>DefaultMaxLevelHeightAbs</var> constant. MaxLevelHeightAbs is an Integer property with the maximum number of visible (user-specified) nodes in a level. <b>0</b> (<b>zero</b>) indicates that the maximum is ignored. The default value for the property is defined in the <var>DefaultMaxLevelHeightAbs</var> constant.
@ -2444,7 +2444,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TCustomLvlGraphControl"> <element name="TCustomLvlGraphControl">
<short>Ancestor for the TLvlGraphControl control</short> <short>Ancestor for the TLvlGraphControl control.</short>
<descr> <descr>
<p> <p>
<var>TCustomLvlGraphControl</var> is a <var>TCustomControl</var> descendant which impements the ancestor for <var>TLvlGraphControl</var>. <var>TCustomLvlGraphControl</var> is a <var>TCustomControl</var> descendant which impements the ancestor for <var>TLvlGraphControl</var>.
@ -2758,7 +2758,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TCustomLvlGraphControl.DoDrawEdge"> <element name="TCustomLvlGraphControl.DoDrawEdge">
<short>Draws a line for the specified Edge using the current Canvas color</short> <short>Draws a line for the specified Edge using the current Canvas color.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -2843,7 +2843,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<!-- public --> <!-- public -->
<element name="TCustomLvlGraphControl.Create"> <element name="TCustomLvlGraphControl.Create">
<short>Constructor for the class instance</short> <short>Constructor for the class instance.</short>
<descr> <descr>
<p> <p>
<var>Create</var> is the overridden constructor for the class instance. <var>Create</var> is the overridden constructor for the class instance.
@ -2852,11 +2852,11 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
<seealso/> <seealso/>
</element> </element>
<element name="TCustomLvlGraphControl.Create.AOwner"> <element name="TCustomLvlGraphControl.Create.AOwner">
<short>Owner of the class instance</short> <short>Owner of the class instance.</short>
</element> </element>
<element name="TCustomLvlGraphControl.Destroy"> <element name="TCustomLvlGraphControl.Destroy">
<short>Destructor for the class instance</short> <short>Destructor for the class instance.</short>
<descr> <descr>
<p> <p>
<var>Destroy</var> is the overridden destructor for the class instance. <var>Destroy</var> is the overridden destructor for the class instance.
@ -3059,13 +3059,13 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TCustomLvlGraphControl.OnMinimizeCrossings"> <element name="TCustomLvlGraphControl.OnMinimizeCrossings">
<short>Event handler signalled to provide an alternative minimize crossing algorithm</short> <short>Event handler signalled to provide an alternative minimize crossing algorithm.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomLvlGraphControl.OnMinimizeOverlappings"> <element name="TCustomLvlGraphControl.OnMinimizeOverlappings">
<short>Event handler signalled to provide an alternative minimize overlappings algorithm</short> <short>Event handler signalled to provide an alternative minimize overlappings algorithm.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -3121,7 +3121,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
</element> </element>
<element name="TLvlGraphControl"> <element name="TLvlGraphControl">
<short>Implements a control used to draw a level (or layered) graph</short> <short>Implements a control used to draw a level (or layered) graph.</short>
<descr> <descr>
<p> <p>
<var>TLvlGraphControl</var> is a <var>TCustomLvlGraphControl</var> descendant which implements a control used to render a level graph (also known as a edlayered graph). A level graph consists of nodes (or vertices) and edges with an equidistant spacing beteen related nodes. <var>TLvlGraphControl</var> is a <var>TCustomLvlGraphControl</var> descendant which implements a control used to render a level graph (also known as a edlayered graph). A level graph consists of nodes (or vertices) and edges with an equidistant spacing beteen related nodes.

16
components/lazcontrols/docs/shortpathedit.xml
View File

@ -3,7 +3,7 @@
<package name="LazControls"> <package name="LazControls">
<module name="ShortPathEdit"> <module name="ShortPathEdit">
<short>Implements the TShortPathEdit control</short> <short>Implements the TShortPathEdit control.</short>
<descr/> <descr/>
<!-- unresolved external references --> <!-- unresolved external references -->
@ -14,7 +14,7 @@
<element name="LazFileUtils"/> <element name="LazFileUtils"/>
<element name="TShortPathEdit"> <element name="TShortPathEdit">
<short>Control used to select a directory on the local file system</short> <short>Control used to select a directory on the local file system.</short>
<descr> <descr>
<p> <p>
<var>TShortPathEdit</var> is a <var>TDirectoryEdit</var> descendant which allows selecting a directory on the local file system. <var>TShortPathEdit</var> is a <var>TDirectoryEdit</var> descendant which allows selecting a directory on the local file system.
@ -40,7 +40,7 @@
<!-- protected --> <!-- protected -->
<element name="TShortPathEdit.CreateDialog"> <element name="TShortPathEdit.CreateDialog">
<short>Creates and configures the dialog used to select a directory</short> <short>Creates and configures the dialog used to select a directory.</short>
<descr> <descr>
<p> <p>
<var>CreateDialog</var> is an overridden method in <var>TShortPathEdit</var> used to create and configure the directory selection dialog for the control. The return value contains the <var>TCommonDialog</var> descendant created and configured in the method. It is actually a <var>TSelectDirectoryDialog</var> instance. <var>CreateDialog</var> is an overridden method in <var>TShortPathEdit</var> used to create and configure the directory selection dialog for the control. The return value contains the <var>TCommonDialog</var> descendant created and configured in the method. It is actually a <var>TSelectDirectoryDialog</var> instance.
@ -58,12 +58,12 @@
<seealso/> <seealso/>
</element> </element>
<element name="TShortPathEdit.CreateDialog.Result"> <element name="TShortPathEdit.CreateDialog.Result">
<short>Directory selection dialog created and configured in the method</short> <short>Directory selection dialog created and configured in the method.</short>
</element> </element>
<!-- published --> <!-- published -->
<element name="TShortPathEdit.RunDialog"> <element name="TShortPathEdit.RunDialog">
<short>Executes the directory selection dialog for the control</short> <short>Executes the directory selection dialog for the control.</short>
<descr> <descr>
<p> <p>
<var>RunDialog</var> is an overridden method in <var>TShortPathEdit</var>. It is an alternate implementation, and does not call the inherited method. <var>RunDialog</var> is an overridden method in <var>TShortPathEdit</var>. It is an alternate implementation, and does not call the inherited method.
@ -76,7 +76,7 @@
</element> </element>
<element name="TShortPathEdit.Directory"> <element name="TShortPathEdit.Directory">
<short>Initial directory used in the directory selection dialog</short> <short>Initial directory used in the directory selection dialog.</short>
<descr> <descr>
<p> <p>
<var>Directory</var> is a <var>String</var> property used to specify the initial directory on the local file system used to select a directory in the control. It is used as the initial directory for the directory selection dialog executed in the RunDialog method. It is also used to store a valid path name returned from the directory selection dialog. <var>Directory</var> is a <var>String</var> property used to specify the initial directory on the local file system used to select a directory in the control. It is used as the initial directory for the directory selection dialog executed in the RunDialog method. It is also used to store a valid path name returned from the directory selection dialog.
@ -89,7 +89,9 @@
</element> </element>
<element name="TShortPathEdit.OnAcceptDirectory"> <element name="TShortPathEdit.OnAcceptDirectory">
<short>Event handler signalled when a directory is selected in the directory selection dialog</short> <short>
Event handler signalled when a directory is selected in the directory selection dialog.
</short>
<descr> <descr>
<p> <p>
<var>OnAcceptDirectory</var> is <var>TAcceptFileNameEvent</var> property with the event handler signalled when a directory path has been selected in the <var>RunDialog</var> method. Arguments to the event handler include the directory name selected in the dialog, or an empty string when the Cancel button is pressed in the dialog. <var>OnAcceptDirectory</var> is <var>TAcceptFileNameEvent</var> property with the event handler signalled when a directory path has been selected in the <var>RunDialog</var> method. Arguments to the event handler include the directory name selected in the dialog, or an empty string when the Cancel button is pressed in the dialog.

362
components/lazcontrols/docs/spinex.xml
View File

File diff suppressed because it is too large Load Diff

29
components/lazcontrols/docs/treefilteredit.xml
View File

@ -3,7 +3,7 @@
<package name="LazControls"> <package name="LazControls">
<module name="TreeFilterEdit"> <module name="TreeFilterEdit">
<short>Implements a control used to filter an associated TreeView</short> <short>Implements a control used to filter an associated TreeView.</short>
<descr/> <descr/>
<element name="TTreeFilterEdit"> <element name="TTreeFilterEdit">
@ -30,16 +30,22 @@
</element> </element>
<element name="TTreeFilterEdit.ShowDirHierarchy"> <element name="TTreeFilterEdit.ShowDirHierarchy">
<short>When a filtered text is a directory name, it is split and shown as a tree structure.</short> <short>
When a filtered text is a directory name, it is split and shown as a tree structure.
</short>
<descr> <descr>
This has effect only in the "sub-branches" mode. The "whole tree" mode uses the existing tree nodes as is and only changes their visibility. <p>
This has effect only in the "sub-branches" mode. The "whole tree" mode uses the existing tree nodes as is and only changes their visibility.
</p>
</descr> </descr>
</element> </element>
<element name="TTreeFilterEdit.ExpandAllInitially"> <element name="TTreeFilterEdit.ExpandAllInitially">
<short>Tree branches are expanded also initially.</short> <short>Tree branches are expanded also initially.</short>
<descr> <descr>
The branches are expanded in any case when the tree is filtered and matches are found. This setting only affects the initial state. <p>
The branches are expanded in any case when the tree is filtered and matches are found. This setting only affects the initial state.
</p>
</descr> </descr>
</element> </element>
@ -49,19 +55,26 @@
<element name="TTreeFilterEdit.GetExistingBranch"> <element name="TTreeFilterEdit.GetExistingBranch">
<short>Get an existing branch for a given tree-node, or Nil if there is none.</short> <short>Get an existing branch for a given tree-node, or Nil if there is none.</short>
<descr>This can be used only with the "sub-branches" mode. <descr>
<p>
This can be used only with the "sub-branches" mode.
</p>
</descr> </descr>
</element> </element>
<element name="TTreeFilterEdit.GetCleanBranch"> <element name="TTreeFilterEdit.GetCleanBranch">
<short>Get a new or existing branch with data cleared for a given tree-node.</short> <short>Get a new or existing branch with data cleared for a given tree-node.</short>
<descr>This can be used only with the "sub-branches" mode. In fact calling this method switches <descr>
the filter into "sub-branches" mode. This is the way to add those branches. <p>
This can be used only with the "sub-branches" mode. In fact calling this method switches the filter into "sub-branches" mode. This is the way to add those branches.
</p>
</descr> </descr>
</element> </element>
<element name="TTreeFilterBranch"> <element name="TTreeFilterBranch">
<short>A branch associated with an existing TreeNode when the filter is used in "sub-branches" mode.</short> <short>
A branch associated with an existing TreeNode when the filter is used in "sub-branches" mode.
</short>
</element> </element>
<element name="TTreeFilterBranch.Create"> <element name="TTreeFilterBranch.Create">

37
components/rtticontrols/fpdoc/rttictrls.xml
View File

@ -2,14 +2,12 @@
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="RunTimeTypeInfoControls"> <package name="RunTimeTypeInfoControls">
<module name="RTTICtrls"> <module name="RTTICtrls">
<short>Contains controls which access properties in TPersistent objects using RTTI</short> <short>
Contains controls which access properties in TPersistent objects using RTTI.
</short>
<descr> <descr>
<p> <p>
Provides LCL controls that access properties of TPersistent objects via RTTI (the FreePascal Run Provides LCL controls that access properties of TPersistent objects via RTTI (the FreePascal Run Time Type Information). Every published property can be edited in the Object Inspector. There you have a TOIPropertyGrid working with TEdit, TComboBox and TButton. These controls extends the possibilities to edit single properties and the developer can choose how to represent the property.
Time Type Information). Every published property can be edited in the Object Inspector. There
you have a TOIPropertyGrid working with TEdit, TComboBox and TButton. These controls extends the
possibilities to edit single properties and the developer can choose how to represent the
property.
</p> </p>
</descr> </descr>
@ -38,12 +36,11 @@
<element name="TAliasStrings"> <element name="TAliasStrings">
<short> <short>
Maps strings to alias strings Maps strings to alias strings.
</short> </short>
<descr> <descr>
<p> <p>
Some RTTI controls uses this to map RTTI values to display values. Eventually accelerate search Some RTTI controls uses this to map RTTI values to display values. Eventually accelerate search for Names and Values.
for Names and Values.
</p> </p>
</descr> </descr>
<seealso/> <seealso/>
@ -133,13 +130,13 @@
</element> </element>
<element name="TPropertyLinkOption"> <element name="TPropertyLinkOption">
<short>Optional flags for TPropertyLink</short> <short>Optional flags for TPropertyLink.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TPropertyLinkOption"> <element name="TPropertyLinkOption">
<short>Options for the RTTI Control to Property Editor link</short> <short>Options for the RTTI Control to Property Editor link.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -147,11 +144,11 @@
<short/> <short/>
</element> </element>
<element name="TPropertyLinkOption.ploAutoSave"> <element name="TPropertyLinkOption.ploAutoSave">
<short>Auto-save on EditingDone</short> <short>Auto-save on EditingDone.</short>
</element> </element>
<!-- TODO: <!-- TODO:
<element name="TPropertyLinkOption.ploDisableOnNil"> <element name="TPropertyLinkOption.ploDisableOnNil">
<short>Disable control if link disconnected</short> <short>Disable control if link disconnected.</short>
</element> </element>
<element name="TPropertyLinkOption.ploReadOnly"> <element name="TPropertyLinkOption.ploReadOnly">
<short/> <short/>
@ -742,13 +739,13 @@
</element> </element>
<element name="TCustomPropertyLink.Owner"> <element name="TCustomPropertyLink.Owner">
<short>The RTTI control using the link</short> <short>The RTTI control using the link.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomPropertyLink.SaveEnabled"> <element name="TCustomPropertyLink.SaveEnabled">
<short>Enable to automatically save changes</short> <short>Enable to automatically save changes.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -760,19 +757,19 @@
</element> </element>
<element name="TCustomPropertyLink.TIObject"> <element name="TCustomPropertyLink.TIObject">
<short>The object for the property</short> <short>The object for the property.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomPropertyLink.TIPropertyName"> <element name="TCustomPropertyLink.TIPropertyName">
<short>The name of the property</short> <short>The name of the property.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<element name="TCustomPropertyLink.TIElementName"> <element name="TCustomPropertyLink.TIElementName">
<short>If the property is a set then the name of the enum can be given here</short> <short>If the property is a set then the name of the enum can be given here.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
@ -913,7 +910,7 @@
<element name="TTIElementNamePropertyEditor.FPropEdits"> <element name="TTIElementNamePropertyEditor.FPropEdits">
<short> <short>
List of TPropertyEditor instances for TIPropertyName List of TPropertyEditor instances for TIPropertyName.
</short> </short>
<descr/> <descr/>
<seealso/> <seealso/>
@ -921,7 +918,7 @@
<element name="TTIElementNamePropertyEditor.FElementPropEdits"> <element name="TTIElementNamePropertyEditor.FElementPropEdits">
<short> <short>
List of TPropertyEditor for TIElementName List of TPropertyEditor for TIElementName.
</short> </short>
</element> </element>

2062
components/rtticontrols/fpdoc/rttigrids.xml
View File

File diff suppressed because it is too large Load Diff