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

Docs: LCL. Converts element links to see also links for topics with content.

Browse Source
This commit is contained in:
dsiders 2021-08-06 02:36:03 +01:00
parent 850a20e3f5
commit bb47f65547
31 changed files with 805 additions and 515 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1056,7 +1056,7 @@
</element>
<!-- argument Visibility: default -->
<element name="TCustomAction.AssignTo.Dest">
<short/>
<short>Persistent object where property values are stored.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomAction.SetName">
@ -1077,7 +1077,7 @@
<!-- function Visibility: protected -->
<element name="TCustomAction.HandleShortCut">
<short>
<var>HandleShortCut</var> - returns True if there is a short cut associated with the handle.
Returns True if there if the action is enabled and executed successfully.
</short>
<descr/>
<seealso/>
@ -1106,7 +1106,7 @@
</element>
<!-- argument Visibility: default -->
<element name="TCustomAction.Create.AOwner">
<short/>
<short>Owner of the class instance.</short>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomAction.Destroy">
@ -1133,7 +1133,7 @@
</element>
<!-- function Visibility: public -->
<element name="TCustomAction.Execute">
<short>Executes the action using a available OnExecute event handler.</short>
<short>Executes the action using an available OnExecute event handler.</short>
<descr>
<p>
<var>Execute</var> is an overridden method in TCustomAction. It checks the State for the ActionList to ensure that it is not suspended. No actions are performed in the method when ActionList.State contains a value other than asNormal.
@ -1238,13 +1238,10 @@
<!-- object Visibility: default -->
<element name="TAction">
<short>
<var>TAction</var> is the basic action object used on the LCL.</short>
<var>TAction</var> is the basic action object used in the LCL.</short>
<descr>
<p>
<var>TAction</var> is the basic action object used on the LCL.
</p>
<p>
It redeclares many properties inherited from TCustomAction on the public section, but does not add any new features. For more details look at the See Also section for TCustomAction.
<var>TAction</var> is the basic action object used in the LCL. It redeclares many properties inherited from TCustomAction on the public section, but does not add any new features. For more details look at the See Also section for TCustomAction.
</p>
<p>
The properties of each Action can be modified at design time in the Object Inspector.

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

@ -100,7 +100,7 @@
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TArrow.Create" link="#rtl.classes.TComponent.Create">
<element name="TArrow.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -115,7 +115,9 @@
<li>ArrowColor</li>
</ul>
</descr>
<seealso/>
<seealso>
<link id="#rtl.classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TArrow.Create.AOwner">

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

@ -1398,19 +1398,40 @@
<element name="TCustomBitBtn.Destroy">
<short>Destructor for the class instance.</short>
<descr></descr>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. It ensures that resource allocated for the internal button glyph and image change link are freed. It calls the inherited destructor prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
</seealso>
</element>
<element name="TCustomBitBtn.Click" link="#lcl.controls.TControl.Click">
<element name="TCustomBitBtn.Click">
<short>
Performs actions needed when the button is clicked.
</short>
<descr>
<p>
<var>Click </var> - the procedure which allows programmatic simulation of a mouse click, and thus activation of the <var>Action</var> associated with the <var>OnClick</var> event.
<var>Click </var> is an overridden method in TCustomBitBtn. It ensures that the correct actions are performed based on the value in the Kind property. When Kind is set to bkClose, the non-nested parent form is closed for the following conditions:
</p>
<ul>
<li>ModalResult is set to mrNone, or</li>
<li>ModalResult is mrCancel and the parent form is displayed as a modal dialog.</li>
</ul>
<p>
If Kind has any other value, the inherited Click method is called to determine the ModalResult and signal the OnChange event handler (when assigned).
</p>
<p>
Click is called when the DialogChar method handles an accelerator key for the control, when the Action for the control is executed, and when a mouse click event is handled for the control.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#lcl.stdctrls.TCustomButton.Click">TCustomButton.Click</link>
<link id="#lcl.stdctrls.TButtonControl.Click">TButtonControl.Click</link>
<link id="#lcl.controls.TControl.Click">TControl.Click</link>
</seealso>
</element>
<element name="TCustomBitBtn.LoadGlyphFromResourceName">
@ -1603,25 +1624,8 @@
<element name="TBitBtn.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
<element name="TBitBtn.DragKind" link="#lcl.controls.TControl.DragKind"/>
<element name="TBitBtn.DragMode" link="#lcl.controls.TControl.DragMode"/>
<element name="TBitBtn.Enabled" link="#lcl.controls.TControl.Enabled">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>Whether the control is <var>Enabled</var>. If not, it usually appears 'greyed-out'.</p>
<p>Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.</p>
</descr>
</element>
<element name="TBitBtn.Font" link="#lcl.controls.TControl.Font">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so.</p>
<p>The properties of <var>Font</var> are defined in the parent class <link id="#lcl.Graphics.TFont">TFont</link>
</p>
</descr>
<seealso></seealso>
</element>
<element name="TBitBtn.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TBitBtn.Font" link="#lcl.controls.TControl.Font"/>
<element name="TBitBtn.Glyph" link="#lcl.buttons.TCustomBitBtn.Glyph"/>
<element name="TBitBtn.GlyphShowMode" link="#lcl.buttons.TCustomBitBtn.GlyphShowMode"/>
<element name="TBitBtn.Kind" link="#lcl.buttons.TCustomBitBtn.Kind"/>
@ -1634,16 +1638,7 @@
<element name="TBitBtn.ImageWidth" link="#lcl.buttons.TCustomBitBtn.ImageWidth"/>
<element name="TBitBtn.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
<element name="TBitBtn.OnClick" link="#lcl.controls.TControl.OnClick">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <var>ActionList</var>.
</p>
<p>Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.</p>
</descr>
<seealso></seealso>
</element>
<element name="TBitBtn.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TBitBtn.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TBitBtn.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TBitBtn.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
@ -1651,40 +1646,46 @@
<element name="TBitBtn.OnEnter" link="#lcl.controls.TWinControl.OnEnter"/>
<element name="TBitBtn.OnExit" link="#lcl.controls.TWinControl.OnExit"/>
<element name="TBitBtn.OnKeyDown" link="#lcl.controls.TWinControl.OnKeyDown">
<element name="TBitBtn.OnKeyDown">
<short>
Event handler signalled when a key is down while the control has focus.
</short>
<descr>
<p>
<var>OnKeyDown</var> - event handler for instance when key is down while control has focus
</p>
<p>
Differs from <link id="#lcl.controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.
<var>OnKeyDown</var> differs from <link id="#lcl.controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#lcl.controls.TWinControl.OnKeyDown">TWinControl.OnKeyDown</link>
</seealso>
</element>
<element name="TBitBtn.OnKeyPress" link="#lcl.controls.TWinControl.OnKeyPress">
<element name="TBitBtn.OnKeyPress">
<short>
Event handler signalled when a key is pressed while the control has focus.
</short>
<descr>
<p>
<var>OnKeyPress</var> - event controller for a key being pressed while the control has focus
</p>
<p>
Differs from <link id="#lcl.controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.
<var>OnKeyPress</var> differs from <link id="#lcl.controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#lcl.controls.TWinControl.OnKeyPress">TWinControl.OnKeyPress</link>
</seealso>
</element>
<element name="TBitBtn.OnKeyUp" link="#lcl.controls.TWinControl.OnKeyUp">
<element name="TBitBtn.OnKeyUp">
<short>
Event handler signalled when a key is released while the control has focus.
</short>
<descr>
<p>
<var>OnKeyUp</var> - event handler for instance when a key is up (not pressed) while the control has focus.
</p>
<p>
The key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.
In <var>OnKeyUp</var>, the key may already have been up when the control received focus, or a pressed key may become released during the time the control has focus.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#lcl.controls.TWinControl.OnKeyUp">TWinControl.OnKeyUp</link>
</seealso>
</element>
<element name="TBitBtn.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
@ -1701,30 +1702,14 @@
<element name="TBitBtn.ParentBidiMode" link="#lcl.controls.TControl.ParentBidiMode"/>
<element name="TBitBtn.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
<element name="TBitBtn.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
<element name="TBitBtn.PopupMenu" link="#lcl.controls.TControl.PopupMenu">
<descr>
<p>
Standard properties, which should be supported by all descendants. Reads the details of the pop-up menu, or stores them. Properties are defined in the parent class <link id="#lcl.Menus.TPopupMenu">TPopupMenu</link>
</p>
</descr>
<seealso></seealso>
</element>
<element name="TBitBtn.ShowHint" link="#lcl.controls.TControl.ShowHint">
<descr>
<p>
Standard properties, which should be supported by all descendants. 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.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TBitBtn.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
<element name="TBitBtn.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
<element name="TBitBtn.Spacing" link="#lcl.buttons.TCustomBitBtn.Spacing"/>
<element name="TBitBtn.TabOrder" link="#lcl.controls.TWinControl.TabOrder"/>
<element name="TBitBtn.TabStop" link="#lcl.controls.TWinControl.TabStop"/>
<element name="TBitBtn.Visible" link="#lcl.controls.TControl.Visible">
<element name="TBitBtn.Visible">
<short>Indicates if the control is visible on its parent.</short>
<descr>
<p>
The <var>Visible</var> property indicates the ability to see a visual control. If <var>Visible</var> is <b>True</b>, the control is shown, otherwise it is hidden. Calling <var>Show</var> sets <var>Visible</var> to <b>True</b>. Setting <var>Visible</var> to <b>False</b> is equivalent to calling the <var>Hide</var> method.
@ -1734,9 +1719,7 @@
</remark>
</descr>
<seealso>
<link id="TBitBtn.Show"/>
<link id="TBitBtn.Hide"/>
<link id="TBitBtn.IsVisible"/>
<link id="#lcl.controls.TControl.Visible">TControl.Visible</link>
</seealso>
</element>
@ -2354,7 +2337,10 @@
<element name="TCustomSpeedButton.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize"/>
<element name="TCustomSpeedButton.Loaded" link="#rtl.Classes.TComponent.Loaded">
<element name="TCustomSpeedButton.Loaded">
<short>
Performs actions needed when LCL component streaming is completed for the control.
</short>
<descr>
<p>
<var>Loaded</var> is called by the LCL streaming system when a root component was completely read from a stream and all properties and references to other objects have been resolved. Descendents of <var>TComponent</var> should override this method to perform additional processing when all published properties have been set from values obtained from the LCL component stream.
@ -2364,7 +2350,9 @@
is done automatically by the LCL streaming system.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.Classes.TComponent">TComponent</link>
</seealso>
</element>
<element name="TCustomSpeedButton.GetGlyphSize">
@ -2629,36 +2617,10 @@
</seealso>
</element>
<element name="TSpeedButton.Action" link="#lcl.controls.TControl.Action">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>The (default) action to be associated with this control.</p>
<p>Can either read the action already associated with the control (GetAction), or write an action to be associated (SetAction).</p>
</descr>
</element>
<element name="TSpeedButton.Align" link="#lcl.controls.TControl.Align">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>Either reads a flag containing alignment instructions (<var>FAlign</var>) or writes alignment instructions (<var>SetAlign</var>).</p>
<p>May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right.</p>
</descr>
</element>
<element name="TSpeedButton.AllowAllUp" link="#lcl.buttons.TCustomSpeedButton.AllowAllUp">
<descr></descr>
</element>
<element name="TSpeedButton.Anchors" link="#lcl.controls.TControl.Anchors">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>Determines how the control is to be anchored to its client or parent 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>
<seealso></seealso>
</element>
<element name="TSpeedButton.Action" link="#lcl.controls.TControl.Action"/>
<element name="TSpeedButton.Align" link="#lcl.controls.TControl.Align"/>
<element name="TSpeedButton.AllowAllUp" link="#lcl.buttons.TCustomSpeedButton.AllowAllUp"/>
<element name="TSpeedButton.Anchors" link="#lcl.controls.TControl.Anchors"/>
<element name="TSpeedButton.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
<element name="TSpeedButton.BidiMode">
@ -2667,26 +2629,13 @@
<seealso></seealso>
</element>
<element name="TSpeedButton.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>Determines the border spacing for this control.</p>
<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>.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TSpeedButton.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
<element name="TSpeedButton.Constraints" link="#lcl.controls.TControl.Constraints"/>
<element name="TSpeedButton.Constraints" link="#lcl.controls.TControl.Constraints">
<descr>
<p>Standard properties, which should be supported by all descendants.</p>
<p>Determine <var>Constraints</var> (max and min height and width) for this control; reads the size constraints or stores new ones.</p>
</descr>
<seealso></seealso>
</element>
<element name="TSpeedButton.Caption" link="#lcl.controls.TControl.Caption">
<element name="TSpeedButton.Caption">
<short>
String with the caption displayed for the control.
</short>
<descr>
<p>
Gets caption as a text-string (<var>GetText</var>), or stores the new caption (<var>SetText</var>). Shows flag if caption is stored (<var>IsCaptionStored</var>).
@ -2707,6 +2656,9 @@
To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.Caption">TControl.Caption</link>
</seealso>
</element>
<element name="TSpeedButton.Color" link="#lcl.buttons.TCustomSpeedButton.Color"/>
@ -2728,7 +2680,10 @@
<element name="TSpeedButton.Spacing" link="#lcl.buttons.TCustomSpeedButton.Spacing"/>
<element name="TSpeedButton.Transparent" link="#lcl.buttons.TCustomSpeedButton.Transparent"/>
<element name="TSpeedButton.Visible" link="#lcl.controls.TControl.Visible">
<element name="TSpeedButton.Visible">
<short>
Indicates if the control is visible on its parent.
</short>
<descr>
<p>
The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets, among others, Visible to True. Setting Visible to False is equivalent to calling Hide method.
@ -2737,37 +2692,14 @@
The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility.
</remark>
</descr>
<seealso></seealso>
</element>
<element name="TSpeedButton.OnClick" link="#lcl.controls.TControl.OnClick">
<descr>
<p>
Standard properties, which should be supported by all descendants.
</p>
<p>
This is often the default action for many controls, and is often the ONLY action specified by the programmer. The action can be specified by the user, either by typing explicit code into the implementation section for this control, or by selecting an action from a pre-supplied <var>ActionList</var>.
</p>
<p>
Reads or writes a flag if a mouse click is detected, and sets a flag if a value is stored.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TSpeedButton.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TSpeedButton.OnDblClick" link="#lcl.controls.TControl.OnDblClick">
<descr>
<p>
Double-clicking is much more common in a Windows environment than in Unix or Linux, where single-clicking is the default method for selecting an object. However, in all environments there could be valid use for a double-click, and a method should be supplied if appropriate.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.OnDblClick">TControl.OnDblClick</link>
<link id="#lcl.controls.TControl.Visible">TControl.Visible</link>
</seealso>
</element>
<element name="TSpeedButton.OnClick" link="#lcl.controls.TControl.OnClick"/>
<element name="TSpeedButton.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TSpeedButton.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TSpeedButton.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
<element name="TSpeedButton.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
<element name="TSpeedButton.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>

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

