From 4788ff848ad89d0784d93808229484194f65f635 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Sat, 29 Dec 2007 16:28:20 +0000 Subject: [PATCH] LazDoc - New information for TActionList, and minor corrections to StdCtrls git-svn-id: trunk@13522 - --- docs/xml/lcl/actnlist.xml | 503 ++++++++++---------------------------- docs/xml/lcl/stdctrls.xml | 15 +- 2 files changed, 141 insertions(+), 377 deletions(-) diff --git a/docs/xml/lcl/actnlist.xml b/docs/xml/lcl/actnlist.xml index ed36e32011..52f3ca0d00 100644 --- a/docs/xml/lcl/actnlist.xml +++ b/docs/xml/lcl/actnlist.xml @@ -72,9 +72,7 @@ - - - + @@ -83,9 +81,7 @@ - - - + @@ -94,9 +90,7 @@ - - - + @@ -105,9 +99,7 @@ - - - + @@ -116,9 +108,7 @@ - - - + @@ -127,9 +117,7 @@ - - - + @@ -138,9 +126,7 @@ - - - + @@ -173,9 +159,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -184,9 +168,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -195,9 +177,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -206,9 +186,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -240,13 +218,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -254,34 +228,27 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + - - - + A generic class for all action list components -

TCustomActionList is a generic class for all components that + +

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.

-

-

TActionList, TAction, TActionLink and TContainedAction are used to centralize +

+

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.

- - - - + + @@ -333,13 +300,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -348,9 +311,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -359,9 +320,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -370,13 +329,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -385,9 +340,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -396,9 +349,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -407,9 +358,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -425,13 +374,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -440,13 +385,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -455,13 +396,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -470,9 +407,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -503,9 +438,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + Deallocates an object @@ -531,13 +464,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -546,13 +475,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -561,13 +486,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -576,13 +497,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -590,9 +507,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -613,14 +528,16 @@ Take the following precautions when creating your own Destroy method: - The basic actions list class - TActionList is the last component on the "Standard" component pallete on the Lazarus IDE. - -To add, remove or modify actions on the list by right-click an ActionList on the form editor and then choose "Edit action list...". This will open the "Action List Editor". You can now use the "+" and "-" buttons to add and remove actions. 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". - - - - + TActionList - The basic actions list class + +

TActionList - The basic actions list class

+

TActionList is the last component on the "Standard" component pallete on the Lazarus IDE.

+

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.

+

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".

+

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".

+

The TActionList + Class introduces very few properties of its own, but inherits a lot from its ancestor, TCustomActionList, and related components TAction, TCustomAction, TContainedAction and TBasicAction

+ @@ -667,13 +584,9 @@ To add, remove or modify actions on the list by right-click an ActionList on the - - - + - - - + @@ -682,13 +595,9 @@ To add, remove or modify actions on the list by right-click an ActionList on the - - - + - - - + @@ -697,13 +606,9 @@ To add, remove or modify actions on the list by right-click an ActionList on the - - - + - - - + @@ -711,9 +616,7 @@ To add, remove or modify actions on the list by right-click an ActionList on the - - - + @@ -721,13 +624,9 @@ To add, remove or modify actions on the list by right-click an ActionList on the - - - + - - - + A generic class for all Action components @@ -736,9 +635,7 @@ To add, remove or modify actions on the list by right-click an ActionList on the 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. - - - + @@ -850,9 +747,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -861,9 +756,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -872,9 +765,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -883,9 +774,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -894,9 +783,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -905,9 +792,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -916,9 +801,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -927,9 +810,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -938,9 +819,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -949,9 +828,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -960,9 +837,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -971,9 +846,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -982,9 +855,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -993,9 +864,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -1004,9 +873,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -1027,9 +894,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -1038,9 +903,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -1049,9 +912,7 @@ You can assign a action to a component by using the Object Inspector. - - - + @@ -1070,9 +931,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + Deallocates an object @@ -1098,13 +957,9 @@ Take the following precautions when creating your own Destroy method: - - - + - - - + @@ -1113,9 +968,7 @@ Take the following precautions when creating your own Destroy method: - - - + @@ -1212,9 +1065,7 @@ Take the following precautions when creating your own Destroy method: 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. - - - + @@ -1228,9 +1079,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1342,9 +1191,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1353,9 +1200,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1364,9 +1209,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1375,9 +1218,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1386,9 +1227,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1397,9 +1236,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1408,9 +1245,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1419,9 +1254,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1430,9 +1263,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1441,9 +1272,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1452,9 +1281,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1463,9 +1290,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1474,9 +1299,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1485,9 +1308,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1496,9 +1317,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1507,9 +1326,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1518,9 +1335,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1529,9 +1344,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1540,9 +1353,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1551,9 +1362,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1562,9 +1371,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1573,9 +1380,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1589,17 +1394,11 @@ Constructors allocate memory and system resources needed by the object. They als - - - + - - - + - - - + @@ -1608,17 +1407,11 @@ Constructors allocate memory and system resources needed by the object. They als - - - + - - - + - - - + @@ -1627,9 +1420,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1638,13 +1429,9 @@ Constructors allocate memory and system resources needed by the object. They als - - - + - - - + @@ -1653,17 +1440,11 @@ Constructors allocate memory and system resources needed by the object. They als - - - + - - - + - - - + @@ -1671,13 +1452,9 @@ Constructors allocate memory and system resources needed by the object. They als - - - + - - - + @@ -1685,9 +1462,7 @@ Constructors allocate memory and system resources needed by the object. They als - - - + @@ -1695,13 +1470,9 @@ Constructors allocate memory and system resources needed by the object. They als - - - + - - - + @@ -1709,17 +1480,11 @@ Constructors allocate memory and system resources needed by the object. They als - - - + - - - + - - - + diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index bbaa131951..48758203a5 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -5274,10 +5274,11 @@ Indicates how text is displayed in a text editing control.

- - - - + TButtonActionLink - provides a link between a button and its corresponding action + +

TButtonActionLink - provides a link between a button and its corresponding action

+

This class provides very few properties of its own, but inherits a lot from its ancestors, TWinControlActionLink, TControlActionLink, TActionLink and TBasicActionLink

+ @@ -6704,10 +6705,8 @@ If the TabStop is True, the control is in the tab order. If TabStop is False, th - Custom Label - Custom label: the base type from which Label is derived. - - + TCustomLabel: the base type from which TLabel is derived. + TCustomLabel: the base type from which TLabel is derived.