mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-08 01:56:12 +02:00
Docs: Batch of documentation updates for LazUtils and LCL. Issue #36312, patch from Don Siders.
git-svn-id: trunk@62238 -
This commit is contained in:
juha
parent
4f009ea169
commit
35efd71284
@ -2175,6 +2175,22 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="UTF8GetStandardCodePage">
|
||||
<short>Gets the default system code page for the wide string manager</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UTF8GetStandardCodePage</var> is a <var>TSystemCodePage</var> function used to get the default code page for strings in the Wide String manager. UTF8GetStandardCodePage is implemented for Windows platforms that use a UTF-8-enabled Runtime Library (RTL). It is assigned as the procedure used by the wide string manager for the platform.
|
||||
</p>
|
||||
<p>
|
||||
<var>stdcp</var> contains the <var>TStandardCodePageEnum</var> enumeration value that identifies the default code page for the platform.
|
||||
</p>
|
||||
<p>
|
||||
The return value contains CP_UTF8 constant.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
<!-- LazUTF8 -->
|
||||
</package>
|
||||
|
||||
@ -3201,7 +3201,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>RestoreEditor</var> is a procedure used to re-enable the editor control in the grid after processing scrollbar messages. RestoreEditor is used when EditorMode contains True. No actions are performed in the method when EditorMode contains False. RestoreEditor toggles the value in EditorMode to force the editor for the SelectCell to be refreshed and redrawn.
|
||||
<var>RestoreEditor</var> is a procedure used to re-enable the editor control in the grid after processing scrollbar messages. RestoreEditor is used when EditorMode contains True. No actions are performed in the method when EditorMode contains False. RestoreEditor toggles the value in EditorMode to force the editor to be refreshed and redrawn.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -4095,31 +4095,6 @@
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- function visibility: protected -->
|
||||
<element name="TCustomDBGrid.SelectCell">
|
||||
<short>
|
||||
Indicates if the cell at the specified coordinates can be selected in the control
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SelectCell</var> is an overridden Boolean function that indicates if the cell at the specified coordinates can be selected in the control. SelectCell uses ColWidths and RowHeights to determine if the cell can be visually selected. The return value is True when both contain positive non-zero values.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<!-- function result visibility: default -->
|
||||
<element name="TCustomDBGrid.SelectCell.Result">
|
||||
<short>True when the cell can be selected</short>
|
||||
</element>
|
||||
<!-- argument visibility: default -->
|
||||
<element name="TCustomDBGrid.SelectCell.aCol">
|
||||
<short>Column for the cell</short>
|
||||
</element>
|
||||
<!-- argument visibility: default -->
|
||||
<element name="TCustomDBGrid.SelectCell.aRow">
|
||||
<short>Row for the cell</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure visibility: protected -->
|
||||
<element name="TCustomDBGrid.UpdateActive">
|
||||
<short>
|
||||
|
||||
@ -9,144 +9,42 @@
|
||||
<module name="Forms">
|
||||
<short>Contains definitions and descriptions for constructing the Forms which are the basis of the Lazarus Graphical User Interface</short>
|
||||
<descr/>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Classes">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="SysUtils">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="TypInfo">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Math">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="AvgLvlTree">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Maps">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLStrConsts">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLType">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLProc">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLIntf">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="InterfaceBase">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LResources">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="GraphType">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Graphics">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Menus">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LMessages">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="CustomTimer">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="ActnList">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="ClipBrd">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="CustApp">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="HelpIntfs">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLClasses">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Controls">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- unresolved type references Visibility: default -->
|
||||
<element name="Classes"/>
|
||||
<element name="SysUtils"/>
|
||||
<element name="Types"/>
|
||||
<element name="TypInfo"/>
|
||||
<element name="Math"/>
|
||||
<element name="CustApp"/>
|
||||
<element name="LCLStrConsts"/>
|
||||
<element name="LCLTypes"/>
|
||||
<element name="LCLProc"/>
|
||||
<element name="LCLIntf"/>
|
||||
<element name="LCLVersion"/>
|
||||
<element name="LCLClasses"/>
|
||||
<element name="InterfaceBase"/>
|
||||
<element name="LResources"/>
|
||||
<element name="GraphType"/>
|
||||
<element name="Graphics"/>
|
||||
<element name="Menus"/>
|
||||
<element name="LMessages"/>
|
||||
<element name="CustomTimer"/>
|
||||
<element name="ActnList"/>
|
||||
<element name="ClipBrd"/>
|
||||
<element name="HelpIntfs"/>
|
||||
<element name="Controls"/>
|
||||
<element name="ImgList"/>
|
||||
<element name="Themes"/>
|
||||
<element name="LazFileUtils"/>
|
||||
<element name="LazUTF8"/>
|
||||
<element name="Maps"/>
|
||||
<element name="IntegerList"/>
|
||||
<element name="LazMethodList"/>
|
||||
<element name="LazLoggerBase"/>
|
||||
<element name="LazUtilities"/>
|
||||
<element name="UITypes"/>
|
||||
|
||||
<!-- procedure type Visibility: default -->
|
||||
<element name="TProcedure">
|
||||
<short>The type of a procedure that takes no arguments.</short>
|
||||
@ -1607,7 +1505,7 @@
|
||||
<element name="TShortCutEvent.Handled">
|
||||
<short>Set Handled to True to prevent further processing of the key.</short>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomForm">
|
||||
<short>The base type for <var>TForm</var>.
|
||||
</short>
|
||||
@ -1728,6 +1626,13 @@
|
||||
<notes><note>?</note>
|
||||
</notes>
|
||||
</element>
|
||||
|
||||
<element name="TCustomForm.FDelayedEventCtr"/>
|
||||
<element name="TCustomForm.FDelayedWMMove"/>
|
||||
<element name="TCustomForm.FDelayedWMSize"/>
|
||||
<element name="TCustomForm.FIsFirstOnShow"/>
|
||||
<element name="TCustomForm.FIsFirstOnActivate"/>
|
||||
|
||||
<element name="TCustomForm.FWindowState" link="TCustomForm.WindowState"/>
|
||||
<!-- function Visibility: private -->
|
||||
<element name="TCustomForm.GetClientHandle" link="TCustomForm.ClientHandle"/>
|
||||
@ -1824,6 +1729,16 @@
|
||||
<element name="TCustomForm.IsKeyPreviewStored.Result">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomForm.DelayedEvent">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomForm.DelayedEvent.Data">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: private -->
|
||||
<element name="TCustomForm.SetActive" link="TCustomForm.Active"/>
|
||||
<element name="TCustomForm.SetActive.AValue">
|
||||
@ -2568,8 +2483,7 @@
|
||||
<element name="TCustomForm.VisibleIsStored.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TCustomForm.DoSendBoundsToInterface" link="#LCL.Controls.TWinControl.DoSendBoundsToInterface"/>
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TCustomForm.DoAutoSize" link="#LCL.Controls.TControl.DoAutoSize"/>
|
||||
<!-- procedure Visibility: protected -->
|
||||
@ -2990,6 +2904,7 @@
|
||||
<notes><note>?</note>
|
||||
</notes>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomForm.SetRestoredBounds">
|
||||
<short>Sets the bounds defining the restored control.</short>
|
||||
@ -3010,6 +2925,10 @@
|
||||
<element name="TCustomForm.SetRestoredBounds.AHeight">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TCustomForm.SetRestoredBounds.ADefaultPosition">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomForm.Show" link="#LCL.Controls.TControl.Show"/>
|
||||
<!-- function Visibility: public -->
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -497,21 +497,6 @@
|
||||
<element name="TLazDockPages.SetActiveNotebookPageComponent.AValue">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TLazDockPages.Create">
|
||||
<short>
|
||||
<var>Create</var> - constructor for <var>TLazDockPages</var>: sets <var>PageClass</var> as <var>TLazDockPage</var>, then calls inherited <var>Create</var>
|
||||
</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso>
|
||||
<link id="#LCL.ComCtrls.TCustomTabControl.Create">TCustomTabControl.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TLazDockPages.Create.TheOwner">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazDockPages.Page">
|
||||
<short>
|
||||
@ -715,6 +700,18 @@
|
||||
<link id="#LCL.Controls.TControl.GetFloatingDockSiteClass">TControl.GetFloatingDockSiteClass</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TLazDockPages.GetPageClass">
|
||||
<short>
|
||||
Gets the TLazDockPage class type used as the page class for the tabbed control
|
||||
</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TLazDockPages.GetPageClass.Result">
|
||||
<short>TLazDockPage class type used for the page class</short>
|
||||
</element>
|
||||
|
||||
<element name="TLazDockPages.Change">
|
||||
<short>
|
||||
<var>Change</var> - calls inherited method, then ensures that all parents recognize MainControl</short>
|
||||
@ -875,7 +872,7 @@ initializes splitter size, title height and width</short>
|
||||
|
||||
The created gap will be tried to fill up.
|
||||
It removes TLazDockSplitter, TLazDockPage and TLazDockPages if they are no
|
||||
longer needed.
|
||||
longer needed.
|
||||
|
||||
Examples:
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -9,54 +9,17 @@
|
||||
<module name="Spin">
|
||||
<short>This unit contains classes for spin edit controls.</short>
|
||||
<descr/>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Classes">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Controls">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="SysUtils">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLType">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLProc">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LMessages">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="ClipBrd">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="StdCtrls">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- unresolved type references Visibility: default -->
|
||||
<element name="Types"/>
|
||||
<element name="Classes"/>
|
||||
<element name="Controls"/>
|
||||
<element name="SysUtils"/>
|
||||
<element name="LCLType"/>
|
||||
<element name="LCLType"/>
|
||||
<element name="StdCtrls"/>
|
||||
<element name="Math"/>
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomFloatSpinEdit">
|
||||
<short>The base class for the float-based spin control</short>
|
||||
@ -555,6 +518,19 @@
|
||||
<element name="TCustomSpinEdit.Create.TheOwner">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomSpinEdit.GetLimitedValue">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomSpinEdit.GetLimitedValue.Result">
|
||||
<short></short>
|
||||
</element>
|
||||
<element name="TCustomSpinEdit.GetLimitedValue.AValue">
|
||||
<short></short>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomSpinEdit.Value">
|
||||
<short>The value of spin control.</short>
|
||||
|
||||
@ -1230,6 +1230,18 @@
|
||||
<short>New values for the property</short>
|
||||
</element>
|
||||
|
||||
<element name="TValueListEditor.UpdateTitleCaptions">
|
||||
<short>Updates TitleCaptions with the specified key and value captions</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TValueListEditor.UpdateTitleCaptions.KeyCap">
|
||||
<short>Caption used for the Key column</short>
|
||||
</element>
|
||||
<element name="TValueListEditor.UpdateTitleCaptions.ValCap">
|
||||
<short>Caption used for the Value column</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TValueListEditor.WSRegisterClass">
|
||||
<short>Registers the class type for the widget set</short>
|
||||
@ -1543,6 +1555,20 @@
|
||||
<short>Shift state value</short>
|
||||
</element>
|
||||
|
||||
<element name="TValueListEditor.LoadContent">
|
||||
<short>
|
||||
Loads configuration and content for the control from the specified XML configuration file
|
||||
</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TValueListEditor.LoadContent.Cfg">
|
||||
<short>XML configuration file with values loaded in the method</short>
|
||||
</element>
|
||||
<element name="TValueListEditor.LoadContent.Version">
|
||||
<short>Control vrsion for the stored content</short>
|
||||
</element>
|
||||
|
||||
<element name="TValueListEditor.ResetDefaultColWidths">
|
||||
<short>
|
||||
Resets columns to their default widths
|
||||
@ -1568,6 +1594,17 @@
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TValueListEditor.SaveContent">
|
||||
<short>
|
||||
Saves the configuration and content in the control to the specified XML configuration file
|
||||
</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TValueListEditor.SaveContent.Cfg">
|
||||
<short>XML configuration file where values are stored in the method</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TValueListEditor.SetCells" link="#lcl.Grids.TCustomStringGrid.SetCells">
|
||||
<short>
|
||||
@ -2015,6 +2052,35 @@
|
||||
<short>True if the specified row has empty key name and value cells</short>
|
||||
</element>
|
||||
|
||||
<element name="TValueListEditor.LoadFromCSVStream">
|
||||
<short>
|
||||
Loads the content for the control from the comma-separated values in the specified stream
|
||||
</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TValueListEditor.LoadFromCSVStream.AStream">
|
||||
<short>TStream instance with the values loaded in the method</short>
|
||||
</element>
|
||||
<element name="TValueListEditor.LoadFromCSVStream.ADelimiter">
|
||||
<short>Delimiter between cell values; default is Comma (',')</short>
|
||||
</element>
|
||||
<element name="TValueListEditor.LoadFromCSVStream.UseTitles">
|
||||
<short>
|
||||
Indicates whether title captions included as the first row in the CSV data
|
||||
</short>
|
||||
</element>
|
||||
<element name="TValueListEditor.LoadFromCSVStream.FromLine">
|
||||
<short>
|
||||
Initial line number in the stream loaded in the method
|
||||
</short>
|
||||
</element>
|
||||
<element name="TValueListEditor.LoadFromCSVStream.SkipEmptyLines">
|
||||
<short>
|
||||
Indicates whether empty lines are ignored when loading the content for the control
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TValueListEditor.MoveColRow">
|
||||
<short>
|
||||
Moves the specified column or row to the new position
|
||||
@ -2854,6 +2920,26 @@
|
||||
Exception message for an invalid row or column operation
|
||||
</short>
|
||||
</element>
|
||||
<element name="rsVLENoRowCountFound">
|
||||
<short>
|
||||
Error message displayed when a row count is not found when loading content in TValueListEditor
|
||||
</short>
|
||||
</element>
|
||||
<element name="rsVLERowIndexOutOfBounds">
|
||||
<short>
|
||||
Error message displayed when an invalid row number is found when loading content in TValueListEditor
|
||||
</short>
|
||||
</element>
|
||||
<element name="rsVLEColIndexOutOfBounds">
|
||||
<short>
|
||||
Error message displayed when an invalid column number is found when loading content in TValueListEditor
|
||||
</short>
|
||||
</element>
|
||||
<element name="rsVLEIllegalColCount">
|
||||
<short>
|
||||
Error message displayed when an invalid column count is found when loading content in TValueListEditor; column count is always 2 in TValueListEditor
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="Register">
|
||||
|
||||
Loading…
Reference in New Issue
Block a user