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

Docs: various updates, mostly fixed bad links

Browse Source 
git-svn-id: trunk@34110 -
This commit is contained in:
dodi 2011-12-11 16:54:59 +00:00
parent bfb6d5511b
commit 6714382934
11 changed files with 214 additions and 276 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -579,19 +579,12 @@ bkYesToAll
</element>
<!-- constructor Visibility: public -->
<element name="TCustomBitBtn.Create">
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
However, if you create the component by code don´t forget to free it when it is no longer needed.
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.
</descr>
<short>Calls inherited <var>Create</var> then initialises layout, style and spacing, creates the Button Glyph</short>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
<link id="#LCL.StdCtrls.TCustomButton.Create">TCustomButton.Create</link>
</seealso>
<short>
<var>Create</var> - constructor for <var>TCustomBitBtn</var>: calls inherited <var>Create</var> then initialises layout, style and spacing, creates the Button Glyph</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomBitBtn.Create.TheOwner">
@ -599,26 +592,12 @@ Constructors allocate memory and system resources needed by the object. They als
</element>
<!-- destructor Visibility: public -->
<element name="TCustomBitBtn.Destroy">
<descr>If you call Destroy for an object which hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
Take the following precautions when creating your own Destroy method:
* Declare Destroy with the override directive, because it is a virtual method.
* Always call 'inherited Destroy;' as the last thing on the destructor code.
* An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them.
* Remember to call Free for all objects created on the constructor.
</descr>
<short>frees Button Glyph then calls inherited <var>Destroy</var>
</short>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
<link id="#LCL.StdCtrls.TCustomButton.Destroy">TCustomButton.Destroy</link>
</seealso>
<short>
<var>Destroy</var> - destructor for <var>TCustomBitBtn</var>: frees Button Glyph then calls inherited <var>Destroy</var>
</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomBitBtn.Glyph">
@ -872,7 +851,8 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<!-- property Visibility: published -->
<element name="TBitBtn.ShowHint" link="#LCL.Controls.TControl.ShowHint">
<descr>// standard properties, which should be supported by all descendants<br/>
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control.
If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint
</descr>
<seealso/>
</element>

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

@ -2271,14 +2271,12 @@
</element>
<!-- constructor Visibility: public -->
<element name="TTabSheet.Create">
<short>
<var>Create</var> - constructor for <var>TTabSheet</var>: calls inherited <var>Create</var> and zeroes <var>ImageIndex</var>
<short>calls inherited <var>Create</var> and zeroes <var>ImageIndex</var>
</short>
<descr/>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
<link id="#LCL.ExtCtrls.TCustomPage.Create">TCustomPage.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2346,7 +2344,7 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTabSheet.ImageIndex" link="#LCL.ExtCtrls.TCustomPage.ImageIndex">
<element name="TTabSheet.ImageIndex" link="TCustomPage.ImageIndex">
<short/>
<descr/>
<seealso/>
@ -2376,7 +2374,7 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTabSheet.OnHide" link="#LCL.ExtCtrls.TCustomPage.OnHide">
<element name="TTabSheet.OnHide" link="TCustomPage.OnHide">
<short/>
<descr/>
<seealso/>
@ -2406,13 +2404,13 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTabSheet.OnShow" link="#LCL.ExtCtrls.TCustomPage.OnShow">
<element name="TTabSheet.OnShow" link="TCustomPage.OnShow">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTabSheet.PageIndex" link="#LCL.ExtCtrls.TCustomPage.PageIndex">
<element name="TTabSheet.PageIndex" link="TCustomPage.PageIndex">
<short/>
<descr/>
<seealso/>
@ -2442,7 +2440,7 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTabSheet.TabVisible" link="#LCL.ExtCtrls.TCustomPage.TabVisible">
<element name="TTabSheet.TabVisible" link="TCustomPage.TabVisible">
<short/>
<descr/>
<seealso/>
@ -2579,7 +2577,7 @@
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
<link id="#LCL.ExtCtrls.TCustomTabControl.Create">TCustomTabControl.Create</link>
<link id="TCustomTabControl.Create">TCustomTabControl.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2658,7 +2656,7 @@
<var>Pages</var> - the actual Pages (<var>TTabSheet</var>) that comprise the component</short>
<descr/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomTabControl.Pages">TCustomTabControl.Pages</link>
<link id="TCustomTabControl.Pages">TCustomTabControl.Pages</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -2713,7 +2711,7 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPageControl.Images" link="#LCL.ExtCtrls.TCustomTabControl.Images">
<element name="TPageControl.Images" link="TCustomTabControl.Images">
<short/>
<descr/>
<seealso/>
@ -2756,7 +2754,7 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPageControl.TabPosition" link="#LCL.ExtCtrls.TCustomTabControl.TabPosition">
<element name="TPageControl.TabPosition" link="TCustomTabControl.TabPosition">
<short/>
<descr/>
<seealso/>
@ -2804,7 +2802,7 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPageControl.OnGetImageIndex" link="#LCL.ExtCtrls.TCustomTabControl.OnGetImageIndex">
<element name="TPageControl.OnGetImageIndex" link="TCustomTabControl.OnGetImageIndex">
<short/>
<descr/>
<seealso/>
@ -13004,7 +13002,7 @@ Const
<dd>if <var>Node1.Text&gt;Node2.Text</var>.</dd>
</dl>
<p>The comparision takes into account Ansi characters, i.e. it takes
care of strange accented characters. Contrary to <link id="AnsiCompareText"/>,
care of strange accented characters. Contrary to AnsiCompareText,
the comparision is case sensitive.
</p>
</descr>
@ -17321,8 +17319,8 @@ the comparision is case sensitive.
<p>Use <var>TopItem</var> to get the topmost visible node. It is usually needed when tree view contains many nodes and scroll bar is requred to display them all. If you need the first node of the tree regardless of visibility use <var>Items</var>[0]</p>
</descr>
<seealso>
<link id="#lcl.ComCtrls.TCustomListview.Items">TCustomTreeView.Items</link>
<link id="#lcl.ComCtrls.TCustomListview.TCustomTreeView.GetNodeAtY">TCustomTreeView.GetNodeAtY</link>
<link id="TCustomTreeView.Items">Items</link>
<link id="TCustomTreeView.GetNodeAtY">GetNodeAtY</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -18512,7 +18510,7 @@ the comparision is case sensitive.
<dd>if <var>Node1.Text&gt;Node2.Text</var>.</dd>
</dl>
<p>The comparision takes into account Ansi characters, i.e. it takes
care of strange accented characters. Contrary to <link id="AnsiCompareText"/>,
care of strange accented characters. Contrary to AnsiCompareText,
the comparision is case sensitive.
</p>
</descr>
@ -18567,10 +18565,7 @@ the comparision is case sensitive.
<link id="#LCL.Controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
</seealso>
</element>
<element name="TCustomTreeView.DoDragMsg">
<short>
<var>DoDragMsg</var> generates system message to indicate object and position for dragging and returns Result of action</short>
</element>
<element name="TCustomTreeView.DoDragMsg" link="Controls.TWinControl.DoDragMsg"/>
<element name="TTreeNode.GetTextPath">
<short>
<var>GetTextPath</var> - returns a string containing the path to the current node delimited by slash</short>