@ -234,17 +234,16 @@
</element>
<!-- object Visibility: default -->
<element name="TCustomCalendar" link="#lcl.controls.TWinControl">
<short>
<var>TCustomCalendar</var> - base class for <var>TCalendar</var>.
</short>
<element name="TCustomCalendar">
<short>Base class for <var>TCalendar</var>.</short>
<descr>
<p>
<var>TCustomCalendar</var> is the base class for <var>TCalendar</var>, a graphic control for selecting a date.
</p>
</descr>
<errors/>
<seealso></seealso>
<seealso>
<link id="#lcl.controls.TWinControl">TWinControl</link>
</seealso>
</element>
<!-- variable Visibility: private -->
@ -382,19 +381,19 @@
<!-- procedure Visibility: protected -->
<element name="TCustomCalendar.LMChanged">
<short>
<var>LMChanged</var> - LCL Message method to deal with changes in the control.
Handles the LCL message received when the control is changed.
</short>
<descr></descr>
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.LMChanged.Message">
<short></short>
<short>Message examined in the method.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomCalendar.LMMonthChanged">
<short>
<var>LMMonthChanged</var> - LCL Message method for change in Month.
Handles the LCL message received when the month has been changed.
</short>
<descr></descr>
<errors/>
@ -402,26 +401,25 @@
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.LMMonthChanged.Message">
<short></short>
<short>Message examined in the method.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomCalendar.LMYearChanged">
<short>
<var>LMYearChanged</var> - LCL Message method for change in Year.
Handles the LCL message received when the year has been changed.
</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.LMYearChanged.Message">
<short></short>
<short>Message examined in the method.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomCalendar.LMDayChanged">
<short>
<var>LMDayChanged</var> - LCL Message method for change in Day.
Handles the LCL message received when the day has been changed.
</short>
<descr></descr>
<errors/>
@ -429,7 +427,7 @@
</element>
<!-- argument Visibility: default -->
<element name="TCustomCalendar.LMDayChanged.Message">
<short></short>
<short>Message examined in the method.</short>
</element>
<!-- class function Visibility: protected -->
@ -443,11 +441,11 @@
<!-- constructor Visibility: public -->
<element name="TCustomCalendar.Create">
<short>
<var>Create</var> - constructor for <var>TCustomCalendar</var>.
Constructor for the class instance.
</short>
<descr>
<p>
<var>Create</var> is the constructor for <var>TCustomCalendar</var>. Create calls the inherited <var>Create</var> method, and sets the style, initial bounds, and display settings for the calendar. Create sets the default date and time value to Now.
<var>Create</var> is the constructor for <var>TCustomCalendar</var>. Create calls the inherited <var>Create</var> method, and sets the style, initial bounds, and display settings for the calendar. Create sets the default date / time value to Now.
</p>
</descr>
<seealso>
@ -488,7 +486,7 @@
<!-- property Visibility: public -->
<element name="TCustomCalendar.Date">
<short>
<var>Date</var> is a string representation of the DateTime value.
String representation for the DateTime property.
</short>
<descr>
<p>

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

@ -296,8 +296,10 @@
</seealso>
</element>
<element name="TCustomColorBox.InitializeWnd" link="#lcl.stdctrls.TCustomComboBox.InitializeWnd">
<short/>
<element name="TCustomColorBox.InitializeWnd">
<short>
Performs actions need to initial the window Handle for the control.
</short>
<descr>
<p>
Updates the combo-box control when its handled is (re-)allocated. Ensures that ItemIndex is updated to reflect the value in Selected.
@ -308,11 +310,19 @@
</seealso>
</element>
<element name="TCustomColorBox.DoAutoAdjustLayout" link="#lcl.controls.TControl.DoAutoAdjustLayout">
<short/>
<element name="TCustomColorBox.DoAutoAdjustLayout">
<short>
Performs actions needed to auto-adjust the control using the specified layout policy.
</short>
<descr>
<p>
Called when an auto adjust policy is applied for the control. Ensures that ColorRectWidth is scaled when needed.
Called when an auto adjust policy is applied for the control. DoAutoAdjustLayout ensures that the item height for the control is scaled using the factor in AYProportion when AMode contains the lapAutoAdjustWithoutHorizontalScrolling or lapAutoAdjustForDPI layout adjustment policy values.
</p>
<p>
In TCustomColorBox, it ensures that ColorRectWidth is scaled when needed.
</p>
<p>
DoAutoAdjustLayout is called from the AutoAdjustLayout method.
</p>
</descr>
<seealso>

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

@ -214,7 +214,7 @@
<short>Ordinal position for the second item in the comparison.</short>
</element>
<element name="TListItemsSortType" link="#lcl.comctrls.TSortType">
<element name="TListItemsSortType">
<short>Alias to the TSortType in <file>ComCtrls.pp</file></short>
<descr/>
<seealso>
@ -754,7 +754,7 @@
<seealso/>
</element>
<element name="TListControlItems.Items" link="#rtl.classes.TCollection.Items">
<element name="TListControlItems.Items">
<short>Provides indexed access to the list of items maintained in the collection.</short>
<descr>
<p>
@ -769,7 +769,8 @@
</descr>
<seealso>
<link id="TListControlItem"/>
<link id="TListControlItems.Count"/>
<link id="#rtl.classes.TCollection.Items">TCollection.Items</link>
<link id="#rtl.classes.TCollection.Count">TCollection.Count</link>
<link id="#rtl.classes.TCollection.Add">TCollection.Add</link>
<link id="#rtl.classes.TCollection.Insert">TCollection.Insert</link>
<link id="#rtl.classes.TCollection.Clear">TCollection.Clear</link>
@ -893,7 +894,7 @@
<short>Collection item examined in the method.</short>
</element>
<element name="TComboExItems.Add" link="#lcl.comboex.TListControlItems.Add">
<element name="TComboExItems.Add">
<short>Adds a new item to the collection.</short>
<descr>
<p>
@ -960,7 +961,7 @@
<short>Pointer to the arbitrary data associated with the item.</short>
</element>
<element name="TComboExItems.Insert" link="#rtl.classes.TCollection.Insert">
<element name="TComboExItems.Insert">
<short>Inserts a collection item at the specified position in the collection.</short>
<descr>
<p>
@ -1177,7 +1178,7 @@
<short>Object for the event notification.</short>
</element>
<element name="TCustomComboBoxEx.InitializeWnd" link="#lcl.stdctrls.TCustomComboBox.InitializeWnd">
<element name="TCustomComboBoxEx.InitializeWnd">
<short>Initializes the window handle for the control.</short>
<descr>
<p>
@ -1949,7 +1950,7 @@
<short>Owner draw state for the check box.</short>
</element>
<element name="TCustomCheckCombo.DropDown" link="#lcl.stdctrls.TCustomComboBox.DropDown">
<element name="TCustomCheckCombo.DropDown">
<short>Displays the drop down for the combo-box.</short>
<descr>
<p>
@ -1957,10 +1958,11 @@
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomComboBox.OnDropDown">TCustomComboBox.OnDropDown</link>
<link id="TCustomCheckCombo.ItemIndex"/>
<link id="TCustomCheckCombo.ItemEnabled"/>
<link id="TCustomCheckCombo.Toggle"/>
<link id="#lcl.stdctrls.TCustomComboBox.ItemIndex">TCustomComboBox.ItemIndex</link>
<link id="#lcl.stdctrls.TCustomComboBox.DropDown">TCustomComboBox.DropDown</link>
<link id="#lcl.stdctrls.TCustomComboBox.OnDropDown">TCustomComboBox.OnDropDown</link>
</seealso>
</element>
@ -2090,15 +2092,17 @@
</seealso>
</element>
<element name="TCustomCheckCombo.MouseLeave" link="#lcl.controls.TControl.MouseLeave">
<element name="TCustomCheckCombo.MouseLeave">
<short>
Deactivates tracking the highlighted check box when the mouse leaves the control.
</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.MouseLeave">TControl.MouseLeave</link>
</seealso>
</element>
<element name="TCustomCheckCombo.MouseMove" link="#lcl.controls.TControl.MouseMove">
<element name="TCustomCheckCombo.MouseMove">
<short>
Tracks changes to the mouse position for the highlighted check box in the control.
</short>
@ -2441,7 +2445,7 @@
</seealso>
</element>
<element name="TCheckComboBox" link="#lcl.comboex.TCustomCheckCombo">
<element name="TCheckComboBox">
<short>Combo-box control which displays check boxes for the items in the control.</short>
<descr>
<p>

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

@ -810,8 +810,11 @@
<descr/>
</element>
<element name="TAlignSet" link="#lcl.controls.TAlign">
<element name="TAlignSet">
<short>Set of alignment options.</short>
<seealso>
<link id="#lcl.controls.TAlign">TAlign</link>
</seealso>
</element>
<element name="TAnchorKind">
@ -1009,17 +1012,21 @@
<short>Small caption, form can be resized.</short>
</element>
<element name="TBorderStyle" link="#lcl.controls.TFormBorderStyle">
<element name="TBorderStyle">
<short>Possible types of borders (with or without border).</short>
<seealso/>
<seealso>
<link id="#lcl.controls.TFormBorderStyle">TFormBorderStyle</link>
</seealso>
</element>
<element name="TControlBorderStyle" link="#lcl.controls.TFormBorderStyle">
<element name="TControlBorderStyle">
<short>Possible types of control borders (with or without border).</short>
<descr>
A subset of TFormBorderStyle, listing only the styles available to a control that is not a form.
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TFormBorderStyle">TFormBorderStyle</link>
</seealso>
</element>
<element name="TControlRoleForForm">
@ -1401,8 +1408,11 @@
</short>
</element>
<element name="TControlState" link="#lcl.controls.TControlStateType">
<element name="TControlState">
<short>Set of Control States allowed in a control.</short>
<seealso>
<link id="TControlStateType"/>
</seealso>
</element>
<element name="TControlCanvas">
@ -2453,7 +2463,7 @@
<element name="TDragDropEvent.Sender">
<short>The target control of the drop.</short>
</element>
<element name="TDragDropEvent.Source" link="#lcl.controls.TDragOverEvent.Source">
<element name="TDragDropEvent.Source">
<short>The dragged control.</short>
</element>
<element name="TDragDropEvent.X">
@ -2693,8 +2703,11 @@
<element name="TDragObjectClass">
<short>A <link id="TDragObject"/> class type.</short>
</element>
<element name="TDragObjectEx" link="#lcl.controls.TDragObject">
<element name="TDragObjectEx">
<short>A drag object that is automatically destroyed after use.</short>
<seealso>
<link id="TDragObject"/>
</seealso>
</element>
<element name="TDragObjectEx">
@ -3396,14 +3409,16 @@
<seealso/>
</element>
<element name="DragManager" link="#lcl.controls.TDragManager">
<element name="DragManager">
<short>The current DragManager (always TDragManagerDefault).</short>
<descr>
<remark>
A <var>DragManager</var> must be implemented in the <file>Controls</file> unit; it requires access to private members in the classes declared in the unit.
</remark>
</descr>
<seealso/>
<seealso>
<link id="TDragManager"/>
</seealso>
</element>
<element name="TDockManager">
@ -4029,7 +4044,7 @@
<element name="TControlCellAligns" link="#lcl.controls.TControlCellAlign"/>
<element name="TControlBorderSpacingDefault" link="#lcl.controls.TControlBorderSpacing">
<element name="TControlBorderSpacingDefault">
<short>Defines the default values for TControlBorderSpacing.</short>
<descr>
<p>
@ -4897,8 +4912,11 @@
<descr>It can be assumed that FClient is not Nil.</descr>
</element>
<element link="#rtl.classes.TBasicActionLink.AssignClient" name="TControlActionLink.AssignClient">
<element name="TControlActionLink.AssignClient">
<short>Called during construction, sets FClient to the given control.</short>
<seealso>
<link id="#rtl.classes.TBasicActionLink">TBasicActionLink</link>
</seealso>
</element>
<element name="TControlActionLink.AssignClient.AClient">
<short>The control linked to the action.</short>
@ -5011,9 +5029,12 @@
<short/>
</element>
<element link="#lcl.actnlist.TActionLink.IsHelpLinked" name="TControlActionLink.IsHelpLinked">
<element name="TControlActionLink.IsHelpLinked">
<short>Help properties are assumed linked only when all these properties match.</short>
<descr>Compares the HelpContext, HelpKeyword and HelpType properties.</descr>
<seealso>
<link id="#lcl.actnlist.TActionLink.IsHelpLinked">TActionLink.IsHelpLinked</link>
</seealso>
</element>
<element name="TControlActionLink.IsHelpLinked.Result">
<short>True only if all three Control properties match the Action properties.</short>
@ -5029,10 +5050,12 @@
<short/>
</element>
<element link="#lcl.controls.TControlActionLink" name="TControlActionLinkClass">
<element name="TControlActionLinkClass">
<short>Class of <link id="TControlActionLink"/></short>
<descr/>
<seealso/>
<seealso>
<link id="TControlActionLink"/>
</seealso>
</element>
<element name="ELayoutException">
@ -5519,13 +5542,13 @@
<short>Available for Widgetsets to use.</short>
</element>
<element link="#rtl.System.TObject.Create" name="TLazAccessibleObject.Create">
<element name="TLazAccessibleObject.Create">
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element link="#rtl.System.TObject.Destroy" name="TLazAccessibleObject.Destroy">
<element name="TLazAccessibleObject.Destroy">
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
@ -6080,7 +6103,7 @@
<short>New value for the AnchorSize property.</short>
</element>
<element link="#lcl.controls.TControl.BorderSpacing" name="TControl.SetBorderSpacing">
<element name="TControl.SetBorderSpacing">
<short>Sets the value for the BorderSpacing property.</short>
<descr/>
<seealso>
@ -6699,11 +6722,16 @@
</short>
</element>
<element link="#lcl.controls.TControl.ControlOrigin" name="TControl.GetControlOrigin">
<short>Returns the origin (top left pixel) of the control, in screen coordinates.</short>
<element name="TControl.GetControlOrigin">
<short>
Returns the origin (top left pixel) of the control, in screen coordinates.
</short>
<seealso>
<link id="TControl.ControlOrigin"/>
</seealso>
</element>
<element name="TControl.GetControlOrigin.Result">
<short/>
<short>Value for the property.</short>
</element>
<element link="#lcl.controls.TControl.ClientHeight" name="TControl.IsClientHeightStored"/>
@ -12674,12 +12702,14 @@
<short/>
</element>
<element link="#lcl.controls.TControl.ChangeScale" name="TWinControl.ChangeScale">
<element name="TWinControl.ChangeScale">
<short>
Scales (resizes) the control and all of its child controls.
</short>
<descr/>
<seealso/>
<seealso>
<link id="TControl.ChangeScale"/>
</seealso>
</element>
<element name="TWinControl.ChangeScale.Multiplier">
<short/>
@ -13374,12 +13404,14 @@
<short/>
</element>
<element link="#lcl.controls.TControl.DoFloatMsg" name="TWinControl.DoFloatMsg">
<element name="TWinControl.DoFloatMsg">
<short>Handler called when the control starts floating.</short>
<descr>
TWinControls can float for themselves, unless they request a special FloatingDockSiteClass.
</descr>
<seealso/>
<seealso>
<link id="TControl.DoFloatMsg"/>
</seealso>
</element>
<element name="TWinControl.DoFloatMsg.ADockSource">
<short/>
@ -14723,8 +14755,11 @@
<short>True if update needed.</short>
</element>
<element link="#lcl.controls.TControl.SetBounds" name="TWinControl.SetBounds">
<element name="TWinControl.SetBounds">
<short>Sets the control bounds and adjusts child and docked controls.</short>
<seealso>
<link id="TControl.SetBounds"/>
</seealso>
</element>
<element name="TWinControl.SetBounds.aLeft">
<short/>
@ -15574,7 +15609,7 @@ if MyControl.CanSetFocus then
<element link="#lcl.controls.TWinControl.DestroyWnd" name="TCustomControl.DestroyWnd"/>
<element link="#lcl.controls.TWinControl.PaintWindow" name="TCustomControl.PaintWindow">
<element name="TCustomControl.PaintWindow">
<short>The Paint handler plug-in, intercepting paint requests.</short>
<descr>
<p>

