PageRenderTime 62ms CodeModel.GetById 16ms app.highlight 34ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/xml/lcl/actnlist.xml

http://github.com/graemeg/lazarus
XML | 1759 lines | 1448 code | 5 blank | 306 comment | 0 complexity | 3e80a2d856e5be9cce6820b7bc4f5bef MD5 | raw file
   1<?xml version="1.0"?>
   2<fpdoc-descriptions>
   3  <package name="lcl">
   4    <!--
   5  ====================================================================
   6    ActnList
   7  ====================================================================
   8-->
   9    <module name="ActnList">
  10      <short>Defines classes for Actions and Lists of actions to be used with LCL components</short>
  11      <descr/>
  12      <!-- unresolved type reference Visibility: default -->
  13      <element name="Classes">
  14        <short/>
  15        <descr/>
  16        <seealso/>
  17      </element>
  18      <!-- unresolved type reference Visibility: default -->
  19      <element name="SysUtils">
  20        <short/>
  21        <descr/>
  22        <seealso/>
  23      </element>
  24      <!-- unresolved type reference Visibility: default -->
  25      <element name="LCLStrConsts">
  26        <short/>
  27        <descr/>
  28        <seealso/>
  29      </element>
  30      <!-- unresolved type reference Visibility: default -->
  31      <element name="LCLProc">
  32        <short/>
  33        <descr/>
  34        <seealso/>
  35      </element>
  36      <!-- unresolved type reference Visibility: default -->
  37      <element name="ImgList">
  38        <short/>
  39        <descr/>
  40        <seealso/>
  41      </element>
  42      <!-- unresolved type reference Visibility: default -->
  43      <element name="LCLClasses">
  44        <short/>
  45        <descr/>
  46        <seealso/>
  47      </element>
  48      <!-- object Visibility: default -->
  49      <element name="TContainedAction">
  50        <short>
  51          <var>TContainedAction</var> - parent class for <var>TCustomAction</var>; defines some properties especially relationships with parents</short>
  52        <descr/>
  53        <errors/>
  54        <seealso/>
  55      </element>
  56      <!-- variable Visibility: private -->
  57      <element name="TContainedAction.FCategory">
  58        <short/>
  59        <descr/>
  60        <seealso/>
  61      </element>
  62      <!-- variable Visibility: private -->
  63      <element name="TContainedAction.FActionList">
  64        <short/>
  65        <descr/>
  66        <seealso/>
  67      </element>
  68      <!-- function Visibility: private -->
  69      <element name="TContainedAction.GetIndex">
  70        <short/>
  71        <descr/>
  72        <errors/>
  73        <seealso/>
  74      </element>
  75      <!-- function result Visibility: default -->
  76      <element name="TContainedAction.GetIndex.Result">
  77        <short/>
  78      </element>
  79      <!-- function Visibility: private -->
  80      <element name="TContainedAction.IsCategoryStored">
  81        <short/>
  82        <descr/>
  83        <errors/>
  84        <seealso/>
  85      </element>
  86      <!-- function result Visibility: default -->
  87      <element name="TContainedAction.IsCategoryStored.Result">
  88        <short/>
  89      </element>
  90      <!-- procedure Visibility: private -->
  91      <element name="TContainedAction.SetCategory">
  92        <short/>
  93        <descr/>
  94        <errors/>
  95        <seealso/>
  96      </element>
  97      <!-- argument Visibility: default -->
  98      <element name="TContainedAction.SetCategory.Value">
  99        <short/>
 100      </element>
 101      <!-- procedure Visibility: private -->
 102      <element name="TContainedAction.SetIndex">
 103        <short/>
 104        <descr/>
 105        <errors/>
 106        <seealso/>
 107      </element>
 108      <!-- argument Visibility: default -->
 109      <element name="TContainedAction.SetIndex.Value">
 110        <short/>
 111      </element>
 112      <!-- procedure Visibility: private -->
 113      <element name="TContainedAction.SetActionList">
 114        <short/>
 115        <descr/>
 116        <errors/>
 117        <seealso/>
 118      </element>
 119      <!-- argument Visibility: default -->
 120      <element name="TContainedAction.SetActionList.AActionList">
 121        <short/>
 122      </element>
 123      <!-- procedure Visibility: protected -->
 124      <element name="TContainedAction.ReadState" link="#rtl.Classes.TComponent.ReadState">
 125        <short/>
 126        <descr/>
 127        <errors/>
 128        <seealso/>
 129      </element>
 130      <!-- argument Visibility: default -->
 131      <element name="TContainedAction.ReadState.Reader">
 132        <short/>
 133      </element>
 134      <!-- procedure Visibility: protected -->
 135      <element name="TContainedAction.SetParentComponent" link="#rtl.Classes.TComponent.SetParentComponent">
 136        <short/>
 137        <descr/>
 138        <errors/>
 139        <seealso/>
 140      </element>
 141      <!-- argument Visibility: default -->
 142      <element name="TContainedAction.SetParentComponent.AParent">
 143        <short/>
 144      </element>
 145      <!-- procedure Visibility: protected -->
 146      <element name="TContainedAction.Change">
 147        <short/>
 148        <descr/>
 149        <errors/>
 150        <seealso/>
 151      </element>
 152      <!-- destructor Visibility: public -->
 153      <element name="TContainedAction.Destroy" link="#rtl.Classes.TBasicAction.Destroy">
 154        <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.
 155
 156Take the following precautions when creating your own Destroy method:
 157
 158* Declare Destroy with the override directive, because it is a virtual method.
 159
 160* Always call 'inherited Destroy;' as the last thing on the destructor code.
 161
 162* 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.
 163
 164* Remember to call Free for all objects created on the constructor.
 165</descr>
 166        <errors/>
 167        <seealso/>
 168      </element>
 169      <!-- function Visibility: public -->
 170      <element name="TContainedAction.Execute" link="#rtl.Classes.TBasicAction.Execute">
 171        <short/>
 172        <descr/>
 173        <errors/>
 174        <seealso/>
 175      </element>
 176      <!-- function result Visibility: default -->
 177      <element name="TContainedAction.Execute.Result">
 178        <short/>
 179      </element>
 180      <!-- function Visibility: public -->
 181      <element name="TContainedAction.GetParentComponent" link="#rtl.Classes.TComponent.GetParentComponent">
 182        <short/>
 183        <descr/>
 184        <errors/>
 185        <seealso/>
 186      </element>
 187      <!-- function result Visibility: default -->
 188      <element name="TContainedAction.GetParentComponent.Result">
 189        <short/>
 190      </element>
 191      <!-- function Visibility: public -->
 192      <element name="TContainedAction.HasParent" link="#rtl.Classes.TComponent.HasParent">
 193        <short/>
 194        <descr/>
 195        <errors/>
 196        <seealso/>
 197      </element>
 198      <!-- function result Visibility: default -->
 199      <element name="TContainedAction.HasParent.Result">
 200        <short/>
 201      </element>
 202      <!-- function Visibility: public -->
 203      <element name="TContainedAction.Update" link="#rtl.Classes.TBasicAction.Update">
 204        <short/>
 205        <descr/>
 206        <errors/>
 207        <seealso/>
 208      </element>
 209      <!-- function result Visibility: default -->
 210      <element name="TContainedAction.Update.Result">
 211        <short/>
 212      </element>
 213      <!-- property Visibility: public -->
 214      <element name="TContainedAction.ActionList">
 215        <short>The <var>ActionList</var> in which this action is contained</short>
 216        <descr/>
 217        <seealso/>
 218      </element>
 219      <!-- property Visibility: public -->
 220      <element name="TContainedAction.Index">
 221        <short>The <var>Index</var> of this action in the list of actions</short>
 222        <descr/>
 223        <seealso/>
 224      </element>
 225      <!-- property Visibility: published -->
 226      <element name="TContainedAction.Category">
 227        <short>The <var>Category</var> of this action</short>
 228        <descr/>
 229        <seealso/>
 230      </element>
 231      <!-- "class of" type Visibility: default -->
 232      <element name="TContainedActionClass">
 233        <short/>
 234        <descr/>
 235        <seealso/>
 236      </element>
 237      <!-- procedure type Visibility: default -->
 238      <element name="TActionEvent">
 239        <short/>
 240        <descr/>
 241        <seealso/>
 242      </element>
 243      <!-- argument Visibility: default -->
 244      <element name="TActionEvent.Action">
 245        <short/>
 246      </element>
 247      <!-- argument Visibility: default -->
 248      <element name="TActionEvent.Handled">
 249        <short/>
 250      </element>
 251      <!-- enumeration type Visibility: default -->
 252      <element name="TActionListState">
 253        <short/>
 254        <descr/>
 255        <seealso/>
 256      </element>
 257      <!-- enumeration value Visibility: default -->
 258      <element name="TActionListState.asNormal">
 259        <short/>
 260      </element>
 261      <!-- enumeration value Visibility: default -->
 262      <element name="TActionListState.asSuspended">
 263        <short/>
 264      </element>
 265      <!-- enumeration value Visibility: default -->
 266      <element name="TActionListState.asSuspendedEnabled">
 267        <short/>
 268      </element>
 269      <!-- object Visibility: default -->
 270      <element name="TCustomActionList">
 271        <short>
 272          <var>TCustomActionList</var> - the ancestor class for <var>TActionList</var>
 273        </short>
 274        <descr>
 275          <p>
 276            <var>TCustomActionList</var> - the ancestor class for <var>TActionList</var>. If you want to define your own action list class, you should derive it from this class.</p>
 277          <p>
 278            <var>TActionList</var>, <var>TAction</var>, <var>TActionLink</var> and <var>TContainedAction</var> are used to centralize
 279 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
 280 to reuse the code, as opposed to the Event-Oriented approach of writing an OnClick event for each component.</p>
 281        </descr>
 282        <seealso>
 283          <link id="TActionList"/>
 284        </seealso>
 285      </element>
 286      <!-- variable Visibility: private -->
 287      <element name="TCustomActionList.FActions">
 288        <short/>
 289        <descr/>
 290        <seealso/>
 291      </element>
 292      <!-- variable Visibility: private -->
 293      <element name="TCustomActionList.FImageChangeLink">
 294        <short/>
 295        <descr/>
 296        <seealso/>
 297      </element>
 298      <!-- variable Visibility: private -->
 299      <element name="TCustomActionList.FImages">
 300        <short/>
 301        <descr/>
 302        <seealso/>
 303      </element>
 304      <!-- variable Visibility: private -->
 305      <element name="TCustomActionList.FOnChange">
 306        <short/>
 307        <descr/>
 308        <seealso/>
 309      </element>
 310      <!-- variable Visibility: private -->
 311      <element name="TCustomActionList.FOnExecute">
 312        <short/>
 313        <descr/>
 314        <seealso/>
 315      </element>
 316      <!-- variable Visibility: private -->
 317      <element name="TCustomActionList.FOnUpdate">
 318        <short/>
 319        <descr/>
 320        <seealso/>
 321      </element>
 322      <!-- variable Visibility: private -->
 323      <element name="TCustomActionList.FState">
 324        <short/>
 325        <descr/>
 326        <seealso/>
 327      </element>
 328      <!-- function Visibility: private -->
 329      <element name="TCustomActionList.GetAction">
 330        <short/>
 331        <descr/>
 332        <errors/>
 333        <seealso/>
 334      </element>
 335      <!-- function result Visibility: default -->
 336      <element name="TCustomActionList.GetAction.Result">
 337        <short/>
 338      </element>
 339      <!-- argument Visibility: default -->
 340      <element name="TCustomActionList.GetAction.Index">
 341        <short/>
 342      </element>
 343      <!-- function Visibility: private -->
 344      <element name="TCustomActionList.GetActionCount">
 345        <short/>
 346        <descr/>
 347        <errors/>
 348        <seealso/>
 349      </element>
 350      <!-- function result Visibility: default -->
 351      <element name="TCustomActionList.GetActionCount.Result">
 352        <short/>
 353      </element>
 354      <!-- procedure Visibility: private -->
 355      <element name="TCustomActionList.ImageListChange">
 356        <short/>
 357        <descr/>
 358        <errors/>
 359        <seealso/>
 360      </element>
 361      <!-- argument Visibility: default -->
 362      <element name="TCustomActionList.ImageListChange.Sender">
 363        <short/>
 364      </element>
 365      <!-- procedure Visibility: private -->
 366      <element name="TCustomActionList.SetAction">
 367        <short/>
 368        <descr/>
 369        <errors/>
 370        <seealso/>
 371      </element>
 372      <!-- argument Visibility: default -->
 373      <element name="TCustomActionList.SetAction.Index">
 374        <short/>
 375      </element>
 376      <!-- argument Visibility: default -->
 377      <element name="TCustomActionList.SetAction.Value">
 378        <short/>
 379      </element>
 380      <!-- procedure Visibility: private -->
 381      <element name="TCustomActionList.SetState">
 382        <short/>
 383        <descr/>
 384        <errors/>
 385        <seealso/>
 386      </element>
 387      <!-- argument Visibility: default -->
 388      <element name="TCustomActionList.SetState.Value">
 389        <short/>
 390      </element>
 391      <!-- procedure Visibility: protected -->
 392      <element name="TCustomActionList.AddAction">
 393        <short>
 394          <var>AddAction</var> - adds an action to the list</short>
 395        <descr/>
 396        <errors/>
 397        <seealso/>
 398      </element>
 399      <!-- argument Visibility: default -->
 400      <element name="TCustomActionList.AddAction.Action">
 401        <short/>
 402      </element>
 403      <!-- procedure Visibility: protected -->
 404      <element name="TCustomActionList.RemoveAction">
 405        <short>
 406          <var>RemoveAction</var> - removes an action from the list</short>
 407        <descr/>
 408        <errors/>
 409        <seealso/>
 410      </element>
 411      <!-- argument Visibility: default -->
 412      <element name="TCustomActionList.RemoveAction.Action">
 413        <short/>
 414      </element>
 415      <!-- procedure Visibility: protected -->
 416      <element name="TCustomActionList.Change">
 417        <short>
 418          <var>Change</var> the action</short>
 419        <descr/>
 420        <errors/>
 421        <seealso/>
 422      </element>
 423      <!-- procedure Visibility: protected -->
 424      <element name="TCustomActionList.GetChildren" link="#rtl.Classes.TComponent.GetChildren">
 425        <short/>
 426        <descr/>
 427        <errors/>
 428        <seealso/>
 429      </element>
 430      <!-- argument Visibility: default -->
 431      <element name="TCustomActionList.GetChildren.Proc">
 432        <short/>
 433      </element>
 434      <!-- argument Visibility: default -->
 435      <element name="TCustomActionList.GetChildren.Root">
 436        <short/>
 437      </element>
 438      <!-- procedure Visibility: protected -->
 439      <element name="TCustomActionList.Notification" link="#rtl.Classes.TComponent.Notification">
 440        <short/>
 441        <descr/>
 442        <errors/>
 443        <seealso/>
 444      </element>
 445      <!-- argument Visibility: default -->
 446      <element name="TCustomActionList.Notification.AComponent">
 447        <short/>
 448      </element>
 449      <!-- argument Visibility: default -->
 450      <element name="TCustomActionList.Notification.Operation">
 451        <short/>
 452      </element>
 453      <!-- procedure Visibility: protected -->
 454      <element name="TCustomActionList.SetChildOrder" link="#rtl.Classes.TComponent.SetChildOrder">
 455        <short/>
 456        <descr/>
 457        <errors/>
 458        <seealso/>
 459      </element>
 460      <!-- argument Visibility: default -->
 461      <element name="TCustomActionList.SetChildOrder.Component">
 462        <short/>
 463      </element>
 464      <!-- argument Visibility: default -->
 465      <element name="TCustomActionList.SetChildOrder.Order">
 466        <short/>
 467      </element>
 468      <!-- procedure Visibility: protected -->
 469      <element name="TCustomActionList.SetImages">
 470        <short>
 471          <var>SetImages</var> - stores a list of images</short>
 472        <descr/>
 473        <errors/>
 474        <seealso/>
 475      </element>
 476      <!-- argument Visibility: default -->
 477      <element name="TCustomActionList.SetImages.Value">
 478        <short/>
 479      </element>
 480      <!-- property Visibility: protected -->
 481      <element name="TCustomActionList.OnChange">
 482        <short>
 483          <var>OnChange</var> - event handler for a change in the action</short>
 484        <descr/>
 485        <seealso/>
 486      </element>
 487      <!-- property Visibility: protected -->
 488      <element name="TCustomActionList.OnExecute">
 489        <short>
 490          <var>OnExecute</var> - event handler for execution of the action</short>
 491        <descr/>
 492        <seealso/>
 493      </element>
 494      <!-- property Visibility: protected -->
 495      <element name="TCustomActionList.OnUpdate">
 496        <short>
 497          <var>OnUpdate</var> - event handler for updating the action</short>
 498        <descr/>
 499        <seealso/>
 500      </element>
 501      <!-- constructor Visibility: public -->
 502      <element name="TCustomActionList.Create">
 503        <short>
 504          <var>Create</var> - constructor for <var>TCustomActionList</var>: calls inherited <var>Create</var> then initialises some local variables</short>
 505        <seealso>
 506          <link id="#rtl.Classes.TComponent.Create"/>
 507        </seealso>
 508      </element>
 509      <!-- argument Visibility: default -->
 510      <element name="TCustomActionList.Create.AOwner">
 511        <short/>
 512      </element>
 513      <!-- destructor Visibility: public -->
 514      <element name="TCustomActionList.Destroy">
 515        <descr>
 516          <var>Destroy</var> sends a <var>opRemove</var> notification to all components 
 517in the free-notification list. After that, all owned components are
 518destroyed by calling <link id="#rtl.Classes.TComponent.DestroyComponents">DestroyComponents</link>
 519(and hence removed from the list of owned components). When this
 520is done, the component removes itself from its owner's child component list.
 521After that, the parent's destroy method is called.
 522</descr>
 523        <short>
 524          <var>Destroy</var> - destructor for <var>TCustomActionList</var>: frees various links then calls inherited <var>Destroy</var>
 525        </short>
 526        <seealso>
 527          <link id="#rtl.Classes.TComponent.Destroy"/>
 528        </seealso>
 529      </element>
 530      <!-- function Visibility: public -->
 531      <element name="TCustomActionList.ExecuteAction" link="#rtl.Classes.TComponent.ExecuteAction">
 532        <descr>
 533          <var>ExecuteAction</var> checks whether <var>Action</var> handles the
 534current component, and if yes, calls the <var>ExecuteAction</var> method,
 535passing itself as a parameter. The function returns <var>True</var> if the
 536action handles the current component.
 537</descr>
 538        <errors/>
 539        <seealso/>
 540      </element>
 541      <!-- function result Visibility: default -->
 542      <element name="TCustomActionList.ExecuteAction.Result">
 543        <short/>
 544      </element>
 545      <!-- argument Visibility: default -->
 546      <element name="TCustomActionList.ExecuteAction.Action">
 547        <short/>
 548      </element>
 549      <!-- function Visibility: public -->
 550      <element name="TCustomActionList.UpdateAction" link="#rtl.Classes.TComponent.UpdateAction">
 551        <descr>
 552          <var>UpdateAction</var> checks whether <var>Action</var> handles the
 553current component, and if yes, calls the <var>UpdateTarget</var> method,
 554passing itself as a parameter. The function returns <var>True</var> if the
 555action handles the current component.
 556</descr>
 557        <errors/>
 558        <seealso/>
 559      </element>
 560      <!-- function result Visibility: default -->
 561      <element name="TCustomActionList.UpdateAction.Result">
 562        <short/>
 563      </element>
 564      <!-- argument Visibility: default -->
 565      <element name="TCustomActionList.UpdateAction.Action">
 566        <short/>
 567      </element>
 568      <!-- function Visibility: public -->
 569      <element name="TCustomActionList.IndexOfName">
 570        <short>The Index value of the name of this action in the ActionList</short>
 571        <descr/>
 572        <errors/>
 573        <seealso/>
 574      </element>
 575      <!-- function result Visibility: default -->
 576      <element name="TCustomActionList.IndexOfName.Result">
 577        <short/>
 578      </element>
 579      <!-- argument Visibility: default -->
 580      <element name="TCustomActionList.IndexOfName.ActionName">
 581        <short/>
 582      </element>
 583      <!-- function Visibility: public -->
 584      <element name="TCustomActionList.ActionByName">
 585        <short>Returns an action identified by its name (as a string)</short>
 586        <descr/>
 587        <errors/>
 588        <seealso/>
 589      </element>
 590      <!-- function result Visibility: default -->
 591      <element name="TCustomActionList.ActionByName.Result">
 592        <short/>
 593      </element>
 594      <!-- argument Visibility: default -->
 595      <element name="TCustomActionList.ActionByName.ActionName">
 596        <short/>
 597      </element>
 598      <!-- property Visibility: public -->
 599      <element name="TCustomActionList.Actions">
 600        <short>The indexed list of actions</short>
 601        <descr/>
 602        <seealso/>
 603      </element>
 604      <!-- argument Visibility: default -->
 605      <element name="TCustomActionList.Actions.Index">
 606        <short/>
 607      </element>
 608      <!-- property Visibility: public -->
 609      <element name="TCustomActionList.ActionCount">
 610        <short>The total number of actions in the actionlist</short>
 611        <descr/>
 612        <seealso/>
 613      </element>
 614      <!-- property Visibility: public -->
 615      <element name="TCustomActionList.Images">
 616        <short>The <var>Images</var> from an <var>ImageList</var> to be associated with the actions, eg in a Menu display</short>
 617      </element>
 618      <!-- property Visibility: public -->
 619      <element name="TCustomActionList.State">
 620        <short>State of the action : Normal, Suspended or SuspendedEnabled</short>
 621        <descr/>
 622        <seealso/>
 623      </element>
 624      <!-- object Visibility: default -->
 625      <element name="TActionList">
 626        <short>
 627          <var>TActionList</var>   - The basic actions list class</short>
 628        <descr>
 629          <p>
 630            <var>TActionList</var> - The basic actions list class</p>
 631          <p>
 632            <var>TActionList</var> is the last component on the "Standard" component pallete on the Lazarus IDE.</p>
 633          <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>
 634          <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>
 635          <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>
 636          <p>The <var>TActionList</var>
 637 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>
 638          </p>
 639          <p>Each entry in the ActionList appears in the Object Inspector as an instance of <var>TAction</var>, and its properties are accessible and modifiable from the Object Inspector</p>
 640        </descr>
 641      </element>
 642      <!-- property Visibility: published -->
 643      <element name="TActionList.Images" link="#LCL.ActnList.TCustomActionList.Images">
 644        <descr/>
 645        <seealso/>
 646      </element>
 647      <!-- property Visibility: published -->
 648      <element name="TActionList.State" link="#LCL.ActnList.TCustomActionList.State">
 649        <descr/>
 650        <seealso/>
 651      </element>
 652      <!-- property Visibility: published -->
 653      <element name="TActionList.OnChange" link="#LCL.ActnList.TCustomActionList.OnChange">
 654        <descr/>
 655        <seealso/>
 656      </element>
 657      <!-- property Visibility: published -->
 658      <element name="TActionList.OnExecute" link="#LCL.ActnList.TCustomActionList.OnExecute">
 659        <descr/>
 660        <seealso/>
 661      </element>
 662      <!-- property Visibility: published -->
 663      <element name="TActionList.OnUpdate" link="#LCL.ActnList.TCustomActionList.OnUpdate">
 664        <descr/>
 665        <seealso/>
 666      </element>
 667      <!-- object Visibility: default -->
 668      <element name="TShortCutList">
 669        <short>TShortCutList - a list of shortcuts for actions in an ActionList</short>
 670        <descr/>
 671        <errors/>
 672        <seealso/>
 673      </element>
 674      <!-- function Visibility: private -->
 675      <element name="TShortCutList.GetShortCuts">
 676        <short/>
 677        <descr/>
 678        <errors/>
 679        <seealso/>
 680      </element>
 681      <!-- function result Visibility: default -->
 682      <element name="TShortCutList.GetShortCuts.Result">
 683        <short/>
 684      </element>
 685      <!-- argument Visibility: default -->
 686      <element name="TShortCutList.GetShortCuts.Index">
 687        <short/>
 688      </element>
 689      <!-- function Visibility: public -->
 690      <element name="TShortCutList.Add">
 691        <short>Add a shortcut to the list; implements the <link id="#rtl.classes.TStrings.Add"/> function</short>
 692        <descr/>
 693        <errors/>
 694        <seealso/>
 695      </element>
 696      <!-- function result Visibility: default -->
 697      <element name="TShortCutList.Add.Result">
 698        <short/>
 699      </element>
 700      <!-- argument Visibility: default -->
 701      <element name="TShortCutList.Add.S">
 702        <short/>
 703      </element>
 704      <!-- function Visibility: public -->
 705      <element name="TShortCutList.IndexOfShortCut">
 706        <short>The index number of the shortcut in the list</short>
 707        <descr/>
 708        <errors/>
 709        <seealso/>
 710      </element>
 711      <!-- function result Visibility: default -->
 712      <element name="TShortCutList.IndexOfShortCut.Result">
 713        <short/>
 714      </element>
 715      <!-- argument Visibility: default -->
 716      <element name="TShortCutList.IndexOfShortCut.Shortcut">
 717        <short/>
 718      </element>
 719      <!-- property Visibility: public -->
 720      <element name="TShortCutList.ShortCuts">
 721        <short>The indexed list of short cuts</short>
 722        <descr/>
 723        <seealso/>
 724      </element>
 725      <!-- argument Visibility: default -->
 726      <element name="TShortCutList.ShortCuts.Index">
 727        <short/>
 728      </element>
 729      <!-- procedure type Visibility: default -->
 730      <element name="THintEvent">
 731        <short/>
 732        <descr/>
 733        <seealso/>
 734      </element>
 735      <!-- argument Visibility: default -->
 736      <element name="THintEvent.HintStr">
 737        <short/>
 738      </element>
 739      <!-- argument Visibility: default -->
 740      <element name="THintEvent.CanShow">
 741        <short/>
 742      </element>
 743      <!-- object Visibility: default -->
 744      <element name="TCustomAction">
 745        <short>
 746          <var>TCustomAction</var> is the ancestor class for <var>TAction</var>
 747        </short>
 748        <descr>
 749          <p>
 750            <var>TCustomAction</var> is a generic class for all components that represent actions that can be be set on the user interface for buttons and other controls. <var>TCustomAction</var> is the ancestor for <var>TAction</var>. If you want to define your own action class, you should derive it from this class.</p>
 751          <p>You can assign a action to a component by using the Object Inspector.</p>
 752        </descr>
 753        <seealso>
 754          <link id="TAction"/>
 755        </seealso>
 756      </element>
 757      <!-- variable Visibility: private -->
 758      <element name="TCustomAction.FDisableIfNoHandler">
 759        <short/>
 760        <descr/>
 761        <seealso/>
 762      </element>
 763      <!-- variable Visibility: private -->
 764      <element name="TCustomAction.FCaption">
 765        <short/>
 766        <descr/>
 767        <seealso/>
 768      </element>
 769      <!-- variable Visibility: private -->
 770      <element name="TCustomAction.FChecking">
 771        <short/>
 772        <descr/>
 773        <seealso/>
 774      </element>
 775      <!-- variable Visibility: private -->
 776      <element name="TCustomAction.FChecked">
 777        <short/>
 778        <descr/>
 779        <seealso/>
 780      </element>
 781      <!-- variable Visibility: private -->
 782      <element name="TCustomAction.FEnabled">
 783        <short/>
 784        <descr/>
 785        <seealso/>
 786      </element>
 787      <!-- variable Visibility: private -->
 788      <element name="TCustomAction.FGroupIndex">
 789        <short/>
 790        <descr/>
 791        <seealso/>
 792      </element>
 793      <!-- variable Visibility: private -->
 794      <element name="TCustomAction.FHelpType">
 795        <short/>
 796        <descr/>
 797        <seealso/>
 798      </element>
 799      <!-- variable Visibility: private -->
 800      <element name="TCustomAction.FHelpContext">
 801        <short/>
 802        <descr/>
 803        <seealso/>
 804      </element>
 805      <!-- variable Visibility: private -->
 806      <element name="TCustomAction.FHelpKeyword">
 807        <short/>
 808        <descr/>
 809        <seealso/>
 810      </element>
 811      <!-- variable Visibility: private -->
 812      <element name="TCustomAction.FHint">
 813        <short/>
 814        <descr/>
 815        <seealso/>
 816      </element>
 817      <!-- variable Visibility: private -->
 818      <element name="TCustomAction.FImageIndex">
 819        <short/>
 820        <descr/>
 821        <seealso/>
 822      </element>
 823      <!-- variable Visibility: private -->
 824      <element name="TCustomAction.FShortCut">
 825        <short/>
 826        <descr/>
 827        <seealso/>
 828      </element>
 829      <!-- variable Visibility: private -->
 830      <element name="TCustomAction.FVisible">
 831        <short/>
 832        <descr/>
 833        <seealso/>
 834      </element>
 835      <!-- variable Visibility: private -->
 836      <element name="TCustomAction.FOnHint">
 837        <short/>
 838        <descr/>
 839        <seealso/>
 840      </element>
 841      <!-- variable Visibility: private -->
 842      <element name="TCustomAction.FSecondaryShortCuts">
 843        <short/>
 844        <descr/>
 845        <seealso/>
 846      </element>
 847      <!-- variable Visibility: private -->
 848      <element name="TCustomAction.FSavedEnabledState">
 849        <short/>
 850        <descr/>
 851        <seealso/>
 852      </element>
 853      <!-- variable Visibility: private -->
 854      <element name="TCustomAction.FAutoCheck">
 855        <short/>
 856        <descr/>
 857        <seealso/>
 858      </element>
 859      <!-- procedure Visibility: private -->
 860      <element name="TCustomAction.SetAutoCheck">
 861        <short/>
 862        <descr/>
 863        <errors/>
 864        <seealso/>
 865      </element>
 866      <!-- argument Visibility: default -->
 867      <element name="TCustomAction.SetAutoCheck.Value">
 868        <short/>
 869      </element>
 870      <!-- procedure Visibility: private -->
 871      <element name="TCustomAction.SetCaption">
 872        <short/>
 873        <descr/>
 874        <errors/>
 875        <seealso/>
 876      </element>
 877      <!-- argument Visibility: default -->
 878      <element name="TCustomAction.SetCaption.Value">
 879        <short/>
 880      </element>
 881      <!-- procedure Visibility: private -->
 882      <element name="TCustomAction.SetChecked">
 883        <short/>
 884        <descr/>
 885        <errors/>
 886        <seealso/>
 887      </element>
 888      <!-- argument Visibility: default -->
 889      <element name="TCustomAction.SetChecked.Value">
 890        <short/>
 891      </element>
 892      <!-- procedure Visibility: private -->
 893      <element name="TCustomAction.SetEnabled">
 894        <short/>
 895        <descr/>
 896        <errors/>
 897        <seealso/>
 898      </element>
 899      <!-- argument Visibility: default -->
 900      <element name="TCustomAction.SetEnabled.Value">
 901        <short/>
 902      </element>
 903      <!-- procedure Visibility: private -->
 904      <element name="TCustomAction.SetGroupIndex">
 905        <short/>
 906        <descr/>
 907        <errors/>
 908        <seealso/>
 909      </element>
 910      <!-- argument Visibility: default -->
 911      <element name="TCustomAction.SetGroupIndex.Value">
 912        <short/>
 913      </element>
 914      <!-- procedure Visibility: private -->
 915      <element name="TCustomAction.SetHelpContext">
 916        <short/>
 917        <descr/>
 918        <errors/>
 919        <seealso/>
 920      </element>
 921      <!-- argument Visibility: default -->
 922      <element name="TCustomAction.SetHelpContext.Value">
 923        <short/>
 924      </element>
 925      <!-- procedure Visibility: private -->
 926      <element name="TCustomAction.SetHelpKeyword">
 927        <short/>
 928        <descr/>
 929        <errors/>
 930        <seealso/>
 931      </element>
 932      <!-- argument Visibility: default -->
 933      <element name="TCustomAction.SetHelpKeyword.Value">
 934        <short/>
 935      </element>
 936      <!-- procedure Visibility: private -->
 937      <element name="TCustomAction.SetHelpType">
 938        <short/>
 939        <descr/>
 940        <errors/>
 941        <seealso/>
 942      </element>
 943      <!-- argument Visibility: default -->
 944      <element name="TCustomAction.SetHelpType.Value">
 945        <short/>
 946      </element>
 947      <!-- procedure Visibility: private -->
 948      <element name="TCustomAction.SetHint">
 949        <short/>
 950        <descr/>
 951        <errors/>
 952        <seealso/>
 953      </element>
 954      <!-- argument Visibility: default -->
 955      <element name="TCustomAction.SetHint.Value">
 956        <short/>
 957      </element>
 958      <!-- procedure Visibility: private -->
 959      <element name="TCustomAction.SetImageIndex">
 960        <short/>
 961        <descr/>
 962        <errors/>
 963        <seealso/>
 964      </element>
 965      <!-- argument Visibility: default -->
 966      <element name="TCustomAction.SetImageIndex.Value">
 967        <short/>
 968      </element>
 969      <!-- procedure Visibility: private -->
 970      <element name="TCustomAction.SetShortCut">
 971        <short/>
 972        <descr/>
 973        <errors/>
 974        <seealso/>
 975      </element>
 976      <!-- argument Visibility: default -->
 977      <element name="TCustomAction.SetShortCut.Value">
 978        <short/>
 979      </element>
 980      <!-- procedure Visibility: private -->
 981      <element name="TCustomAction.SetVisible">
 982        <short/>
 983        <descr/>
 984        <errors/>
 985        <seealso/>
 986      </element>
 987      <!-- argument Visibility: default -->
 988      <element name="TCustomAction.SetVisible.Value">
 989        <short/>
 990      </element>
 991      <!-- function Visibility: private -->
 992      <element name="TCustomAction.GetSecondaryShortCuts">
 993        <short/>
 994        <descr/>
 995        <errors/>
 996        <seealso/>
 997      </element>
 998      <!-- function result Visibility: default -->
 999      <element name="TCustomAction.GetSecondaryShortCuts.Result">