155
docs/xml/lcl/controls.xml
View File

@ -4110,7 +4110,7 @@ dmFindTarget: find child control under the mouse
<short/>
</element>
<element name="TControl.ConstrainedResize">
<short>Invokes the <link id="TControl.OnConstrainedResize"/> handler, allowing to modify the suggested Constraints.
<short>Invokes the <link id="#lcl.Controls.TControl.OnConstrainedResize"/> handler, allowing to modify the suggested Constraints.
</short>
</element>
<element name="TControl.ConstrainedResize.MinWidth">
@ -4158,21 +4158,21 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DoOnResize">
<short>Invokes the <link id="TControl.OnResize">OnResize</link> notification handler.
<short>Invokes the <link id="#lcl.Controls.TControl.OnResize">OnResize</link> notification handler.
</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DoOnChangeBounds">
<short>Invokes the <link id="TControl.OnChangeBounds">OnChangeBounds</link> event handler</short>
<short>Invokes the <link id="#lcl.Controls.TControl.OnChangeBounds">OnChangeBounds</link> event handler</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.CheckOnChangeBounds">
<short>Checks for changes and calls <link id="TControl.DoOnChangeBounds">DoOnChangeBounds</link> if needed.
<short>Checks for changes and calls <link id="#lcl.Controls.TControl.DoOnChangeBounds">DoOnChangeBounds</link> if needed.
</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.Resize">
<short>Checks for changes and calls <link id="TControl.DoOnResize">DoOnResize</link> if needed.
<short>Checks for changes and calls <link id="#lcl.Controls.TControl.DoOnResize">DoOnResize</link> if needed.
</short>
</element>
<!-- procedure Visibility: protected -->
@ -5067,7 +5067,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DoEndDock">
<short>Invokes the <link id="TControl.OnEndDock">OnEndDock</link> handler.</short>
<short>Invokes the <link id="#lcl.Controls.TControl.OnEndDock">OnEndDock</link> handler.</short>
</element>
<element name="TControl.DoEndDock.Target">
<short/>
@ -5080,7 +5080,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DoEndDrag">
<short>Invokes the <link id="TControl.OnEndDrag">OnEndDrag</link> handler.</short>
<short>Invokes the <link id="#lcl.Controls.TControl.OnEndDrag">OnEndDrag</link> handler.</short>
</element>
<element name="TControl.DoEndDrag.Target">
<short/>
@ -5093,14 +5093,14 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DoStartDock">
<short>Invokes the <link id="TControl.OnStartDock">OnStartDock</link> handler</short>
<short>Invokes the <link id="#lcl.Controls.TControl.OnStartDock">OnStartDock</link> handler</short>
</element>
<element name="TControl.DoStartDock.DragObject">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DoStartDrag">
<short>Invokes the <link id="TControl.OnStartDrag">OnStartDrag</link> handler</short>
<short>Invokes the <link id="#lcl.Controls.TControl.OnStartDrag">OnStartDrag</link> handler</short>
</element>
<element name="TControl.DoStartDrag.DragObject">
<short/>
@ -5175,26 +5175,26 @@ dmFindTarget: find child control under the mouse
<!-- procedure Visibility: protected -->
<element name="TControl.Click">
<short>Invokes the
<link id="TControl.OnClick">OnClick</link>
<link id="#lcl.Controls.TControl.OnClick">OnClick</link>
and ActionLink.Execute
handlers.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DblClick">
<short>Invokes the
<link id="TControl.OnDblClick">OnDblClick</link>
<link id="#lcl.Controls.TControl.OnDblClick">OnDblClick</link>
handler.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.TripleClick">
<short>Invokes the
<link id="TControl.OnTripleClick">OnTripleClick</link>
<link id="#lcl.Controls.TControl.OnTripleClick">OnTripleClick</link>
handler.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.QuadClick">
<short>Invokes the
<link id="TControl.OnQuadClick">OnQuadClick</link>
<link id="#lcl.Controls.TControl.OnQuadClick">OnQuadClick</link>
handler.</short>
</element>
<!-- procedure Visibility: protected -->
@ -5225,7 +5225,7 @@ dmFindTarget: find child control under the mouse
<descr>
<p>Called by the MouseMove message handler.
The DragManager is notified while the control is being dragged.
Finally the <link id="TControl.OnMouseMove">OnMouseMove</link> handler is invoked.</p>
Finally the <link id="#lcl.Controls.TControl.OnMouseMove">OnMouseMove</link> handler is invoked.</p>
</descr>
</element>
<element name="TControl.MouseMove.Shift">
@ -5241,7 +5241,7 @@ dmFindTarget: find child control under the mouse
<!-- procedure Visibility: protected -->
<element name="TControl.MouseUp">
<short>Invokes the
<link id="TControl.OnMouseUp">OnMouseUp</link> handler.</short>
<link id="#lcl.Controls.TControl.OnMouseUp">OnMouseUp</link> handler.</short>
<descr/>
<errors/>
<seealso/>
@ -5263,7 +5263,7 @@ dmFindTarget: find child control under the mouse
<!-- procedure Visibility: protected -->
<element name="TControl.MouseEnter">
<short>Invokes the
<link id="TControl.OnMouseEnter">OnMouseEnter</link> handler.</short>
<link id="#lcl.Controls.TControl.OnMouseEnter">OnMouseEnter</link> handler.</short>
<descr/>
<errors/>
<seealso/>
@ -5271,7 +5271,7 @@ dmFindTarget: find child control under the mouse
<!-- procedure Visibility: protected -->
<element name="TControl.MouseLeave">
<short>Invokes the
<link id="TControl.OnMouseLeave">OnMouseLeave</link> handler.</short>
<link id="#lcl.Controls.TControl.OnMouseLeave">OnMouseLeave</link> handler.</short>
<descr/>
<errors/>
<seealso/>
@ -6198,8 +6198,8 @@ dmFindTarget: find child control under the mouse
<element name="TControl.GetColorResolvingParent">
<short>Returns the color of the control while resolving clDefault and ParentColor</short>
<descr>This convenience routine will allow to obtain the Color of the control while resolving clDefault.
&#x9;&#x9; It will never return clDefault, but it might return non-RGB color. To obtain a purely RGB result
&#x9;&#x9;&#x9; use GetRGBColorResolvingParent.</descr>
It will never return clDefault, but it might return non-RGB color. To obtain a purely RGB result
use GetRGBColorResolvingParent.</descr>
<seealso>
<link id="TControl.Color"/>
<link id="TControl.GetDefaultColor"/>
@ -6211,7 +6211,7 @@ dmFindTarget: find child control under the mouse
<element name="TControl.GetRGBColorResolvingParent">
<short>Returns a RGB value for the color of the control</short>
<descr>This convenience routine will allow to obtain the Color of the control while resolving clDefault,
&#x9;&#x9; ParentColor and system color indexes and returns a RGB TColor.</descr>
ParentColor and system color indexes and returns a RGB TColor.</descr>
<seealso>
<link id="TControl.Color"/>
<link id="TControl.GetDefaultColor"/>
@ -6542,7 +6542,6 @@ dmFindTarget: find child control under the mouse
</descr>
<seealso>
<link id="#lcl.Controls.TControl.RealGetText">RealGetText</link>
<link id="#lcl.Controls.TControl.GetText">GetText</link>
</seealso>
</element>
<element name="TControl.GetTextBuf.Result">
@ -6575,7 +6574,6 @@ dmFindTarget: find child control under the mouse
</descr>
<seealso>
<link id="#lcl.Controls.TControl.RealSetText">RealSetText</link>
<link id="#lcl.Controls.TControl.SetText">SetText</link>
</seealso>
</element>
<element name="TControl.SetTextBuf.Buffer">
@ -6983,9 +6981,9 @@ dmFindTarget: find child control under the mouse
</p>
</descr>
<seealso>
<link id="#lcl.Controls.TAnchorSide"/>
<link id="#lcl.Controls.AnchorAsAlign"/>
<link id="#lcl.Controls.AnchorToNeighbour"/>
<link id="TAnchorSide"/>
<link id="TControl.AnchorAsAlign"/>
<link id="TControl.AnchorToNeighbour"/>
</seealso>
</element>
<element name="TControl.AnchorSide.Kind">
@ -7163,9 +7161,9 @@ dmFindTarget: find child control under the mouse
<short>The background color of the control.</short>
<descr>
<p>The default Color is the same as the parent window Color. If the color is clDefault
&#x9;&#x9; then the result will need to be passed through GetDefaultColor to resolve clDefault.
&#x9;&#x9; Convenience routines which obtains the color resolving clDefault and ParentColor are also
&#x9;&#x9; provided as TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent</p>
then the result will need to be passed through GetDefaultColor to resolve clDefault.
Convenience routines which obtains the color resolving clDefault and ParentColor are also
provided as TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent</p>
</descr>
<seealso>
<link id="TControl.ParentColor"/>
@ -7606,10 +7604,10 @@ dmFindTarget: find child control under the mouse
<descr>While this property is True, all changes to the Color of the parent will be
also done to the Color of the control, syncronizing them and keeping them with the same value.
If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
&#x9;&#x9; The combination of ParentColor with clDefault can cause problems in resolving clDefault. To obtain the Color
&#x9;&#x9; property of a control while taking into account clDefault and ParentColor one whould use TControl.GetColorResolvingParent.
&#x9;&#x9; This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use
&#x9;&#x9; TColor.GetRGBColorResolvingParent
The combination of ParentColor with clDefault can cause problems in resolving clDefault. To obtain the Color
property of a control while taking into account clDefault and ParentColor one whould use TControl.GetColorResolvingParent.
This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use
TColor.GetRGBColorResolvingParent
</descr>
<seealso>
<link id="TControl.Color"/>
@ -7664,7 +7662,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- property Visibility: public -->
<element name="TControl.ShowHint">
<short>Enables the <link id="TControl.Hint">Hint</link> display.</short>
<short>Enables the <link id="#lcl.Controls.TControl.Hint">Hint</link> display.</short>
<descr>
<p>When True, the Hint text is shown when the mouse hovers over the control.
</p>
@ -7761,7 +7759,7 @@ dmFindTarget: find child control under the mouse
<seealso>
<link id="#lcl.Controls.TWndMethod">TWndMethod</link>
<link id="#lcl.LMessages.TLMessage">TLMessage</link>
<link id="#lcl.Controls.Perform">Perform</link>
<link id="TControl.Perform">Perform</link>
</seealso>
</element>
<!-- range type Visibility: default -->
@ -8868,7 +8866,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.CreateBrush">
<short>Creates the <link id="TWinControl.Brush">Brush</link>, if not already created.
<short>Creates the <link id="#lcl.Controls.TWinControl.Brush">Brush</link>, if not already created.
</short>
<descr/>
<errors/>
@ -8906,7 +8904,7 @@ dmFindTarget: find child control under the mouse
<!-- procedure Visibility: protected -->
<element name="TWinControl.CMBiDiModeChanged">
<short>Handler for
changed <link id="TWinControl.BiDiMode">BiDiMode</link>
changed <link id="#lcl.Controls.TControl.BiDiMode">BiDiMode</link>
message.
Notifies the widget and all child controls.
</short>
@ -8920,7 +8918,7 @@ dmFindTarget: find child control under the mouse
<!-- procedure Visibility: protected -->
<element name="TWinControl.CMBorderChanged">
<short>Handler for
changed <link id="TWinControl.Border">Border</link>
changed Border properties
message.
Adjusts and invalidates the control.
</short>
@ -8931,7 +8929,7 @@ dmFindTarget: find child control under the mouse
<!-- procedure Visibility: protected -->
<element name="TWinControl.CMEnabledChanged">
<short>Handler for
changed <link id="TWinControl.Enabled">Enabled</link>
changed <link id="#lcl.Controls.TControl.Enabled">Enabled</link>
message.
Notifies the widgetset.
</short>
@ -8973,7 +8971,7 @@ dmFindTarget: find child control under the mouse
<!-- procedure Visibility: protected -->
<element name="TWinControl.CMVisibleChanged">
<short>Handler for
changed <link id="TWinControl.Visible">Visible</link>
changed <link id="#lcl.Controls.TControl.Visible">Visible</link>
message.
Handles Focus, forces UpdateControlState.
</short>
@ -9059,7 +9057,7 @@ dmFindTarget: find child control under the mouse
<short>Handler for
loosing Focus
event.
Eventually triggers <link id="TControl.EditingDone"/>.
Eventually triggers <link id="#lcl.Controls.TControl.EditingDone"/>.
</short>
<descr/>
<errors/>
@ -9570,11 +9568,11 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.DoEnter">
<short>Invokes the <link id="TWinControl.OnEnter">OnEnter</link> event handler.</short>
<short>Invokes the <link id="#lcl.Controls.TWinControl.OnEnter">OnEnter</link> event handler.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.DoExit">
<short>Invoke the <link id="TWinControl.OnExit">OnExit</link> event handler.</short>
<short>Invoke the <link id="#lcl.Controls.TWinControl.OnExit">OnExit</link> event handler.</short>
</element>
<!-- function Visibility: protected -->
<element name="TWinControl.DoKeyDownBeforeInterface">
@ -9637,7 +9635,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- function Visibility: protected -->
<element name="TWinControl.DoKeyPress">
<short>Tries all <link id="TWinControl.OnKeyPress">OnKeyPress</link> handlers, of Parents first.
<short>Tries all <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> handlers, of Parents first.
</short>
<descr/>
<errors/>
@ -9740,7 +9738,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.KeyDown">
<short>Invokes the <link id="TWinControl.OnKeyDown">OnKeyDown</link> handler.
<short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> handler.
</short>
<descr/>
<errors/>
@ -9754,7 +9752,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.KeyDownBeforeInterface">
<short>Invokes the <link id="TWinControl.OnKeyDown">OnKeyDown</link> handler.
<short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> handler.
</short>
<descr/>
<errors/>
@ -9782,7 +9780,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.KeyPress">
<short>Invokes the <link id="TWinControl.OnKeyPress">OnKeyPress</link> handler.
<short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link> handler.
</short>
<descr/>
<errors/>
@ -9793,7 +9791,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.KeyUp">
<short>Invokes the <link id="TWinControl.OnKeyUp">OnKeyUp</link> handler.
<short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyUp">OnKeyUp</link> handler.
</short>
<descr/>
<errors/>
@ -9807,7 +9805,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.KeyUpBeforeInterface">
<short>Invokes the <link id="TWinControl.OnKeyUp">OnKeyUp</link> handler.
<short>Invokes the <link id="#lcl.Controls.TWinControl.OnKeyUp">OnKeyUp</link> handler.
</short>
<descr/>
<errors/>
@ -9835,7 +9833,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- procedure Visibility: protected -->
<element name="TWinControl.UTF8KeyPress">
<short>Invokes the <link id="TWinControl.OnUTF8KeyPress">OnUTF8KeyPress</link> handler.
<short>Invokes the <link id="#lcl.Controls.TWinControl.OnUTF8KeyPress">OnUTF8KeyPress</link> handler.
</short>
<descr/>
<errors/>
@ -11391,7 +11389,7 @@ End;
</element>
<!-- object Visibility: default -->
<element name="TDockZone">
<short>Represents an node in an <link id="TDockTree"/>.</short>
<short>Represents an node in an <link id="#lcl.Controls.TDockTree">TDockTree</link>.</short>
<descr>
<p>It encapsulates a dock zone, containing either other zones or a single control.
</p>
@ -12339,7 +12337,6 @@ End;
<descr/>
<errors/>
<seealso>
<link id="CaptureControl"/>
</seealso>
</element>
<element name="SetCaptureControl.Control">
@ -12360,7 +12357,6 @@ End;
</descr>
<errors/>
<seealso>
<link id="CaptureControl"/>
</seealso>
</element>
<element name="GetCaptureControl.Result">
@ -12716,7 +12712,7 @@ End;
<element name="TGetDockCaptionEvent.ACaption">
<short/>
</element>
<element link="TDragManager" name="TDragManagerDefault">
<element name="TDragManagerDefault" link="TDragManager">
<short>Implementation of TDragManager.</short>
</element>
<!-- object Visibility: default -->
@ -12729,7 +12725,6 @@ End;
</descr>
<errors/>
<seealso>
<link id="TDragManagerDefault"/>
</seealso>
</element>
<!-- variable Visibility: private -->
@ -13108,7 +13103,7 @@ End;
<short></short>
</element>
<!-- Variables go here -->
<!-- variable Visibility: default -->
<!-- variable Visibility: implementation -->
<element name="CaptureControl">
<short>Hidden reference to the currently capturing control.</short>
<descr>The interface knows, which TWinControl has the capture.
@ -13129,7 +13124,7 @@ End;
<seealso/>
</element>
<!-- variable Visibility: default -->
<element link="TDragManager" name="DragManager">
<element name="DragManager" link="TDragManager">
<short>The current DragManager (always TDragManagerDefault).</short>
<descr>A DragManager can be implemented only in the Controls unit,
because it must access private elements of the other classes,
@ -13174,7 +13169,7 @@ End;
<li>the Width and Height are bound by the <var>Constraints</var> properties. The Contraints can also be overriden by the widgetset. For example the winapi does not allow resizing the height of a combobox. And the gtk widgetset does not allow resizing the width of a vertical scrollbar</li>
</ul>
<p>The new size is calculated by the protected method <link id="#lcl.Controls.TControl.CalculatePreferredSize">TControl.CalculatePreferredSize</link>.
&#x9;&#x9;&#x9; This method asks the widgetset for an appropriate Width and Height. For example a <var>TButton</var> has preferred Width and Height. A <var>TComboBox</var> has only a preferred Height. The preferred Width is returned as 0 and so the LCL does not autosize the Width - it keeps the width unaltered. Finally a <var>TMemo</var> has no preferred Width or Height. Therefore AutoSize has no effect on a TMemo.</p>
This method asks the widgetset for an appropriate Width and Height. For example a <var>TButton</var> has preferred Width and Height. A <var>TComboBox</var> has only a preferred Height. The preferred Width is returned as 0 and so the LCL does not autosize the Width - it keeps the width unaltered. Finally a <var>TMemo</var> has no preferred Width or Height. Therefore AutoSize has no effect on a TMemo.</p>
<p>Some controls override this method. For example the <var>TGraphicControl</var> descendants like <var>TLabel</var> have no window handle and so cannot query the widgetset. They must calculate their preferred Width and Height themselves.</p>
<p>The widgetsets must override the <var>GetPreferredSize</var> method for each widget class that has a preferred size (Width or Height or both).</p>
<p>
@ -13194,8 +13189,10 @@ End;
<p>If Parent=nil then Left, Top depend on the widgetset and the window manager. Till Lazarus 0.9.25 this is typically the screen coordinate of the left,top of the client area of the form. This is Delphi incompatible. It is planned to change this to the Left, Top of the window.</p>
<p>Hint:</p>
<p>Each time you change Left and Top the LCL moves instantly. If you want to change both Left and Top use instead:</p>
<code>with Button1 do
&#x9; SetBounds(NewLeft,NewTop,Width,Height);</code>
<code>
with Button1 do
SetBounds(NewLeft,NewTop,Width,Height);
</code>
<ul>
<li>Width</li>
<li>Height</li>
@ -13229,26 +13226,26 @@ End;
<li>FBaseBoundsLock: integer</li>
</ul>
<p>Increased/Decreased by LockBaseBounds/UnlockBaseBounds.
&#x9;&#x9; Used to keep FBaseBounds during SetBounds calls.</p>
Used to keep FBaseBounds during SetBounds calls.</p>
<ul>
<li>FBaseParentClientSize: TPoint</li>
</ul>
<p>The Parent.ClientRect size valid for the FBaseBounds.
&#x9;&#x9; FBaseBounds and FBaseParentClientSize are used to calculate the distance for
&#x9;&#x9; akRight (akBottom).
&#x9;&#x9; When the parent is resized, the LCL knows what distance to keep.</p>
FBaseBounds and FBaseParentClientSize are used to calculate the distance for
akRight (akBottom).
When the parent is resized, the LCL knows what distance to keep.</p>
<ul>
<li>FBoundsRectForNewParent: TRect</li>
</ul>
<p>When changing the Parent of a control the Handle is recreated and many
&#x9;&#x9; things can happen. Especially for docking forms the process is too
&#x9;&#x9; unreliable. Therefore the BoundsRect is saved. The VCL uses a similar
&#x9;&#x9; mechanism.</p>
things can happen. Especially for docking forms the process is too
unreliable. Therefore the BoundsRect is saved. The VCL uses a similar
mechanism.</p>
<ul>
<li>FLastDoChangeBounds: TRect</li>
</ul>
<p>Used to avoid calling OnChangeBounds with the same coordinates. This reduces
&#x9;&#x9;&#x9;&#x9; user defined autosizing.</p>
user defined autosizing.</p>
<ul>
<li>FLastResizeClientHeight: integer</li>
<li>FLastResizeClientWidth: integer</li>
@ -13256,15 +13253,15 @@ End;
<li>FLastResizeWidth: integer</li>
</ul>
<p>Used to avoid calling OnResize with the same coordinates. This reduces user
&#x9;&#x9;&#x9;&#x9; defined autosizing.</p>
defined autosizing.</p>
<ul>
<li>FLoadedClientSize: TPoint</li>
</ul>
<p>During loading many things are delayed and many things are set and worse: in
&#x9;&#x9;&#x9;&#x9; the wrong order. That's why SetClientWidth/SetClientHeight calls are stored
&#x9;&#x9;&#x9;&#x9; and set at end of loading again.
&#x9;&#x9;&#x9;&#x9; This way the LCL can restore the distances (e.g. akRight) used during
&#x9;&#x9;&#x9;&#x9; designing.</p>
the wrong order. That's why SetClientWidth/SetClientHeight calls are stored
and set at end of loading again.
This way the LCL can restore the distances (e.g. akRight) used during
designing.</p>
<ul>
<li>FReadBounds: TRect</li>
</ul>
@ -13291,8 +13288,8 @@ End;
<li>procedure ChangeBounds(ALeft, ATop, AWidth, AHeight: integer); virtual;</li>
</ul>
<p>This is the internal SetBounds.
&#x9;&#x9;&#x9;&#x9;&#x9;&#x9; Applies constraints, updates base bounds, calls OnChangeBound, OnResize,
&#x9;&#x9;&#x9;&#x9;&#x9;&#x9; locks bounds.</p>
Applies constraints, updates base bounds, calls OnChangeBound, OnResize,
locks bounds.</p>
<ul>
<li>procedure DoSetBounds(ALeft, ATop, AWidth, AHeight: integer); virtual;</li>
</ul>
@ -13319,8 +13316,8 @@ End;
<li>function GetChildsRect(Scrolled: boolean): TRect; virtual;</li>
</ul>
<p>Returns the Client rectangle relative to the control's Left, Top.
&#x9;&#x9;&#x9;&#x9;&#x9;&#x9; If Scrolled is true, the rectangle is moved by the current scrolling values
&#x9;&#x9;&#x9;&#x9;&#x9;&#x9; (for an example see TScrollingWincontrol).</p>
If Scrolled is true, the rectangle is moved by the current scrolling values
(for an example see TScrollingWincontrol).</p>
<ul>
<li>function GetClientScrollOffset: TPoint; virtual;</li>
</ul>
@ -13329,8 +13326,10 @@ End;
<li>function GetControlOrigin: TPoint; virtual;</li>
</ul>
<p>Returns the screen coordinate of the topleft coordinate 0,0 of the control area. (The topleft pixel of the control on the screen)
&#x9;&#x9;&#x9;&#x9;&#x9;&#x9; Note that this value is the position as stored in the interface and is not always in sync with the LCL. When a control is moved, the LCL sets the
bounds to the wanted position and sends a move message to the interface. It is up to the interface to handle moves instantly or queued.</p>
Note that this value is the position as stored in the interface and is not always in sync with the LCL.
When a control is moved, the LCL sets the bounds to the wanted position
and sends a move message to the interface.
It is up to the interface to handle moves instantly or queued.</p>
</descr>
</topic>
<topic name="Control coordinates">

