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

Docs: LCL/stdctrls. Removes extra spaces in topics. Updates tagging for True and False values.

Browse Source
This commit is contained in:
dsiders 2022-06-20 15:59:06 +01:00
parent c638424842
commit 1d1d79fef9
1 changed files with 92 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -492,7 +492,7 @@
<short>Preferred height calculated for the control.</short>
</element>
<element name="TCustomScrollBar.CalculatePreferredSize.WithThemeSpace">
<short>True when space is reserved for theme element details in the calculated dimensions.</short>
<short><b>True</b> when space is reserved for theme element details in the calculated dimensions.</short>
</element>
<element name="TCustomScrollBar.Create">
@ -1217,7 +1217,7 @@
<seealso/>
</element>
<element name="TComboBoxStyleHelper.HasEditBox.Result">
<short>True if an selected item value is editable.</short>
<short><b>True</b> if an selected item value is editable.</short>
</element>
<element name="TComboBoxStyleHelper.SetEditBox">
@ -1229,7 +1229,7 @@
<short>Style values after adding or removing the edit box.</short>
</element>
<element name="TComboBoxStyleHelper.SetEditBox.AHasEditBox">
<short>True enables the edit box; <b>False</b> disables the edit box.</short>
<short><b>True</b> enables the edit box; <b>False</b> disables the edit box.</short>
</element>
<element name="TComboBoxStyleHelper.IsOwnerDrawn">
@ -1238,7 +1238,7 @@
<seealso/>
</element>
<element name="TComboBoxStyleHelper.IsOwnerDrawn.Result">
<short>True if the style includes an owner-drawn option.</short>
<short><b>True</b> if the style includes an owner-drawn option.</short>
</element>
<element name="TComboBoxStyleHelper.IsVariable">
@ -1247,7 +1247,7 @@
<seealso/>
</element>
<element name="TComboBoxStyleHelper.IsVariable.Result">
<short>True when the option is included for variable height list items.</short>
<short><b>True</b> when the option is included for variable height list items.</short>
</element>
<element name="TOwnerDrawState">
@ -1644,7 +1644,7 @@
<seealso/>
</element>
<element name="TCustomComboBox.CanShowEmulatedTextHint.Result">
<short>True when emulated TextHints are used, and the control state allows the hint display.</short>
<short><b>True</b> when emulated TextHints are used, and the control state allows the hint display.</short>
</element>
<element name="TCustomComboBox.CreateParams">
@ -2428,7 +2428,7 @@
</seealso>
</element>
<element name="TCustomComboBox.SelectItem.Result">
<short>True when a matching item was found and selected.</short>
<short><b>True</b> when a matching item was found and selected.</short>
</element>
<element name="TCustomComboBox.SelectItem.AnItem">
<short>The text to find in Items.</short>
@ -2453,7 +2453,7 @@
<short>Always set to <b>True</b> in the method.</short>
</element>
<element name="TCustomComboBox.ShouldAutoAdjust.AHeight">
<short>True when AutoSize is not enabled for the control.</short>
<short><b>True</b> when AutoSize is not enabled for the control.</short>
</element>
<element name="TCustomComboBox.ItemHeight">
@ -3032,7 +3032,7 @@
</element>
<element name="TCustomComboBox.AutoSelected">
<short>True indicates that the selection was marked automatically by the control.</short>
<short><b>True</b> indicates that the selection was marked automatically by the control.</short>
<descr>
<p>
<b>True</b> indicates that the combo-box control has just performed an <var>AutoSelect</var> operation so that subsequent mouse-clicks and keystrokes proceed normally without selecting the text.
@ -3484,7 +3484,7 @@
<short>The list box control for the notification.</short>
</element>
<element name="TSelectionChangeEvent.User">
<short>True if the user changed the selection, <b>False</b> if changed by code.</short>
<short><b>True</b> if the user changed the selection, <b>False</b> if changed by code.</short>
</element>
<element name="TListBoxOption">
@ -3655,7 +3655,7 @@
<short>Ordinal position for the item.</short>
</element>
<element name="TCustomListBox.SendItemSelected.IsSelected">
<short>True when the item is selected; <b>False</b> when it is not selected.</short>
<short><b>True</b> when the item is selected; <b>False</b> when it is not selected.</short>
</element>
<element name="TCustomListBox.ClearSelectedCache">
@ -3682,7 +3682,7 @@
<seealso/>
</element>
<element name="TCustomListBox.GetSelectedCache.Result">
<short>True when the item is selected in the cache.</short>
<short><b>True</b> when the item is selected in the cache.</short>
</element>
<element name="TCustomListBox.GetSelectedCache.Index">
<short>Ordinal position in Items for the cached item.</short>
@ -4135,7 +4135,7 @@
</seealso>
</element>
<element name="TCustomListBox.DoSelectionChange.User">
<short>True when the selection change results from user interaction with the control.</short>
<short><b>True</b> when the selection change results from user interaction with the control.</short>
</element>
<element name="TCustomListBox.SendItemIndex">
@ -4366,7 +4366,7 @@
<short>The item position.</short>
</element>
<element name="TCustomListBox.ItemAtPos.Existing">
<short>True when the index is requested for insertion of a new item.</short>
<short><b>True</b> when the index is requested for insertion of a new item.</short>
</element>
<element name="TCustomListBox.ItemRect">
@ -4407,7 +4407,7 @@
</seealso>
</element>
<element name="TCustomListBox.ItemVisible.Result">
<short>True when the specified item is at least partially visible in the control.</short>
<short><b>True</b> when the specified item is at least partially visible in the control.</short>
</element>
<element name="TCustomListBox.ItemVisible.Index">
<short>Ordinal position for the item examined in the method.</short>
@ -4435,7 +4435,7 @@
</seealso>
</element>
<element name="TCustomListBox.ItemFullyVisible.Result">
<short>True when the specified item is fully visible in the list box control.</short>
<short><b>True</b> when the specified item is fully visible in the list box control.</short>
</element>
<element name="TCustomListBox.ItemFullyVisible.Index">
<short>Ordinal position for the item examined in the method.</short>
@ -4571,7 +4571,7 @@
<short>Ordinal position for the final item changed in the method.</short>
</element>
<element name="TCustomListBox.SelectRange.ASelected">
<short>True if the items are selected; <b>False</b> when they are unselected.</short>
<short><b>True</b> if the items are selected; <b>False</b> when they are unselected.</short>
</element>
<element name="TCustomListBox.DeleteSelected">
@ -5373,7 +5373,7 @@
</seealso>
</element>
<element name="TCustomEdit.CanShowEmulatedTextHint.Result">
<short>True when the emulated text hint can be displayed.</short>
<short><b>True</b> when the emulated text hint can be displayed.</short>
</element>
<element name="TCustomEdit.CalculatePreferredSize">
@ -5394,7 +5394,7 @@
<short>Preferred height calculated for the control.</short>
</element>
<element name="TCustomEdit.CalculatePreferredSize.WithThemeSpace">
<short>True when space is reserved for theme element details.</short>
<short><b>True</b> when space is reserved for theme element details.</short>
</element>
<element name="TCustomEdit.CreateParams">
@ -5754,7 +5754,7 @@
</seealso>
</element>
<element name="TCustomEdit.ChildClassAllowed.Result">
<short>True if a child control using the specified class type are allowed for the control.</short>
<short><b>True</b> if a child control using the specified class type are allowed for the control.</short>
</element>
<element name="TCustomEdit.ChildClassAllowed.ChildClass">
<short>Class type for the child control.</short>
@ -5908,10 +5908,10 @@
</seealso>
</element>
<element name="TCustomEdit.ShouldAutoAdjust.AWidth">
<short>True when Width can be auto-adjusted.</short>
<short><b>True</b> when Width can be auto-adjusted.</short>
</element>
<element name="TCustomEdit.ShouldAutoAdjust.AHeight">
<short>True when Height can be auto-adjusted.</short>
<short><b>True</b> when Height can be auto-adjusted.</short>
</element>
<element name="TCustomEdit.WMSetFocus">
@ -6209,7 +6209,7 @@
<short>Event handler added in the method.</short>
</element>
<element name="TCustomEdit.AddHandlerOnChange.AsFirst">
<short>True if the handler is stored at the top of the method list for the handler type.</short>
<short><b>True</b> if the handler is stored at the top of the method list for the handler type.</short>
</element>
<element name="TCustomEdit.RemoveHandlerOnChange">
@ -6418,7 +6418,7 @@
</element>
<element name="TCustomEdit.Modified">
<short>True when the value in Text has been changed.</short>
<short><b>True</b> when the value in Text has been changed.</short>
<descr>
<p>
<var>Modified</var> is a <var>Boolean</var> property which indicates if the value in <var>Text</var> has been changed when a <b>CM_TEXTCHANGED</b> message is handled for the control. The value is set to <b>True</b> in the <var>TextChanged</var> method. The value is reset to <b>False</b> when <var>RealSetText</var> is called to store the value in Text to the buffer for the control.
@ -7097,7 +7097,7 @@ end;
</seealso>
</element>
<element name="TCustomMemo.CanShowEmulatedTextHint.Result">
<short>True when an emulated TextHint can be displayed for the control.</short>
<short><b>True</b> when an emulated TextHint can be displayed for the control.</short>
</element>
<element name="TCustomMemo.Create">
@ -7704,7 +7704,7 @@ end;
</seealso>
</element>
<element name="TCustomStaticText.DialogChar.Result">
<short>True if the message was handled as an accelerator key.</short>
<short><b>True</b> if the message was handled as an accelerator key.</short>
</element>
<element name="TCustomStaticText.DialogChar.Message">
<short>Message examined in the method.</short>
@ -7904,7 +7904,7 @@ end;
<element name="TButtonControl.IsCheckedStored" link="#lcl.stdctrls.TButtonControl.Checked"/>
<element name="TButtonControl.IsCheckedStored.Result">
<short>True when the value in Checked is included in the LCL streaming mechanism.</short>
<short><b>True</b> when the value in Checked is included in the LCL streaming mechanism.</short>
</element>
<element name="TButtonControl.WMDefaultClicked">
@ -8222,7 +8222,7 @@ end;
</seealso>
</element>
<element name="TCustomButton.UpdateFocus.AFocused">
<short>True when the button is focused, <b>False</b> when it loses focus.</short>
<short><b>True</b> when the button is focused, <b>False</b> when it loses focus.</short>
</element>
<element name="TCustomButton.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
@ -8291,7 +8291,7 @@ end;
</seealso>
</element>
<element name="TCustomButton.DialogChar.Result">
<short>True if the message was handled as an accelerator key.</short>
<short><b>True</b> if the message was handled as an accelerator key.</short>
</element>
<element name="TCustomButton.DialogChar.Message">
<short>Message examined in the method.</short>
@ -8299,7 +8299,7 @@ end;
<element name="TCustomButton.ChildClassAllowed" link="#lcl.controls.TWinControl.ChildClassAllowed"/>
<element name="TCustomButton.ChildClassAllowed.Result">
<short>True when the widgetset class indicates child controls are allowed.</short>
<short><b>True</b> when the widgetset class indicates child controls are allowed.</short>
</element>
<element name="TCustomButton.ChildClassAllowed.ChildClass">
<short>Not used in the current implementation.</short>
@ -8562,7 +8562,7 @@ end;
</element>
<element name="TCustomButton.Active">
<short>True if the control is the Cancel or Default button.</short>
<short><b>True</b> if the control is the Cancel or Default button.</short>
<descr>
<p>
<var>Active</var> is a read-only <var>Boolean</var> property which indicates if the control is the active default control for the parent form.
@ -8579,7 +8579,7 @@ end;
</element>
<element name="TCustomButton.Cancel">
<short>True if the button is the modal Cancel button.</short>
<short><b>True</b> if the button is the modal Cancel button.</short>
<descr>
<p>
<var>Cancel</var> is a <var>Boolean</var> property which indicates if the button is the modal Cancel button on a form. The default value for the property is <b>False</b>.
@ -8616,7 +8616,7 @@ end;
</element>
<element name="TCustomButton.Default">
<short>True if the button is the default button in a modal form.</short>
<short><b>True</b> if the button is the default button in a modal form.</short>
<descr>
<p>
<var>Default</var> is a <var>Boolean</var> property which indicates if the button can be used as the default button control on a form. Default is essentially a design-time setting that indicates an intent. At run-time, the default button is the ActiveDefaultControl on the form. The default value for the property is <b>False</b>.
@ -9000,7 +9000,7 @@ end;
</seealso>
</element>
<element name="TCustomCheckBox.DialogChar.Result">
<short>True when the control state is toggled by the accelerator key.</short>
<short><b>True</b> when the control state is toggled by the accelerator key.</short>
</element>
<element name="TCustomCheckBox.DialogChar.Message">
<short>Control message examined in the method.</short>
@ -9499,7 +9499,7 @@ end;
</seealso>
</element>
<element name="TRadioButton.DialogChar.Result">
<short>True when the message is handled and the control is focused.</short>
<short><b>True</b> when the message is handled and the control is focused.</short>
</element>
<element name="TRadioButton.DialogChar.Message">
<short>Message examined for the accelerator key.</short>
@ -9757,7 +9757,7 @@ end;
</seealso>
</element>
<element name="TCustomLabel.HasMultiLine.Result">
<short>True when CR or LF characters are used in the text for the label.</short>
<short><b>True</b> when CR or LF characters are used in the text for the label.</short>
</element>
<element name="TCustomLabel.CalculatePreferredSize">
@ -9787,7 +9787,7 @@ end;
<short>Preferred height calculated for the control.</short>
</element>
<element name="TCustomLabel.CalculatePreferredSize.WithThemeSpace">
<short>True to reserve space for theme element details.</short>
<short><b>True</b> to reserve space for theme element details.</short>
</element>
<element name="TCustomLabel.CalculateSize">
@ -9834,7 +9834,7 @@ end;
<seealso/>
</element>
<element name="TCustomLabel.DialogChar.Result">
<short>True when the message is handled as an accelerator key.</short>
<short><b>True</b> when the message is handled as an accelerator key.</short>
</element>
<element name="TCustomLabel.DialogChar.Message">
<short>Message examined in the method.</short>
@ -10116,7 +10116,7 @@ end;
<seealso/>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.Result">
<short>True when the text fits within the size constraints in MaxWidth and MaxHeight.</short>
<short><b>True</b> when the text fits within the size constraints in MaxWidth and MaxHeight.</short>
</element>
<element name="TCustomLabel.CalcFittingFontHeight.TheText">
<short>Text measured in the method.</short>
@ -10162,7 +10162,7 @@ end;
</seealso>
</element>
<element name="TCustomLabel.AdjustFontForOptimalFill.Result">
<short>True when the font height was changed in the method.</short>
<short><b>True</b> when the font height was changed in the method.</short>
</element>
<element name="TCustomLabel.Paint">