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

Docs: LCL/various. Fixes XML tagging with extra or missing space characters.

Browse Source
This commit is contained in:
dsiders 2022-04-09 19:14:21 +01:00
parent 34143c995e
commit ac840480e1
5 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1608,7 +1608,7 @@
</short>
<descr>
<p>
<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:
<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>

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

@ -1039,7 +1039,7 @@
</short>
<descr>
<p>
<var>SimplePanel </var> is a Boolean property which indicates if a single panel is displayed in the status bar with the text in SimpleText
<var>SimplePanel</var> is a Boolean property which indicates if a single panel is displayed in the status bar with the text in SimpleText
</p>
<p>
If <b>True</b>, the value of <var>SimpleText</var> is displayed; if <b>False</b>, the contents of the individual <var>Panels</var> is displayed.
@ -4896,7 +4896,7 @@
<var>TTabControl</var> - a series of <var>Tabs</var> along the edge of a display area; selection of a <var>Tab</var> governs the contents of the <var>DisplayRect</var>
</p>
<p>
Use <var>TTabControl </var>by selecting its icon from the Common Controls tab of the IDE Component Palette and placing it at the desired location on the <var>Form</var>. Use the Form Designer and Object Inspector to adjust its shape, size, alignment, anchoring and other properties. Tabs can be added or removed from the component by selecting it, then right-clicking with the mouse to get a pop-up menu whose first item is 'Add Tab'. Once created, the Tabs can be edited by selecting the <var>Tabs</var> entry in the Object Inspector and selecting the ellipsis (...) which will cause a pop-up String editor to appear. The tabs can be given new captions, moved up and down the list or removed altogether as required.
Use <var>TTabControl</var>by selecting its icon from the Common Controls tab of the IDE Component Palette and placing it at the desired location on the <var>Form</var>. Use the Form Designer and Object Inspector to adjust its shape, size, alignment, anchoring and other properties. Tabs can be added or removed from the component by selecting it, then right-clicking with the mouse to get a pop-up menu whose first item is 'Add Tab'. Once created, the Tabs can be edited by selecting the <var>Tabs</var> entry in the Object Inspector and selecting the ellipsis (...) which will cause a pop-up String editor to appear. The tabs can be given new captions, moved up and down the list or removed altogether as required.
</p>
<p>
Each Tab has an Index (starting from 0) and this index can be used to specify an entry from <var>Images</var> for display in the <var>DisplayRect</var>.
@ -11950,11 +11950,11 @@
<element name="TListView">
<short>
<var>TListView </var> - a window showing a list of <var>Items</var> which may or may not have associated icons.
<var>TListView</var> - a window showing a list of <var>Items</var> which may or may not have associated icons.
</short>
<descr>
<p>
<var>TListView </var>- a window showing a list of items which may or may not have associated icons.
<var>TListView</var>- a window showing a list of items which may or may not have associated icons.
</p>
<p>
At first this control looks very like <link id="#lcl.stdctrls.TListBox">TListBox</link> but it has a much higher degree of complexity. It is capable of displaying Items in <var>Columns</var> of <var>Rows</var> and it can have images associated with the list <var>Items</var>.
@ -14438,7 +14438,7 @@
<element name="TToolButton.Index">
<short>
<var>Index </var>- is the sequence number for the button in ButtonList.
<var>Index</var>- is the sequence number for the button in ButtonList.
</short>
<descr>
<p>
@ -15673,7 +15673,7 @@ AToolbar.ButtonHeight := 30;
<short>List with images displayed when a tool button is not enabled.</short>
<descr>
<p>
<var>DisabledImages </var> is a <var>TCustomImageList</var> property with icon images displayed on tool buttons when they are not Enabled. Use <var>Images</var> for the images displayed when the tool button are enabled but not hovered. Use <var>HotImages</var> for the images displayed when tool buttons are hovered under the mouse cursor.
<var>DisabledImages</var> is a <var>TCustomImageList</var> property with icon images displayed on tool buttons when they are not Enabled. Use <var>Images</var> for the images displayed when the tool button are enabled but not hovered. Use <var>HotImages</var> for the images displayed when tool buttons are hovered under the mouse cursor.
</p>
<p>
The image position for a tool button is stored in the ImageIndex property in the TToolButton instance.This requires the image at a given position in the image lists to target the same button on the tool bar control.
@ -17647,7 +17647,7 @@ AToolbar.ButtonHeight := 30;
<short>Drawing style used for a grabber or gripper displayed on the control.</short>
<descr>
<p>
<var>GrabStyle</var> is a <var>TGrabStyle </var>property with the drawing style used for a grabber or gripper displayed for the control. The default value for the property is defined in the <var>cDefGrabStyle</var> constant.
<var>GrabStyle</var> is a <var>TGrabStyle</var>property with the drawing style used for a grabber or gripper displayed for the control. The default value for the property is defined in the <var>cDefGrabStyle</var> constant.
</p>
</descr>
<seealso/>
@ -18272,7 +18272,7 @@ AToolbar.ButtonHeight := 30;
</short>
<descr>
<p>
<var>Tickmarks </var> indicates where the ticks appear relative to the slider in the track bar control.
<var>Tickmarks</var> indicates where the ticks appear relative to the slider in the track bar control.
</p>
<dl>
<dt>tmBottomRight</dt>
@ -19597,7 +19597,7 @@ AToolbar.ButtonHeight := 30;
<element name="TTreeNode.DisplayRect">
<short>
<var>DisplayRect</var> - returns the coordinates of the rectangle containing the current entry; if <var>TextOnly </var>is True, returns the coordinates for the text.
<var>DisplayRect</var> - returns the coordinates of the rectangle containing the current entry; if <var>TextOnly</var>is True, returns the coordinates for the text.
</short>
<descr/>
<seealso/>
@ -26149,7 +26149,7 @@ OldExpanded.Free;
<element name="THeaderSection.Width">
<short>
The <var>Width </var>of the section that appears on the <var>THeaderControl</var>.
The <var>Width</var>of the section that appears on the <var>THeaderControl</var>.
</short>
</element>
@ -26643,7 +26643,7 @@ OldExpanded.Free;
<element name="TCustomHeaderControl.SectionDrag">
<short>
<var>SectionDrag</var> - method to emulate the <var>OnSectionDrag </var>event.
<var>SectionDrag</var> - method to emulate the <var>OnSectionDrag</var>event.
</short>
<descr/>
<seealso/>

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