5
docs/xml/lcl/dialogs.xml
View File

@ -666,7 +666,6 @@ and then check the result to see if the user made a valid choice and pressed the
<descr/>
<errors/>
<seealso>
<link id="#LCL.Dialogs.TCommonDialog.Destroy">TCommonDialog.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
@ -1073,7 +1072,6 @@ if no file is specified, the Save File As dialog is invoked and the buffer is sa
<descr>Select Directory Dialog: allows the user to select a directory when the directory structure is displayed as a tree.</descr>
<errors/>
<seealso>
<link id="#lcl.dirsel.tdirseldlg">TDirSelDlg</link>
<link id="#lcl.editbtn.tdirectoryedit">TDirectoryEdit</link>
</seealso>
</element>
@ -2172,7 +2170,7 @@ you need to use TReplaceDialog to do that<br/>
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TFindDialog.Destroy" link="#LCL.Dialogs.TCommonDialog.Destroy">
<element name="TFindDialog.Destroy">
<short/>
<descr/>
<errors/>
@ -3110,7 +3108,6 @@ If a valid directory is given, the selected directory in the tree will be set to
<var>Destroy</var> - destructor for <var>TColorDialog</var>: frees custom colours then calls inherited <var>Destroy</var>
</short>
<seealso>
<link id="#LCL.Dialogs.TCommonDialog.Destroy">TCommonDialog.Destroy</link>
</seealso>
</element>
<element name="TColorDialog.CustomColors">

