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

Docs: LCL, LazUtils. Adds missing topics or content.

Browse Source
This commit is contained in:
dsiders 2021-09-03 16:47:09 +01:00
parent 573f49ef02
commit 2473e77422
4 changed files with 158 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/xml/lazutils/graphtype.xml
View File

@ -28,9 +28,11 @@
<element name="LazLoggerBase"/>
<element name="TGraphicsColor">
<short/>
<short>Defines the Integer range type with values that can be used for colors.</short>
<descr/>
<seealso/>
<seealso>
<link id="#lcl.graphics.TColor">TColor</link>
</seealso>
</element>
<element name="TGraphicsFillStyle">
@ -46,25 +48,27 @@
</element>
<element name="TGraphicsBevelCut">
<short/>
<short>Represents bevel drawing styles.</short>
<descr/>
<seealso/>
</element>
<element name="TGraphicsBevelCut.bvNone">
<short/>
<short>The bevel is not drawn.</short>
</element>
<element name="TGraphicsBevelCut.bvLowered">
<short/>
<short>The bevel is drawn with a lowered or inset appearance.</short>
</element>
<element name="TGraphicsBevelCut.bvRaised">
<short/>
<short>The bevel is drawn with a raised or outset appearance.</short>
</element>
<element name="TGraphicsBevelCut.bvSpace">
<short/>
<short>
The bevel is drawn as a space using the required width, netiher inset nor outset.
</short>
</element>
<element name="TGraphicsDrawEffect">
<short/>
<short>Represents drawing effects which can be applied to graphic elements.</short>
<descr/>
<seealso/>
</element>
@ -1144,7 +1148,9 @@
</element>
<element name="MissingBits">
<short/>
<short>
Used to pad bit data in a raw image to specific precisions and byte boundaries.
</short>
<descr>
Used to pad bit data in a raw image to specific precisions and byte boundaries.
</descr>

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

@ -15722,7 +15722,7 @@ if MyControl.CanSetFocus then
</seealso>
</element>
<element link="#lcl.controls.TWinControl.BorderStyle" name="TCustomControl.BorderStyle"/>
<element name="TCustomControl.BorderStyle" link="#lcl.controls.TWinControl.BorderStyle"/>
<element name="TCustomControl.OnPaint">
<short>
@ -16073,7 +16073,7 @@ if MyControl.CanSetFocus then
</element>
<element name="TDockZone.Top">
<short>The top coordinate of this zone.</short>
<short>The top coordinate for the dock zone.</short>
<descr/>
<seealso/>
</element>
@ -16123,26 +16123,33 @@ if MyControl.CanSetFocus then
</element>
<element name="TForEachZoneProc">
<short>The type of an ForEachZone callback procedure, currently unused.
<short>The type for a ForEachZone callback procedure, currently unused.
</short>
<descr/>
<seealso/>
</element>
<element name="TForEachZoneProc.Zone">
<short>The iterated zone.
</short>
<short>The iterated zone.</short>
</element>
<element name="TDockTreeFlag">
<short/>
<short>Represents flag values used in TDockTree.</short>
<descr/>
<seealso/>
<seealso>
<link id="TDockTree"/>
</seealso>
</element>
<element name="TDockTreeFlag.dtfUpdateAllNeeded">
<short/>
</element>
<element link="#lcl.controls.TDockTreeFlag" name="TDockTreeFlags"/>
<element name="TDockTreeFlags">
<short>Set type used to store values from the TDockTreeFlag enumeration.</short>
<descr/>
<seealso>
<link id="TDockTreeFlag"/>
</seealso>
</element>
<element name="TDockTree">
<short>A docking manager for tree-style layouts.</short>
@ -16552,9 +16559,15 @@ if MyControl.CanSetFocus then
<element name="TDockTree.MouseMessage" link="#lcl.controls.TDockManager.MouseMessage"/>
<element name="DockSplitterClass">
<short/>
<descr/>
<seealso/>
<short>Class type used to create new splitter class instances.</short>
<descr>
<p>
Normally contains a reference to the <var>TSplitter</var> class, as assigned in the initialization section for the <file>extctrls.pp</file> unit.
</p>
</descr>
<seealso>
<link id="#lcl.extctrls.TSplitter">TSplitter</link>
</seealso>
</element>
<element name="TMouse">

26
docs/xml/lcl/dbactns.xml
View File

@ -18,7 +18,7 @@
This file is part of the Lazarus Component Library (<b>LCL</b>).
</p>
<p>
The following components are registered but not diplayed on the Lazarus IDE component palette:
The following components are registered but not displayed on the Lazarus IDE component palette:
</p>
<ul>
<li>TDataSetFirst</li>
@ -706,6 +706,30 @@
<element name="TDataSetPost.DataSource" link="#lcl.dbactns.TDataSetAction.DataSource"/>
<element name="Register">
<short>
Registers components for use in the Lazarus IDE.
</short>
<descr>
<p>
The following components are registered but not displayed on the Lazarus IDE component palette:
</p>
<ul>
<li>TDataSetFirst</li>
<li>TDataSetLast</li>
<li>TDataSetNext</li>
<li>TDataSetPrior</li>
<li>TDataSetRefresh</li>
<li>TDataSetCancel</li>
<li>TDataSetDelete</li>
<li>TDataSetEdit</li>
<li>TDataSetInsert</li>
<li>TDataSetPost</li>
</ul>
</descr>
<seealso/>
</element>
</module>
<!-- DBActns -->
</package>

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

