FPDoc - fixed some xml coding errrors, and updated constructors and destructors in comctrls.xml, controls.xml, customtimer.xml and extctrls.xml

git-svn-id: trunk@18357 -
This commit is contained in:
kirkpatc 2009-01-20 14:23:58 +00:00
parent fbdb916c8c
commit f96550f8e2
4 changed files with 239 additions and 158 deletions

View File

@ -7401,7 +7401,7 @@
</ul>
</descr>
<seealso>
<link id="TToolButton"/>
<link id="#LCL.ComCtrls.TToolButton"/>
</seealso>
<example file="comctrls/ttoolbutton.pas"/>
</element>
@ -8256,7 +8256,7 @@
<short>Determines the style of the tool button.</short>
<descr>See TToolButtonStyle for the possible Style values.</descr>
<seealso>
<link id="TToolButtonStyle"/>
<link id="#LCL.ComCtrls.TToolButtonStyle"/>
</seealso>
<example file="comctrls/ttoolbutton.pas"/>
</element>
@ -8362,7 +8362,7 @@
<p>Typically, the tool buttons correspond to items in an application's menu and gives the user more direct access to the application's commands.</p>
</descr>
<seealso>
<link id="TToolButton"/>
<link id="#LCL.ComCtrls.TToolButton"/>
<link id="#lcl.stdctrls.HowToUseStdCtrls">HowToUseStdCtrls</link>
</seealso>
<example file="comctrls/ttoolbutton.pas"/>
@ -9011,7 +9011,7 @@
<p>To add tool buttons to the toolbar at design time, select the toolbar, right-click, and choose New Button. To create a space (separator) between one button and the next, select New Separator. To create a divider between buttons, add a button and set its <var>Style</var> propery to <var>tbsDivider</var>. Other controls may be added to the toolbar directly from the Component palette. </p>
</descr>
<seealso>
<link id="TToolButton.Style"/>
<link id="#LCL.ComCtrls.TToolButton.Style"/>
</seealso>
<example file="comctrls/ttoolbutton.pas"/>
</element>
@ -15715,7 +15715,7 @@ the comparision is case sensitive.
to display a hierarchical list of items. Items are shown by their caption and an optional bitmap.</descr>
<seealso>
<link id="#lcl.stdctrls.HowToUseStdCtrls"/>
<link id="TCustomTreeView"/>
<link id="#LCL.ComCtrls.TCustomTreeView"/>
</seealso>
</element>
<!-- property Visibility: published -->
@ -16281,12 +16281,12 @@ the comparision is case sensitive.
</element>
<!-- function Visibility: default -->
<element name="CompareExpandedNodes">
<short>Function to compare the node text two nodes.</short>
<short>Function to compare the node text of two nodes.</short>
<descr>
<p>This function does an ANSICompare on the NodeText of two nodes. The parameters Data1 and Data2 are pointers to the nodes to be compared. The result is the same is the result from ANSICompareText.</p>
<p>-1: The nodetext from the first node is lower then the nodetext from the second.</p>
<p>0: The nodetext-s from both nodes are equal.</p>
<var>1: The nodetext from the first node is higher then the nodetext from the second.</var>
<p>1: The nodetext from the first node is higher then the nodetext from the second.</p>
</descr>
</element>
<!-- function result Visibility: default -->
@ -16308,7 +16308,7 @@ the comparision is case sensitive.
<p>This function does an ANSICompare on the NodeText of two nodes. The parameters Data1 and Data2 are pointers to the nodes to be compared. The result is the same is the result from ANSICompareText.</p>
<p>-1: The given text is lower then the nodetext from the given node.</p>
<p>0: The given text is equal to the nodetext from the given node.</p>
<var>1: The given text is higher then the nodetext from the given node.</var>
<p>1: The given text is higher then the nodetext from the given node.</p>
</descr>
</element>
<!-- function result Visibility: default -->

View File