46
docs/xml/lcl/extctrls.xml
View File

@ -137,7 +137,7 @@
<descr>
<p>
<var>TPage</var>: One of the pages in a tabbed Notebook</p>
<p>Inherits most of its properties from <link id="#lcl.ExtCtrls.TCustomPage">TCustomPage</link>
<p>Inherits most of its properties from TCustomPage
</p>
</descr>
<seealso>
@ -170,7 +170,7 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPage.ImageIndex" link="#LCL.ExtCtrls.TCustomPage.ImageIndex">
<element name="TPage.ImageIndex">
<short/>
<descr/>
<seealso/>
@ -242,7 +242,7 @@
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TPage.PageIndex" link="#LCL.ExtCtrls.TCustomPage.PageIndex">
<element name="TPage.PageIndex" link="#LCL.ComCtrls.TCustomPage.PageIndex">
<short/>
<descr/>
<seealso/>
@ -2245,16 +2245,7 @@
<element name="TBevel">
<short>A bevel placed around the edge of buttons and other components</short>
<descr>
<p>
<var>TBevel</var>
- a bevel placed around the edge of buttons and other components.</p>
<p>Its appearance is governed by <link id="#lcl.ExtCtrls.TBevelShape">TBevelShape</link>, <link id="#lcl.ExtCtrls.TBevelStyle">TBevelStyle</link> and <link id="#lcl.ExtCtrls.TBevelwidth">TBevelwidth</link>
<p>Its appearance is governed by <link id="TBevelShape"/> and <link id="TBevelStyle"/>
</p>
</descr>
</element>
@ -2350,7 +2341,6 @@
<!-- property Visibility: published -->
<element name="TBevel.Align" link="#LCL.Controls.TControl.Align">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>)</p>
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
</descr>
@ -2359,8 +2349,7 @@
<!-- property Visibility: published -->
<element name="TBevel.Anchors" link="#LCL.Controls.TControl.Anchors">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determines how the control is to be anchored to its client or parent conrol</p>
<p>Determines how the control is to be anchored to its parent control</p>
<p>Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in <var>IsAnchorsStored</var>
</p>
</descr>
@ -2369,7 +2358,6 @@
<!-- property Visibility: published -->
<element name="TBevel.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determines the border spacing for this control</p>
<p>Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.</p>
<p>The properties are defined in the parent class <link id="#lcl.Controls.TControlBorderSpacing">TControlBorderSpacing</link>
@ -2380,7 +2368,6 @@
<!-- property Visibility: published -->
<element name="TBevel.Constraints" link="#LCL.Controls.TControl.Constraints">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
</descr>
<seealso/>
@ -2400,7 +2387,7 @@
<descr>
<var>Name</var> is the name of the component. This name should be a valid
identifier, i.e. must start with a letter, and can contain only letters,
numbers and the underscore character. When attempting to set the name of a
digits and the underscore character. When attempting to set the name of a
component, the name will be checked for validity. Furthermore, when a
component is owned by another component, the name must be either empty
or must be unique among the child component names.
@ -2450,16 +2437,12 @@ being raised.
<!-- property Visibility: published -->
<element name="TBevel.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds">
<descr>
<p>// standard properties, which should be supported by all descendants</p>
<p>Reads or Writes flag if bounds are changed</p>
</descr>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TBevel.OnResize" link="#LCL.Controls.TControl.OnResize">
<descr>// standard properties, which should be supported by all descendants<br/>
Reads or Writes flag if control is re-sized.
</descr>
<descr></descr>
<seealso/>
</element>
<!-- property Visibility: published -->
@ -2499,18 +2482,15 @@ Reads or Writes flag if control is re-sized.
<element name="TCustomRadioGroup">
<short>
<var>TCustomRadioGroup:</var> the base type for
<var>TRadioGroup</var>
</short>
<descr>
<p>
<var>TCustomRadioGroup:</var> the base type for
<var>TRadioGroup</var>
</p>
<p>A group of related but mutually exclusive radio buttons,
requiring the user to select one af a set of alternatives</p>
<p>This class defines <var>Items</var>, where the captions for individual radio boxes are stored, <var>Rows</var> and <var>Columns</var> for arranging the radio boxes, and ColumnLayout to determine whether the data are arranged down the columns first, or across the rows first.</p>
selectable by the user.</p>
<p>This class defines <var>Items</var>, where the captions of the individual radio boxes are stored,
<var>Rows</var> and <var>Columns</var> for arranging the radio boxes,
and ColumnLayout to determine whether the data are arranged
down the columns first, or across the rows first.</p>
</descr>
</element>
<!-- variable Visibility: private -->
@ -3253,7 +3233,7 @@ requiring the user to select one af a set of alternatives</p>
<descr/>
<errors/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomGroupBox.Create">TCustomGroupBox.Create</link>
<link id="#LCL.StdCtrls.TCustomGroupBox.Create">TCustomGroupBox.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->