49
docs/xml/lcl/dbctrls.xml
View File

@ -1893,7 +1893,11 @@
<element link="#lcl.controls.TControl.ParentFont" name="TDBText.ParentFont"/>
<element link="#lcl.controls.TControl.ParentShowHint" name="TDBText.ParentShowHint"/>
<element link="#lcl.controls.TControl.PopupMenu" name="TDBText.PopupMenu"/>
<element link="#lcl.stdctrls.TCustomLabel.ShowAccelChar" name="TDBText.ShowAccelChar">
<element name="TDBText.ShowAccelChar">
<short>
Enables or disables drawing of accelerator or shortcut keys for the label.
</short>
<descr>
<p>
<var>ShowAccelChar</var> controls if an underlined character in the label is drawn for the accelerator or shortcut key. Changing the value for the property causes the WidgetSetClass to be notified of the potential change to the Caption and size for the control.
@ -1901,11 +1905,14 @@
<p>The default value for the property is <b>True</b>.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.stdctrls.TCustomLabel.ShowAccelChar">TCustomLabel.ShowAccelChar</link>
</seealso>
</element>
<element link="#lcl.controls.TControl.ShowHint" name="TDBText.ShowHint"/>
<element link="#lcl.stdctrls.TCustomLabel.Transparent" name="TDBText.Transparent"/>
<element link="#lcl.controls.TControl.Visible" name="TDBText.Visible">
<element name="TDBText.Visible">
<short>Indicates if the control is displayed.</short>
<descr>
<p>The <var>Visible</var> property represents the ability to see a visual control. If Visible is set to <b>True</b> the control is shown, otherwise it is hidden. Calling Show sets Visible to <b>True</b>. Setting Visible to <b>False</b> is equivalent to calling the <var>Hide</var> method.
@ -1913,7 +1920,9 @@
<remark>The Visible property does not depend on control's parent visibility. Use <var>IsVisible</var> method to consider this and get the real visibility.
</remark>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.Visible">TControl.Visible</link>
</seealso>
</element>
<element name="TDBText.WordWrap">
<short>Indicates if text is wrapped at the right edge of the control.</short>
@ -5298,10 +5307,12 @@
<element name="TDBMemo.GetField.Result">
<short>Value for the property.</short>
</element>
<element link="#lcl.stdctrls.TCustomEdit.GetReadOnly" name="TDBMemo.GetReadOnly">
<element name="TDBMemo.GetReadOnly">
<short>Gets the value for the ReadOnly property.</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.GetReadOnly">TCustomEdit.GetReadOnly</link>
</seealso>
</element>
<element name="TDBMemo.GetReadOnly.Result">
<short>Value for the property.</short>
@ -5346,10 +5357,12 @@
<element name="TDBMemo.GetReadOnly.Result">
<short>Value for the property.</short>
</element>
<element link="#lcl.stdctrls.TCustomEdit.SetReadOnly" name="TDBMemo.SetReadOnly">
<element name="TDBMemo.SetReadOnly">
<short>Sets the value for the ReadOnly property.</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.SetReadOnly">TCustomEdit.SetReadOnly</link>
</seealso>
</element>
<element name="TDBMemo.SetReadOnly.AValue">
<short>New value for the property.</short>
@ -5714,7 +5727,7 @@
<element link="#lcl.controls.TControl.ParentFont" name="TDBMemo.ParentFont"/>
<element link="#lcl.controls.TControl.ParentShowHint" name="TDBMemo.ParentShowHint"/>
<element link="#lcl.controls.TControl.PopupMenu" name="TDBMemo.PopupMenu"/>
<element link="#lcl.stdctrls.TCustomEdit.ReadOnly" name="TDBMemo.ReadOnly">
<element name="TDBMemo.ReadOnly">
<short>Indicates that the text in the control cannot be modified.
</short>
<descr>
@ -5724,10 +5737,11 @@
</p>
<p>Read and write access specifiers in TDBMemo are overridden, and to the property value is redirected to the ReadOnly property in the TFieldDataLink instance used in the class. Write access calls the inherited method prior to updating the value in the field data link.
</p>
<remark>Please note: A value assigned to ReadOnly may be overridden by the Field definition from the target database table.
<remark>A value assigned to ReadOnly may be overridden by the Field definition from the target database table.
</remark>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.ReadOnly">TCustomEdit.ReadOnly</link>
<link id="#fcl.db.TDataLink.ReadOnly">TDataLink.ReadOnly</link>
</seealso>
</element>
@ -6074,15 +6088,18 @@
<element link="#lcl.controls.TControl.OnEndDrag" name="TDBGroupBox.OnEndDrag"/>
<element link="#lcl.controls.TWinControl.OnEnter" name="TDBGroupBox.OnEnter"/>
<element link="#lcl.controls.TWinControl.OnExit" name="TDBGroupBox.OnExit"/>
<element link="#lcl.controls.TWinControl.OnKeyDown" name="TDBGroupBox.OnKeyDown">
<element name="TDBGroupBox.OnKeyDown">
<short>
Event handler signalled when a key is down while the control has focus.
</short>
<descr>
<p>
<var>OnKeyDown</var> is an event handler signalled when a key is down while control has focus.
</p>
<p>Differs from <link id="#lcl.controls.TWinControl.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.
<var>OnKeyDown</var> differs from <link id="TDBGroupBox.OnKeyPress">OnKeyPress</link> in that the key may have already been down when the control received focus; with <var>OnKeyPress</var> the key needs to become pressed while the control has focus.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TWinControl.OnKeyDown">TWinControl.OnKeyDown</link>
</seealso>
</element>
<element name="TDBGroupBox.OnKeyPress">
<short>
@ -6093,7 +6110,7 @@
<var>OnKeyPress</var> is an event controller signalled when a key is being pressed while the control has focus.
</p>
<p>
Differs from <link id="#lcl.controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.
Differs from <link id="TDBGroupBox.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.
</p>
</descr>
<seealso>

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

@ -1710,7 +1710,7 @@
<short>New value for the FieldName property.</short>
</element>
<element name="TColumn.CreateTitle" link="#lcl.grids.TGridColumn.CreateTitle">
<element name="TColumn.CreateTitle">
<short>
Creates the title used for the grid column.
</short>
@ -1719,7 +1719,9 @@
<var>CreateTitle</var> is an overridden TGridColumnTitle function used to create the title used as a fixed caption for the column.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#lcl.grids.TGridColumn.CreateTitle">TGridColumn.CreateTitle</link>
</seealso>
</element>
<element name="TColumn.CreateTitle.Result">
<short>Title for the column.</short>
@ -4949,7 +4951,7 @@
</seealso>
</element>
<element name="TCustomDBGrid.SetEditText" link="#lcl.grids.TCustomGrid.SetEditText">
<element name="TCustomDBGrid.SetEditText">
<short>
Sets the textual value for the editor in the specified cell.
</short>
@ -4958,16 +4960,18 @@
SetEditText sets the textual value for the editor in the specified cell.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#lcl.grids.TCustomGrid.SetEditText">TCustomGrid.SetEditText</link>
</seealso>
</element>
<element name="TCustomDBGrid.SetEditText.ACol">
<short/>
<short>Column number for the cell updated in the method.</short>
</element>
<element name="TCustomDBGrid.SetEditText.ARow">
<short/>
<short>Row number for the cell updated in the method.</short>
</element>
<element name="TCustomDBGrid.SetEditText.Value">
<short/>
<short>New value for the cell.</short>
</element>
<element name="TCustomDBGrid.SetFixedCols">

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

@ -1177,14 +1177,16 @@
<short>Default title for the dialog.</short>
</element>
<element name="TSaveDialog.Create" link="#lcl.dialogs.TOpenDialog.Create">
<element name="TSaveDialog.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create update the component style flags to the value used for the dialog type.
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create update the component style flags to the value used for the dialog type.
</p>
</descr>
<seealso/>
<seealso>
<link id="TOpenDialog.Create"/>
</seealso>
</element>
<element name="TSaveDialog.Create.AOwner">
<short>Owner of the class instance.</short>
@ -1765,7 +1767,7 @@ ADialog.CustomColors.Values['ColorA'] := 'FFFF00';
</seealso>
</element>
<element name="TFontDialog.Create" link="#rtl.classes.TComponent.Create">
<element name="TFontDialog.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -1781,7 +1783,7 @@ ADialog.CustomColors.Values['ColorA'] := 'FFFF00';
<short>Owner of the class instance.</short>
</element>
<element name="TFontDialog.Destroy" link="#rtl.classes.TComponent.Destroy">
<element name="TFontDialog.Destroy">
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>

50
docs/xml/lcl/editbtn.xml
View File

@ -621,10 +621,12 @@
<short>Owner of the class instance.</short>
</element>
<element name="TCustomEditButton.Destroy" link="#lcl.controls.TWinControl.Destroy">
<element name="TCustomEditButton.Destroy">
<short>Destructor for the class instance.</short>
<descr></descr>
<seealso></seealso>
<seealso>
<link id="#lcl.controls.TWinControl.Destroy">TWinControl.Destroy</link>
</seealso>
</element>
<element name="TEditButton">
@ -1529,7 +1531,7 @@
<short>New value for the property.</short>
</element>
<element name="TFileNameEdit.GetDefaultGlyphName" link="#lcl.editbtn.TCustomEditButton.GetDefaultGlyphName">
<element name="TFileNameEdit.GetDefaultGlyphName">
<short>Gets the default glyph name used for the Button on the control.</short>
<descr>
<p>
@ -1539,6 +1541,7 @@
<seealso>
<link id="ResBtnFileOpen"/>
<link id="TCustomEditButton.LoadDefaultGlyph"/>
<link id="TCustomEditButton.GetDefaultGlyphName"/>
</seealso>
</element>
@ -1647,7 +1650,7 @@
<short></short>
</element>
<element name="TFileNameEdit.Create" link="#lcl.editbtn.TCustomEditButton.Create">
<element name="TFileNameEdit.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -1658,16 +1661,19 @@
<link id="TFileNameEdit.DialogFiles"/>
<link id="TFileNameEdit.DialogKind"/>
<link id="TFileNameEdit.DialogOptions"/>
<link id="TCustomEditButton.Create"/>
</seealso>
</element>
<element name="TFileNameEdit.Create.AOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TFileNameEdit.Destroy" link="#lcl.editbtn.TCustomEditButton.Destroy">
<element name="TFileNameEdit.Destroy">
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
<seealso>
<link id="TCustomEditButton.Destroy"/>
</seealso>
</element>
<element name="TFileNameEdit.RunDialog">
@ -1832,16 +1838,20 @@
<seealso></seealso>
</element>
<element name="TFileNameEdit.ButtonOnlyWhenFocused" link="#lcl.editbtn.TCustomEditButton.ButtonOnlyWhenFocused">
<element name="TFileNameEdit.ButtonOnlyWhenFocused">
<short>Controls visibility of the Button when the control loses focus.</short>
<descr/>
<seealso/>
<seealso>
<link id="TCustomEditButton.ButtonOnlyWhenFocused"/>
</seealso>
</element>
<element name="TFileNameEdit.ButtonWidth" link="#lcl.editbtn.TCustomEditButton.ButtonWidth">
<element name="TFileNameEdit.ButtonWidth" >
<short>Width of the Button displayed in the control.</short>
<descr/>
<seealso/>
<seealso>
<link id="TCustomEditButton.ButtonWidth"/>
</seealso>
</element>
<element name="TFileNameEdit.Constraints" link="#lcl.controls.TControl.Constraints"/>
@ -2508,7 +2518,7 @@
<seealso/>
</element>
<element name="TDateEdit.GetDefaultGlyphName" link="#lcl.editbtn.TCustomEditButton.GetDefaultGlyphName">
<element name="TDateEdit.GetDefaultGlyphName">
<short>Gets the default glyph name displayed on the Button for the control.</short>
<descr>
<p>
@ -2524,12 +2534,14 @@
<short>Resource name for the default glyph.</short>
</element>
<element name="TDateEdit.ButtonClick" link="#lcl.editbtn.TCustomEditButton.ButtonClick">
<element name="TDateEdit.ButtonClick">
<short>
Implements the handler executed when the Button for the control is clicked.
</short>
<descr></descr>
<seealso></seealso>
<seealso>
<link id="TCustomEditButton.ButtonClick"/>
</seealso>
</element>
<element name="TDateEdit.EditDblClick">
@ -3240,17 +3252,19 @@
<element name="TCalcEdit.GetDefaultGlyphName" link="#lcl.editbtn.TCustomEditButton.GetDefaultGlyphName"/>
<element name="TCalcEdit.GetDefaultGlyphName.Result"/>
<element name="TCalcEdit.ButtonClick" link="#lcl.editbtn.TCustomEditButton.ButtonClick">
<element name="TCalcEdit.ButtonClick">
<short>Performs actions needed when the button for the control is clicked.</short>
<descr>
<p>
<var>ButtonClick</var> is an overridden method used to perform actions needed when the <var>Button</var> for the control is clicked. For <var>TCalcEdit</var>, the <var>RunDialog</var> method is called to execute the dialog for the control and to capture it results. When <var>FocusOnButtonClick</var> is set, the <var>FocusAndMaybeSelectAll</var> method is called to give focus to the <var>Edit</var> control in the class.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="TCustomEditButton.ButtonClick"/>
</seealso>
</element>
<element name="TCalcEdit.Create" link="#lcl.editbtn.TCustomEditButton.Create">
<element name="TCalcEdit.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -3263,7 +3277,9 @@
<dd>Set to poScreenCenter</dd>
</dl>
</descr>
<seealso/>
<seealso>
<link id="TCustomEditButton.Create"/>
</seealso>
</element>
<element name="TCalcEdit.Create.AOwner">
<short>Owner of the class instance.</short>

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