1000        <short/>
1001      </element>
1002      <!-- procedure Visibility: private -->
1003      <element name="TCustomAction.SetSecondaryShortCuts">
1004        <short/>
1005        <descr/>
1006        <errors/>
1007        <seealso/>
1008      </element>
1009      <!-- argument Visibility: default -->
1010      <element name="TCustomAction.SetSecondaryShortCuts.Value">
1011        <short/>
1012      </element>
1013      <!-- function Visibility: private -->
1014      <element name="TCustomAction.IsSecondaryShortCutsStored">
1015        <short/>
1016        <descr/>
1017        <errors/>
1018        <seealso/>
1019      </element>
1020      <!-- function result Visibility: default -->
1021      <element name="TCustomAction.IsSecondaryShortCutsStored.Result">
1022        <short/>
1023      </element>
1024      <!-- variable Visibility: protected -->
1025      <element name="TCustomAction.FImage">
1026        <short/>
1027        <descr/>
1028        <seealso/>
1029      </element>
1030      <!-- variable Visibility: protected -->
1031      <element name="TCustomAction.FMask">
1032        <short/>
1033        <descr/>
1034        <seealso/>
1035      </element>
1036      <!-- procedure Visibility: protected -->
1037      <element name="TCustomAction.AssignTo" link="#rtl.Classes.TPersistent.AssignTo">
1038        <descr>
1039          <p>
1040            <var>AssignTo</var> is the generic function to assign the class' contents to 
1041another class. This method must be overridden by descendent classes to
1042actually assign the content of the source instance to the destination
1043instance. 
1044</p>
1045          <p>The <link id="TPersistent"/> implementation of <var>Assignto</var> raises 
1046an <var>EConvertError</var> exception. This is done for the following
1047reason: If the source class doesn't know how to assign itself to the
1048destination class (using <var>AssignTo</var>), the destination class may 
1049know how get the data from the source class (using <link id="TPersistent.Assign">Assign</link>). If all descendent methods are
1050implemented correctly, then if neither of the two classes knows how to
1051assign their contents to each other, execution will end up at <link id="TPersistent.Assign"/>, which will simply execute 
1052</p>
1053          <code>Dest.AssignTo(Self);
1054</code>
1055          <p>If neither of the classes knows how to assign to/from each other, then
1056execution will end up at the <var>TPersistent</var> implementation of
1057<var>AssignTo</var>, and an exception will be raised.
1058</p>
1059        </descr>
1060        <errors/>
1061        <seealso/>
1062      </element>
1063      <!-- argument Visibility: default -->
1064      <element name="TCustomAction.AssignTo.Dest">
1065        <short/>
1066      </element>
1067      <!-- procedure Visibility: protected -->
1068      <element name="TCustomAction.SetName" link="#rtl.Classes.TComponent.SetName">
1069        <short/>
1070        <descr/>
1071        <errors/>
1072        <seealso/>
1073      </element>
1074      <!-- argument Visibility: default -->
1075      <element name="TCustomAction.SetName.Value">
1076        <short/>
1077      </element>
1078      <!-- function Visibility: protected -->
1079      <element name="TCustomAction.HandleShortCut">
1080        <short>
1081          <var>HandleShortCut</var> - returns True if there is a short cut associated with the handle</short>
1082        <descr/>
1083        <errors/>
1084        <seealso/>
1085      </element>
1086      <!-- function result Visibility: default -->
1087      <element name="TCustomAction.HandleShortCut.Result">
1088        <short/>
1089      </element>
1090      <!-- property Visibility: protected -->
1091      <element name="TCustomAction.SavedEnabledState">
1092        <short>
1093          <var>SavedEnabledState</var> - if True, the Enabled state has been saved</short>
1094        <descr/>
1095        <seealso/>
1096      </element>
1097      <!-- constructor Visibility: public -->
1098      <element name="TCustomAction.Create">
1099        <short>
1100          <var>Create</var> - constructor for <var>TCustomAction</var>: calls inherited <var>Create</var> then initialises some local variables</short>
1101        <seealso>
1102          <link id="#rtl.Classes.TBasicAction.Create"/>
1103        </seealso>
1104      </element>
1105      <!-- argument Visibility: default -->
1106      <element name="TCustomAction.Create.AOwner">
1107        <short/>
1108      </element>
1109      <!-- destructor Visibility: public -->
1110      <element name="TCustomAction.Destroy">
1111        <short>
1112          <var>Destroy</var> - destructor for <var>TCustomAction</var>: frees various lists and images, then calls inherited <var>Destroy</var>
1113        </short>
1114        <seealso>
1115          <link id="#rtl.Classes.TBasicAction.Destroy"/>
1116        </seealso>
1117      </element>
1118      <!-- function Visibility: public -->
1119      <element name="TCustomAction.DoHint">
1120        <short>
1121          <var>DoHint</var> - method for displaying the hint contained in <var>HintStr</var> if True value is returned</short>
1122      </element>
1123      <!-- function result Visibility: default -->
1124      <element name="TCustomAction.DoHint.Result">
1125        <short>True if hint is to be displayed</short>
1126      </element>
1127      <!-- argument Visibility: default -->
1128      <element name="TCustomAction.DoHint.HintStr">
1129        <short>
1130          <var>HintStr</var> - the text-string for display as a hint</short>
1131      </element>
1132      <!-- function Visibility: public -->
1133      <element name="TCustomAction.Execute" link="#rtl.Classes.TBasicAction.Execute"/>
1134      <!-- function result Visibility: default -->
1135      <element name="TCustomAction.Execute.Result">
1136        <short>True if action is to be performed</short>
1137      </element>
1138      <!-- property Visibility: public -->
1139      <element name="TCustomAction.AutoCheck">
1140        <short>
1141          <var>AutoCheck</var> - whether the control (eg a CheckBox) is to be automatically checked</short>
1142      </element>
1143      <!-- property Visibility: public -->
1144      <element name="TCustomAction.Caption">
1145        <short>The <var>Caption</var> to be used if this action is associated with a visible component</short>
1146      </element>
1147      <!-- property Visibility: public -->
1148      <element name="TCustomAction.Checked">
1149        <short>Whether the CheckBox associated with the action is <var>Checked</var> (default False)</short>
1150      </element>
1151      <!-- property Visibility: public -->
1152      <element name="TCustomAction.DisableIfNoHandler">
1153        <short>
1154          <var>DisableIfNoHandler </var>- don't use this action if no Handler has been provided</short>
1155      </element>
1156      <!-- property Visibility: public -->
1157      <element name="TCustomAction.Enabled">
1158        <short>
1159          <var>Enabled</var> - whether this action is able to be used (default True)</short>
1160      </element>
1161      <!-- property Visibility: public -->
1162      <element name="TCustomAction.GroupIndex">
1163        <short>
1164          <var>GroupIndex </var>- Index of the action within its group</short>
1165      </element>
1166      <!-- property Visibility: public -->
1167      <element name="TCustomAction.HelpContext">
1168        <short>
1169          <var>HelpContext </var>- the index for a context-based help message</short>
1170      </element>
1171      <!-- property Visibility: public -->
1172      <element name="TCustomAction.HelpKeyword">
1173        <short>
1174          <var>HelpKeyWord </var>- the keyword of a context-based help message</short>
1175      </element>
1176      <!-- property Visibility: public -->
1177      <element name="TCustomAction.HelpType">
1178        <short>
1179          <var>HelpType</var> - the sort of help message to be offered: default Context-based</short>
1180      </element>
1181      <!-- property Visibility: public -->
1182      <element name="TCustomAction.Hint">
1183        <short>
1184          <var>Hint</var> - a pop-up message that appears when the mouse hovers over an object</short>
1185      </element>
1186      <!-- property Visibility: public -->
1187      <element name="TCustomAction.ImageIndex">
1188        <short>
1189          <var>ImageIndex </var>- the index number of the image to be associated with this action</short>
1190      </element>
1191      <!-- property Visibility: public -->
1192      <element name="TCustomAction.ShortCut">
1193        <short>
1194          <var>ShortCut </var>- an index to a shortcut list</short>
1195      </element>
1196      <!-- property Visibility: public -->
1197      <element name="TCustomAction.SecondaryShortCuts">
1198        <short>
1199          <var>SecondaryShortCuts</var> - a stringlist containing shortcuts</short>
1200      </element>
1201      <!-- property Visibility: public -->
1202      <element name="TCustomAction.Visible">
1203        <short>
1204          <var>Visible</var> - is this action visible? (default True)</short>
1205      </element>
1206      <!-- property Visibility: public -->
1207      <element name="TCustomAction.OnHint">
1208        <short>
1209          <var>OnHint</var> - action to be taken when a hint is required</short>
1210      </element>
1211      <!-- object Visibility: default -->
1212      <element name="TAction">
1213        <short>
1214          <var>TAction</var> is the basic action object used on the LCL.</short>
1215        <descr>
1216          <p>
1217            <var>TAction</var> is the basic action object used on the LCL.</p>
1218          <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>
1219          <p>The properties of each Action can be modified at design time in the Object Inspector</p>
1220        </descr>
1221        <seealso>
1222          <link id="TCustomAction"/>
1223        </seealso>
1224      </element>
1225      <!-- constructor Visibility: public -->
1226      <element name="TAction.Create" link="#LCL.ActnList.TCustomAction.Create"/>
1227      <!-- argument Visibility: default -->
1228      <element name="TAction.Create.AOwner">
1229        <short/>
1230      </element>
1231      <!-- property Visibility: published -->
1232      <element name="TAction.AutoCheck" link="#LCL.ActnList.TCustomAction.AutoCheck">
1233        <descr/>
1234        <seealso/>
1235      </element>
1236      <!-- property Visibility: published -->
1237      <element name="TAction.Caption" link="#LCL.ActnList.TCustomAction.Caption">
1238        <descr/>
1239        <seealso/>
1240      </element>
1241      <!-- property Visibility: published -->
1242      <element name="TAction.Checked" link="#LCL.ActnList.TCustomAction.Checked">
1243        <descr/>
1244        <seealso/>
1245      </element>
1246      <!-- property Visibility: published -->
1247      <element name="TAction.Enabled" link="#LCL.ActnList.TCustomAction.Enabled">
1248        <descr/>
1249        <seealso/>
1250      </element>
1251      <!-- property Visibility: published -->
1252      <element name="TAction.GroupIndex" link="#LCL.ActnList.TCustomAction.GroupIndex">
1253        <descr/>
1254        <seealso/>
1255      </element>
1256      <!-- property Visibility: published -->
1257      <element name="TAction.HelpContext" link="#LCL.ActnList.TCustomAction.HelpContext">
1258        <descr/>
1259        <seealso/>
1260      </element>
1261      <!-- property Visibility: published -->
1262      <element name="TAction.HelpKeyword" link="#LCL.ActnList.TCustomAction.HelpKeyword">
1263        <descr/>
1264        <seealso/>
1265      </element>
1266      <!-- property Visibility: published -->
1267      <element name="TAction.HelpType" link="#LCL.ActnList.TCustomAction.HelpType">
1268        <descr/>
1269        <seealso/>
1270      </element>
1271      <!-- property Visibility: published -->
1272      <element name="TAction.Hint" link="#LCL.ActnList.TCustomAction.Hint">
1273        <descr/>
1274        <seealso/>
1275      </element>
1276      <!-- property Visibility: published -->
1277      <element name="TAction.ImageIndex" link="#LCL.ActnList.TCustomAction.ImageIndex">
1278        <descr/>
1279        <seealso/>
1280      </element>
1281      <!-- property Visibility: published -->
1282      <element name="TAction.OnExecute" link="#rtl.Classes.TBasicAction.OnExecute">
1283        <descr><p><var>OnExecute</var> is the event triggered when the action is activated
1284(executed). The event is triggered e.g. when the user clicks e.g. on a menu
1285item or a button associated to the action. The application programmer 
1286should provide a <var>OnExecute</var> event handler to execute whatever code
1287is necessary when the button is pressed or the menu item is chosen.
1288</p><p>Note that assigning an <var>OnExecute</var> handler will result in the
1289<link id="TBasicAction.Execute">Execute</link> method returning a
1290<var>True</var> value. Predefined actions (such as dataset actions)
1291will check the result of <var>Execute</var> and will not perform their 
1292normal task if the <var>OnExecute</var> handler was called.
1293</p><p>Since version 1.1 setting OnExecute no longer sets the owner's OnClick. You can now specify an event for the action and a more specific OnClick for control and both are called. OnClick is called before OnExecute.
1294</p>
1295        </descr>
1296        <seealso/>
1297      <short>Event called when action is executed</short>
1298      </element>
1299      <!-- property Visibility: published -->
1300      <element name="TAction.OnHint" link="#LCL.ActnList.TCustomAction.OnHint">
1301        <descr/>
1302        <seealso/>
1303      </element>
1304      <!-- property Visibility: published -->
1305      <element name="TAction.OnUpdate" link="#rtl.Classes.TBasicAction.OnUpdate">
1306        <descr>
1307          <var>OnUpdate</var> is the event triggered when the application is idle, and
1308the action is being updated. The <var>OnUpdate</var> event can be used to
1309set the state of the action, for instance disable it if the action cannot be
1310executed at this point in time.
1311</descr>
1312        <seealso/>
1313      </element>
1314      <!-- property Visibility: published -->
1315      <element name="TAction.SecondaryShortCuts" link="#LCL.ActnList.TCustomAction.SecondaryShortCuts">
1316        <descr/>
1317        <seealso/>
1318      </element>
1319      <!-- property Visibility: published -->
1320      <element name="TAction.ShortCut" link="#LCL.ActnList.TCustomAction.ShortCut">
1321        <short/>
1322        <descr/>
1323        <seealso/>
1324      </element>
1325      <!-- property Visibility: published -->
1326      <element name="TAction.Visible" link="#LCL.ActnList.TCustomAction.Visible">
1327        <descr/>
1328        <seealso/>
1329      </element>
1330      <!-- object Visibility: default -->
1331      <element name="TActionLink">
1332        <short>A link between an action and a client class</short>
1333        <descr>The class definition includes a number of protected procedures for setting properties for the action (as defined in <link id="TCustomAction"/>), and a number of public boolean functions to indicate which part of the action is linked to the client
1334</descr>
1335        <errors/>
1336        <seealso/>
1337      </element>
1338      <!-- procedure Visibility: protected -->
1339      <element name="TActionLink.SetAutoCheck">
1340        <short>
1341          <var>SetAutoCheck</var> - specifies the value of AutoCheck, whether True or False</short>
1342        <descr/>
1343        <errors/>
1344        <seealso/>
1345      </element>
1346      <!-- argument Visibility: default -->
1347      <element name="TActionLink.SetAutoCheck.Value">
1348        <short/>
1349      </element>
1350      <!-- procedure Visibility: protected -->
1351      <element name="TActionLink.SetCaption">
1352        <short>
1353          <var>SetCaption</var> - specifies the string to be used as caption</short>
1354        <descr/>
1355        <errors/>
1356        <seealso/>
1357      </element>
1358      <!-- argument Visibility: default -->
1359      <element name="TActionLink.SetCaption.Value">
1360        <short/>
1361      </element>
1362      <!-- procedure Visibility: protected -->
1363      <element name="TActionLink.SetChecked">
1364        <short>
1365          <var>SetChecked</var> - specifies the value of the Checked property: True or False</short>
1366        <descr/>
1367        <errors/>
1368        <seealso/>
1369      </element>
1370      <!-- argument Visibility: default -->
1371      <element name="TActionLink.SetChecked.Value">
1372        <short/>
1373      </element>
1374      <!-- procedure Visibility: protected -->
1375      <element name="TActionLink.SetEnabled">
1376        <short>
1377          <var>SetEnabled</var> - specifies the value of the <var>Enabled</var> property: True or False</short>
1378        <descr/>
1379        <errors/>
1380        <seealso/>
1381      </element>
1382      <!-- argument Visibility: default -->
1383      <element name="TActionLink.SetEnabled.Value">
1384        <short/>
1385      </element>
1386      <!-- procedure Visibility: protected -->
1387      <element name="TActionLink.SetGroupIndex">
1388        <short>
1389          <var>SetGroupIndex</var> - specifies the value for the Group Index</short>
1390        <descr/>
1391        <errors/>
1392        <seealso/>
1393      </element>
1394      <!-- argument Visibility: default -->
1395      <element name="TActionLink.SetGroupIndex.Value">
1396        <short/>
1397      </element>
1398      <!-- procedure Visibility: protected -->
1399      <element name="TActionLink.SetHelpContext">
1400        <short>
1401          <var>SetHelpContext</var> - specifies the value to be used for context-sensitive Help</short>
1402        <descr/>
1403        <errors/>
1404        <seealso/>
1405      </element>
1406      <!-- argument Visibility: default -->
1407      <element name="TActionLink.SetHelpContext.Value">
1408        <short/>
1409      </element>
1410      <!-- procedure Visibility: protected -->
1411      <element name="TActionLink.SetHelpKeyword">
1412        <short>
1413          <var>SetHelpKeyword</var> - specifies the keyword to be used for Help</short>
1414        <descr/>
1415        <errors/>
1416        <seealso/>
1417      </element>
1418      <!-- argument Visibility: default -->
1419      <element name="TActionLink.SetHelpKeyword.Value">
1420        <short/>
1421      </element>
1422      <!-- procedure Visibility: protected -->
1423      <element name="TActionLink.SetHelpType">
1424        <short>
1425          <var>SetHelpType</var> - specifies the trpe of Help to be used</short>
1426        <descr/>
1427        <errors/>
1428        <seealso/>
1429      </element>
1430      <!-- argument Visibility: default -->
1431      <element name="TActionLink.SetHelpType.Value">
1432        <short/>
1433      </element>
1434      <!-- procedure Visibility: protected -->
1435      <element name="TActionLink.SetHint">
1436        <short>
1437          <var>SetHint</var> - specifies the string to be used for Hints</short>
1438        <descr/>
1439        <errors/>
1440        <seealso/>
1441      </element>
1442      <!-- argument Visibility: default -->
1443      <element name="TActionLink.SetHint.Value">
1444        <short/>
1445      </element>
1446      <!-- procedure Visibility: protected -->
1447      <element name="TActionLink.SetImageIndex">
1448        <short>
1449          <var>SetImageIndex</var> - specifies the index value for the image associated with the action</short>
1450        <descr/>
1451        <errors/>
1452        <seealso/>
1453      </element>
1454      <!-- argument Visibility: default -->
1455      <element name="TActionLink.SetImageIndex.Value">
1456        <short/>
1457      </element>
1458      <!-- procedure Visibility: protected -->
1459      <element name="TActionLink.SetShortCut">
1460        <short>
1461          <var>SetShortCut</var> - specifies the shortcut for the action</short>
1462        <descr/>
1463        <errors/>
1464        <seealso/>
1465      </element>
1466      <!-- argument Visibility: default -->
1467      <element name="TActionLink.SetShortCut.Value">
1468        <short/>
1469      </element>
1470      <!-- procedure Visibility: protected -->
1471      <element name="TActionLink.SetVisible">
1472        <short>
1473          <var>SetVisible</var> - specifies whether or not the control for the action is <var>Visible</var>
1474        </short>
1475        <descr/>
1476        <errors/>
1477        <seealso/>
1478      </element>
1479      <!-- argument Visibility: default -->
1480      <element name="TActionLink.SetVisible.Value">
1481        <short/>
1482      </element>
1483      <!-- function Visibility: public -->
1484      <element name="TActionLink.IsCaptionLinked">
1485        <short>Is the action's <var>Caption</var> linked to the client?</short>
1486        <descr/>
1487        <errors/>
1488        <seealso/>
1489      </element>
1490      <!-- function result Visibility: default -->
1491      <element name="TActionLink.IsCaptionLinked.Result">
1492        <short/>
1493      </element>
1494      <!-- function Visibility: public -->
1495      <element name="TActionLink.IsCheckedLinked">
1496        <short>Is the action's <var>Checked</var> property linked to the client?</short>
1497        <descr/>
1498        <errors/>
1499        <seealso/>
1500      </element>
1501      <!-- function result Visibility: default -->
1502      <element name="TActionLink.IsCheckedLinked.Result">
1503        <short/>
1504      </element>
1505      <!-- function Visibility: public -->
1506      <element name="TActionLink.IsEnabledLinked">
1507        <short>Is the action's <var>Enabled</var> property linked to the client?</short>
1508        <descr/>
1509        <errors/>
1510        <seealso/>
1511      </element>
1512      <!-- function result Visibility: default -->
1513      <element name="TActionLink.IsEnabledLinked.Result">
1514        <short/>
1515      </element>
1516      <!-- function Visibility: public -->
1517      <element name="TActionLink.IsGroupIndexLinked">
1518        <short>Is the action's <var>GroupIndex</var> property linked to the client?</short>
1519        <descr/>
1520        <errors/>
1521        <seealso/>
1522      </element>
1523      <!-- function result Visibility: default -->
1524      <element name="TActionLink.IsGroupIndexLinked.Result">
1525        <short/>
1526      </element>
1527      <!-- function Visibility: public -->
1528      <element name="TActionLink.IsHelpContextLinked">
1529        <short>Is the action's <var>HelpContext</var> property linked to the client?</short>
1530        <descr/>
1531        <errors/>
1532        <seealso/>
1533      </element>
1534      <!-- function result Visibility: default -->
1535      <element name="TActionLink.IsHelpContextLinked.Result">
1536        <short/>
1537      </element>
1538      <!-- function Visibility: public -->
1539      <element name="TActionLink.IsHelpLinked">
1540        <short>Is the action's <var>Help</var> property linked to the client?</short>
1541        <descr/>
1542        <errors/>
1543        <seealso/>
1544      </element>
1545      <!-- function result Visibility: default -->
1546      <element name="TActionLink.IsHelpLinked.Result">
1547        <short/>
1548      </element>
1549      <!-- function Visibility: public -->
1550      <element name="TActionLink.IsHintLinked">
1551        <short>Is the action's <var>Hint</var> property linked to the client?</short>
1552        <descr/>
1553        <errors/>
1554        <seealso/>
1555      </element>
1556      <!-- function result Visibility: default -->
1557      <element name="TActionLink.IsHintLinked.Result">
1558        <short/>
1559      </element>
1560      <!-- function Visibility: public -->
1561      <element name="TActionLink.IsImageIndexLinked">
1562        <short>Is the action's <var>ImageIndex </var>property linked to the client?</short>
1563        <descr/>
1564        <errors/>
1565        <seealso/>
1566      </element>
1567      <!-- function result Visibility: default -->
1568      <element name="TActionLink.IsImageIndexLinked.Result">
1569        <short/>
1570      </element>
1571      <!-- function Visibility: public -->
1572      <element name="TActionLink.IsShortCutLinked">
1573        <short>Is the action's <var>ShortCut</var> property linked to the client?</short>
1574        <descr/>
1575        <errors/>
1576        <seealso/>
1577      </element>
1578      <!-- function result Visibility: default -->
1579      <element name="TActionLink.IsShortCutLinked.Result">
1580        <short/>
1581      </element>
1582      <!-- function Visibility: public -->
1583      <element name="TActionLink.IsVisibleLinked">
1584        <short>Is the action's <var>Visible</var> property linked to the client?</short>
1585        <descr/>
1586        <errors/>
1587        <seealso/>
1588      </element>
1589      <!-- function result Visibility: default -->
1590      <element name="TActionLink.IsVisibleLinked.Result">
1591        <short/>
1592      </element>
1593      <!-- "class of" type Visibility: default -->
1594      <element name="TActionLinkClass">
1595        <short>
1596          <var>TActionLinkClass</var> - class of <var>TActionLink</var>
1597        </short>
1598        <descr/>
1599        <seealso/>
1600      </element>
1601      <!-- procedure type Visibility: default -->
1602      <element name="TEnumActionProc">
1603        <short/>
1604        <descr/>
1605        <seealso/>
1606      </element>
1607      <!-- argument Visibility: default -->
1608      <element name="TEnumActionProc.Category">
1609        <short/>
1610      </element>
1611      <!-- argument Visibility: default -->
1612      <element name="TEnumActionProc.ActionClass">
1613        <short/>
1614      </element>
1615      <!-- argument Visibility: default -->
1616      <element name="TEnumActionProc.Info">
1617        <short/>
1618      </element>
1619      <!-- procedure Visibility: default -->
1620      <element name="RegisterActions">
1621        <short/>
1622        <descr/>
1623        <errors/>
1624        <seealso/>
1625      </element>
1626      <!-- argument Visibility: default -->
1627      <element name="RegisterActions.CategoryName">
1628        <short/>
1629      </element>
1630      <!-- argument Visibility: default -->
1631      <element name="RegisterActions.AClasses">
1632        <short/>
1633      </element>
1634      <!-- argument Visibility: default -->
1635      <element name="RegisterActions.Resource">
1636        <short/>
1637      </element>
1638      <!-- procedure Visibility: default -->
1639      <element name="UnRegisterActions">
1640        <short/>
1641        <descr/>
1642        <errors/>
1643        <seealso/>
1644      </element>
1645      <!-- argument Visibility: default -->
1646      <element name="UnRegisterActions.AClasses">
1647        <short/>
1648      </element>
1649      <!-- procedure Visibility: default -->
1650      <element name="EnumRegisteredActions">
1651        <short/>
1652        <descr/>
1653        <errors/>
1654        <seealso/>
1655      </element>
1656      <!-- argument Visibility: default -->
1657      <element name="EnumRegisteredActions.Proc">
1658        <short/>
1659      </element>
1660      <!-- argument Visibility: default -->
1661      <element name="EnumRegisteredActions.Info">
1662        <short/>
1663      </element>
1664      <!-- function Visibility: default -->
1665      <element name="CreateAction">
1666        <short/>
1667        <descr/>
1668        <errors/>
1669        <seealso/>
1670      </element>
1671      <!-- function result Visibility: default -->
1672      <element name="CreateAction.Result">
1673        <short/>
1674      </element>
1675      <!-- argument Visibility: default -->
1676      <element name="CreateAction.TheOwner">
1677        <short/>
1678      </element>
1679      <!-- argument Visibility: default -->
1680      <element name="CreateAction.ActionClass">
1681        <short/>
1682      </element>
1683      <!-- constant Visibility: default -->
1684      <element name="RegisterActionsProc">
1685        <short/>
1686        <descr/>
1687        <seealso/>
1688      </element>
1689      <!-- argument Visibility: default -->
1690      <element name="CategoryName">
1691        <short/>
1692      </element>
1693      <!-- argument Visibility: default -->
1694      <element name="Resource">
1695        <short/>
1696      </element>
1697      <!-- constant Visibility: default -->
1698      <element name="UnRegisterActionsProc">
1699        <short/>
1700        <descr/>
1701        <seealso/>
1702      </element>
1703      <!-- argument Visibility: default -->
1704      <element name="AClasses">
1705        <short/>
1706      </element>
1707      <!-- constant Visibility: default -->
1708      <element name="EnumRegisteredActionsProc">
1709        <short/>
1710        <descr/>
1711        <seealso/>
1712      </element>
1713      <!-- argument Visibility: default -->
1714      <element name="Proc">
1715        <short/>
1716      </element>
1717      <!-- argument Visibility: default -->
1718      <element name="Info">
1719        <short/>
1720      </element>
1721      <!-- constant Visibility: default -->
1722      <element name="CreateActionProc">
1723        <short/>
1724        <descr/>
1725        <seealso/>
1726      </element>
1727      <!-- function result Visibility: default -->
1728      <element name="Result">
1729        <short/>
1730      </element>
1731      <!-- argument Visibility: default -->
1732      <element name="TheOwner">
1733        <short/>
1734      </element>
1735      <!-- argument Visibility: default -->
1736      <element name="ActionClass">
1737        <short/>
1738      </element>
1739      <!-- variable Visibility: default -->
1740      <element name="ApplicationActionComponent">
1741        <short/>
1742        <descr/>
1743        <seealso/>
1744      </element>
1745      <!-- procedure Visibility: default -->
1746      <element name="Register">
1747        <short/>
1748        <descr/>
1749        <errors/>
1750        <seealso/>
1751      </element>
1752      <element name="TCustomActionList.IsShortCut">
1753        <short>This action is associated with a shortcut</short>
1754      </element>
1755      <element name="TAction.DisableIfNoHandler" link="#LCL.ActnList.TCustomAction.DisableIfNoHandler"/>
1756    </module>
1757    <!-- ActnList -->
1758  </package>
1759</fpdoc-descriptions>