4
docs/xml/lcl/forms.xml
View File

@ -265,7 +265,7 @@
</element>
<!-- object Visibility: default -->
<element name="TCustomHintAction">
<short>Action taken when a new value is assigned to <link id="TApplication.Hint"/>,
<short>Action taken when a new value is assigned to <link id="#lcl.Forms.TApplication.Hint"/>,
and no OnHint handler is available.
</short>
<descr>
@ -322,7 +322,7 @@
</element>
<!-- object Visibility: default -->
<element name="TControlScrollBar">
<short>Type of a scrollbar in a <link id="TScrollingWinControl"/>.
<short>Type of a scrollbar in a <link id="#lcl.Forms.TScrollingWinControl"/>.
</short>
<descr>
<p>

37
docs/xml/lcl/graphics.xml
View File

@ -2843,21 +2843,18 @@ Default is psSolid
<!-- property Visibility: published -->
<element name="TBrush.Style">
<short>
<var>Style</var> of the
<var>Brush</var>
<var>Style</var> of the <var>Brush</var>
</short>
<descr>Enumerated type - default Solid
</descr>
<descr>Enumerated type - default Solid</descr>
<seealso>
<link id="TBrushStyle"/>
</seealso>
</element>
<!-- record type Visibility: default -->
<element name="TRegionData">
<short>The <var>Data</var> about the current <var>Region</var> on the <var>Screen</var> or <var>Canvas</var>
[found where???]
</short>
<descr>At present the Region can only be rectangular; the ability to define it as a Polygon is not yet implemented</descr>
</element>
@ -2889,7 +2886,13 @@ Default is psSolid
</element>
<!-- variable Visibility: default -->
<element name="TRegionData.Winding">
<short>If True, use <var>Winding</var><var/> mode to construct the Polygon</short>
<short>If True, use <var>Winding</var> mode to construct the Polygon</short>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRegionData.Reference">
<short>A <var>Reference</var> made to the current Region</short>
<descr/>
<seealso/>
</element>
@ -2897,15 +2900,8 @@ Default is psSolid
<element name="TRegion">
<short>A defined <var>Region</var> on the screen, in which text is written</short>
<seealso>
<link id="TRegionData">TRegionData (in same Unit)</link>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TRegion.FRegionData">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TRegion.FreeHandle">
<short/>
@ -9522,12 +9518,6 @@ Checks for the presence of a valid Lazarus Resource, then uses
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TRegionData.Reference">
<short>A <var>Reference</var> made to the current Region</short>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TRegion.FreeReference">
<short/>
@ -10149,7 +10139,6 @@ Checks for the presence of a valid Lazarus Resource, then uses
<errors/>
<seealso>
<link id="#fcl.FPCanvas.TFPCustomCanvas.DoMoveTo">TFPCustomCanvas.DoMoveTo</link>
<link id="#LCL.Graphics.TCanvas.MoveTo">TCanvas.MoveTo</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -10170,7 +10159,6 @@ Checks for the presence of a valid Lazarus Resource, then uses
<errors/>
<seealso>
<link id="#fcl.FPCanvas.TFPCustomCanvas.DoLineTo">TFPCustomCanvas.DoLineTo</link>
<link id="#LCL.Graphics.TCanvas.LineTo">TCanvas.LineTo</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -10190,7 +10178,6 @@ Checks for the presence of a valid Lazarus Resource, then uses
<errors/>
<seealso>
<link id="#fcl.FPCanvas.TFPCustomCanvas.DoLine">TFPCustomCanvas.DoLine</link>
<link id="#LCL.Graphics.TCanvas.Line">TCanvas.Line</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -10218,7 +10205,7 @@ Checks for the presence of a valid Lazarus Resource, then uses
</short>
<descr/>
<errors>If <var>SrcCanvas</var> is not of type <var>TCanvas</var> then writes a warning to the debug output that copying is not supported
</errors>
</errors>
<seealso>
<link id="#fcl.FPCanvas.TFPCustomCanvas.DoCopyRect">TFPCustomCanvas.DoCopyRect</link>
<link id="#LCL.Graphics.TCanvas.CopyRect">TCanvas.CopyRect</link>