@ -348,7 +348,7 @@ mrLast=mrYesToAll=10</descr>
<element name="TAnchorKind">
<short>Enumerated type listing the possible positions for alignment of a control</short>
<descr>
<printshort id="TAnchorKind"/>
<p>Enumerated type listing the possible positions for alignment of a control</p>
<pre>akTop,
akLeft,
akRight,
@ -962,8 +962,8 @@ mrLast=mrYesToAll=10</descr>
<element name="TControlCanvas">
<short>The base class for the canvas property of several graphic controls, such as TGraphicControl and TCustomControl</short>
<seealso>
<link id="TGraphicControl"/>
<link id="TCustomControl"/>
<link id="#lcl.Controls.TGraphicControl"/>
<link id="#lcl.Controls.TCustomControl"/>
<link id="#lcl.Graphics.TCanvas">TCanvas</link>
</seealso>
</element>
@ -1681,7 +1681,7 @@ mrLast=mrYesToAll=10</descr>
<element name="TDragObject.HideDragImage">
<short>Procedure for hiding the drag image during movement</short>
<seealso>
<link id="TDragObject.ShowDragImage">ShowDragImage</link>
<link id="#lcl.Controls.TDragObject.ShowDragImage">ShowDragImage</link>
</seealso>
</element>
<!-- function Visibility: public -->
@ -1696,7 +1696,7 @@ mrLast=mrYesToAll=10</descr>
<element name="TDragObject.ShowDragImage">
<short>Procedure for keeping the image visible during movement</short>
<seealso>
<link id="TDragObject.HideDragImage">HideDragImage</link>
<link id="#lcl.Controls.TDragObject.HideDragImage">HideDragImage</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -1753,7 +1753,7 @@ mrLast=mrYesToAll=10</descr>
<element name="TBaseDragControlObject">
<short>An ancestor class for many drag control objects</short>
<seealso>
<link id="TDragObject"/>
<link id="#lcl.Controls.TDragObject"/>
</seealso>
</element>
<!-- variable Visibility: private -->
@ -1818,7 +1818,7 @@ mrLast=mrYesToAll=10</descr>
<short>Assigns source object</short>
<descr>Overrides definition in parent class</descr>
<seealso>
<link id="TDragObject"/>
<link id="#lcl.Controls.TDragObject"/>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -3423,7 +3423,7 @@ mrLast=mrYesToAll=10</descr>
<!-- procedure Visibility: protected -->
<element name="TControlActionLink.SetHelpContext">
<short>
<p>SetHelpContext</p> - specifies the context-based help variable to use</short>
<var>SetHelpContext</var> - specifies the context-based help variable to use</short>
<descr/>
<errors/>
<seealso/>
@ -4200,8 +4200,8 @@ mrLast=mrYesToAll=10</descr>
<short>Function to get text-string associated with control</short>
<descr>Uses RealGetText rather than GetTextBuf to avoid unnecessary read-writes to PChar buffers</descr>
<seealso>
<link id="TControl.GetTextBuf">GetTextBuf</link>
<link id="RealGetText"/>
<link id="#lcl.Controls.TControl.GetTextBuf">GetTextBuf</link>
<link id="#lcl.Controls.TControl.RealGetText"/>
</seealso>
</element>
<!-- function result Visibility: default -->
@ -4667,8 +4667,8 @@ mrLast=mrYesToAll=10</descr>
<short>Stores text in buffer</short>
<descr>Uses RealSetText rather than SetTextBuf to avoid unnecessary read-writes to PChar buffer</descr>
<seealso>
<link id="TControl.RealSetText">RealSetText</link>
<link id="TControl.SetTextBuf">SetTextBuf</link>
<link id="#lcl.Controls.TControl.RealSetText">RealSetText</link>
<link id="#lcl.Controls.TControl.SetTextBuf">SetTextBuf</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -4709,7 +4709,7 @@ mrLast=mrYesToAll=10</descr>
<element name="TControl.FControlState">
<short>Flag showing the set of states for this control</short>
<seealso>
<link id="TControlState"/>
<link id="#lcl.Controls.TControlState"/>
</seealso>
</element>
<!-- variable Visibility: protected -->
@ -5647,40 +5647,40 @@ mrLast=mrYesToAll=10</descr>
<short>
<var>Click</var> - a procedure that allows the programmer to simulate a mouse click over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnClick"/> event</short>
<link id="#lcl.Controls.TControl.OnClick"/> event</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.DblClick">
<short>
<var>DblClick</var> - a procedure that allows the programmer to simulate a mouse double-click over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnDblClick"/> event</short>
<link id="#lcl.Controls.TControl.OnDblClick"/> event</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.TripleClick">
<short>
<var>TripleClick</var> - a procedure that allows the programmer to simulate a mouse triple-click over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnTripleClick"/> event</short>
<link id="#lcl.Controls.TControl.OnTripleClick"/> event</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.QuadClick">
<short>
<var>QuadClick</var> - a procedure that allows the programmer to simulate a mouse quadruple-click over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnQuadClick"/> event</short>
<link id="#lcl.Controls.TControl.OnQuadClick"/> event</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TControl.MouseDown">
<short>
<var>MouseDown</var> - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseDown"/> event</short>
<link id="#lcl.Controls.TControl.OnMouseDown"/> event</short>
<descr>
<p>
<var>MouseDown</var> - a procedure that allows the programmer to simulate a mouse button being down over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseDown"/> event</p>
<link id="#lcl.Controls.TControl.OnMouseDown"/> event</p>
<p>
<var>Button</var> specifies which mouse button;
<var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed;
@ -5710,12 +5710,12 @@ mrLast=mrYesToAll=10</descr>
<short>
<var>MouseMove</var> - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseMove"/> event</short>
<link id="#lcl.Controls.TControl.OnMouseMove"/> event</short>
<descr>
<p>
<var>MouseMove</var> - a procedure that allows the programmer to simulate a mouse being moved over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseMove"/> event</p>
<link id="#lcl.Controls.TControl.OnMouseMove"/> event</p>
<p>
<var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed;
<var>X, Y</var> show mouse position</p>
@ -5740,12 +5740,12 @@ mrLast=mrYesToAll=10</descr>
<short>
<var>MouseUp</var> - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseUp"/> event</short>
<link id="#lcl.Controls.TControl.OnMouseUp"/> event</short>
<descr>
<p>
<var>MouseUp</var> - a procedure that allows the programmer to simulate a mouse button being Up over the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseUp"/> event</p>
<link id="#lcl.Controls.TControl.OnMouseUp"/> event</p>
<p>
<var>Button</var> specifies which mouse button;
<var>Shift</var> signifies whether Ctrl, Shift or Alt keys are also pressed;
@ -5775,7 +5775,7 @@ mrLast=mrYesToAll=10</descr>
<short>
<var>MouseEnter</var> - a procedure that allows the programmer to simulate a mouse entering the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseEnter"/> event</short>
<link id="#lcl.Controls.TControl.OnMouseEnter"/> event</short>
<descr/>
<errors/>
<seealso/>
@ -5785,7 +5785,7 @@ mrLast=mrYesToAll=10</descr>
<short>
<var>MouseLeave</var> - a procedure that allows the programmer to simulate a mouse leaving the control, and initiates the same
<var>Action</var> as that associated with the
<link id="OnMouseLeave"/> event</short>
<link id="#lcl.Controls.TControl.OnMouseLeave"/> event</short>
<descr/>
<errors/>
<seealso/>
@ -5930,9 +5930,9 @@ mrLast=mrYesToAll=10</descr>
<descr>This is the function that is actually used by <var>GetTextBuf</var>, and loads a string rather than performing read-write to a <var>PChar</var> buffer
</descr>
<seealso>
<link id="TControl.GetTextBuf">GetTextBuf</link>
<link id="TControl.RealSetText">RealSetText</link>
<link id="TControl.SetTextBuf">SetTextBuf</link>
<link id="#lcl.Controls.TControl.GetTextBuf">GetTextBuf</link>
<link id="#lcl.Controls.TControl.RealSetText">RealSetText</link>
<link id="#lcl.Controls.TControl.SetTextBuf">SetTextBuf</link>
</seealso>
</element>
<!-- function result Visibility: default -->
@ -5945,9 +5945,9 @@ mrLast=mrYesToAll=10</descr>
<descr>This is the procedure that is actually used by <var>SetTextBuf,</var> and stores text as a string rather than performing read-write to a <var>PChar</var> buffer
</descr>
<seealso>
<link id="TControl.SetTextBuf">SetTextBuf</link>
<link id="TControl.RealGetText">RealGetText</link>
<link id="TControl.GetTextBuf">GetTextBuf</link>
<link id="#lcl.Controls.TControl.SetTextBuf">SetTextBuf</link>
<link id="#lcl.Controls.TControl.RealGetText">RealGetText</link>
<link id="#lcl.Controls.TControl.GetTextBuf">GetTextBuf</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -6500,7 +6500,7 @@ mrLast=mrYesToAll=10</descr>
<short>Remove a previously docked control and put a new control in its place</short>
<descr>Checks to see whether there is a previously docked control, <br/>and removes it, then puts the new control in its place</descr>
<seealso>
<link id="TControl.ManualDock">ManualDock</link>
<link id="#lcl.Controls.TControl.ManualDock">ManualDock</link>
</seealso>
</element>
<!-- function result Visibility: default -->
@ -6654,7 +6654,7 @@ mrLast=mrYesToAll=10</descr>
<descr>Checks that this is a new control, then calls SetBounds to set up coordinates defining its position
</descr>
<seealso>
<link id="TControl.SetBounds">SetBounds</link>
<link id="#lcl.Controls.TControl.SetBounds">SetBounds</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -6890,8 +6890,8 @@ mrLast=mrYesToAll=10</descr>
<short>
<var>Hide </var>this control</short>
<seealso>
<link id="TControl.Visible"/>
<link id="TControl.Show"/>
<link id="#lcl.Controls.TControl.Visible"/>
<link id="#lcl.Controls.TControl.Show"/>
</seealso>
</element>
<!-- procedure Visibility: public -->
@ -6975,8 +6975,8 @@ mrLast=mrYesToAll=10</descr>
</pre>
</descr>
<seealso>
<link id="TControl.RealGetText">RealGetText</link>
<link id="TControl.GetText">GetText</link>
<link id="#lcl.Controls.TControl.RealGetText">RealGetText</link>
<link id="#lcl.Controls.TControl.GetText">GetText</link>
</seealso>
</element>
<!-- function result Visibility: default -->
@ -7021,8 +7021,8 @@ mrLast=mrYesToAll=10</descr>
</pre>
</descr>
<seealso>
<link id="TControl.RealSetText">RealSetText</link>
<link id="TControl.SetText">SetText</link>
<link id="#lcl.Controls.TControl.RealSetText">RealSetText</link>
<link id="#lcl.Controls.TControl.SetText">SetText</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -7107,8 +7107,8 @@ mrLast=mrYesToAll=10</descr>
<descr/>
<errors/>
<seealso>
<link id="TControl.Visible"/>
<link id="TControl.Hide"/>
<link id="#lcl.Controls.TControl.Visible"/>
<link id="#lcl.Controls.TControl.Hide"/>
</seealso>
</element>
<!-- procedure Visibility: public -->
@ -7258,7 +7258,7 @@ mrLast=mrYesToAll=10</descr>
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right</p>
</descr>
<seealso>
<link id="TAlign"/>
<link id="#lcl.Controls.TAlign"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7271,7 +7271,7 @@ mrLast=mrYesToAll=10</descr>
</p>
</descr>
<seealso>
<link id="TAnchors"/>
<link id="#lcl.Controls.TAnchors"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7284,7 +7284,7 @@ mrLast=mrYesToAll=10</descr>
</p>
</descr>
<seealso>
<link id="TAnchorSide"/>
<link id="#lcl.Controls.TAnchorSide"/>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -7406,7 +7406,7 @@ introduced. These functions interface with the LCLInterface. </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>
<link id="TSizeConstraints"/>
<link id="#lcl.Controls.TSizeConstraints"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7434,7 +7434,7 @@ introduced. These functions interface with the LCLInterface. </p>
- whether mouse has been clicked, data being read, control being re-drawn, etc. Reads or stores the state of the control.</p>
</descr>
<seealso>
<link id="TControlState"/>
<link id="#lcl.Controls.TControlState"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7449,7 +7449,7 @@ introduced. These functions interface with the LCLInterface. </p>
- whether the control responds to mouse clicks, can be re-sized, has particular actions, etc. Reads the stored style, or saves the new style</p>
</descr>
<seealso>
<link id="TControlStyle"/>
<link id="#lcl.Controls.TControlStyle"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7522,8 +7522,8 @@ Reads a logical (boolean) flag or sets it to determine whether this object is a
<short>Event Handler when a hint needs to be shown</short>
<descr>// standard properties, which should be supported by all descendants<br/>Reads or Writes a flag when a hint (a small pop-up box, appearing when the mouse hovers over an object) is to be shown</descr>
<seealso>
<link id="THintInfo"/>
<link id="TControlShowHintEvent"/>
<link id="#lcl.Controls.THintInfo"/>
<link id="#lcl.Controls.TControlShowHintEvent"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7532,7 +7532,7 @@ Reads a logical (boolean) flag or sets it to determine whether this object is a
<descr>// standard properties, which should be supported by all descendants<br/>
Reads or writes a flag to find or store the identity of the parent for this control. The parent is of type TWincontrol</descr>
<seealso>
<link id="TWinControl"/>
<link id="#lcl.Controls.TWinControl"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7552,7 +7552,7 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<short>Flag to determine: Is hint to be displayed for this control?</short>
<descr>// standard properties, which should be supported by all descendants<br/>Reads flag or writes one to determine if a hint is to be shown when mouse hovers over this control. If value is stored, a storage flag is set. Display of the actual hint is controlled by OnShowHint</descr>
<seealso>
<link id="TControl.OnShowHint">OnShowHint</link>
<link id="#lcl.Controls.TControl.OnShowHint">OnShowHint</link>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7568,9 +7568,9 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<remark>The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.</remark>
</descr>
<seealso>
<link id="TControl.IsVisible"/>
<link id="TControl.Show"/>
<link id="TControl.Hide"/>
<link id="#lcl.Controls.TControl.IsVisible"/>
<link id="#lcl.Controls.TControl.Show"/>
<link id="#lcl.Controls.TControl.Hide"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -7578,7 +7578,7 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<short>Reads or writes a message associated with this window</short>
<descr>// standard properties, which should be supported by all descendants<br/>Reads message from flag area, or stores a message</descr>
<seealso>
<link id="TWndMethod"/>
<link id="#lcl.Controls.TWndMethod"/>
<link id="#lcl.LMessages.TLMessage"/>
</seealso>
</element>
@ -8253,7 +8253,7 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<p>Defines procedures and functions related to windowed controls, some of which override virtual methods defined in ancestor classes.</p>
</descr>
<seealso>
<link id="TControl"/>
<link id="#lcl.Controls.TControl"/>
</seealso>
</element>
<!-- variable Visibility: private -->
@ -10100,7 +10100,7 @@ Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPop
<short>
<var>CreateParams</var> - create parameters for this windowed class</short>
<descr>
<printshort id="TWinControl.CreateParams"/>
<p><var>CreateParams</var> - create parameters for this windowed class</p>
<p>Definition of parameters:</p>
<pre>TCreateParams = record
Caption: PChar;
@ -10177,7 +10177,7 @@ End;
<short>
<var>InitializeWnd</var> - initialise the window for this control</short>
<descr>
<printshort id="TWinControl.InitializeWnd"/>
<p><var>InitializeWnd</var> - initialise the window for this control</p>
<p>Gets called after the Handle is created and before the child handles are created</p>
</descr>
<errors/>
@ -10401,7 +10401,7 @@ End;
<short>Definitions of how any child control is to be sized</short>
<descr>Reads values from flag or stores values to flag. Most of the properties are inherited from TControlChildSizing, <br/>which you should read to find out more about this control</descr>
<seealso>
<link id="TControlChildSizing"/>
<link id="#lcl.Controls.TControlChildSizing"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -10447,7 +10447,7 @@ End;
<short>Property that actually controls the docking process</short>
<descr>Reads or writes a flag. Derived from the parent class TDockManager</descr>
<seealso>
<link id="TDockManager"/>
<link id="#lcl.Controls.TDockManager"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -11246,7 +11246,7 @@ need the ability to accept keyboard input or contain other controls. </p>
<var>Paint</var> method called in response to paint requests received by the parent control.</p>
</descr>
<seealso>
<link id="TWinControl"/>
<link id="#lcl.Controls.TWinControl"/>
<link id="#lcl.Graphics.TCanvas"/>
</seealso>
</element>
@ -11336,8 +11336,8 @@ getting the parent control's Canvas dimensions.</p>
<descr>Contains simple basic definitions to create, destroy and paint window controls and set basic properties like canvas and border
</descr>
<seealso>
<link id="TWinControl"/>
<link id="TControl"/>
<link id="#lcl.Controls.TWinControl"/>
<link id="#lcl.Controls.TControl"/>
</seealso>
</element>
<!-- variable Visibility: private -->
@ -11369,7 +11369,7 @@ getting the parent control's Canvas dimensions.</p>
<short>Paint handler plug-in</short>
<descr>This is a plug-in in TWinControl to get the DC, <br/>assign it to our canvas and call the paint method for <br/>descendants to do the actual painting</descr>
<seealso>
<link id="TWinControl.PaintWindow"/>
<link id="#lcl.Controls.TWinControl.PaintWindow"/>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -11425,7 +11425,7 @@ getting the parent control's Canvas dimensions.</p>
<descr>Only a restricted series of options is available: none or a single border.
</descr>
<seealso>
<link id="TBorderStyle"/>
<link id="#lcl.Controls.TBorderStyle"/>
</seealso>
</element>
<!-- property Visibility: public -->
@ -11978,7 +11978,7 @@ getting the parent control's Canvas dimensions.</p>
</pre>
</descr>
<seealso>
<link id="TDockManager"/>
<link id="#lcl.Controls.TDockManager"/>
</seealso>
</element>
<!-- variable Visibility: private -->
@ -12637,7 +12637,7 @@ getting the parent control's Canvas dimensions.</p>
<descr>Calls CursorToIdent to find correct entry in look-up table</descr>
<errors/>
<seealso>
<link id="CursorToIdent"/>
<link id="#lcl.Controls.CursorToIdent"/>
</seealso>
</element>
<!-- function result Visibility: default -->
@ -12653,7 +12653,7 @@ getting the parent control's Canvas dimensions.</p>
<short>
<var>StringToCursor</var> - returns the cursor value corresponding to the name supplied</short>
<descr>
<printshort id="StringToCursor"/>
<p><var>StringToCursor</var> - returns the cursor value corresponding to the name supplied</p>
<p>Finds the numeric cursor value corresponding to the name <var>S</var> in the cursor look-up table</p>
</descr>
</element>
@ -13476,7 +13476,7 @@ getting the parent control's Canvas dimensions.</p>
<!-- property Visibility: public -->
<element name="TDragManager.DragThreshold">
<short>The threshold amount by which the mouse must move before the dragging process starts.</short>
<descr>The threshold amount by which the mouse must move before the dragging process starts. Default is 5 pixels - irrelevant if <link id="DragImmediate"/> is true
<descr>The threshold amount by which the mouse must move before the dragging process starts. Default is 5 pixels - irrelevant if <link id="#lcl.Controls.TDragManager.DragImmediate"/> is true
</descr>
<seealso/>
</element>

