paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-14 10:39:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
dsiders 2022-06-14 21:50:45 +01:00
parent 09d974065f
commit a6dbf90460
1 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -410,7 +410,7 @@
</p> </p>
<dl> <dl>
<dt>gsmAlways</dt> <dt>gsmAlways</dt>
<dd>Return value is True</dd> <dd>Return value is <b>True</b></dd>
<dt>gsmNever</dt> <dt>gsmNever</dt>
<dd>Return value is <b>False</b></dd> <dd>Return value is <b>False</b></dd>
<dt>gsmApplication</dt> <dt>gsmApplication</dt>
@ -481,7 +481,7 @@
GlyphChanged is procedure which provides the default implementation for the OnChange event handler. Sender is the TObject instance for the change notification, and normally receives a reference to the current TButtonGlyph class instance. GlyphChanged is procedure which provides the default implementation for the OnChange event handler. Sender is the TObject instance for the change notification, and normally receives a reference to the current TButtonGlyph class instance.
</p> </p>
<p> <p>
GlyphChanged ensures that the internal ImagesCache member is set to Nil, and the ClearImages methods is called to remove images stored in the Images property. When CanShow returns True, the internal ImagesCache member is re-populated and registered to listen for changes to the Glyph property. GlyphChanged ensures that the internal ImagesCache member is set to Nil, and the ClearImages methods is called to remove images stored in the Images property. When CanShow returns <b>True</b>, the internal ImagesCache member is re-populated and registered to listen for changes to the Glyph property.
</p> </p>
<p> <p>
GlyphChanged is assigned to the OnChange event handler when the class instance is created, and when a bitmap is assigned to the Glyph property. GlyphChanged is assigned to the OnChange event handler when the class instance is created, and when a bitmap is assigned to the Glyph property.
@ -2537,7 +2537,7 @@
<element name="TCustomSpeedButton.Notification"> <element name="TCustomSpeedButton.Notification">
<short> <short>
Performs action needed when a sub-component is added or removed for the control. Performs actions needed when a sub-component is added or removed for the control.
</short> </short>
<descr></descr> <descr></descr>
<seealso></seealso> <seealso></seealso>
@ -2692,7 +2692,9 @@
Updates internal members used to track state changes in the control. Updates internal members used to track state changes in the control.
</short> </short>
<descr> <descr>
<var>UpdateState</var> brings the state up to date, implementing any pending changes, and rendering non-valid if <var>InvalidateOnChange</var> is True. <p>
<var>UpdateState</var> brings the state up to date, implementing any pending changes, and rendering non-valid if <var>InvalidateOnChange</var> is <b>True</b>.
</p>
</descr> </descr>
<seealso></seealso> <seealso></seealso>
</element> </element>
@ -2777,7 +2779,7 @@
Sender is the new action instance for the event, or Nil when the value in Action has been removed (set to Nil). Sender is the new action instance for the event, or Nil when the value in Action has been removed (set to Nil).
</p> </p>
<p> <p>
CheckDefaults indicates whether existing properties values in the control are used as default values. When set to <b>False</b>, the values from the action instance are applied to the control. Values from the action may be used (when assigned) if the properties in the control are unassigned - even when CheckDefaults is True. CheckDefaults indicates whether existing properties values in the control are used as default values. When set to <b>False</b>, the values from the action instance are applied to the control. Values from the action may be used (when assigned) if the properties in the control are unassigned - even when CheckDefaults is <b>True</b>.
</p> </p>
<p> <p>
ActionChange calls the inherited method to update property values like Caption, Enabled, Hint, Visible, HelpContext and HelpKeyword. When Sender is a TCustomAction instance, the values in GroupIndex, ImageIndex, and Images are also updated with the values from the action. ActionChange calls the inherited method to update property values like Caption, Enabled, Hint, Visible, HelpContext and HelpKeyword. When Sender is a TCustomAction instance, the values in GroupIndex, ImageIndex, and Images are also updated with the values from the action.
@ -3126,7 +3128,7 @@
Set <var>Flat</var> to <b>True</b> to draw the control without relief, elevation, or a three-dimensional appearance. The default value for the property is <b>False</b>. Changing the value for the property causes the control to be redrawn. Set <var>Flat</var> to <b>True</b> to draw the control without relief, elevation, or a three-dimensional appearance. The default value for the property is <b>False</b>. Changing the value for the property causes the control to be redrawn.
</p> </p>
<p> <p>
Flat is used in the <var>GetDrawDetails</var> method to select the theme element details applied to the control for its current state. When set to <b>False</b>, TThemedButton element details are used. When set to True, TThemedToolBar element details are used. See <link id="TCustomSpeedButton.GetDrawDetails">GetDrawDetails</link> for more information about the values used for specific button states. Flat is used in the <var>GetDrawDetails</var> method to select the theme element details applied to the control for its current state. When set to <b>False</b>, TThemedButton element details are used. When set to <b>True</b>, TThemedToolBar element details are used. See <link id="TCustomSpeedButton.GetDrawDetails">GetDrawDetails</link> for more information about the values used for specific button states.
</p> </p>
</descr> </descr>
<seealso> <seealso>
@ -3280,7 +3282,7 @@
</short> </short>
<descr> <descr>
<p> <p>
<var>PressedImageIndex</var> is a <var>TImageIndex</var> property with the ordinal position for the glyph bitmap displayed when the Down property is True. The default value for the property is -1, and indicates that an explicit value has not been assigned for the property. <var>PressedImageIndex</var> is a <var>TImageIndex</var> property with the ordinal position for the glyph bitmap displayed when the Down property is <b>True</b>. The default value for the property is -1, and indicates that an explicit value has not been assigned for the property.
</p> </p>
<p> <p>
The property value is read from and written to the image index members in ButtonGlyph. The property value is read from and written to the image index members in ButtonGlyph.
@ -3342,10 +3344,10 @@
<short>Indicates if the Caption for the speed button is displayed.</short> <short>Indicates if the Caption for the speed button is displayed.</short>
<descr> <descr>
<p> <p>
The default value for the property is True. Changing the value for the property causes the control to be redrawn. The default value for the property is <b>True</b>. Changing the value for the property causes the control to be redrawn.
</p> </p>
<p> <p>
ShowCaption is used in the MeasureDraw method. When set to True, the text extent for Caption is displayed using the Font and Layout for the control. It is also used in the GetTextSize method when the text extent is calculated. ShowCaption is used in the MeasureDraw method. When set to <b>True</b>, the text extent for Caption is displayed using the Font and Layout for the control. It is also used in the GetTextSize method when the text extent is calculated.
</p> </p>
</descr> </descr>
<seealso/> <seealso/>