88
docs/xml/lcl/interfacebase.xml
View File

@ -510,7 +510,7 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppInit">
<short>Initializes the application on the platform, returns Screen information.</short>
<descr>Called by Application.Initialize. Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Called by Application.Initialize. Don't use this directly, the LCL will use it when adequate.</descr>
<errors/>
<seealso/>
</element>
@ -520,7 +520,7 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppRun">
<short>Enters a state in which the application waits for system messages</short>
<descr>Called by Application.Run. Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Called by Application.Run. Don't use this directly, the LCL will use it when adequate.</descr>
<errors>
</errors>
<seealso>
@ -532,7 +532,7 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppWaitMessage">
<short>Waits for arrival of a message.</short>
<descr>Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Don't use this directly, the LCL will use it when adequate.</descr>
<errors>
</errors>
<seealso>
@ -541,7 +541,7 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppProcessMessages">
<short>Handles all pending messages.</short>
<descr>Called by Application.ProcessMessages. Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Called by Application.ProcessMessages. Don't use this directly, the LCL will use it when adequate.</descr>
<errors>
</errors>
<seealso>
@ -550,14 +550,14 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppTerminate">
<short>Terminates the application.</short>
<descr>Called by Application.Terminate. Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Called by Application.Terminate. Don't use this directly, the LCL will use it when adequate.</descr>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppMinimize">
<short>Minimizes the whole application to the taskbar.</short>
<descr>Called by Application.Minimize. Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Called by Application.Minimize. Don't use this directly, the LCL will use it when adequate.</descr>
<seealso>
<link id="TWidgetSet.AppRestore"/>
</seealso>
@ -565,7 +565,7 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppRestore">
<short>Restore application previously minimized to the taskbar.</short>
<descr>Called by Application.Restore. Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Called by Application.Restore. Don't use this directly, the LCL will use it when adequate.</descr>
<seealso>
<link id="TWidgetSet.AppMinimize"/>
</seealso>
@ -573,13 +573,13 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppBringToFront">
<short>Brings the entire application on top of all other non-topmost programs.</short>
<descr>Called by Application.BringToFront. Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Called by Application.BringToFront. Don't use this directly, the LCL will use it when adequate.</descr>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppSetIcon">
<short>Set the icon of the taskbar button.</short>
<descr>Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Don't use this directly, the LCL will use it when adequate.</descr>
<seealso>
</seealso>
</element>
@ -592,7 +592,7 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppSetTitle">
<short></short>
<descr>Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Don't use this directly, the LCL will use it when adequate.</descr>
<errors>
</errors>
<seealso>
@ -604,7 +604,7 @@
<!-- procedure Visibility: public -->
<element name="TWidgetSet.AppSetVisible">
<short>Change the visibility of the application window.</short>
<descr>Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Don't use this directly, the LCL will use it when adequate.</descr>
<seealso>
</seealso>
</element>
@ -614,7 +614,7 @@
<!-- function Visibility: public -->
<element name="TWidgetSet.AppRemoveStayOnTopFlags">
<short>Resets all StayOnTop windows to NoTopmost.</short>
<descr>Don't use this directly, the LCL will use it when adequate.<descr/>
<descr>Don't use this directly, the LCL will use it when adequate.</descr>
<seealso>
</seealso>
</element>
@ -771,22 +771,20 @@
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.IsHelpKey">
<short></short>
<short>Checks whether the widgetset uses the key to show help.</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TWidgetSet.IsHelpKey.Result">
<short></short>
<short>True when this is a Help key.</short>
</element>
<element name="TWidgetSet.IsHelpKey.Key">
<short></short>
<short>The virtual key.</short>
</element>
<element name="TWidgetSet.IsHelpKey.Shift">
<short></short>
<short>The modifier key state.</short>
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.CreateTimer">
@ -1022,7 +1020,7 @@
<!-- function Visibility: public -->
<element name="TWidgetSet.CallNextHookEx">
<short>Calls the next procedure in the hook chain.</short>
<descr><descr/>
<descr/>
<errors/>
<seealso/>
</element>
@ -4170,6 +4168,8 @@
</p><p>
Flags specify how the window is invalidated or validated,
and when repainting occurs.
Flags other than RDW_ERASE may not be supported by all platforms.
</p><p>
To invalidate specify RDW_INVALIDATE, and optionally one of:
</p>
<ul>
@ -4183,6 +4183,7 @@
</li>
</ul>
<p>
Validation is not implemented for all platforms.
To validate specify RDW_VALIDATE, and optionally one of:
</p>
<ul>
@ -4636,9 +4637,9 @@
<element name="TWidgetSet.SetCursor">
<short>Changes the shape of the mouse cursor.</short>
<descr/>
<errors/>
<seealso>
<link id="#lcl.Controls.TCursor"/>
<link id="TWidgetSet.CreateStandardCursor"/>
</seealso>
</element>
<element name="TWidgetSet.SetCursor.Result">
@ -5704,19 +5705,18 @@
<short></short>
</element>
<element name="TWidgetSet.AllocateHWnd">
<short></short>
<short>Allocates an invisible window that can be used to receive messages.</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
<link id="TWidgetSet.DeallocateHWnd"/>
</seealso>
</element>
<element name="TWidgetSet.AllocateHWnd.Result">
<short></short>
<short>The window handle, zero on failure.</short>
</element>
<element name="TWidgetSet.AllocateHWnd.Method">
<short></short>
<short>The callback method for the window. Can be Nil.</short>
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.AskUser">
@ -5976,19 +5976,19 @@
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.CreateStandardCursor">
<short></short>
<short>Creates one of the standard cursors.</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
<link id="#lcl.Controls.TCursor"/>
<link id="TWidgetSet.SetCursor"/>
</seealso>
</element>
<element name="TWidgetSet.CreateStandardCursor.Result">
<short></short>
<short>The cursor handle, zero on failure.</short>
</element>
<element name="TWidgetSet.CreateStandardCursor.ACursor">
<short></short>
<short>The cursor shape.</short>
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.DCClipRegionValid">
@ -6007,16 +6007,15 @@
</element>
<!-- procedure Visibility: public -->
<element name="TWidgetSet.DeallocateHWnd">
<short></short>
<short>Deletes a window created with AllocateHWnd.</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
<link id="TWidgetSet.AllocateHWnd"/>
</seealso>
</element>
<element name="TWidgetSet.DeallocateHWnd.Wnd">
<short></short>
<short>The window handle.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TWidgetSet.DestroyRubberBand">
@ -6033,19 +6032,21 @@
</element>
<!-- procedure Visibility: public -->
<element name="TWidgetSet.DrawDefaultDockImage">
<short></short>
<short>Draws the DockRect during drag-dock operations.</short>
<descr>
</descr>
<errors>
The Windows implementation doesn't cooperate with the DragManager.
[See Mantis 0018525?]
</errors>
<seealso>
</seealso>
</element>
<element name="TWidgetSet.DrawDefaultDockImage.AOldRect">
<short></short>
<short>The old DockRect.</short>
</element>
<element name="TWidgetSet.DrawDefaultDockImage.ANewRect">
<short></short>
<short>The new DockRect.</short>
</element>
<element name="TWidgetSet.DrawDefaultDockImage.AOperation">
<short></short>
@ -6273,18 +6274,16 @@
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.GetControlConstraints">
<short/>
<short>Updates the constraints object (e.g. TSizeConstraints) with interface specific bounds.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TWidgetSet.GetControlConstraints.Result">
<short/>
<short>False on failure.</short>
</element>
<!-- argument Visibility: default -->
<element name="TWidgetSet.GetControlConstraints.Constraints">
<short/>
<short>Should be a TSizeConstraints.</short>
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.GetDCOriginRelativeToWindow">
@ -6551,14 +6550,13 @@
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.IntfSendsUTF8KeyPress">
<short/>
<short>Returns the interface capability to send UTF-8 characters[?]</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TWidgetSet.IntfSendsUTF8KeyPress.Result">
<short/>
<short>True when UTF-8 KeyPress messages are sent[?]</short>
</element>
<!-- function Visibility: public -->
<element name="TWidgetSet.InvalidateFrame">