@ -11022,7 +11022,7 @@
<var>IsParentOf</var> is a <var>Boolean</var> function used to determine if the current control instance is ultimately a parent of the control specified in AControl. No actions are performed in the method when AControl has not been assigned (<b>Nil</b>), and the return value is set to <b>False</b>.
</p>
<p>
IsParentOf visits each control in the Parent control hierarchy, and returns <b>True </b> if the current class instance (Self) is found in the tree. The return value is <b>False</b> if the current control instance is not found in the Parent control tree.
IsParentOf visits each control in the Parent control hierarchy, and returns <b>True</b> if the current class instance (Self) is found in the tree. The return value is <b>False</b> if the current control instance is not found in the Parent control tree.
</p>
</descr>
<seealso>
@ -20578,7 +20578,7 @@ BoundsRect.Left:=3; // WRONG: common newbie mistake
<p>
<b>procedure SetClientHeight(Value: Integer);</b> <br/>
<b>procedure SetClientSize(Value: TPoint);</b> <br/>
<b>procedure SetClientWidth(Value: Integer); </b>
<b>procedure SetClientWidth(Value: Integer);</b>
</p>
<p>
Exists for Delphi compatibility too. Resizes the control, to get the wanted ClientRect size.

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

@ -2035,7 +2035,7 @@
<element name="TColumn.Field">
<short>
<var>Field </var> in the <var>Dataset</var> associated with this <var>Column</var>.
<var>Field</var> in the <var>Dataset</var> associated with this <var>Column</var>.
</short>
<descr>
<p>
@ -2371,7 +2371,7 @@
<element name="TCustomDBGrid">
<short>
<var>TCustomDBGrid </var> is the base class for <var>TDBGrid</var>
<var>TCustomDBGrid</var> is the base class for <var>TDBGrid</var>
</short>
<descr>
<p>
@ -4947,7 +4947,7 @@
</descr>
<seealso></seealso>
</element>
<element name="TCustomDBGrid.SaveGridOptions">
<short>
Saves values in the Options property to the specified XML configuration file.

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