@ -1261,7 +1261,7 @@
<element name="TShape.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TShape.GetControlClassDefaultSize" link="#lcl.controls.TControl.GetControlClassDefaultSize">
<element name="TShape.GetControlClassDefaultSize">
<short>Gets the default size for instances of the control.</short>
<descr>
<p>
@ -1271,8 +1271,9 @@
GetControlClassDefaultSize is called from the <var>Create</var> method, and used to set the initial value in the <var>Bounds</var> for the control.
</p>
</descr>
<errors/>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
</seealso>
</element>
<element name="TShape.GetControlClassDefaultSize.Result">
<short>TSize instance with the dimensions for instances of the control class.</short>
@ -4516,7 +4517,7 @@
<element name="TCustomLabeledEdit.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomLabeledEdit.SetParent" link="#lcl.controls.TControl.SetParent">
<element name="TCustomLabeledEdit.SetParent">
<short>Sets the value for the Parent property.</short>
<descr>
<p>
@ -4528,6 +4529,7 @@
<link id="TCustomLabeledEdit.LabelPosition"/>
<link id="TCustomLabeledEdit.LabelSpacing"/>
<link id="#lcl.controls.TControl.Parent">TControl.Parent</link>
<link id="#lcl.controls.TControl.SetParent">TControl.SetParent</link>
</seealso>
</element>
<element name="TCustomLabeledEdit.SetParent.AParent">

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

@ -722,10 +722,12 @@
</seealso>
</element>
<element name="TCustomFilterComboBox.Notification" link="#lcl.controls.TControl.Notification">
<element name="TCustomFilterComboBox.Notification">
<short>Handles notification messages for sub-components in the control.</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.Notification">TControl.Notification</link>
</seealso>
</element>
<element name="TCustomFilterComboBox.Notification.AComponent">
<short>Component for the notification message.</short>

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

@ -1006,8 +1006,8 @@
<element name="TScrollingWinControl.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TScrollingWinControl.AlignControls" link="#lcl.controls.TWinControl.AlignControls">
<short/>
<element name="TScrollingWinControl.AlignControls">
<short>Aligns the controls which have the class instance as their parent.</short>
<descr>
<p>
Calls the inherited method to align the specified control and its children to the parent control. Ensures that the page, range, and position in the scroll bars are recalculated when <var>AutoScroll</var> is enabled and both <var>HorzScrollBar</var> and <var>VertScrollBar</var> are in use.
@ -1056,8 +1056,8 @@
</seealso>
</element>
<element name="TScrollingWinControl.CreateWnd" link="#lcl.controls.TWinControl.CreateWnd">
<short/>
<element name="TScrollingWinControl.CreateWnd">
<short>Creates the window handle for the control.</short>
<descr>
<p>
Ensures that the scroll bar page, range, and visibiity are established when the handles for the windowed control are created. Temporarily disables auto-sizing in the method, and re-enables auto-sizing prior to exit. Calls the inherited method to create the window and its handles.
@ -1065,6 +1065,7 @@
</descr>
<seealso>
<link id="TScrollingWinControl.UpdateScrollBars"/>
<link id="#lcl.controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
</seealso>
</element>
@ -1170,7 +1171,7 @@
<short>True when something has been changed in the scroll bar settings.</short>
</element>
<element name="TScrollingWinControl.SetAutoScroll" link="#lcl.forms.TScrollingWinControl.AutoScroll">
<element name="TScrollingWinControl.SetAutoScroll">
<short>Sets the value for the AutoScroll property.</short>
<descr>
<p>
@ -2203,7 +2204,7 @@
<seealso/>
</element>
<element name="TModalResult" link="#lcl.uitypes.TModalResult">
<element name="TModalResult">
<short>Dummy type for the values that can be returned as a modal result.</short>
<descr>
<p>
@ -2528,8 +2529,11 @@
<element name="TCustomForm.GetEffectiveShowInTaskBar.Result">
<short>Effect visibility for the form icon in the task bar.</short>
</element>
<element name="TCustomForm.GetMonitor" link="#lcl.forms.TCustomForm.Monitor">
<element name="TCustomForm.GetMonitor">
<short>Gets the value for the Monitor property.</short>
<seealso>
<link id="TCustomForm.Monitor"/>
</seealso>
</element>
<element name="TCustomForm.GetMonitor.Result">
<short>Value for the property.</short>
@ -3230,7 +3234,7 @@
<short>True when Color has value other than clDefault or clBtnFace.</short>
</element>
<element name="TCustomForm.CreateParams" link="#lcl.controls.TWinControl.CreateParams">
<element name="TCustomForm.CreateParams">
<short>Initializes parameters used to create the handle for the form instance.</short>
<descr>
<p>
@ -3507,7 +3511,7 @@
<short>Operation performed for the component.</short>
</element>
<element name="TCustomForm.PaintWindow" link="#lcl.controls.TCustomControl.PaintWindow">
<element name="TCustomForm.PaintWindow">
<short>
Calls the Paint method using the specified device context in the control Canvas.
</short>
@ -3519,18 +3523,22 @@
PaintWindow assigns the device context in <var>dc</var> to the <var>Canvas</var> handle. The <var>Paint</var> method is called to signal the <var>OnPaint</var> event handler (when assigned). If a design surface is active for the form instance, its <var>PaintGrid</var> method is called. The Canvas handle is reset to 0 prior to exiting from the method.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TCustomControl.PaintWindow">TCustomControl.PaintWindow</link>
</seealso>
</element>
<element name="TCustomForm.PaintWindow.dc">
<short>Device context (Handle) assigned to the Canvas for the form.</short>
</element>
<element name="TCustomForm.RequestAlign" link="#lcl.controls.TControl.RequestAlign">
<element name="TCustomForm.RequestAlign">
<short>
Calls the user Alignment handler (AlignControls). Here: NOP for a top-level form.
</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.RequestAlign">TControl.RequestAlign</link>
</seealso>
</element>
<element name="TCustomForm.Resizing">
@ -3598,7 +3606,7 @@
<short>True for BringToFront.</short>
</element>
<element name="TCustomForm.SetParent" link="#lcl.controls.TControl.Parent">
<element name="TCustomForm.SetParent">
<short>Sets the value for the Parent property.</short>
<descr>
<p>
@ -3623,7 +3631,7 @@
<short>New value for the property.</short>
</element>
<element name="TCustomForm.MoveToDefaultPosition" link="#lcl.forms.TCustomForm.Position">
<element name="TCustomForm.MoveToDefaultPosition">
<short>Moves the form to the location specified in the Position property.</short>
<descr>
<p>
@ -3640,7 +3648,9 @@
MoveToDefaultPosition is called from the <var>AllAutoSized</var>, <var>SetRestoredBounds</var>, and <var>UpdateShowing</var> methods. It is also called when a new value is assigned to the Position property.
</p>
</descr>
<seealso/>
<seealso>
<link id="TCustomForm.Position"/>
</seealso>
</element>
<element name="TCustomForm.UpdateShowing">
@ -3669,7 +3679,7 @@
</seealso>
</element>
<element name="TCustomForm.SetVisible" link="#lcl.controls.TControl.SetVisible">
<element name="TCustomForm.SetVisible">
<short>Sets the value for the Visible property.</short>
<descr>
<p>
@ -3679,13 +3689,15 @@
SetVisible calls the inherited method to store the new property value, and to perform resizing and control messages as needed. The <var>UpdateVisible</var> method in <var>Application</var> is called to ensure that the application is visible in the task bar when one of its forms is visible.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.SetVisible">TControl.SetVisible</link>
</seealso>
</element>
<element name="TCustomForm.SetVisible.Value">
<short>New value for the property.</short>
</element>
<element name="TCustomForm.AllAutoSized" link="#lcl.controls.TWinControl.AllAutoSized">
<element name="TCustomForm.AllAutoSized">
<short>If the the form is about to show, calculate its metrics.</short>
<descr>
<p>
@ -3703,7 +3715,7 @@
<link id="TCustomForm.MoveToDefaultPosition"/>
<link id="TCustomForm.Position"/>
<link id="#lcl.controls.TWinControl.Showing">TWinControl.Showing</link>
<link id="#lcl.controls.TWinControl.AllAutoSize">TWinControl.AllAutoSize</link>
<link id="#lcl.controls.TWinControl.AllAutoSized">TWinControl.AllAutoSized</link>
<link id="#lcl.controls.TWinControl.DoAllAutoSize">TWinControl.DoAllAutoSize</link>
</seealso>
</element>
@ -3942,7 +3954,7 @@
</seealso>
</element>
<element name="TCustomForm.DoDock" link="#lcl.controls.TControl.DoDock">
<element name="TCustomForm.DoDock">
<short>Docks or undocks the form in the specified dock site.</short>
<descr>
<p>
@ -3966,9 +3978,9 @@
</descr>
<seealso>
<link id="TCustomForm.BorderStyle"/>
<link id="#lcl.controls.TControl.Dock">TControl.Dock</link>
<link id="#lcl.controls.TControl.DoDock">TControl.DoDock</link>
<link id="#lcl.controls.TControl.HostDockSite">TControl.HostDockSite</link>
<link id="#lcl.controls.TWinControl.Dock">TWinControl.Dock</link>
</seealso>
</element>
<element name="TCustomForm.DoDock.NewDockSite">
@ -3980,7 +3992,7 @@
</short>
</element>
<element name="TCustomForm.GetFloating" link="#lcl.controls.TControl.GetFloating">
<element name="TCustomForm.GetFloating">
<short>Gets the value for the Floating properties.</short>
<descr/>
<seealso>
@ -4283,7 +4295,7 @@
<short>The control receiving the focus.</short>
</element>
<element name="TCustomForm.FormIsUpdating" link="#lcl.controls.TControl.FormIsUpdating">
<element name="TCustomForm.FormIsUpdating">
<short>
Indicates if the BeginFormUpdate method has been called without a corresponding EndFormUpdate method call.
</short>
@ -4295,6 +4307,7 @@
<seealso>
<link id="TCustomForm.BeginFormUpdate"/>
<link id="TCustomForm.EndFormUpdate"/>
<link id="#lcl.controls.TControl.FormIsUpdating">TControl.FormIsUpdating</link>
</seealso>
</element>
<element name="TCustomForm.FormIsUpdating.Result">
@ -4550,7 +4563,7 @@
</short>
</element>
<element name="TCustomForm.Show" link="#lcl.controls.TControl.Show">
<element name="TCustomForm.Show">
<short>Displays the form instance with support for High DPI scaling.</short>
<descr>
<p>
@ -4563,7 +4576,9 @@
Show sets the value in the <var>Visible</var> property to <b>True</b>, and calls the <var>ShowWindow</var> routine in the LCL interface at run-time using the <var>Handle</var> and <var>WindowState</var> for the form. The <var>BringToFront</var> method is called to apply the Z-Order for the form instance and its siblings.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.Show">TControl.Show</link>
</seealso>
</element>
<element name="TCustomForm.ShowModal">
@ -4768,14 +4783,18 @@
<seealso/>
</element>
<element name="TCustomForm.Dock" link="#lcl.controls.TControl.Dock">
<short/>
<element name="TCustomForm.Dock">
<short>
Docks the form to the specified dock site.
</short>
<descr>
<p>
Calls the inherited method using the values in <var>NewDockSite</var> and <var>ARect</var> as arguments.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.Dock">TControl.Dock</link>
</seealso>
</element>
<element name="TCustomForm.Dock.NewDockSite">
<short/>
@ -5003,7 +5022,7 @@
</seealso>
</element>
<element name="TCustomForm.Caption" link="#lcl.controls.TControl.Caption">
<element name="TCustomForm.Caption">
<short>The text displayed in the title bar for the form.</short>
<descr>
<p>
@ -5493,7 +5512,7 @@
</seealso>
</element>
<element name="TCustomForm.OnResize" link="#lcl.controls.TControl.OnResize">
<element name="TCustomForm.OnResize">
<short>Event handler signalled when the size for the form is changed.</short>
<descr>
<p>
@ -5700,14 +5719,18 @@
</seealso>
</element>
<element name="TCustomForm.Visible" link="#lcl.controls.TControl.Visible">
<short/>
<element name="TCustomForm.Visible">
<short>
Indicates if the control is visible on its parent.
</short>
<descr>
<p>
Re-declared in TCustomForm to use a different storage specifier than the ancestor class. In TCustomForm, visibility is not tied to an Action or an ActionLink; it uses the value in the Visible property.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.Visible">TControl.Visible</link>
</seealso>
</element>
<element name="TCustomForm.WindowState">
@ -5742,7 +5765,7 @@
</seealso>
</element>
<element name="TForm" link="#lcl.forms.TCustomForm">
<element name="TForm">
<short>Implements a form used in an LCL application.</short>
<descr>
<p>
@ -5762,12 +5785,16 @@
<element name="TForm.LCLVersionIsStored" link="#lcl.forms.TForm.LCLVersion"/>
<element name="TForm.LCLVersionIsStored.Result" link="#lcl.forms.TForm.LCLVersion.Result"/>
<element name="TForm.WSRegisterClass" link="#lcl.forms.TCustomForm.WSRegisterClass">
<short/>
<element name="TForm.WSRegisterClass">
<short>
Creates an assocation between the class type and its widgetset class.
</short>
<descr>
WSRegisterClass is an overridden class procedure used to register the widgetset class used to create new instances of the form.
</descr>
<seealso/>
<seealso>
<link id="#lcl.forms.TCustomForm.WSRegisterClass">TCustomForm.WSRegisterClass</link>
</seealso>
</element>
<element name="TForm.CreateWnd">
@ -5989,7 +6016,7 @@
<seealso/>
</element>
<element name="TCustomDockForm.DoAddDockClient" link="#lcl.controls.TWinControl.DoAddDockClient">
<element name="TCustomDockForm.DoAddDockClient">
<short>
Adds Client as a child control which fills the entire area for the docked form.
</short>
@ -5998,7 +6025,9 @@
DoAddDockClient is an overridden method used to add the control in Client to the docked form. It calls the inherited method on entry to set the Parent in Client to the current class instance. It sets the Align property in Client to alAlign to align the control to the bounds for the docked form. Values in the BorderSpacing property in Client are reset to 0; the current class instance provides the BorderSpacing values for the docked control. At run-time, the Visible property is set to True to display the docked form after the Client has been added.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TWinControl.DoAddDockClient">TWinControl.DoAddDockClient</link>
</seealso>
</element>
<element name="TCustomDockForm.DoAddDockClient.Client">
<short>Control added to the docked form instance.</short>
@ -6007,10 +6036,12 @@
<short>Not used in the current implementation.</short>
</element>
<element name="TCustomDockForm.DoRemoveDockClient" link="#lcl.controls.TWinControl.DoRemoveDockClient">
<element name="TCustomDockForm.DoRemoveDockClient">
<short>Closes (releases) the form after the last client has been undocked.</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.controls.TWinControl.DoRemoveDockClient">TWinControl.DoRemoveDockClient</link>
</seealso>
</element>
<element name="TCustomDockForm.DoRemoveDockClient.Client">
<short/>
@ -6034,13 +6065,15 @@
<short/>
</element>
<element name="TCustomDockForm.Loaded" link="#lcl.forms.TCustomForm.Loaded">
<element name="TCustomDockForm.Loaded">
<short>
Tries to make all child controls dockclients. This is of little use in practice,
a floating hostdocksite should have no child controls.
</short>
<descr/>
<seealso/>
<seealso>
<link id="TCustomForm.Loaded"/>
</seealso>
</element>
<element name="TCustomDockForm.Create">
@ -6366,7 +6399,7 @@
</seealso>
</element>
<element name="THintWindow.Create" link="#rtl.classes.TComponent.Create">
<element name="THintWindow.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -6652,10 +6685,12 @@
</seealso>
</element>
<element name="THintWindowClass" link="#lcl.forms.THintWindow">
<element name="THintWindowClass">
<short>Class of <var>THintWindow</var>.</short>
<descr/>
<seealso/>
<seealso>
<link id="THintWindow"/>
</seealso>
</element>
<element name="THintWindowRendered">
@ -7095,7 +7130,7 @@
<short>Ordinal position for the property value.</short>
</element>
<element name="TScreen.GetCustomFormsZOrdered" link="#lcl.forms.TScreen.CustomFormsZOrdered">
<element name="TScreen.GetCustomFormsZOrdered">
<short>Gets the value for the indexed CustomFormsZOrdered property.</short>
<descr/>
<seealso>
@ -7213,7 +7248,7 @@
<short>Value for the property.</short>
</element>
<element name="TScreen.GetForms" link="#lcl.forms.TScreen.Forms">
<element name="TScreen.GetForms">
<short>Gets the value for the indexed Forms property.</short>
<descr/>
<seealso>
@ -7227,7 +7262,7 @@
<short>Ordinal position for the form instance in the property value.</short>
</element>
<element name="TScreen.GetHeight" link="#lcl.forms.TScreen.Height">
<element name="TScreen.GetHeight">
<short>Gets the value for the Height property.</short>
<descr>
<p>
@ -7366,19 +7401,23 @@
<short>The notification handler.</short>
</element>
<element name="TScreen.DoAddDataModule" link="#lcl.forms.TScreen.DataModules">
<element name="TScreen.DoAddDataModule">
<short>Adds the specified data module to the list.</short>
<descr/>
<seealso/>
<seealso>
<link id="TScreen.DataModules"/>
</seealso>
</element>
<element name="TScreen.DoAddDataModule.DataModule">
<short>Data module instance added in the method.</short>
</element>
<element name="TScreen.DoRemoveDataModule" link="#lcl.forms.TScreen.DataModules">
<element name="TScreen.DoRemoveDataModule">
<short>Removes the specified data module from the list.</short>
<descr/>
<seealso/>
<seealso>
<link id="TScreen.DataModules"/>
</seealso>
</element>
<element name="TScreen.DoRemoveDataModule.DataModule">
<short>Data module removed in the method.</short>
@ -7473,7 +7512,7 @@
<short>Value for the property.</short>
</element>
<element name="TScreen.Create" link="#rtl.classes.TComponent.Create">
<element name="TScreen.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -7510,7 +7549,7 @@
</seealso>
</element>
<element name="TScreen.CustomFormIndex" link="#lcl.forms.TScreen.CustomForms">
<element name="TScreen.CustomFormIndex">
<short>Gets the ordinal position in CustomForms for the requested form.</short>
<descr>
<p>
@ -8585,7 +8624,7 @@
</seealso>
</element>
<element name="TScreen.MonitorCount" link="#lcl.forms.TScreen.Monitors">
<element name="TScreen.MonitorCount">
<short>The number of available Monitors.</short>
<descr>
<p>
@ -8595,7 +8634,9 @@
Use <var>Monitors</var> to access a <var>TMonitor</var> instance by its ordinal position in the list.
</p>
</descr>
<seealso/>
<seealso>
<link id="TScreen.Monitors"/>
</seealso>
</element>
<element name="TScreen.Monitors">
@ -9185,10 +9226,12 @@
<short>Handler provides the Handle for the main form.</short>
</element>
<element name="PAsyncCallQueueItem" link="#lcl.forms.TAsyncCallQueueItem">
<element name="PAsyncCallQueueItem">
<short>A queued asynchronous callback request node.</short>
<descr/>
<seealso/>
<seealso>
<link id="TAsyncCallQueueItem"/>
</seealso>
</element>
<element name="TAsyncCallQueueItem">
@ -10814,21 +10857,23 @@
<short>Indicates if the method waits for the next message.</short>
</element>
<element name="TApplication.Run" link="#fcl.CustApp.TCustomApplication.Run">
<element name="TApplication.Run">
<short>
Loads the MainForm and passes control to the event loop for the application.
</short>
<descr>
</descr>
<seealso>
<link id="TApplication.RunLoop"/>
<link id="#fcl.CustApp.TCustomApplication.Run">TCustomApplication.Run</link>
</seealso>
</element>
<element name="TApplication.ShowException" link="#fcl.CustApp.TCustomApplication.ShowException">
<element name="TApplication.ShowException">
<short>Shows the exception message and asks the user to abort or continue.</short>
<descr/>
<seealso/>
<seealso>
<link id="#fcl.CustApp.TCustomApplication.ShowException">TCustomApplication.ShowException</link>
</seealso>
</element>
<element name="TApplication.ShowException.E">
<short>The exception to display for the application.</short>
@ -10837,10 +10882,12 @@
</seealso>
</element>
<element name="TApplication.Terminate" link="#fcl.CustApp.TCustomApplication.Terminate">
<element name="TApplication.Terminate">
<short>The application is terminated and the component engine is shutdown.</short>
<descr/>
<seealso/>
<seealso>
<link id="#fcl.CustApp.TCustomApplication.Terminate">TCustomApplication.Terminate</link>
</seealso>
</element>
<element name="TApplication.DisableIdleHandler">
@ -12449,7 +12496,7 @@
<seealso/>
</element>
<element name="TApplication.Title" link="#fcl.CustApp.TCustomApplication.Title">
<element name="TApplication.Title">
<short>Contains the title for the application.</short>
<descr>
<p>
@ -12457,7 +12504,6 @@
</p>
</descr>
<seealso>
<link id="TApplication.GetExeName"/>
<link id="#fcl.CustApp.TCustomApplication.Title">TCustomApplication.Title</link>
</seealso>
</element>

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