2
docs/xml/lcl/interfaces/win32/win32int.xml
View File

@ -4066,7 +4066,7 @@
<short/>
</element>
<element name="TWin32WidgetSet.IntfSendsUTF8KeyPress">
<short/>
<short>Returns the interface capability to send UTF-8 characters[?]</short>
<descr/>
<errors/>
<seealso/>

80
docs/xml/lcl/lclproc.xml
View File

@ -1843,7 +1843,7 @@
</element>
<!-- "type" alias type Visibility: default -->
<element name="UTF16String">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -1852,7 +1852,7 @@
</element>
<!-- pointer type Visibility: default -->
<element name="PUTF16String" link="UTF16String">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -1861,7 +1861,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8CharacterLength">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr/>
<errors/>
@ -1875,7 +1875,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8Length">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr/>
<errors/>
@ -1895,7 +1895,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8CharacterToUnicode">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr/>
<errors/>
@ -1912,7 +1912,7 @@
</element>
<!-- function Visibility: default -->
<element name="UnicodeToUTF8">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr/>
<errors/>
@ -1929,7 +1929,7 @@
</element>
<!-- function Visibility: default -->
<element name="UnicodeToUTF8SkipErrors">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -1949,7 +1949,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8ToDoubleByteString">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr/>
<errors/>
@ -1963,7 +1963,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8ToDoubleByte">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr/>
<errors/>
@ -1983,7 +1983,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8FindNearestCharStart">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr/>
<errors/>
@ -2003,7 +2003,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8CharStart">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr/>
<errors/>
@ -2023,7 +2023,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8CharToByteIndex">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2046,7 +2046,7 @@
</element>
<!-- procedure Visibility: default -->
<element name="UTF8FixBroken">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2060,7 +2060,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8CharacterStrictLength">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2077,7 +2077,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8CStringToUTF8String">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2097,7 +2097,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8Pos">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2117,7 +2117,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8Copy">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2140,7 +2140,7 @@
</element>
<!-- procedure Visibility: default -->
<element name="UTF8Delete">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2160,7 +2160,7 @@
</element>
<!-- procedure Visibility: default -->
<element name="UTF8Insert">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2180,7 +2180,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8LowerCase">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2197,7 +2197,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8UpperCase">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2214,7 +2214,7 @@
</element>
<!-- function Visibility: default -->
<element name="FindInvalidUTF8Character">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2237,7 +2237,7 @@
</element>
<!-- function Visibility: default -->
<element name="ValidUTF8String">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2254,7 +2254,7 @@
</element>
<!-- procedure Visibility: default -->
<element name="AssignUTF8ListToAnsi">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2271,7 +2271,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF16CharacterLength">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2288,7 +2288,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF16Length">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2311,7 +2311,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF16CharacterToUnicode">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2331,7 +2331,7 @@
</element>
<!-- function Visibility: default -->
<element name="UnicodeToUTF16">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2348,7 +2348,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8CompareStr">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2368,7 +2368,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8CompareText">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2388,7 +2388,7 @@
</element>
<!-- alias type Visibility: default -->
<element name="TConvertResult">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2397,7 +2397,7 @@
</element>
<!-- alias type Visibility: default -->
<element name="TConvertOption">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2406,7 +2406,7 @@
</element>
<!-- alias type Visibility: default -->
<element name="TConvertOptions">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2415,7 +2415,7 @@
</element>
<!-- function Visibility: default -->
<element name="ConvertUTF8ToUTF16">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2447,7 +2447,7 @@
</element>
<!-- function Visibility: default -->
<element name="ConvertUTF16ToUTF8">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2479,7 +2479,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF8ToUTF16">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2496,7 +2496,7 @@
</element>
<!-- function Visibility: default -->
<element name="UTF16ToUTF8">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2513,7 +2513,7 @@
</element>
<!-- procedure Visibility: default -->
<element name="LCLGetLanguageIDs">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2530,7 +2530,7 @@
</element>
<!-- function Visibility: default -->
<element name="CreateFirstIdentifier">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>
@ -2547,7 +2547,7 @@
</element>
<!-- function Visibility: default -->
<element name="CreateNextIdentifier">
<short> Deprecated, see <link id="#LCL.LazUTF8"/> for replacements.
<short> Deprecated, see <link id="#LazUtils.LazUTF8"/> for replacements.
</short>
<descr>
</descr>

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

@ -2813,7 +2813,8 @@
<!-- object Visibility: default -->
<element name="TMemoScrollbar">
<short>A ScrollBar for use in Memo Boxes.</short>
<descr>Scroll Bar specifically for use in Memo Boxes. Inherits most of its properties from its ancestor, <link id="#lcl.Forms.TControlScrollBar">TControlScrollBar</link>
<descr>Scroll Bar specifically for use in Memo Boxes.
Inherits most of its properties from its ancestor, <link id="#lcl.Forms.TControlScrollBar">TControlScrollBar</link>
</descr>
</element>
<!-- function Visibility: protected -->
@ -4493,7 +4494,8 @@
</p><p>
E.g. when you have a NameEdit1 control on a form, preceded by a label NameLabel1,
you can set NameLabel1.FocusControl to NameEdit1, and NameLabel1.Caption to '&amp;Name'.
This makes the NameLabel1 displayed as '<b>N</b>ame' [should be underlined, but fpdoc errors on '<u>N</u>ame' ?].
This makes the NameLabel1 displayed as '<b>N</b>ame'.
<!-- should be underlined, but fpdoc errors on '<u>N</u>ame' -->
</p>
</descr>
<seealso>