mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-12-04 04:18:22 +01:00
LazDoc - new material for TAction and TCustomAction; minor corrections to StdCtrls.xml; Unit definition for StdActns.xml
git-svn-id: trunk@13532 -
This commit is contained in:
kirkpatc
parent
878e4f3ba1
commit
88d02f87da
@ -7,7 +7,7 @@
|
||||
====================================================================
|
||||
-->
|
||||
<module name="ActnList">
|
||||
<short/>
|
||||
<short>Defines classes for Actions and Lists of actions to be used with LCL components</short>
|
||||
<descr/>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Classes">
|
||||
@ -235,18 +235,12 @@ Take the following precautions when creating your own Destroy method:
|
||||
<element name="TActionListState.asSuspendedEnabled"><short/></element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomActionList">
|
||||
<short>A generic class for all action list components</short>
|
||||
<short><i>TCustomActionList</i> - the ancestor class for <i>TActionList</i></short>
|
||||
<descr>
|
||||
<p>TCustomActionList is a generic class for all components that
|
||||
represent action lists. TCustomActionList is the ancestor for TActionList.
|
||||
If you want to define your own action list class, you should use this
|
||||
class to derive it from.</p>
|
||||
<p/>
|
||||
<p>TActionList, TAction, TActionLink and TContainedAction are used to centralize
|
||||
the implementation of user commands, and can then be linked to the apropriete
|
||||
button, menu or another component. This an Object-Oriented programming strategy
|
||||
to reuse the code, as oposed to the Event-Oriented approach of writing an
|
||||
OnClick event for each component.</p>
|
||||
<p><i>TCustomActionList</i> - the ancestor class for <i>TActionList</i>. If you want to define your own action list class, you should derive it from this class.</p>
|
||||
<p><i>TActionList</i>, <i>TAction</i>, <i>TActionLink</i> and <i>TContainedAction</i> are used to centralize
|
||||
the implementation of user commands, and can then be linked to the appropriate button, menu or another component. This is an Object-Oriented programming strategy
|
||||
to reuse the code, as opposed to the Event-Oriented approach of writing an OnClick event for each component.</p>
|
||||
</descr>
|
||||
<seealso><link id="TActionList"/></seealso>
|
||||
</element>
|
||||
@ -428,33 +422,13 @@ Take the following precautions when creating your own Destroy method:
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TCustomActionList.Create">
|
||||
<short>Creates a new instance of the TCustomActionList class</short>
|
||||
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
|
||||
|
||||
However, if you create the component by code don´t forget to free it when it is no longer needed.
|
||||
|
||||
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short><i>Create </i>a new instance of the <i>TCustomActionList </i>class</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomActionList.Create.AOwner"><short/></element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TCustomActionList.Destroy">
|
||||
<short>Deallocates an object</short>
|
||||
<descr>If you call Destroy for an object witch hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
|
||||
|
||||
Take the following precautions when creating your own Destroy method:
|
||||
|
||||
* Declare Destroy with the override directive, because it is a virtual method.
|
||||
|
||||
* Always call 'inherited Destroy;' as the last thing on the destructor code.
|
||||
|
||||
* An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them.
|
||||
|
||||
* Remember to call Free for all objects created on the constructor.</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short><i>Destroy </i>- Deallocates an object</short>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomActionList.ExecuteAction">
|
||||
@ -516,9 +490,7 @@ Take the following precautions when creating your own Destroy method:
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomActionList.Images">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>The <i>Images</i> from an <i>ImageList</i> to be associated with the actions, eg in a Menu display</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomActionList.State">
|
||||
@ -528,15 +500,16 @@ Take the following precautions when creating your own Destroy method:
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TActionList">
|
||||
<short><i>TActionList</i> - The basic actions list class</short>
|
||||
<short><i>TActionList</i> - The basic actions list class</short>
|
||||
<descr>
|
||||
<p><i>TActionList</i> - The basic actions list class</p>
|
||||
<p><i>TActionList</i> is the last component on the "Standard" component pallete on the Lazarus IDE.</p>
|
||||
<p>To use an ActionList, click on the icon on the IDE Standard Components toolbar, then click anywhere on the main form and an ActionList icon will appear. It doesn't matter where you position it, because it is not visible at run-time. </p>
|
||||
<p>You can add, remove or modify actions on the list by right-clicking on the ActionList icon on the form editor and then choosing "Edit action list...". This will open the "Action List Editor". </p>
|
||||
<p>You can add, remove or modify actions on the list by right-clicking on the ActionList icon on the form editor and then choosing "Edit action list...", or by double-clicking on the icon with the left mouse button. This will open the "Action List Editor". </p>
|
||||
<p>You can now use the "+" and "-" buttons to add and remove actions. The ActionList editor menu allows you to select standard actions from a selection (option 'New Standard Action') or create a new action (option 'New Action'). To edit an action, click it and then open the object inspector. To add code to be executed when an action is triggered, double-click the action's name on the "Action List Editor".</p>
|
||||
<p>The <i>TActionList</i>
|
||||
Class introduces very few properties of its own, but inherits a lot from its ancestor, <link id="#lcl.ActnLst.TCustomActionList">TCustomActionList</link>, and related components <link id="#lcl.ActnLst.TAction">TAction</link>, <link id="#lcl.ActnLst.TCustomAction">TCustomAction</link>, <link id="#lcl.ActnLst.TContainedAction">TContainedAction</link> and <link id="#rtl.Classes.TBasicAction">TBasicAction</link></p>
|
||||
Class introduces very few properties of its own, but inherits a lot from its ancestor, <link id="#lcl.ActnList.TCustomActionList">TCustomActionList</link>, and related components <link id="#lcl.ActnList.TAction">TAction</link>, <link id="#lcl.ActnList.TCustomAction">TCustomAction</link>, <link id="#lcl.ActnList.TContainedAction">TContainedAction</link> and <link id="#rtl.Classes.TBasicAction">TBasicAction</link></p>
|
||||
<p>Each entry in the ActionList appears in the Object Inspector as an instance of <i>TAction</i>, and its properties are accessible and modifiable from the Object Inspector</p>
|
||||
</descr>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
@ -629,12 +602,11 @@ Take the following precautions when creating your own Destroy method:
|
||||
<element name="THintEvent.CanShow"><short/></element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomAction">
|
||||
<short>A generic class for all Action components</short>
|
||||
<descr>TCustomAction is a generic class for all components that represent actions that can be be set on the user interface for buttons and other controls. TCustomAction is the ancestor for TAction. If you want to define your own action class, you should use this class to derive it from.
|
||||
|
||||
TActionList, TAction, TActionLink and TContainedAction are used to centralize the implementation of user commands, and can then be linked to the appropriate button, menu or another component. This is an Object-Oriented programming strategy to reuse code, as opposed to the Event-Oriented approach of writing an OnClick event for each component.
|
||||
|
||||
You can assign a action to a component by using the Object Inspector.</descr>
|
||||
<short><i>TCustomAction</i> is the ancestor class for <i>TAction</i></short>
|
||||
<descr>
|
||||
<p><i>TCustomAction</i> is a generic class for all components that represent actions that can be be set on the user interface for buttons and other controls. <i>TCustomAction</i> is the ancestor for <i>TAction</i>. If you want to define your own action class, you should derive it from this class.</p>
|
||||
<p>You can assign a action to a component by using the Object Inspector.</p>
|
||||
</descr>
|
||||
<seealso><link id="TAction"/></seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
@ -921,163 +893,106 @@ You can assign a action to a component by using the Object Inspector.</descr>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TCustomAction.Create">
|
||||
<short>Creates a new instance of the TCustomAction class</short>
|
||||
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
|
||||
|
||||
However, if you create the component by code don´t forget to free it when it is no longer needed.
|
||||
|
||||
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short><i>Create</i> a new instance of the <i>TCustomAction</i> class</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomAction.Create.AOwner"><short/></element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TCustomAction.Destroy">
|
||||
<short>Deallocates an object</short>
|
||||
<descr>If you call Destroy for an object witch hasn´t being initialized yet it will generate an error. Always use the Free method to deallocate objects, because it verifies if object variable doesn´t contain the value nil.
|
||||
|
||||
Take the following precautions when creating your own Destroy method:
|
||||
|
||||
* Declare Destroy with the override directive, because it is a virtual method.
|
||||
|
||||
* Always call 'inherited Destroy;' as the last thing on the destructor code.
|
||||
|
||||
* An exception may be raised on the constructor in case there is not enought memory to create an object, or something else goes wrong. If the exception is not handled inside the constructor, the object will be only partially built. In this case Destroy will be called, so your destructor must check if the resources were really allocated before disposing of them.
|
||||
|
||||
* Remember to call Free for all objects created on the constructor.</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short><i>Destroy </i>- Deallocates an object</short>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomAction.DoHint">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short><i>DoHint</i> - method for displaying the hint contained in <i>HintStr</i> if True value is returned</short>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomAction.DoHint.Result"><short/></element>
|
||||
<element name="TCustomAction.DoHint.Result">
|
||||
<short>True if hint is to be displayed</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomAction.DoHint.HintStr"><short/></element>
|
||||
<element name="TCustomAction.DoHint.HintStr">
|
||||
<short><i>HintStr</i> - the text-string for display as a hint</short>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomAction.Execute">
|
||||
<short/>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<short><i>Execute</i> - method to determine if action is to be performed</short>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomAction.Execute.Result"><short/></element>
|
||||
<element name="TCustomAction.Execute.Result">
|
||||
<short>True if action is to be performed</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.AutoCheck">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>AutoCheck</i> - whether the control (eg a CheckBox) is to be automatically checked</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.Caption">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>The <i>Caption</i> to be used if this action is associated with a visible component</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.Checked">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Whether the CheckBox associated with the action is <i>Checked</i> (default False)</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.DisableIfNoHandler">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>DisableIfNoHandler </i>- don't use this action if no Handler has been provided</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.Enabled">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>Enabled</i> - whether this action is able to be used (default True)</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.GroupIndex">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>GroupIndex </i>- Index of the action within its group</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.HelpContext">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>HelpContext </i>- the index for a context-based help message</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.HelpKeyword">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>HelpKeyWord </i>- the keyword of a context-based help message</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.HelpType">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>HelpType</i> - the sort of help message to be offered: default Context-based</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.Hint">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>Hint</i> - a pop-up message that appears when the mouse hovers over an object</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.ImageIndex">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>ImageIndex </i>- the index number of the image to be associated with this action</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.ShortCut">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>ShortCut </i>- an index to a shortcut list</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.SecondaryShortCuts">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>SecondaryShortCuts</i> - a stringlist containing shortcuts</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.Visible">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>Visible</i> - is this action visible? (default True)</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomAction.OnHint">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short><i>OnHint</i> - action to be taken when a hint is required</short>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TAction">
|
||||
<short>The basic action class</short>
|
||||
<descr>TAction is the basic action object used on the LCL.
|
||||
|
||||
It redeclares many properties inherited from TCustomAction on the published section, but does not add any new features. For more details look at the See Also section for TCustomAction.</descr>
|
||||
<short><i>TAction</i> is the basic action object used on the LCL.</short>
|
||||
<descr>
|
||||
<p><i>TAction</i> is the basic action object used on the LCL.</p>
|
||||
<p>It redeclares many properties inherited from TCustomAction on the public section, but does not add any new features. For more details look at the See Also section for TCustomAction.</p>
|
||||
<i>The properties of each Action can be modified at design time in the Object Inspector</i>
|
||||
</descr>
|
||||
<seealso><link id="TCustomAction"/></seealso>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TAction.Create">
|
||||
<short>Creates a new instance of the TAction class</short>
|
||||
<descr>If you drop a component on the form editor you don´t need to add code to explicitly create it. The component is automatically created together with the the form, and destroyed when the form is destroyed.
|
||||
|
||||
However, if you create the component by code don´t forget to free it when it is no longer needed.
|
||||
|
||||
Constructors allocate memory and system resources needed by the object. They also call the constructor of any sub-objects present in the class.</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TAction.Create"/>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TAction.Create.AOwner"><short/></element>
|
||||
<!-- property Visibility: published -->
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
-->
|
||||
|
||||
<module name="StdActns">
|
||||
<short></short>
|
||||
<short>Defines some standard actions to be used in Action Lists in the LCL</short>
|
||||
<descr>
|
||||
</descr>
|
||||
|
||||
|
||||
@ -5277,7 +5277,7 @@ Indicates how text is displayed in a text editing control.</p>
|
||||
<short><i>TButtonActionLink</i> - provides a link between a button and its corresponding action</short>
|
||||
<descr>
|
||||
<p><i>TButtonActionLink</i> - provides a link between a button and its corresponding action</p>
|
||||
<p>This class provides very few properties of its own, but inherits a lot from its ancestors, <link id="#lcl.Controls.TWinControlActionLink">TWinControlActionLink</link>, <link id="#lcl.Controls.TControlActionLink">TControlActionLink</link>, <link id="#lcl.ActnLst.TActionLink">TActionLink</link> and <link id="#rtl.Classes.TBasicActionLink">TBasicActionLink</link></p>
|
||||
<p>This class provides very few properties of its own, but inherits a lot from its ancestors, <link id="#lcl.Controls.TWinControlActionLink">TWinControlActionLink</link>, <link id="#lcl.Controls.TControlActionLink">TControlActionLink</link>, <link id="#lcl.ActnList.TActionLink">TActionLink</link> and <link id="#rtl.Classes.TBasicActionLink">TBasicActionLink</link></p>
|
||||
</descr>
|
||||
</element>
|
||||
<!-- variable Visibility: protected -->
|
||||
|
||||
Loading…
Reference in New Issue
Block a user