@ -8381,7 +8381,7 @@
<element name="TRasterImage.GetMaskHandle.Result">
<short>Value for the property.</short>
</element>
<element link="#lcl.graphics.TGraphic.GetMimeType" name="TRasterImage.GetMimeType">
<element name="TRasterImage.GetMimeType">
<short>Gets the value for the MimeType property.</short>
<descr/>
<seealso>
@ -8423,13 +8423,14 @@
<element name="TRasterImage.GetRawImageDescriptionPtr.Result">
<short/>
</element>
<element link="#lcl.graphics.TGraphic.GetTransparent" name="TRasterImage.GetTransparent">
<element name="TRasterImage.GetTransparent">
<short>Gets the value for the Transparent property.</short>
<descr/>
<seealso>
<link id="TGraphic.Transparent"/>
<link id="TRaasterImage.TransparentMode"/>
<link id="TRaasterImage.TransparentColor"/>
<link id="TGraphic.GetTransparent"/>
<link id="TRasterImage.TransparentMode"/>
<link id="TRasterImage.TransparentColor"/>
</seealso>
</element>
<element name="TRasterImage.GetTransparent.Result">
@ -8462,7 +8463,7 @@
<element name="TRasterImage.GetHeight.Result">
<short>Value for the property.</short>
</element>
<element link="#lcl.graphics.TGraphic.GetWidth" name="TRasterImage.GetWidth">
<element name="TRasterImage.GetWidth">
<short>Gets the value for the Width property.</short>
<descr/>
<seealso>
@ -9998,7 +9999,7 @@
<link id="TRasterImage.HandleNeeded"/>
</seealso>
</element>
<element link="#lcl.graphics.TRasterImage.InternalReleaseBitmapHandle" name="TCustomBitmap.InternalReleaseBitmapHandle">
<element name="TCustomBitmap.InternalReleaseBitmapHandle">
<short/>
<descr/>
<seealso>
@ -10008,12 +10009,10 @@
<element name="TCustomBitmap.InternalReleaseBitmapHandle.Result">
<short/>
</element>
<element link="#lcl.graphics.TRasterImage.InternalReleaseMaskHandle" name="TCustomBitmap.InternalReleaseMaskHandle">
<element name="TCustomBitmap.InternalReleaseMaskHandle">
<short/>
<descr/>
<seealso>
<link id="TCustomBitmap.MaskHandle"/>
</seealso>
<seealso></seealso>
</element>
<element name="TCustomBitmap.InternalReleaseMaskHandle.Result">
<short/>
@ -10277,7 +10276,7 @@
<element name="TCustomBitmap.BitmapHandleAllocated.Result">
<short/>
</element>
<element link="#lcl.graphics.TRasterImage.MaskHandleAllocated" name="TCustomBitmap.MaskHandleAllocated">
<element name="TCustomBitmap.MaskHandleAllocated">
<short>Determines if the mask handle has been allocated for the image.</short>
<descr>
<p>
@ -10620,13 +10619,15 @@
<element name="TFPImageBitmap.WriteStream.Stream">
<short>Stream where the image data is stored.</short>
</element>
<element link="#lcl.graphics.TGraphic.GetFileExtensions" name="TFPImageBitmap.GetFileExtensions">
<element name="TFPImageBitmap.GetFileExtensions">
<short>Returns a list of the file extensions available for the image type.</short>
<descr>
<p>Always returns an empty string ('') in TFPImageBitmap.
</p>
</descr>
<seealso/>
<seealso>
<link id="TGraphic.GetFileExtensions"/>
</seealso>
</element>
<element name="TFPImageBitmap.GetFileExtensions.Result">
<short>List of file extensions supported for the image type.</short>
@ -11193,10 +11194,12 @@
<element name="TSharedIcon.UpdateFromHandle.NewHandle">
<short/>
</element>
<element link="#lcl.graphics.TSharedRasterImage.IsEmpty" name="TSharedIcon.IsEmpty">
<element name="TSharedIcon.IsEmpty">
<short>Indicates if the shared icon is empty (contains no icon images).</short>
<descr/>
<seealso/>
<seealso>
<link id="TSharedRasterImage.IsEmpty"/>
</seealso>
</element>
<element name="TSharedIcon.IsEmpty.Result">
<short/>
@ -12953,17 +12956,21 @@
<descr/>
<seealso/>
</element>
<element link="#lcl.graphics.TSharedImage.FreeHandle" name="TSharedCursorImage.FreeHandle">
<element name="TSharedCursorImage.FreeHandle">
<short>Frees the handle for the cursor image.</short>
<descr/>
<seealso>
<link id="TSharedImage.FreeHandle"/>
</seealso>
</element>
<element link="#lcl.graphics.TSharedIcon.GetImagesClass" name="TSharedCursorImage.GetImagesClass">
<short>Gets the class reference used to create a new cursor image in the Images property.</short>
<element name="TSharedCursorImage.GetImagesClass">
<short>
Gets the class reference used to create a new cursor image in the Images property.
</short>
<descr/>
<seealso/>
<seealso>
<link id="TSharedIcon.GetImagesClass"/>
</seealso>
</element>
<element name="TSharedCursorImage.GetImagesClass.Result">
<short>Class reference used to create images in the shared cursor image list.</short>

125
docs/xml/lcl/grids.xml
View File