@ -1895,7 +1895,7 @@
<element name="TCustomSplitter.AnchorSplitter">
<short>
<var>AnchorSplitter</var> anchors the splitter to <var>AControl </var>using the specified <var>Kind</var> of anchor.
<var>AnchorSplitter</var> anchors the splitter to <var>AControl</var> using the specified <var>Kind</var> of anchor.
</short>
<descr>
<p>
@ -4405,12 +4405,11 @@
<element name="TCustomCheckGroup.ColumnLayout">
<short>
<var>ColumnLayout</var>
<var>HorizontalThenVertical </var> or vice versa.
<var>ColumnLayout</var> - <var>HorizontalThenVertical</var> or vice versa.
</short>
<descr>
<p>
<var>ColumnLayout</var> is a <var>TColumnLayout</var> property which specifies the layout strategy used when rendering the <var>Items</var> in the grouped edit control. The default value for the property is <var>clHorizontalThenVertical</var>, and causes check boxes to be drawn horizontally for the required number of <var>Columns</var> before advancing.
<var>ColumnLayout</var> is a <var>TColumnLayout</var> property which specifies the layout strategy used when rendering the <var>Items</var> in the grouped edit control. The default value for the property is <var>clHorizontalThenVertical</var>, and causes check boxes to be drawn horizontally for the required number of <var>Columns</var> before advancing.
</p>
<p>
Assigning a new value for the property causes <var>ChildSizing</var> to be updated to use the corresponding value in its <var>Layout</var> property.
@ -4865,12 +4864,12 @@
<element name="TCustomLabeledEdit.EditLabel">
<short>
<var>EditLabel </var>- the label attached to the edit box.</short>
<var>EditLabel</var> - the label attached to the edit box.</short>
</element>
<element name="TCustomLabeledEdit.LabelPosition">
<short>
<var>LabelPosition </var> - whether above, below, to the left or to the right of the Edit box.
<var>LabelPosition</var> - whether above, below, to the left or to the right of the Edit box.
</short>
</element>
@ -4988,7 +4987,7 @@
<var>TCustomPanel</var>is the base type for <var>TPanel</var>.
</p>
<p>
A Panel is a defined rectangular area on a form into which other components can be placed to group them functionally and geographically. <var>TCustomPanel </var> defines the positioning and beveling properties of any descendent classes, and provides methods for painting and writing text to the panel.
A Panel is a defined rectangular area on a form into which other components can be placed to group them functionally and geographically. <var>TCustomPanel</var> defines the positioning and beveling properties of any descendent classes, and provides methods for painting and writing text to the panel.
</p>
</descr>
</element>
@ -5363,7 +5362,7 @@
<element name="TCustomPanel.BevelWidth">
<short>
<var>BevelWidth </var>- the Width of the panel's bevel in pixels.
<var>BevelWidth</var> - the Width of the panel's bevel in pixels.
</short>
</element>
@ -6232,7 +6231,7 @@
</short>
<descr>
<p>
<var>TCustomTrayIcon </var> is the base class for <var>TTrayIcon</var>, a multi-platform system tray icon component. It allows an icon to be displayed in the system tray when the Application or Form is active. TCustomTrayIcon provides properties, methods, and events used to configure, display, and control the tray icon. The component is supported on multiple platforms, but its implementation is platform-specific.
<var>TCustomTrayIcon</var> is the base class for <var>TTrayIcon</var>, a multi-platform system tray icon component. It allows an icon to be displayed in the system tray when the Application or Form is active. TCustomTrayIcon provides properties, methods, and events used to configure, display, and control the tray icon. The component is supported on multiple platforms, but its implementation is platform-specific.
</p>
<p>
On the Windows platform, the system tray is usually located on the bottom-right corner of the screen, but it can be located on other edges for the physical screen. For other platforms, the position and other features varies according to the window or display manager in use.