@ -217,7 +217,7 @@
</element>
<element name="TCDWSEventCapability">
<short/>
<short>Represents events handled in a custom-drawn widgetset.</short>
<descr/>
<seealso/>
</element>
@ -235,7 +235,7 @@
</element>
<element name="TCDWSEventCapabilities">
<short/>
<short>Set type used to store values from the TCDWSEventCapability enumeration.</short>
<descr/>
<seealso/>
</element>
@ -4009,24 +4009,26 @@ end;
</element>
<element name="CreateMessageDialog">
<short/>
<short>
Creates a dialog form type with the specified caption, message, and buttons.
</short>
<descr/>
<seealso/>
</element>
<element name="CreateMessageDialog.Result">
<short/>
<short>TForm instance with the content representing the specified parameters.</short>
</element>
<element name="CreateMessageDialog.AMsg">
<short/>
<short>Message text for the dialog.</short>
</element>
<element name="CreateMessageDialog.ACaption">
<short/>
<short>Caption displayed as the title for the dialog.</short>
</element>
<element name="CreateMessageDialog.DlgType">
<short/>
<short>Identifies the dialog type and the image for the dialog.</short>
</element>
<element name="CreateMessageDialog.Buttons">
<short/>
<short>Set of TMsgDlgBtn buttons displayed on the dialog.</short>
</element>
<element name="DefaultPromptDialog">
@ -4155,6 +4157,57 @@ end;
<short/>
</element>
<element name="DefaultQuestionDialog">
<short>Implements a widgetset-independent dialog.</short>
<descr>
<p>
Shows a dialog with aCaption as Title, aMsg as Text, DlgType as Icon,
HelpCtx as Help context and Buttons to define the shown buttons and their
TModalResult.
</p>
<p>
Buttons is a list of TModalResult and strings. For each number a button is
created. To set a custom caption, add a string after a button.
</p>
<p>
The default TModalResults defined in controls.pp (mrNone..mrLast) does not need
a caption. The default captions will be used.
</p>
<p>
Examples for Buttons:
</p>
<code>[mrOk,mrCancel,'Cancel now',mrIgnore,300,'Do it','IsDefault']</code>
<p>
This will result in 4 buttons:
</p>
<ul>
<li>'Ok' returning mrOk</li>
<li>'Cancel now' returning mrCancel</li>
<li>'Ignore' returning mrIgnore</li>
<li>'Do it' returning 300. This will be the default button (focused)</li>
</ul>
</descr>
<seealso/>
</element>
<element name="DefaultQuestionDialog.Result">
<short/>
</element>
<element name="DefaultQuestionDialog.ACaption">
<short/>
</element>
<element name="DefaultQuestionDialog.AMsg">
<short/>
</element>
<element name="DefaultQuestionDialog.DlgType">
<short/>
</element>
<element name="DefaultQuestionDialog.Buttons">
<short/>
</element>
<element name="DefaultQuestionDialog.HelpCtx">
<short/>
</element>
<element name="ShowMessage">
<short>Displays the specified message text.</short>
<descr>
@ -4310,7 +4363,9 @@ end;
</element>
<element name="RegisterDialogForCopyToClipboard">
<short/>
<short>
Registers the method and data used for TCustomCopyToClipboardDialog instances.
</short>
<descr/>
<seealso/>
</element>
@ -4319,21 +4374,25 @@ end;
</element>
<element name="DialogCopyToClipboard">
<short/>
<descr/>
<short>Copies the content from the specified dialog to the clipboard.</short>
<descr>
<p>
Content from the dialog is stored as text in the clipboard. No actions are performed in the routine if Key and Shift contain values for keys other than Ctrl+C or Ctrl+Ins. The clipboard will contain lines with the Caption and Message text for the dialog, as well as the captions (sans accelerator keys) for controls displayed on the dialog.
</p>
</descr>
<seealso/>
</element>
<element name="DialogCopyToClipboard.Self">
<short/>
<short>Dialog form instance examined in the routine.</short>
</element>
<element name="DialogCopyToClipboard.Sender">
<short/>
<short>Not used in the routine.</short>
</element>
<element name="DialogCopyToClipboard.Key">
<short/>
<short>Virtual key code which initiated the operation.</short>
</element>
<element name="DialogCopyToClipboard.Shift">
<short/>
<short>Shift, Ctrl, or Alt modifier for the key code.</short>
</element>
<element name="cInputQueryEditSizePixels">
@ -4370,6 +4429,23 @@ end;
<short>Set type for directory selection options.</short>
</element>
<element name="TInputCloseQueryEvent">
<short>
Specifies an event handler signalled when an InputQuery dialog is about to close.
</short>
<descr/>
<seealso/>
</element>
<element name="TInputCloseQueryEvent.Sender">
<short/>
</element>
<element name="TInputCloseQueryEvent.AValues">
<short/>
</element>
<element name="TInputCloseQueryEvent.ACanClose">
<short/>
</element>
<element name="SelectDirectory">
<short>A function that allows a user to select a directory.</short>
<descr>
@ -4625,7 +4701,9 @@ end;
</element>
<element name="dbgs">
<short/>
<short>
Creates a formatted debugger message for one or more TOpenOption values.
</short>
<descr/>
<seealso/>
</element>