@ -2420,10 +2420,12 @@
<short>Class generating the notification.</short>
</element>
<element name="TGridColumnTitle.GetAlignment" link="#lcl.grids.TGridColumnTitle.Alignment">
<element name="TGridColumnTitle.GetAlignment">
<short>Gets the value for the Alignment property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumnTitle.Alignment"/>
</seealso>
</element>
<element name="TGridColumnTitle.GetAlignment.Result">
<short>Value for the property.</short>
@ -2537,7 +2539,7 @@
<short>True when the Layout has been assigned in the column title.</short>
</element>
<element name="TGridColumnTitle.SetAlignment" link="#lcl.grids.TGridColumnTitle.Alignment">
<element name="TGridColumnTitle.SetAlignment">
<short>Sets the value in the Alignment property.</short>
<descr/>
<seealso>
@ -2548,7 +2550,7 @@
<short>New value for the property.</short>
</element>
<element name="TGridColumnTitle.SetColor" link="#lcl.grids.TGridColumnTitle.Color">
<element name="TGridColumnTitle.SetColor">
<short>Sets the value in the Color property.</short>
<descr/>
<seealso>
@ -2559,7 +2561,7 @@
<short>New value for the property.</short>
</element>
<element name="TGridColumnTitle.SetFont" link="#lcl.grids.TGridColumnTitle.Font">
<element name="TGridColumnTitle.SetFont">
<short>Sets the value in the Font property.</short>
<descr/>
<seealso>
@ -2570,7 +2572,7 @@
<short>New value for the property.</short>
</element>
<element name="TGridColumnTitle.SetLayout" link="#lcl.grids.TGridColumnTitle.Layout">
<element name="TGridColumnTitle.SetLayout">
<short>Sets the value in the Layout property.</short>
<descr/>
<seealso>
@ -2967,19 +2969,23 @@
<short>Class instance generating the notification.</short>
</element>
<element name="TGridColumn.GetAlignment" link="#lcl.grids.TGridColumn.Alignment">
<element name="TGridColumn.GetAlignment">
<short>Gets the value for the Alignment property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.Alignment"/>
</seealso>
</element>
<element name="TGridColumn.GetAlignment.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetColor" link="#lcl.grids.TGridColumn.Color">
<element name="TGridColumn.GetColor">
<short>Gets the value for the Color property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.Color"/>
</seealso>
</element>
<element name="TGridColumn.GetColor.Result">
<short>Value for the property.</short>
@ -2996,91 +3002,111 @@
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetFont" link="#lcl.grids.TGridColumn.Font">
<element name="TGridColumn.GetFont">
<short>Gets the value for the Font property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.Font"/>
</seealso>
</element>
<element name="TGridColumn.GetFont.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetGrid" link="#lcl.grids.TGridColumn.Grid">
<element name="TGridColumn.GetGrid">
<short>Gets the value for the Grid property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.Grid"/>
</seealso>
</element>
<element name="TGridColumn.GetGrid.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetLayout" link="#lcl.grids.TGridColumn.Layout">
<element name="TGridColumn.GetLayout">
<short>Gets the value for the Layout property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.Layout"/>
</seealso>
</element>
<element name="TGridColumn.GetLayout.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetMaxSize" link="#lcl.grids.TGridColumn.MaxSize">
<element name="TGridColumn.GetMaxSize">
<short>Gets the value for the MaxSize property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.MaxSize"/>
</seealso>
</element>
<element name="TGridColumn.GetMaxSize.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetMinSize" link="#lcl.grids.TGridColumn.MinSize">
<element name="TGridColumn.GetMinSize">
<short>Gets the value for the MinSize property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.MinSize"/>
</seealso>
</element>
<element name="TGridColumn.GetMinSize.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetSizePriority" link="#lcl.grids.TGridColumn.SizePriority">
<element name="TGridColumn.GetSizePriority">
<short>Gets the value for the SizePriority property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.SizePriority"/>
</seealso>
</element>
<element name="TGridColumn.GetSizePriority.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetPickList" link="#lcl.grids.TGridColumn.PickList">
<element name="TGridColumn.GetPickList">
<short>Gets the list of strings in the picklist.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.PickList"/>
</seealso>
</element>
<element name="TGridColumn.GetPickList.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetReadOnly" link="#lcl.grids.TGridColumn.ReadOnly">
<element name="TGridColumn.GetReadOnly">
<short>Gets the value for the ReadOnly property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.ReadOnly"/>
</seealso>
</element>
<element name="TGridColumn.GetReadOnly.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetVisible" link="#lcl.grids.TGridColumn.Visible">
<element name="TGridColumn.GetVisible">
<short>Gets the value for the Visible property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.Visible"/>
</seealso>
</element>
<element name="TGridColumn.GetVisible.Result">
<short>Value for the property.</short>
</element>
<element name="TGridColumn.GetWidth" link="#lcl.grids.TGridColumn.Width">
<element name="TGridColumn.GetWidth">
<short>Gets the value for the Width property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TGridColumn.Width"/>
</seealso>
</element>
<element name="TGridColumn.GetWidth.Result">
<short>Value for the property.</short>
@ -3962,10 +3988,12 @@
<short>Value for the property.</short>
</element>
<element name="TGridColumns.Update" link="#rtl.classes.TCollection.Update">
<element name="TGridColumns.Update">
<short>Notifies the Grid using the collection when a column is updated.</short>
<descr/>
<seealso/>
<seealso>
<link id="#rtl.classes.TCollection">TCollection</link>
</seealso>
</element>
<element name="TGridColumns.Update.Item">
<short>Collection item requiring the update notification.</short>
@ -4910,7 +4938,7 @@
<short>TPoint instance with the column and row numbers for the cell.</short>
</element>
<element name="TCustomGrid.GetSelectedColumn" link="#lcl.grids.TCustomGrid.SelectedColumn">
<element name="TCustomGrid.GetSelectedColumn">
<short>Gets the value for the SelectedColumn property.</short>
<descr/>
<seealso>
@ -9276,7 +9304,7 @@
<short>Screen coordinates for the mouse pointer.</short>
</element>
<element name="TCustomGrid.KeyDown" link="#lcl.controls.TWinControl.KeyDown">
<element name="TCustomGrid.KeyDown">
<short>Handles key down events for the grid control.</short>
<descr>
<p>
@ -9473,7 +9501,7 @@
<short>TMouseButton value examined in the method.</short>
</element>
<element name="TCustomGrid.MouseDown" link="#lcl.controls.TControl.MouseDown">
<element name="TCustomGrid.MouseDown">
<short>Handles mouse down events for the grid control.</short>
<descr>
<p>
@ -9525,7 +9553,9 @@
Other cells use the values in Options and CursorState to determine whether the mouse event is for column sizing, selection, or enabling/disabling the cell editor. GridState is updated to the corresponding value.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TControl.MouseDown">TControl.MouseDown</link>
</seealso>
</element>
<element name="TCustomGrid.MouseDown.Button">
<short>Mouse button for the event.</short>
@ -10626,14 +10656,18 @@
<notes><note>Need to check whether column resizing is also restricted HERE.</note></notes>
</element>
<element name="TCustomGrid.BorderStyle" link="#lcl.controls.TWinControl.BorderStyle">
<short/>
<element name="TCustomGrid.BorderStyle">
<short>
Drawing style used for the borders on the control.
</short>
<descr>
<p>
Only a restricted range of values is available in TCustomGrid: a single border or none.
Only a restricted range of values are available in TCustomGrid: a single border or none.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TWinControl.BorderStyle">TWinControl.BorderStyle</link>
</seealso>
</element>
<element name="TCustomGrid.BorderColor">
@ -15295,11 +15329,16 @@
<element name="TStringGrid.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
<element name="TStringGrid.OnDrawCell" link="#lcl.grids.TCustomGrid.OnDrawCell"/>
<element name="TStringGrid.OnEditButtonClick" link="#lcl.grids.TCustomGrid.OnEditButtonClick">
<short>Deprecated.</short>
<element name="TStringGrid.OnEditButtonClick">
<short>Deprecated. Use <var>OnButtonClick</var> instead.</short>
<descr>
<p>Use <var>OnButtonClick</var> instead.</p>
<p>
Deprecated. Use <var>OnButtonClick</var> instead.
</p>
</descr>
<seealso>
<link id="TCustomGrid.OnButtonClick"/>
</seealso>
</element>
<element name="TStringGrid.OnButtonClick" link="#lcl.grids.TCustomGrid.OnButtonClick"/>

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

@ -2303,14 +2303,16 @@
<element name="TCustomAbstractGroupedEdit.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
<element name="TCustomAbstractGroupedEdit.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
<element name="TCustomAbstractGroupedEdit.OnUtf8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress">
<element name="TCustomAbstractGroupedEdit.OnUtf8KeyPress">
<short>
Event handler signalled for UTF-8 key press events.
</short>
<descr>
<p>
<var>OnUTF8KeyPress</var> uses the <var>InternalOnEditUtf8KeyPress</var> method as the default event handler for the control, as assigned in the <var>Create</var> constructor.
</p>
</descr>
<seealso>
<link id="TCustomAbstractGroupedEdit.InternalOnEditUtf8KeyPress"/>
<link id="#lcl.controls.TWinControl.OnUTF8KeyPress">TWinControl.OnUTF8KeyPress</link>
</seealso>
</element>

113
docs/xml/lcl/imglist.xml
View File

@ -285,8 +285,11 @@
<short>Number of images that require data storage.</short>
</element>
<element name="TCustomImageListResolution.GetReference" link="#lcl.imglist.TCustomImageListResolution.Reference">
<element name="TCustomImageListResolution.GetReference">
<short>Gets the value for the Reference property.</short>
<seealso>
<link id="TCustomImageListResolution.Reference"/>
</seealso>
</element>
<element name="TCustomImageListResolution.GetReference.Result">
<short>Value for the Reference property.</short>
@ -1204,22 +1207,31 @@
<element name="TScaledImageListResolution.FHeight" link="#lcl.imglist.TScaledImageListResolution.Height"/>
<element name="TScaledImageListResolution.GetCount" link="#lcl.imglist.TScaledImageListResolution.Count">
<element name="TScaledImageListResolution.GetCount">
<short>Gets the value for the Count property.</short>
<descr>
<link id="TScaledImageListResolution.Count"/>
</descr>
</element>
<element name="TScaledImageListResolution.GetCount.Result">
<short>Value for the Count property.</short>
</element>
<element name="TScaledImageListResolution.GetSize" link="#lcl.imglist.TScaledImageListResolution.Size">
<element name="TScaledImageListResolution.GetSize">
<short>Gets the value for the Size property.</short>
<seealso>
<link id="TScaledImageListResolution.Size"/>
</seealso>
</element>
<element name="TScaledImageListResolution.GetSize.Result">
<short>Value for the Size property.</short>
</element>
<element name="TScaledImageListResolution.GetValid" link="#lcl.imglist.TScaledImageListResolution.Valid">
<element name="TScaledImageListResolution.GetValid">
<short>Gets the value for the Valid property.</short>
<seealso>
<link id="TScaledImageListResolution.Valid"/>
</seealso>
</element>
<element name="TScaledImageListResolution.GetValid.Result">
<short>Value for the the Valid property.</short>
@ -1254,8 +1266,11 @@
<short>Scale factor applied to the scaled images.</short>
</element>
<element name="TScaledImageListResolution.GetBitmap" link="#lcl.imglist.TCustomImageListResolution.GetBitmap">
<element name="TScaledImageListResolution.GetBitmap">
<short>Gets the scaled bitmap for the specified image.</short>
<seealso>
<link id="TCustomImageListResolution.GetBitmap"/>
</seealso>
</element>
<element name="TScaledImageListResolution.GetBitmap.Index">
<short>Ordinal position for the bitmap requested in the method.</short>
@ -1267,8 +1282,11 @@
<short>Drawing effect applied to the image.</short>
</element>
<element name="TScaledImageListResolution.Draw" link="#lcl.imglist.TCustomImageListResolution.Draw">
<element name="TScaledImageListResolution.Draw">
<short>Draws the scaled image to the specified canvas.</short>
<seealso>
<link id="TCustomImageListResolution.Draw"/>
</seealso>
</element>
<element name="TScaledImageListResolution.Draw.ACanvas">
<short>Canvas used to render the image.</short>
@ -1295,8 +1313,11 @@
<short>Image type for the rendered image.</short>
</element>
<element name="TScaledImageListResolution.StretchDraw" link="#lcl.imglist.TCustomImageListResolution.StretchDraw">
<element name="TScaledImageListResolution.StretchDraw">
<short>Draws the scaled image sized to the target rectangle.</short>
<seealso>
<link id="TCustomImageListResolution.StretchDraw"/>
</seealso>
</element>
<element name="TScaledImageListResolution.StretchDraw.ACanvas">
<short/>
@ -1311,7 +1332,7 @@
<short/>
</element>
<element name="TScaledImageListResolution.DrawOverlay" link="#lcl.imglist.TCustomImageListResolution.DrawOverlay">
<element name="TScaledImageListResolution.DrawOverlay">
<short>Draws an image with an overlay at the specified canvas position.</short>
<descr>
<p>
@ -1338,6 +1359,7 @@
<link id="TScaledImageListResolution.StretchDraw"/>
<link id="TCustomImageListResolution.Draw"/>
<link id="TCustomImageListResolution.StretchDraw"/>
<link id="TCustomImageListResolution.DrawOverlay"/>
</seealso>
</element>
<element name="TScaledImageListResolution.DrawOverlay.ACanvas">
@ -1498,8 +1520,11 @@
</short>
</element>
<element name="TCustomImageListResolutions.GetItems" link="#lcl.imglist.TCustomImageListResolutions.Items">
<element name="TCustomImageListResolutions.GetItems">
<short>Gets the value for the indexed Items property.</short>
<seealso>
<link id="TCustomImageListResolutions.Items"/>
</seealso>
</element>
<element name="TCustomImageListResolutions.GetItems.Result">
<short>Value for the Items property.</short>
@ -1508,8 +1533,11 @@
<short>Ordinal position for the requested item.</short>
</element>
<element name="TCustomImageListResolutions.GetCount" link="#lcl.imglist.TCustomImageListResolutions.Count">
<element name="TCustomImageListResolutions.GetCount">
<short>Gets the value for the Count property.</short>
<seealso>
<link id="TCustomImageListResolutions.Count"/>
</seealso>
</element>
<element name="TCustomImageListResolutions.GetCount.Result">
<short>Value for the Count property.</short>
@ -1747,8 +1775,11 @@
<element name="TCustomImageListResolutionEnumerator.FDesc"/>
<element name="TCustomImageListResolutionEnumerator.GetCurrent" link="#lcl.imglist.TCustomImageListResolutionEnumerator.Current">
<element name="TCustomImageListResolutionEnumerator.GetCurrent">
<short>Gets the value for the Current property.</short>
<seealso>
<link id="TCustomImageListResolutionEnumerator.Current"/>
</seealso>
</element>
<element name="TCustomImageListResolutionEnumerator.GetCurrent.Result">
<short>Value for the Current property.</short>
@ -2028,50 +2059,71 @@
</seealso>
</element>
<element name="TCustomImageList.SetBkColor" link="#lcl.imglist.TCustomImageList.BkColor">
<element name="TCustomImageList.SetBkColor">
<short>Sets the value for the BkColor property.</short>
<seealso>
<link id="TCustomImageList.BkColor"/>
</seealso>
</element>
<element name="TCustomImageList.SetBkColor.Value">
<short>New value for the BkColor property.</short>
</element>
<element name="TCustomImageList.SetDrawingStyle" link="#lcl.imglist.TCustomImageList.DrawingStyle">
<element name="TCustomImageList.SetDrawingStyle">
<short>Sets the value for the DrawingStyle property.</short>
<seealso>
<link id="TCustomImageList.DrawingStyle"/>
</seealso>
</element>
<element name="TCustomImageList.SetDrawingStyle.AValue">
<short>New value for the DrawingStyle property.</short>
</element>
<element name="TCustomImageList.SetHeight" link="#lcl.imglist.TCustomImageList.Height">
<element name="TCustomImageList.SetHeight">
<short>Sets the value for the Height property.</short>
<seealso>
<link id="TCustomImageList.Height"/>
</seealso>
</element>
<element name="TCustomImageList.SetHeight.Value">
<short>New value for the Height property.</short>
</element>
<element name="TCustomImageList.SetMasked" link="#lcl.imglist.TCustomImageList.Masked">
<element name="TCustomImageList.SetMasked">
<short>Sets the value for the Masked property.</short>
<seealso>
<link id="TCustomImageList.Masked"/>
</seealso>
</element>
<element name="TCustomImageList.SetMasked.AValue">
<short>New value for the Masked property.</short>
</element>
<element name="TCustomImageList.SetShareImages" link="#lcl.imglist.TCustomImageList.ShareImages">
<element name="TCustomImageList.SetShareImages">
<short>Sets the value for the ShareImages property.</short>
<seealso>
<link id="TCustomImageList.ShareImages"/>
</seealso>
</element>
<element name="TCustomImageList.SetShareImages.AValue">
<short>New value for the ShareImages property.</short>
</element>
<element name="TCustomImageList.SetWidth" link="#lcl.imglist.TCustomImageList.Width">
<element name="TCustomImageList.SetWidth">
<short>Sets the value for the Width property.</short>
<seealso>
<link id="TCustomImageList.Width"/>
</seealso>
</element>
<element name="TCustomImageList.SetWidth.Value">
<short>New value for the Width property.</short>
</element>
<element name="TCustomImageList.GetReference" link="#lcl.imglist.TCustomImageList.Reference">
<element name="TCustomImageList.GetReference">
<short>Gets the value for the Reference property.</short>
<seealso>
<link id="TCustomImageList.Reference"/>
</seealso>
</element>
<element name="TCustomImageList.GetReference.Result">
<short>Value for the Reference property.</short>
@ -2123,8 +2175,11 @@
<short>Scaling factor used for the target canvas.</short>
</element>
<element name="TCustomImageList.GetWidthForPPI" link="#lcl.imglist.TCustomImageList.WidthForPPI">
<element name="TCustomImageList.GetWidthForPPI">
<short>Gets the value for the WidthForPPI property.</short>
<seealso>
<link id="TCustomImageList.WidthForPPI"/>
</seealso>
</element>
<element name="TCustomImageList.GetWidthForPPI.Result">
<short>Image width derived for the specified display density.</short>
@ -2136,8 +2191,11 @@
<short>Display density (PPI) for the calculation.</short>
</element>
<element name="TCustomImageList.GetHeightForPPI" link="#lcl.imglist.TCustomImageList.HeightForPPI">
<element name="TCustomImageList.GetHeightForPPI">
<short>Gets the value for the HeightForPPI property.</short>
<seealso>
<link id="TCustomImageList.HeightForPPI"/>
</seealso>
</element>
<element name="TCustomImageList.GetHeightForPPI.Result">
<short>Image height derived for the specified display density.</short>
@ -2177,8 +2235,11 @@
</element>
<element name="TCustomImageList.GetCount" link="#lcl.imglist.TCustomImageList.Count">
<element name="TCustomImageList.GetCount">
<short>Gets the value for the Count property.</short>
<seealso>
<link id="TCustomImageList.Count"/>
</seealso>
</element>
<element name="TCustomImageList.GetCount.Result">
<short>Value for the Count property.</short>
@ -2257,8 +2318,11 @@
<short>Icon width requested in the method.</short>
</element>
<element name="TCustomImageList.GetResolutionByIndex" link="#lcl.imglist.TCustomImageList.ResolutionByIndex">
<element name="TCustomImageList.GetResolutionByIndex">
<short>Gets the value for the ResolutionByIndex property.</short>
<seealso>
<link id="TCustomImageList.ResolutionByIndex"/>
</seealso>
</element>
<element name="TCustomImageList.GetResolutionByIndex.Result">
<short>Value for the ResolutionByIndex property.</short>
@ -2267,8 +2331,11 @@
<short>Index position for the requested image resolution.</short>
</element>
<element name="TCustomImageList.GetResolutionCount" link="#lcl.imglist.TCustomImageList.ResolutionCount">
<element name="TCustomImageList.GetResolutionCount">
<short>Gets the value for the ResolutionCount property.</short>
<seealso>
<link id="TCustomImageList.ResolutionCount"/>
</seealso>
<seealso>
<link id="TCustomImageList.ResolutionCount"/>
<link id="TCustomImageList.Resolutions"/>

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

