paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-22 14:59:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/buttons. Adds content for TCustomSpeedButton.ActionChange.

Browse Source 
* Depends on adafca05.

(cherry picked from commit 123fe0c949)
This commit is contained in:
dsiders 2021-11-05 20:18:34 +01:00 committed by Maxim Ganetsky
parent f58c696ff0
commit 532c1dc7f2
1 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2322,12 +2322,35 @@
<seealso></seealso>
</element>
<element name="TCustomSpeedButton.ActionChange" link="#lcl.controls.TControl.ActionChange"/>
<element name="TCustomSpeedButton.ActionChange">
<short>
Performs action when a new value is assigned to the Action property for the control.
</short>
<descr>
<p>
ActionChange is overridden in TCustomSpeedButton to ensure that values from the new action instance in Sender are stored to properties in the control. ActionChange is the routine which implements the OnChange event handler for the ActionLink in the control. It is signalled (from TControl) when a new value is assigned to the Action property, or when the control is loaded using LCL component streaming.
</p>
<p>
Sender is the new action instance for the event, or Nil when the value in Action has been removed (set to Nil).
</p>
<p>
CheckDefaults indicates whether existing properties values in the control are used as default values. When set to False, 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.
</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.
</p>
</descr>
<seealso>
<link id="#lcl.controls.TControl.ActionChange">TControl.ActionChange</link>
</seealso>
</element>
<element name="TCustomSpeedButton.ActionChange.Sender">
<short></short>
<short>New action instance for the event.</short>
</element>
<element name="TCustomSpeedButton.ActionChange.CheckDefaults">
<short></short>
<short>
True to use existing action properties as default values, False to use properties from the new action.
</short>
</element>
<element name="TCustomSpeedButton.GetActionLinkClass" link="#lcl.controls.TControl.GetActionLinkClass"/>