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

Docs: LCL/actnlist. Fixes invalid parameter name, and adds missing content.

Browse Source 
* Renames TActionEvent.Action to TActionEvent.AAction
* Adds content in TShortCutList and ApplicationActionComponent topics.

(cherry picked from commit d0137e028e)
This commit is contained in:
dsiders 2024-01-08 07:09:34 +00:00
parent 1ebad6e312
commit 1e8275f185
1 changed files with 39 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/xml/lcl/actnlist.xml
View File

@ -362,7 +362,7 @@ TCustomActionList.
<seealso/> <seealso/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TActionEvent.Action"> <element name="TActionEvent.AAction">
<short>TBasicAction for the event notification.</short> <short>TBasicAction for the event notification.</short>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
@ -1017,8 +1017,31 @@ the Object Inspector.
<short> <short>
A list of shortcuts (accelerator keys) for actions in an action list. A list of shortcuts (accelerator keys) for actions in an action list.
</short> </short>
<descr/> <descr>
<seealso/> <p>
<var>TShortCutList</var> is a <var>TStringList</var> descendant used to store
text and TShortCut class instances for accelerator keys used on actions. It
provides additional properties and methods needed to maintain the TShortCut
instances in the list.
</p>
<p>
The overridden Add method stores both the caption text and a TShortCut instance
needed for an accelerator key. The caption is stored in the Lines property.
The Objects property is used to store the TShortCut value.
</p>
<p>
Use the indexed ShortCuts property to access a TShortCut value in Objects by
its ordinal position.
</p>
<p>
TShortCutList is the type used to implement the SecondaryShortCuts property in
TCustomAction.
</p>
</descr>
<seealso>
<link id="TCustomAction.SecondaryShortCuts"/>
<link id="#rtl.classes.TShortCut">TShortCut</link>
</seealso>
</element> </element>
<!-- private --> <!-- private -->
@ -2134,7 +2157,19 @@ TBasicActionClass reference used to create the new action instance.
<short> <short>
TApplication instance used to update and execute actions. TApplication instance used to update and execute actions.
</short> </short>
<descr/> <descr>
<p>
<var>ApplicationActionComponent</var> is a unit global <var>TComponent</var>
variable with the TApplication instance used to update and execute an action.
It is used in the Update and Execute methods in TContainedAction when the
action does not have an assigned OnExecute handler or is not stored in an
action list.
</p>
<p>
ApplicationActionComponent is maintained when the TApplication instance is
created or freed for an application.
</p>
</descr>
<seealso> <seealso>
<link id="TContainedAction.Execute"/> <link id="TContainedAction.Execute"/>
<link id="TContainedAction.Update"/> <link id="TContainedAction.Update"/>