@ -267,10 +267,12 @@
<element name="TWin32WidgetSet.GetAppHandle.Result">
<short>Returns FAppHandle.</short>
</element>
<element name="TWin32WidgetSet.SetAppHandle" link="#lcl.win32int.TWidgetSet.AppHandle">
<element name="TWin32WidgetSet.SetAppHandle">
<short>Sets the application window handle, if not done before.</short>
<descr/>
<seealso/>
<seealso>
<link id="TWidgetSet.AppHandle"/>
</seealso>
</element>
<element name="TWin32WidgetSet.SetAppHandle.AValue">
<short/>
@ -313,20 +315,29 @@
<element name="TWin32WidgetSet.GetLCLCapability.ACapability">
<short/>
</element>
<element name="TWin32WidgetSet.AppInit" link="#lcl.InterfaceBase.TWidgetSet.AppInit">
<element name="TWin32WidgetSet.AppInit">
<short>Initializes the application on the platform, returns Screen information.</short>
</element>
<element name="TWin32WidgetSet.AppInit.ScreenInfo">
<short/>
</element>
<element name="TWin32WidgetSet.AppMinimize" link="#lcl.InterfaceBase.TWidgetSet.AppMinimize">
<element name="TWin32WidgetSet.AppMinimize">
<short>Minimizes the whole application to the taskbar.</short>
<seealso>
<link id="#lcl.InterfaceBase.TWidgetSet.AppMinimize">TWidgetSet.AppMinimize</link>
</seealso>
</element>
<element name="TWin32WidgetSet.AppRestore" link="#lcl.InterfaceBase.TWidgetSet.AppRestore">
<element name="TWin32WidgetSet.AppRestore">
<short>Restore application previously minimized to the taskbar.</short>
<seealso>
<link id="#lcl.InterfaceBase.TWidgetSet.AppRestore">TWidgetSet.AppRestore</link>
</seealso>
</element>
<element name="TWin32WidgetSet.AppBringToFront" link="#lcl.InterfaceBase.TWidgetSet.AppBringToFront">
<element name="TWin32WidgetSet.AppBringToFront">
<short>Brings the entire application on top of all other non-topmost programs.</short>
<seealso>
<link id="#lcl.InterfaceBase.TWidgetSet.AppBringToFront">TWidgetSet.AppBringToFront</link>
</seealso>
</element>
<element name="TWin32WidgetSet.AppProcessMessages" link="#lcl.InterfaceBase.TWidgetSet.AppProcessMessages">
<short>Handles all pending messages.</short>

14
docs/xml/lcl/lazhelphtml.xml
View File

@ -92,7 +92,7 @@
<short>True when the property value is stored.</short>
</element>
<element name="THTMLHelpDatabase.SetBaseURL" link="#lcl.lazhelphtml.THTMLHelpDatabase.BaseURL">
<element name="THTMLHelpDatabase.SetBaseURL">
<short>Sets the value in the BaseURL property.</short>
<seealso>
<link id="THTMLHelpDatabase.BaseURL"/>
@ -102,7 +102,7 @@
<short>New value for the BaseURL property.</short>
</element>
<element name="THTMLHelpDatabase.SetDefaultBaseURL" link="#lcl.lazhelphtml.THTMLHelpDatabase.DefaultBaseURL">
<element name="THTMLHelpDatabase.SetDefaultBaseURL">
<short>Sets the value for the DefaultBaseURL property.</short>
<seealso>
<link id="THTMLHelpDatabase.DefaultBaseURL"/>
@ -476,19 +476,25 @@
<element name="THTMLBrowserHelpViewer.FOnFindDefaultBrowser" link="#lcl.lazhelphtml.THTMLBrowserHelpViewer.OnFindDefaultBrowser"/>
<element name="THTMLBrowserHelpViewer.SetBrowserParams" link="#lcl.lazhelphtml.THTMLBrowserHelpViewer.BrowserParams">
<element name="THTMLBrowserHelpViewer.SetBrowserParams">
<short>
Sets the value in the BrowserParams property.
</short>
<seealso>
<link id="THTMLBrowserHelpViewer.BrowserParams"/>
</seealso>
</element>
<element name="THTMLBrowserHelpViewer.SetBrowserParams.AValue">
<short>New value for the property.</short>
</element>
<element name="THTMLBrowserHelpViewer.SetBrowserPath" link="#lcl.lazhelphtml.THTMLBrowserHelpViewer.BrowserPath">
<element name="THTMLBrowserHelpViewer.SetBrowserPath">
<short>
Sets the value in the BrowserPath property.
</short>
<seealso>
<link id="THTMLBrowserHelpViewer.BrowserPath"/>
</seealso>
</element>
<element name="THTMLBrowserHelpViewer.SetBrowserPath.AValue">
<short>New value for the property.</short>

39
docs/xml/lcl/lazhelpintf.xml
View File

@ -751,8 +751,11 @@
<element name="THelpDBISourceFile.FBasePathObject" link="#lcl.lazhtmlintf.THelpDBISourceFile.BasePathObject"/>
<element name="THelpDBISourceFile.FFilename" link="#lcl.lazhtmlintf.THelpDBISourceFile.Filename"/>
<element name="THelpDBISourceFile.SetFilename" link="#lcl.lazhtmlintf.THelpDBISourceFile.Filename">
<element name="THelpDBISourceFile.SetFilename">
<short>Sets the value for the Filename property.</short>
<seealso>
<link id="THelpDBISourceFile.Filename"/>
</seealso>
</element>
<element name="THelpDBISourceFile.SetFilename.AValue">
<short>New value for the property.</short>
@ -1480,16 +1483,18 @@
<short>List with class references for each registered help database.</short>
</element>
<element name="THelpDatabases.GetItems" link="#lcl.lazhelpintf.THelpDatabases.Items">
<element name="THelpDatabases.GetItems">
<short>Gets a value in the Items property by its ordinal position.</short>
<descr/>
<seealso/>
<seealso>
<link id="THelpDatabases.Items"/>
</seealso>
</element>
<element name="THelpDatabases.GetItems.Result">
<short/>
<short>Value for the indexed property.</short>
</element>
<element name="THelpDatabases.GetItems.Index">
<short/>
<short>Ordinal position for the indexed property value.</short>
</element>
<element name="THelpDatabases.DoRegisterDatabase">
@ -2147,19 +2152,23 @@
<element name="THelpViewer.FStorageName" link="#lcl.lazhelpintf.THelpViewer.StorageName"/>
<element name="THelpViewer.FSupportedMimeTypes" link="#lcl.lazhelpintf.THelpViewer.SupportedMimeTypes"/>
<element name="THelpViewer.SetAutoRegister" link="#lcl.lazhelpintf.THelpViewer.AutoRegister">
<element name="THelpViewer.SetAutoRegister">
<short>Sets the value in the AutoRegister property.</short>
<descr/>
<seealso/>
<seealso>
<link id="THelpViewer.AutoRegister"/>
</seealso>
</element>
<element name="THelpViewer.SetAutoRegister.AValue">
<short>New value for the property.</short>
</element>
<element name="THelpViewer.SetSupportedMimeTypes" link="#lcl.lazhelpintf.THelpViewer.SupportedMimeTypes">
<element name="THelpViewer.SetSupportedMimeTypes">
<short>Sets the value in the SupportedMimeTypes property.</short>
<descr/>
<seealso/>
<seealso>
<link id="THelpViewer.SupportedMimeTypes"/>
</seealso>
</element>
<element name="THelpViewer.SetSupportedMimeTypes.List">
<short>List with value used in the property.</short>
@ -2507,10 +2516,12 @@
<element name="THelpBasePathObject.FBasePath" link="#lcl.lazhelpintf.THelpBasePathObject.BasePath"/>
<element name="THelpBasePathObject.SetBasePath" link="#lcl.lazhelpintf.THelpBasePathObject.BasePath">
<element name="THelpBasePathObject.SetBasePath">
<short>Sets the value for the BasePath property.</short>
<descr/>
<seealso/>
<seealso>
<link id="THelpBasePathObject.BasePath"/>
</seealso>
</element>
<element name="THelpBasePathObject.SetBasePath.AValue">
<short>New value for the property.</short>
@ -2541,10 +2552,12 @@
<element name="THelpBaseURLObject.FBaseURL" link="#lcl.lazhelpintf.THelpBaseURLObject.BaseURL"/>
<element name="THelpBaseURLObject.SetBaseURL" link="#lcl.lazhelpintf.THelpBaseURLObject.BaseURL">
<element name="THelpBaseURLObject.SetBaseURL">
<short>Sets the value in the BaseURL property.</short>
<descr/>
<seealso/>
<seealso>
<link id="THelpBaseURLObject.BaseURL"/>
</seealso>
</element>
<element name="THelpBaseURLObject.SetBaseURL.AValue">
<short>New value for the property.</short>

8
docs/xml/lcl/lclintf.xml
View File

@ -2315,10 +2315,12 @@ end;
<short/>
</element>
<element name="MonitorFromWindow" link="#lcl.InterfaceBase.MonitorFromWindow">
<short>Finds the monitor covering most of a window.</short>
<element name="MonitorFromWindow">
<short>Finds the monitor which contains most of the specified window.</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.forms.TScreen.MonitorFromWindow"/>
</seealso>
</element>
<element name="MonitorFromWindow.Result">
<short/>

44
docs/xml/lcl/lclrescache.xml
View File