View File

@ -141,22 +141,29 @@
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
<!-- constructor Visibility: public -->
<element name="TCustomTimer.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<element name="TCustomTimer.Create">
<short>
<var>Create</var> - constructor for <var>TCustomTimer</var>: calls inherited <var>Create</var>, sets up handle and initialises timer interval</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomTimer.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<element name="TCustomTimer.Destroy">
<short>
<var>Destroy</var>: destructor for <var>TCustomTimer</var>: disables and kills timer then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy"/>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Enabled">

View File

@ -106,13 +106,12 @@
<descr>
<p>
<var>TPageFlag</var> - enumerated type containing possible values for page flags for notebook pages</p>
<pre/>
pfAdded, // handle of page added to notebook handle
<pre>pfAdded, // handle of page added to notebook handle
pfAdding, // currently handle of page adding to notebook handle
pfRemoving, // currently removing page handle from notebook handle
pfInserting // currently inserting page into notebook
</descr>
</pre>
</descr>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
@ -316,11 +315,14 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomPage.Create" link="#lcl.Controls.TControl.Create">
<short/>
<element name="TCustomPage.Create">
<short>
<var>Create</var> - constructor for <var>TCustomPage</var>: calls inherited <var>Create</var> then initialises style, visibility, alignment and caption</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#lcl.Controls.TControl.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPage.Create.TheOwner">
@ -505,10 +507,14 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TNBPages.Create" link="#rtl.System.TObject.Create">
<element name="TNBPages.Create">
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#rtl.System.TObject.Create"/>
</seealso>
<short>
<var>Create</var> - constructor for <var>TNBPages</var>: calls inherited <var>Create</var> then sets up the list of pages on the notebook</short>
</element>
<!-- argument Visibility: default -->
<element name="TNBPages.Create.thePageList">
@ -1132,22 +1138,29 @@
<var>Page</var> that is currently selected and is available for interaction</short>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomNotebook.Create" link="#LCL.Controls.TWinControl.Create">
<short/>
<element name="TCustomNotebook.Create">
<short>
<var>Create</var> - constructor for <var>TCustomNotebook</var>: calls inherited <var>Create</var> creates a pagelist, then sets initial bounds and default values for local variables and properties</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TWinControl.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomNotebook.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomNotebook.Destroy" link="#LCL.Controls.TWinControl.Destroy">
<short/>
<element name="TCustomNotebook.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TCustomNotebook</var>: clears and frees pages and list, then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TCustomNotebook.TabIndexAtClientPos">
@ -1576,7 +1589,7 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TNotebook.Create" link="#LCL.Controls.TWinControl.Create">
<element name="TNotebook.Create" link="#LCL.ExtCtrls.TCustomNotebook.Create">
<short/>
<descr/>
<errors/>
@ -1908,22 +1921,29 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TIdleTimer.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<element name="TIdleTimer.Create">
<short>
<var>Create</var>: constructor for <var>TIdleTimer</var>: calls inherited <var>Create</var> then sets up operating mode (autostart and autoend)</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.CustomTimer.TCustomTimer.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TIdleTimer.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TIdleTimer.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<element name="TIdleTimer.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TIdleTimer</var>: turns off <var>AutoEnabled</var> then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.CustomTimer.TCustomTimer.Destroy"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TIdleTimer.AutoEnabled">
@ -2062,22 +2082,29 @@
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TShape.Create" link="#LCL.Controls.TGraphicControl.Create">
<short/>
<element name="TShape.Create">
<short>
<var>Create</var> - constructor for <var>TShape</var>: calls inherited <var>Create</var>, sets default styles and bounds, creates pen and brush</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TShape.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TShape.Destroy" link="#LCL.Controls.TGraphicControl.Destroy">
<short/>
<element name="TShape.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TShape</var>: frees pen and brush, then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Destroy"/>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TShape.Paint" link="#LCL.Controls.TGraphicControl.Paint">
@ -2626,11 +2653,14 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomSplitter.Create" link="#LCL.Controls.TCustomControl.Create">
<short/>
<element name="TCustomSplitter.Create">
<short>
<var>Create</var> - constructor for <var>TCustomSplitter</var>: calls inherited <var>Create</var> then sets initial alignment, size and style</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TCustomControl.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomSplitter.Create.TheOwner">
@ -2868,11 +2898,14 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TPaintBox.Create" link="#LCL.Controls.TGraphicControl.Create">
<short/>
<element name="TPaintBox.Create">
<short>
<var>Create</var> - constructor for <var>TPaintBox</var>: calls inherited <var>Create</var> then sets initial bounds and style</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TPaintBox.Create.AOwner">
@ -3179,22 +3212,29 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomImage.Create" link="#LCL.Controls.TGraphicControl.Create">
<short/>
<element name="TCustomImage.Create">
<short>
<var>Create</var> - constructor for <var>TCustomImage</var>: calls inherited <var>Create</var> then sets default style, bounds and local variables: creates space for the picture</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomImage.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomImage.Destroy" link="#LCL.Controls.TGraphicControl.Destroy">
<short/>
<element name="TCustomImage.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TCustomImage</var>: frees picture then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Destroy"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TCustomImage.Align" link="#LCL.Controls.TControl.Align">
@ -3290,7 +3330,7 @@
: a graphic image placed on the form; usually loaded from a picture file.</p>
<p>The actual image is found in <var>Picture</var> or <var>Canvas</var>
</p>
<p>Inherits most of its properties from its ancestors, <link id="TCustomImage">TCustomImage</link>, <link id="#lcl.Controls.TGraphicControl">TGraphicControl</link> and <link id="#lcl.Controls.TControl">TControl</link>
<p>Inherits most of its properties from its ancestors, <link id="#lcl.ExtCtrls.TCustomImage">TCustomImage</link>, <link id="#lcl.Controls.TGraphicControl">TGraphicControl</link> and <link id="#lcl.Controls.TControl">TControl</link>
</p>
</descr>
<seealso>
@ -3486,7 +3526,7 @@
- a bevel placed around the edge of buttons and other components.</p>
<p>Its appearance is governed by <link id="TBevelShape">TBevelShape</link>, <link id="TBevelStyle">TBevelStyle</link> and <link id="TBevelwidth">TBevelwidth</link>
<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>
</descr>
</element>
@ -3554,17 +3594,21 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TBevel.Create" link="Classes.TComponent.Create">
<element name="TBevel.Create">
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TGraphicControl.Create"/>
</seealso>
<short>
<var>Create</var> - cunstructor for <var>TBevel</var>: calls inherited <var>Create</var> then sets initial style, shape and bounds</short>
</element>
<!-- argument Visibility: default -->
<element name="TBevel.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TBevel.Destroy" link="#rtl.Classes.TComponent.Destroy">
<element name="TBevel.Destroy" link="#LCL.Controls.TGraphicControl.Destroy">
<descr/>
<errors/>
<seealso/>
@ -3942,22 +3986,29 @@ requiring the user to select one af a set of alternatives</p>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomRadioGroup.Create" link="#LCL.Controls.TWinControl.Create">
<short/>
<element name="TCustomRadioGroup.Create">
<short>
<var>Create</var> - constructor for <var>TCustomRadioGroup</var>: calls inherited <var>Create</var>, then sets list of buttons, and initialises layout and sizing properties</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.StdCtrls.TCustomGroupBox.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomRadioGroup.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomRadioGroup.Destroy" link="#LCL.Controls.TWinControl.Destroy">
<short/>
<element name="TCustomRadioGroup.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TCustomRadioGroup</var>: frees items and buttons, then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TCustomRadioGroup.CanModify">
@ -4053,13 +4104,13 @@ requiring the user to select one af a set of alternatives</p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TRadioGroup.ColumnLayout" link="ExtCtrls.TCustomRadioGroup.ColumnLayout">
<element name="TRadioGroup.ColumnLayout" link="#lcl.ExtCtrls.TCustomRadioGroup.ColumnLayout">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TRadioGroup.Columns" link="ExtCtrls.TCustomRadioGroup.Columns">
<element name="TRadioGroup.Columns" link="#lcl.ExtCtrls.TCustomRadioGroup.Columns">
<short/>
<descr/>
<seealso/>
@ -4083,13 +4134,13 @@ requiring the user to select one af a set of alternatives</p>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TRadioGroup.ItemIndex" link="ExtCtrls.TCustomRadioGroup.ItemIndex">
<element name="TRadioGroup.ItemIndex" link="#lcl.ExtCtrls.TCustomRadioGroup.ItemIndex">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TRadioGroup.Items" link="ExtCtrls.TCustomRadioGroup.Items">
<element name="TRadioGroup.Items" link="#lcl.ExtCtrls.TCustomRadioGroup.Items">
<short>
<var>Items</var> - a string list containing the captions of the radio boxes</short>
<descr>
@ -4470,22 +4521,29 @@ requiring the user to select one af a set of alternatives</p>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomCheckGroup.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<element name="TCustomCheckGroup.Create">
<short>
<var>Create</var> - constructor for <var>TCustomCheckGroup</var>: calls inherited <var>Create</var>, then sets styles, creates lists, initialises sizing and layout properties</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.ExtCtrls.TCustomGroupBox.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomCheckGroup.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomCheckGroup.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<element name="TCustomCheckGroup.Destroy">
<short>
<var>Destroy</var> - destructor for <var>TCustomCheckGroup</var>: frees items and buttons, then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#LCL.Controls.TWinControl.Destroy"/>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TCustomCheckGroup.Rows">
@ -5010,7 +5068,7 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
: The base type for
<var>LabeledEdit</var>.</p>
<p>Note particularly the <link id="TCustomLabeledEdit.EditLabel">EditLabel</link> property (see <link id="#lcl.Extctrls.TBoundLabel">TBoundLabel</link>), which contains the label attached to the Edit control.</p>
<p>Note particularly the <link id="#lcl.ExtCtrls.TCustomLabeledEdit.EditLabel">EditLabel</link> property (see <link id="#lcl.Extctrls.TBoundLabel">TBoundLabel</link>), which contains the label attached to the Edit control.</p>
</descr>
<seealso>
<link id="#lcl.StdCtrls.TCustomEdit">TCustomEdit</link>
@ -5156,11 +5214,14 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomLabeledEdit.Create" link="#lcl.StdCtrls.TCustomEdit.Create">
<short/>
<element name="TCustomLabeledEdit.Create">
<short>
<var>Create</var> - constructor for <var>TCustomLabeledEdit</var>: calls inherited <var>Create</var> then sets initial position and label spacing</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#lcl.StdCtrls.TCustomEdit.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomLabeledEdit.Create.TheOwner">
@ -5696,11 +5757,14 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomPanel.Create" link="#lcl.Controls.TCustomControl.Create">
<short/>
<element name="TCustomPanel.Create">
<short>
<var>Create</var> - constructor for <var>TCustomPanel</var>: calls inherited <var>Create</var> then sets initial style, bevel, colour, alignment and bounds</short>
<descr/>
<errors/>
<seealso/>
<seealso>
<link id="#lcl.Controls.TCustomControl.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomPanel.Create.TheOwner">
@ -6111,17 +6175,28 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the
<short>
<var>TTrayIcon</var> is a multiplatform System Tray component. It adds an icon to the tray and signifies an application that is inactive but ready to be activated. Under Windows the System tray is usually located on the bottom-right corner of the screen, but it may be elsewhere. On other operating systems this position varies.</short>
</element>
<element name="TCustomTrayIcon.Create" link="#rtl.Classes.TComponent.Create">
<element name="TCustomTrayIcon.Create">
<descr>
<var>Create</var> creates a new instance of a <var>TCustomTrayIcon</var> class.
If <var>AOwner</var> is not <var>Nil</var>, the new component attempts to insert itself in the list of owned components of the owner.
</descr>
</descr>
<short>
<var>Create</var> - constructor for <var>TCustomTrayIcon</var>: performs inherited <var>Create</var> then creates icon, timer and initialises balloon timeout</short>
<seealso>
<link id="#rtl.Classes.TComponent.Create"/>
</seealso>
</element>
<element name="TCustomTrayIcon.Destroy" link="#rtl.Classes.TComponent.Destroy">
<element name="TCustomTrayIcon.Destroy">
<descr>
<var>Destroy</var> sends a <var>opRemove</var> notification to all components in the free-notification list. After that, all owned components are destroyed by calling <link id="TComponent.DestroyComponents">DestroyComponents</link> (and hence removed from the list of owned components). When this is done, the component removes itself from its owner's child component list.
<var>Destroy</var> sends a <var>opRemove</var> notification to all components in the free-notification list. After that, all owned components are destroyed by calling <link id="#rtl.Classes.TComponent.DestroyComponents">DestroyComponents</link> (and hence removed from the list of owned components). When this is done, the component removes itself from its owner's child component list.
After that, the parent's destroy method is called.
</descr>
</descr>
<short>
<var>Destroy</var> - destructor for <var>TCustomTrayIcon</var>: frees icon and timer then calls inherited <var>Destroy</var>
</short>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy"/>
</seealso>
</element>
<element name="TCustomTrayIcon.Hide">
<short>Hide - Removes the icon from the System Tray</short>
@ -6210,7 +6285,7 @@ After that, the parent's destroy method is called.
compatible.
</p>
<p>The <var>TPersistent</var> implementation of <var>Assign</var> does nothing
but calling the <link id="TPersistent.AssignTo">AssignTo</link> method of
but calling the <link id="#rtl.Classes.TPersistent.AssignTo">AssignTo</link> method of
source. This means that if the destination class does not know how to assign
the contents of the source class, the source class instance is asked to assign
itself to the destination class. This means that it is necessary to
@ -7041,7 +7116,6 @@ will copy the <var>contents</var> of the <var>Source</var> class to the
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTrayIcon.FBalloonFlags">
<short/>