@ -402,21 +402,35 @@
<short/>
</element>
<element name="TResourceCache.Create" link="#rtl.System.TObject.Create">
<short/>
<descr/>
<element name="TResourceCache.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Allocates resources for the internal TAVLTree instances used for items and descriptors in the class instance, and sets the default values for properties.
</p>
</descr>
<seealso/>
</element>
<element name="TResourceCache.Clear">
<short><var>Clear</var> the current Resource Cache.</short>
<descr/>
<short>Clears the current entries in the Resource Cache.</short>
<descr>
<p>
Frees entries in the internal items and descriptors for the resource cache.
</p>
</descr>
<seealso/>
</element>
<element name="TResourceCache.Destroy" link="#rtl.System.TObject.Destroy">
<short/>
<descr/>
<element name="TResourceCache.Destroy">
<short>
Destructor for the class instance.
</short>
<descr>
<p>
Frees resources allocates in the Create constructor, and calls the inherited method prior to exit.
</p>
</descr>
<seealso/>
</element>
@ -529,8 +543,8 @@
<seealso/>
</element>
<element name="TBlockResourceCacheDescriptor.Destroy" link="#rtl.System.TObject.Destroy">
<short/>
<element name="TBlockResourceCacheDescriptor.Destroy">
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -552,9 +566,13 @@
<descr/>
</element>
<element name="TBlockResourceCache.Create" link="#rtl.System.TObject.Create">
<short/>
<descr/>
<element name="TBlockResourceCache.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Allocates resources needed for the cache descriptor. Sets the initial DataSize for the cache. Assign the default compare routine used for the block resources.
</p>
</descr>
<seealso/>
</element>
<element name="TBlockResourceCache.Create.TheDataSize">

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

@ -61,12 +61,14 @@
<element name="TUpdateTranslator.FStackPath"/>
<element name="TUpdateTranslator.IntUpdateTranslation" link="#lcl.lcltranslator.TUpdateTranslator.UpdateTranslation">
<element name="TUpdateTranslator.IntUpdateTranslation">
<short>
Performs action required to update string translations for persistent objects using RTTI.
</short>
<descr></descr>
<seealso></seealso>
<seealso>
<link id="TUpdateTranslator.UpdateTranslation"/>
</seealso>
</element>
<element name="TUpdateTranslator.IntUpdateTranslation.AnInstance">
<short>Persistent object updated in the method.</short>

12
docs/xml/lcl/lresources.xml
View File

@ -93,10 +93,12 @@
<seealso/>
</element>
<!-- variable Visibility: private -->
<element link="#lcl.lresources.TLResourceList.Items" name="TLResourceList.FList">
<element name="TLResourceList.FList">
<short>Member with the list for resource descriptions.</short>
<descr/>
<seealso/>
<seealso>
<link id="TLResourceList.Items"/>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLResourceList.FMergeList">
@ -2564,10 +2566,12 @@
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="LazarusResources" link="#lcl.lresources.TLResourceList">
<element name="LazarusResources">
<short>The list with all of the loaded standard resources.</short>
<descr/>
<seealso/>
<seealso>
<link id="TLResourceList"/>
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="PropertiesToSkip">

31
docs/xml/lcl/menus.xml
View File

@ -1033,8 +1033,10 @@
<seealso/>
</element>
<element name="TMenuItem.Loaded" link="#rtl.classes.TComponent.Loaded">
<short>Performs actions needed after the component is loaded using LCL streaming.</short>
<element name="TMenuItem.Loaded">
<short>
Performs actions needed after the component is loaded using LCL streaming.
</short>
<descr>
<p>
Loaded is overridden in TMenuItem, and calls the inherited method on entry. It calls the <var>ActionChange</var> method if <var>Action</var> has been assigned for the class instance.
@ -1043,17 +1045,20 @@
<seealso>
<link id="TMenuItem.Action"/>
<link id="TMenuItem.ActionChange"/>
<link id="#rtl.classes.TComponent">TComponent</link>
</seealso>
</element>
<element name="TMenuItem.Notification" link="#rtl.classes.TComponent.Notification">
<element name="TMenuItem.Notification">
<short>Performs a notification when the menu item is added or removed.</short>
<descr>
<p>
<var>Notification</var> is an overridden method in <var>TMenuItem</var>, and calls the inherited method on entry. Notification ensures that the class instances in <var>Action</var> and <var>SubMenuImages</var> are set to <b>Nil</b> when the remove <var>Operation</var> is received for either member.
</p>
</descr>
<seealso/>
<seealso>
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
</seealso>
</element>
<element name="TMenuItem.Notification.AComponent">
<short>Component for the notification.</short>
@ -1062,7 +1067,7 @@
<short>Operation for the notification.</short>
</element>
<element name="TMenuItem.GetChildren" link="#rtl.classes.TComponent.GetChildren">
<element name="TMenuItem.GetChildren">
<short>Performs an operation for a component instance and its Items.</short>
<descr>
<p>
@ -1075,7 +1080,9 @@
No actions are performed in the method when Items has not been assigned (contains Nil).
</p>
</descr>
<seealso/>
<seealso>
<link id="#rtl.classes.TComponent">TComponent</link>
</seealso>
</element>
<element name="TMenuItem.GetChildren.Proc">
<short>Object procedure called for the component.</short>
@ -1133,14 +1140,16 @@
<short>New value for the property.</short>
</element>
<element name="TMenuItem.SetChildOrder" link="#rtl.classes.TComponent.SetChildOrder">
<element name="TMenuItem.SetChildOrder">
<short>Moves a menu item to the specified position in a menu.</short>
<descr>
<p>
Stores the value in the Order parameter to the MenuIndex property in the Child menu item.
</p>
</descr>
<seealso/>
<seealso>
<link id="#rtl.classes.TComponent">TComponent</link>
</seealso>
</element>
<element name="TMenuItem.SetChildOrder.Child">
<short>Menu item affected in the method.</short>
@ -1178,7 +1187,7 @@
<short>New value for the property.</short>
</element>
<element name="TMenuItem.SetParentComponent" link="#rtl.classes.TComponent.SetParentComponent">
<element name="TMenuItem.SetParentComponent">
<short>
Ensures that the menu item is parented by the specified menu or menu item.
</short>
@ -1196,7 +1205,9 @@
An <var>Exception</var> is raised if AValue is derived from any class type other than TMenu or TMenuItem. The current class instance is not re-parented when AValue contains <b>Nil</b>.
</p>
</descr>
<seealso/>
<seealso>
<link id="#rtl.classes.TComponent">TComponent</link>
</seealso>
</element>
<element name="TMenuItem.SetParentComponent.AValue">
<short>Menu or menu item used as the parent for the current class instance.</short>

3
docs/xml/lcl/printers.xml
View File

@ -484,7 +484,7 @@
</seealso>
</element>
<element name="TPrinterCanvas.Changing" link="#lcl.graphics.TCanvas.Changing">
<element name="TPrinterCanvas.Changing">
<short>
Signals the OnChanging event when the printer status is changed.
</short>
@ -499,6 +499,7 @@
<seealso>
<link id="TPrinter.Printing"/>
<link id="EPrinter"/>
<link id="#lcl.graphics.TCanvas.Changing">TCanvas.Changing</link>
<link id="#lcl.graphics.TCanvas.OnChanging">TCanvas.OnChanging</link>
</seealso>
</element>

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

@ -85,7 +85,7 @@
<element name="TCustomRubberBand.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<element name="TCustomRubberBand.Create" link="#rtl.Classes.TComponent.Create">
<element name="TCustomRubberBand.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
@ -94,7 +94,7 @@
</descr>
<seealso>
<link id="TCustomRubberBand.Shape"/>
<link id="TRubberBandShape.rsLine"/>
<link id="TRubberBandShape"/>
</seealso>
</element>
<element name="TCustomRubberBand.Create.AOwner">
@ -118,7 +118,7 @@
</seealso>
</element>
<element name="TRubberBand" link="#lcl.rubberband.TCustomRubberBand">
<element name="TRubberBand">
<short>
Implements a rubber-band selection.
</short>

12
docs/xml/lcl/shellctrls.xml
View File

@ -52,7 +52,7 @@
</element>
<element name="TObjectType.otFolders">
<short>
Indicates that folders (directories) should be visible. This include folders which represent virtual objects such as disks devices. Hidden folders are shown only if otHidden is also present.
Indicates that folders (directories) should be visible. This includes folders which represent virtual objects such as disk devices. Hidden folders are shown only if otHidden is also present.
</short>
</element>
<element name="TObjectType.otNonFolders">
@ -1039,8 +1039,10 @@
<short>New value for the property.</short>
</element>
<element name="TCustomShellListView.WSRegisterClass" link="#lcl.controls.TWinControl.WSRegisterClass">
<short/>
<element name="TCustomShellListView.WSRegisterClass">
<short>
Registers an association between the class type and its widgetset class.
</short>
<descr>
<p>
<var>WSRegisterClass</var> is an overridden class method in <var>TCustomShellListView</var>. It registers properties that are ignored in the class instance during LCL component streaming, including:
@ -1054,7 +1056,9 @@
It calls the inherited method, and registers the companion widgetset class instance.
</p>
</descr>
<seealso/>
<seealso>
<link id="#lcl.controls.TWinControl.WSRegisterClass">TWinControl.WSRegisterClass</link>
</seealso>
</element>
<element name="TCustomShellListView.PopulateWithRoot">

19
docs/xml/lcl/stdactns.xml
View File

@ -78,13 +78,15 @@
<element name="StdCtrls"/>
<element name="Clipbrd"/>
<element name="THintAction" link="#lcl.forms.TCustomHintAction">
<element name="THintAction">
<short>
<var>THintAction </var>- standard action for dealing with requests
for a <var>Hint</var>.
</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.forms.TCustomHintAction">TCustomHintAction</link>
</seealso>
</element>
<element name="TEditAction">
@ -942,7 +944,7 @@
<short>Value for the property.</short>
</element>
<element name="TFileOpen.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
<element name="TFileOpen.GetDialogClass">
<short>
Gets the class reference used to create the Dialog for the action.
</short>
@ -950,6 +952,7 @@
<seealso>
<link id="TFileOpen.Dialog"/>
<link id="TCommonDialogClass"/>
<link id="TCommonDialogAction.GetDialogClass"/>
</seealso>
</element>
<element name="TFileOpen.GetDialogClass.Result">
@ -1297,14 +1300,18 @@
<element name="TSearchFind.GetFindDialog"/>
<element name="TSearchFind.GetFindDialog.Result"/>
<element name="TSearchFind.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
<short/>
<element name="TSearchFind.GetDialogClass">
<short>
Gets the dialog class type.
</short>
<descr>
<p>
Returns the <var>TFindDialog</var> class type in <var>TSearchFind</var>.
</p>
</descr>
<seealso/>
<seealso>
<link id="TCommonDialogAction.GetDialogClass"/>
</seealso>
</element>
<element name="TSearchFind.GetDialogClass.Result">
<short>Returns TFindDialog for the action.</short>

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

@ -3487,10 +3487,16 @@
<short>Message handled in the method.</short>
</element>
<element name="TCustomListBox.WMLButtonUp" link="#lcl.controls.TControl.WMLButtonUp">
<element name="TCustomListBox.WMLButtonUp">
<short>
Prevents Click from being called twice when using ClickOnSelChange to trigger a click event.
Handles Left mouse button Up events for the control.
</short>
<descr>
Prevents Click from being called twice when using ClickOnSelChange to trigger a click event.
</descr>
<seealso>
<link id="#lcl.controls.TControl.WMLButtonUp">TControl.WMLButtonUp</link>
</seealso>
</element>
<element name="TCustomListBox.WMLButtonUp.Message">
<short>Message handled in the method.</short>
@ -3565,19 +3571,40 @@
</element>
<element name="TCustomListBox.BeforeDragStart">
<short>Calls BeginDrag.</short>
<descr/>
<seealso/>
<short>
Notifies the widgetset class that a Drag operation is starting.
</short>
<descr>
<p>
<var>BeforeDragStart</var> is an overridden method in <var>TCustomListBox</var> used to perform actions needed to start a drag operation for the control. In TCustomListBox, this means that the DragStart method in the widgetset class is called. No actions are performed in the method if the Handle has not been allocated for the control.
</p>
<p>
BeforeDragStart is called when mouse up, down, and move messages are handled by the DragManager for an application.
</p>
</descr>
<seealso>
<link id="TControl.BeforeDragStart"/>
</seealso>
</element>
<element name="TCustomListBox.BeginAutoDrag" link="#lcl.controls.TControl.BeginAutoDrag">
<short>Calls BeginDrag.</short>
<descr/>
<seealso/>
<element name="TCustomListBox.BeginAutoDrag">
<short>
Starts a non-immediate drag / dock operation for the control.
</short>
<descr>
<p>
Calls the inherited <var>BeginDrag</var> method with the <var>Immediate</var> argument set to <b>False</b>. The drag operation is detected and handled by the DragManager for the application.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.BeginAutoDrag">TControl.BeginAutoDrag</link>
</seealso>
</element>
<element name="TCustomListBox.CalculateStandardItemHeight">
<short>Determine the standard Height of the items, when no widget has yet been created.</short>
<short>
Determines the standard Height of the items, when no widget has yet been created.
</short>
</element>
<element name="TCustomListBox.CalculateStandardItemHeight.Result">
<short>Height for the items in the control.</short>
@ -3587,8 +3614,8 @@
<short>Sends the design-time value for ItemIndex to the widgetset class.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TWinControl.Loaded"/>
<link id="#rtl.classes.TComponent.Loaded">TComponent.Loaded</link>
<link id="#LCL.Controls.TWinControl.Loaded"/>
</seealso>
</element>
@ -3799,10 +3826,12 @@
<short>New value for the property.</short>
</element>
<element name="TCustomListBox.SetItems" link="#lcl.stdctrls.TCustomListBox.Items">
<element name="TCustomListBox.SetItems">
<short>Sets the value for the Items property.</short>
<descr/>
<seealso/>
<seealso>
<link id="TCustomListBox.Items"/>
</seealso>
</element>
<element name="TCustomListBox.SetItems.Value">
<short>New value for the property.</short>
@ -9163,7 +9192,7 @@ end;
<element name="TRadioButton.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TRadioButton.ApplyChanges" link="#lcl.stdctrls.TCustomCheckBox.ApplyChanges">
<element name="TRadioButton.ApplyChanges">
<short>Updates the state for sibling radio buttons in the parent.</short>
<descr>
<p>