1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
StdActns
====================================================================
-->
<module name="StdActns">
<short>
Defines standard actions to be used in Action Lists in the LCL.
</short>
<descr>
<p>
<file>stdactns.pas</file> contains <var>TAction</var> descendents
which can be used in <var>TActionList</var> for common actions
performed using controls. This file is part of the Lazarus Component
Library (<b>LCL</b>).
</p>
<p>
The following components are registered but not displayed on the
Lazarus IDE component palette:
</p>
<p>
<b>Edit</b> Actions
</p>
<ul>
<li>TEditCut</li>
<li>TEditCopy</li>
<li>TEditPaste</li>
<li>TEditSelectAll</li>
<li>TEditUndo</li>
<li>TEditDelete</li>
</ul>
<p>
<b>Search</b> Actions
</p>
<ul>
<li>TSearchFind</li>
<li>TSearchReplace</li>
<li>TSearchFindFirst</li>
<li>TSearchFindNext</li>
</ul>
<p>
<b>Help</b> Actions
</p>
<ul>
<li>THelpAction</li>
<li>THelpContents</li>
<li>THelpTopicSearch</li>
<li>THelpOnHelp</li>
<li>THelpContextAction</li>
</ul>
<p>
<b>Dialog</b> Actions
</p>
<ul>
<li>TFontEdit</li>
<li>TColorSelect</li>
</ul>
<p>
<b>File</b> Actions
</p>
<ul>
<li>TFileOpen</li>
<li>TFileOpenWith</li>
<li>TFileSaveAs</li>
<li>TFileExit</li>
</ul>
</descr>
<!-- unresolved references -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="ActnList"/>
<element name="Forms"/>
<element name="Dialogs"/>
<element name="StdCtrls"/>
<element name="Clipbrd"/>
<element name="THintAction">
<short>
<var>THintAction</var> - standard action for dealing with requests
for a <var>Hint</var>.
</short>
<descr/>
<seealso>
<link id="#lcl.forms.TCustomHintAction">TCustomHintAction</link>
</seealso>
</element>
<element name="TEditAction">
<short>The base class for standard editing actions applied to an edit control.</short>
<descr>
<p>
<var>TEditAction</var> is a <var>TAction</var> descendant which defines the base class for standard editing actions applied to an edit control. It provides a <var>Control</var> property with the <var>TCustomEdit</var> control where the action is applied. It provides an overridden <var>HandlesTarget</var> method to determine if the action can be applied to a specified control.
</p>
<p>
Do not create instances of TEditAction. Use one of the descendent classes that implement <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods, like:
</p>
<ul>
<li>TEditCut</li>
<li>TEditCopy</li>
<li>TEditPaste</li>
<li>TEditUndo</li>
<li>TEditSelectAll</li>
<li>TEditDelete</li>
</ul>
</descr>
<seealso>
<link id="#lcl.actnlist.TAction">TAction</link>
<link id="#lcl.actnlist.TCustomAction">TCustomAction</link>
<link id="#lcl.actnlist.TContainedAction">TContainedAction</link>
<link id="#rtl.classes.TBasicAction">TBasicAction</link>
</seealso>
</element>
<element name="TEditAction.FControl">
<short>Member with the edit control for the editing action.</short>
</element>
<element name="TEditAction.SetControl">
<short>Sets the value for the Control property.</short>
<descr/>
<seealso>
<link id="TEditAction.Control"/>
</seealso>
</element>
<element name="TEditAction.SetControl.AValue">
<short>New value for the Control property.</short>
</element>
<element name="TEditAction.Notification">
<short>
Handles the notification performed when a component is added to or removed from the class instance.
</short>
<descr>
<p>
Calls the inherited method on entry. Ensures that the value in the <var>Control</var> member is set to <b>Nil</b> when the component is removed from the class instance.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
</seealso>
</element>
<element name="TEditAction.Notification.AComponent">
<short>Component for the notification.</short>
</element>
<element name="TEditAction.Notification.Operation">
<short>Operation performed for the component.</short>
</element>
<element name="TEditAction.Destroy">
<short>Destructor for the class instance.</short>
<descr/>
<seealso>
<link id="#rtl.classes.TBasicAction.Destroy">TBasicAction.Destroy</link>
</seealso>
</element>
<element name="TEditAction.HandlesTarget">
<short>
Indicates if the editing action can be used for the specified target control.
</short>
<descr>
<p>
<var>HandlesTarget</var> is a <var>Boolean</var> function which indicates if the editing action can be applied to the object in Target. The return value is <b>True</b> when:
</p>
<ul>
<li>Target has been assigned.</li>
<li>Control and Target are the same object instance, or...</li>
<li>Control is unassigned, and Target is a TCustomEdit descendant.</li>
</ul>
</descr>
<seealso>
<link id="#rtl.classes.TBasicAction.HandlesTarget">TBasicAction.HandlesTarget</link>
</seealso>
</element>
<element name="TEditAction.HandlesTarget.Result">
<short>True when the action can be applied to the target.</short>
</element>
<element name="TEditAction.HandlesTarget.Target">
<short>Object instance with the target control for the action.</short>
</element>
<element name="TEditAction.Control">
<short>The edit control associated with this action.</short>
<descr>
<p>
<var>Control</var> is a <var>TCustomEdit</var> property with the control for the standard editing action. Control limits the target for the action to a specific control. Setting a new value for the property causes a free notification to be added or removed as needed for the new property value.
</p>
</descr>
<seealso>
<link id="TEditAction.Notification"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
<link id="#rtl.classes.TComponent.FreeNotification">TComponent.FreeNotification</link>
<link id="#rtl.classes.TComponent.RemoveFreeNotification">TComponent.RemoveFreeNotification</link>
</seealso>
</element>
<element name="TEditCut">
<short>
Editing action used to cut the selected value in a control to the clipboard.
</short>
<descr>
<p>
<var>TEditCut</var> is a <var>TEditAction</var> descendant which performs a cut to clipboard editing action for a <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
</p>
</descr>
<seealso>
<link id="TEditAction"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
</element>
<element name="TEditCut.ExecuteTarget">
<short>Executes the action for the specified target control.</short>
<descr>
<p>
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
</p>
<p>
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>CutToClipboard</var> method is called to perform the editing action.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.CutToClipboard">TCustomEdit.CutToClipboard</link>
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
</seealso>
</element>
<element name="TEditCut.ExecuteTarget.Target">
<short>Object where the editing action is applied.</short>
</element>
<element name="TEditCut.UpdateTarget">
<short>Updates the enabled state for the action.</short>
<descr>
<p>
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
</p>
<p>
Target is the object instance examined in the method. It is cast to the <var>TCustomEdit</var> type used in the <var>Control</var> property. The <var>Enabled</var> property is set to <b>True</b> when the control in Target has an active text selection (<var>SelLength</var> is not 0).
</p>
<p>
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
</p>
</descr>
<seealso>
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
</seealso>
</element>
<element name="TEditCut.UpdateTarget.Target">
<short>Object instance with the values examined in the method.</short>
</element>
<element name="TEditCopy">
<short>
Editing action used to copy the selected value in a control to the clipboard.
</short>
<descr>
<p>
<var>TEditCopy</var> is a <var>TEditAction</var> descendant which performs a copy to clipboard editing action for the selected value in a <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
</p>
</descr>
<seealso>
<link id="TEditAction"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
</element>
<element name="TEditCopy.ExecuteTarget">
<short>Executes the action for the specified target control.</short>
<descr>
<p>
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
</p>
<p>
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>CopyToClipboard</var> method is called to perform the editing action.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.CopyToClipboard">TCustomEdit.CopyToClipboard</link>
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
</seealso>
</element>
<element name="TEditCopy.ExecuteTarget.Target">
<short>Object where the editing action is applied.</short>
</element>
<element name="TEditCopy.UpdateTarget">
<short>Updates the enabled state for the action.</short>
<descr>
<p>
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
</p>
<p>
Target is the object instance examined in the method. It is cast to the <var>TCustomEdit</var> type used in the <var>Control</var> property. The <var>Enabled</var> property is set to <b>True</b> when the control in Target has an active text selection (<var>SelLength</var> is not 0).
</p>
<p>
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
</p>
</descr>
<seealso>
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
</seealso>
</element>
<element name="TEditCopy.UpdateTarget.Target">
<short>Object instance with the values examined in the method.</short>
</element>
<element name="TEditPaste">
<short>
Editing action used to paste values from the clipboard into the specified control.
</short>
<descr>
<p>
<var>TEditPaste</var> is a <var>TEditAction</var> descendant which copies the contents of the clipboard editing action into the specified <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
</p>
</descr>
<seealso>
<link id="TEditAction"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
</element>
<element name="TEditPaste.UpdateTarget">
<short>Updates the enabled state for the action.</short>
<descr>
<p>
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
</p>
<p>
UpdateTarget sets the value in Enabled to True when values in the Clipboard includes the CF_TEXT content format.
</p>
<p>
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
</p>
</descr>
<seealso>
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
<link id="#lcl.clipbrd.Clipboard">Clipboard</link>
<link id="#lcl.clipbrd.TClipboard.HasFormat">TClipboard.HasFormat</link>
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
</seealso>
</element>
<element name="TEditPaste.UpdateTarget.Target">
<short>Object instance with values examined in the method.</short>
</element>
<element name="TEditPaste.ExecuteTarget">
<short>Executes the action for the specified target control.</short>
<descr>
<p>
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
</p>
<p>
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>PasteFromClipboard</var> method is called to perform the editing action.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.CopyToClipboard">TCustomEdit.PasteFromClipboard</link>
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
</seealso>
</element>
<element name="TEditPaste.ExecuteTarget.Target">
<short>Object instance where the editing action is applied.</short>
</element>
<element name="TEditSelectAll">
<short>
Editing action used to select all of the content in the value for the specified control.
</short>
<descr>
<p>
<var>TEditSelectAll</var> is a <var>TEditAction</var> descendant which selects all of the content in the value for the specified <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
</p>
</descr>
<seealso>
<link id="TEditAction"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
</element>
<element name="TEditSelectAll.ExecuteTarget">
<short>Executes the action for the specified target control.</short>
<descr>
<p>
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
</p>
<p>
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>SelectAll</var> method is called to perform the editing action.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.SelectAll">TCustomEdit.SelectAll</link>
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
</seealso>
</element>
<element name="TEditSelectAll.ExecuteTarget.Target">
<short>Object instance where the editing action is applied.</short>
</element>
<element name="TEditSelectAll.UpdateTarget">
<short>Updates the enabled state for the action.</short>
<descr>
<p>
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
</p>
<p>
Target is the object instance with values examined in the method. It is cast to the TCustomEdit type used in the Control property, and its Text property is checked for an existing text value. UpdateTarget sets the value in Enabled to True when Text is not an empty string ('').
</p>
<p>
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
</p>
</descr>
<seealso>
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
<link id="#lcl.stdctrls.TCustomEdit.Text">TCustomEdit.Text</link>
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
</seealso>
</element>
<element name="TEditSelectAll.UpdateTarget.Target">
<short>Object instance with values examined in the method.</short>
</element>
<element name="TEditUndo">
<short>
Editing action used to Undo the previous change to the value for the specified control.
</short>
<descr>
<p>
<var>TEditUndo</var> is a <var>TEditAction</var> descendant which reverses the previous change to the value for the specified <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
</p>
</descr>
<seealso>
<link id="TEditAction"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
</element>
<element name="TEditUndo.ExecuteTarget">
<short>Executes the action for the specified target control.</short>
<descr>
<p>
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
</p>
<p>
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>Undo</var> method is called to perform the editing action.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.Undo">TCustomEdit.Undo</link>
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
</seealso>
</element>
<element name="TEditUndo.ExecuteTarget.Target">
<short>Object instance where the editing action is applied.</short>
</element>
<element name="TEditUndo.UpdateTarget">
<short>Updates the enabled state for the action.</short>
<descr>
<p>
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
</p>
<p>
Target is the object instance with values examined in the method. It is cast to the TCustomEdit type used in the Control property, and its CanUndo method is called to get the value assigned to the Enabled property.
</p>
<p>
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
</p>
</descr>
<seealso>
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
<link id="#lcl.stdctrls.TCustomEdit.CanUndo">TCustomEdit.CanUndo</link>
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
</seealso>
</element>
<element name="TEditUndo.UpdateTarget.Target">
<short>Object instance with the values examined in the method.</short>
</element>
<element name="TEditDelete">
<short>
Editing action used to remove the current selection in the specified control.
</short>
<descr>
<p>
<var>TEditDelete</var> is a <var>TEditAction</var> descendant which removes the current selected text for the specified <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
</p>
</descr>
<seealso>
<link id="TEditAction"/>
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
</seealso>
</element>
<element name="TEditDelete.ExecuteTarget">
<short>Executes the action for the specified target control.</short>
<descr>
<p>
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
</p>
<p>
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>ClearSelection</var> method is called to perform the editing action.
</p>
</descr>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.ClearSelection">TCustomEdit.ClearSelection</link>
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
</seealso>
</element>
<element name="TEditDelete.ExecuteTarget.Target">
<short>Object instance where the editing action is applied.</short>
</element>
<element name="TEditDelete.UpdateTarget">
<short>Updates the enabled state for the action.</short>
<descr>
<p>
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
</p>
<p>
Target is the object instance with values examined in the method. It is cast to the TCustomEdit type used in the Control property, and sets Enabled to True when text is currently selected in the control.
</p>
<p>
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
</p>
</descr>
<seealso>
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
<link id="#lcl.stdctrls.TCustomEdit.SelLength">TCustomEdit.SelLength</link>
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
</seealso>
</element>
<element name="TEditDelete.UpdateTarget.Target">
<short>Object instance with values examined in the method.</short>
</element>
<element name="THelpAction">
<short>
The base class for standard help actions.
</short>
<descr>
<p>
<var>THelpAction</var> is a <var>TAction</var> descendant which implements the base class for help actions. It is used as the ancestor for classes including: THelpContents, THelpTopicSearch, THelpOnHelp , and THelpContextAction.
</p>
</descr>
<seealso>
<link id="THelpContents"/>
<link id="THelpTopicSearch"/>
<link id="THelpOnHelp"/>
<link id="THelpContextAction"/>
<link id="#lcl.actnlist.TAction">TAction</link>
</seealso>
</element>
<element name="THelpAction.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Calls the inherited constructor.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TBasicAction.Create">TBasicAction.Create</link>
</seealso>
</element>
<element name="THelpAction.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="THelpAction.HandlesTarget">
<short>Determines whether the help action can be applied to the Target control.</short>
<descr>
<p>
Calls the inherited method.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TBasicAction.HandlesTarget">TBasicAction.HandlesTarget</link>
</seealso>
</element>
<element name="THelpAction.HandlesTarget.Result">
<short>True if the action can be applied to the target control.</short>
</element>
<element name="THelpAction.HandlesTarget.Target">
<short>Object instance with the control examined in the method.</short>
</element>
<element name="THelpAction.UpdateTarget">
<short>
Updates the enabled state for the action using values in the target control.
</short>
<descr>
<p>
Calls the inherited method.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
</seealso>
</element>
<element name="THelpAction.UpdateTarget.Target">
<short>Object instance with values examined in the method.</short>
</element>
<element name="THelpContents">
<short>
Help action used to display a Table of Contents for the HelpContext.
</short>
<descr/>
<seealso/>
</element>
<element name="THelpContents.ExecuteTarget">
<short>Executes the help action for the HelpContext.</short>
<descr>
<p>
Calls the inherited method.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.ExecuteTarget</link>
</seealso>
</element>
<element name="THelpContents.ExecuteTarget.Target">
<short>Object instance with the context for the help action.</short>
</element>
<element name="THelpTopicSearch">
<short>
Help action used to search for a help topic.
</short>
<descr>
</descr>
<seealso/>
</element>
<element name="THelpTopicSearch.ExecuteTarget">
<short>Executes the help action for the help context.</short>
<descr/>
<seealso/>
</element>
<element name="THelpTopicSearch.ExecuteTarget.Target">
<short>Object instance with the help context.</short>
</element>
<element name="THelpOnHelp">
<short>
Help action used to display the Help on Help topic, or "How to Get Help".
</short>
<descr/>
<seealso/>
</element>
<element name="THelpOnHelp.ExecuteTarget">
<short>Executes the help action.</short>
<descr/>
<seealso/>
</element>
<element name="THelpOnHelp.ExecuteTarget.Target">
<short/>
</element>
<element name="THelpContextAction">
<short>
Help action used to get help for a specific help context.
</short>
<descr/>
<seealso/>
</element>
<element name="THelpContextAction.ExecuteTarget">
<short>Executes the help action.</short>
<descr/>
<seealso/>
</element>
<element name="THelpContextAction.ExecuteTarget.Target">
<short/>
</element>
<element name="THelpContextAction.UpdateTarget">
<short>Updates the enabled state for the help action.</short>
<descr/>
<seealso/>
</element>
<element name="THelpContextAction.UpdateTarget.Target">
<short/>
</element>
<element name="TCommonDialogClass">
<short>
Class reference for the TCommonDialog type.
</short>
<descr>
<p>
Contains the class reference used to create new dialog instances in TCommonDialogAction. TCommonDialogClass is the type returned from the GetDialogClass method in TCommonDialogAction.
</p>
</descr>
<seealso/>
</element>
<element name="TCommonDialogAction">
<short>
Dialog action used to create, configure, and display a dialog.
</short>
<descr/>
<seealso>
<link id="#lcl.actnlist.TCustomAction">TCustomAction</link>
</seealso>
</element>
<element name="TCommonDialogAction.FBeforeExecute"/>
<element name="TCommonDialogAction.FExecuteResult"/>
<element name="TCommonDialogAction.FOnAccept"/>
<element name="TCommonDialogAction.FOnCancel"/>
<element name="TCommonDialogAction.FDialog">
<short>
<var>FDialog</var> - local variable holding the Dialog associated
with this action.
</short>
</element>
<element name="TCommonDialogAction.DoAccept">
<short>
<var>DoAccept</var> - perform the code for the
<var>OnAccept</var> event.
</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.DoBeforeExecute">
<short>Performs the BeforeExecute notification when assigned.</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.DoCancel">
<short>
<var>DoCancel</var> - perform the code for the
<var>OnCancel</var> event.
</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.GetDialogClass">
<short>
<var>GetDialogClass</var> - returns the class type for the dialog
associated with this action.
</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.GetDialogClass.Result">
<short/>
</element>
<element name="TCommonDialogAction.CreateDialog">
<short>
Create a new instance of the class type used in the Dialog property.
</short>
<descr>
<p>
Calls GetDialogClass to get the class reference used to create the dialog instance. When assigned, it is created and stored in the Dialog property. It Name is set to the ClassName for the class reference, and it is marked as a sub-component for the class instance.
</p>
</descr>
<seealso/>
</element>
<element name="TCommonDialogAction.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method on entry. Create calls <var>CreateDialog</var> to create and configure a new instance of the dialog class type used in the implementation. It sets the value in <var>Enabled</var> to <b>True</b>.
</p>
</descr>
<seealso>
<link id="TCommonDialogAction.CreateDialog"/>
<link id="TCommonDialogAction.GetDialogClass"/>
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
<link id="#rtl.classes.TBasicAction.Create">TBasicAction.Create</link>
</seealso>
</element>
<element name="TCommonDialogAction.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TCommonDialogAction.HandlesTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.Handlestarget.Result">
<short/>
</element>
<element name="TCommonDialogAction.Handlestarget.Target">
<short/>
</element>
<element name="TCommonDialogAction.ExecuteTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.ExecuteTarget.Target">
<short/>
</element>
<element name="TCommonDialogAction.ExecuteResult">
<short>
<var>ExecuteResult</var> - the result of the execution:
True if successful.
</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.BeforeExecute">
<short>
<var>BeforeExecute</var> - event handler for performance before
execution of the action.
</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.OnAccept">
<short>
<var>OnAccept</var> - event handler for a press of the Accept button.
</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.OnCancel">
<short>
<var>OnCancel</var> - event handler for a press of the Cancel button.
</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.OnUpdate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileAction">
<short>
<var>TFileAction</var> - base class for providing actions associated
with various file dialogs and menu options.
</short>
<descr/>
<seealso>
<link id="TCommonDialogAction"/>
</seealso>
</element>
<element name="TFileAction.GetFileName">
<short>
Gets the value for the FileName property.
</short>
<descr/>
<seealso>
<link id="TFileAction.FileName"/>
</seealso>
</element>
<element name="TFileAction.GetFileName.Result">
<short>Value for the property.</short>
</element>
<element name="TFileAction.SetFileName">
<short>
Sets the value for the FileName property.
</short>
<descr/>
<seealso>
<link id="TFileAction.FileName"/>
</seealso>
</element>
<element name="TFileAction.SetFileName.AValue">
<short>New value for the property.</short>
</element>
<element name="TFileAction.GetDialog">
<short>
<var>GetDialog</var> - returns a <var>TOpenDialog</var> for use in
this File action.
</short>
<descr/>
<seealso>
<link id="#lcl.dialogs.TOpenDialog">TOpenDialog</link>
</seealso>
</element>
<element name="TFileAction.GetDialog.Result">
<short>TOpenDialog instance used in the class.</short>
</element>
<element name="TFileAction.FileName">
<short>
File name returned from the dialog in the action.
</short>
<descr>
<p>
<var>FileName</var> is a <var>TFileName</var> property with the
file name returned in the Open dialog for the action.
</p>
</descr>
<seealso>
<link id="TFileAction.GetDialog"/>
</seealso>
</element>
<element name="TFileOpen">
<short>
<var>TFileOpen</var> - standard action (including opening a dialog)
associated with the <var>File Open</var> menu option.
</short>
<descr/>
<seealso>
<link id="TFileAction"/>
</seealso>
</element>
<element name="TFileOpen.FUseDefaultApp"/>
<element name="TFileOpen.GetDialog">
<short>
Gets the value for the Dialog property.
</short>
<descr/>
<seealso>
<link id="TFileOpen.Dialog"/>
</seealso>
</element>
<element name="TFileOpen.GetDialog.Result">
<short>Value for the property.</short>
</element>
<element name="TFileOpen.GetDialogClass">
<short>
Gets the class reference used to create the Dialog for the action.
</short>
<descr/>
<seealso>
<link id="TFileOpen.Dialog"/>
<link id="TCommonDialogClass"/>
<link id="TCommonDialogAction.GetDialogClass"/>
</seealso>
</element>
<element name="TFileOpen.GetDialogClass.Result">
<short>TCommonDialogClass reference used to create the Dialog.</short>
</element>
<element name="TFileOpen.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TFileOpen.Dialog">
<short>The Open <var>Dialog</var> to be used with this action.</short>
<descr>
<p>
<var>Dialog</var> is a read-only <var>TOpenDialog</var> property
with the dialog used to select a file for the File Open action.
</p>
</descr>
<seealso>
<link id="TFileAction.FileName"/>
</seealso>
</element>
<element name="TFileOpen.Enabled" link="#lcl.actnlist.TCustomAction.Enabled"/>
<element name="TFileOpen.HelpContext" link="#lcl.actnlist.TCustomAction.HelpContext"/>
<element name="TFileOpen.HelpKeyword" link="#lcl.actnlist.TCustomAction.HelpKeyword"/>
<element name="TFileOpen.HelpType" link="#lcl.actnlist.TCustomAction.HelpType"/>
<element name="TFileOpen.Hint" link="#lcl.actnlist.TCustomAction.Hint"/>
<element name="TFileOpen.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TFileOpen.ShortCut" link="#lcl.actnlist.TCustomAction.ShortCut"/>
<element name="TFileOpen.SecondaryShortCuts" link="#lcl.actnlist.TCustomAction.SecondaryShortCuts"/>
<element name="TFileOpen.UseDefaultApp">
<short>
Indicates if the default application should be used to open the
file for the action.
</short>
<descr>
<p>
<var>UseDefaultApp</var> is a <var>Boolean</var> property which
indicates if the default application should be used to open the
selected <var>FileName</var>. The default value for the property is
<b>False</b>.
</p>
<remark>
UseDefaultApp is not used in the current LCL version.
</remark>
</descr>
<seealso>
<link id="TFileAction.FileName"/>
</seealso>
</element>
<element name="TFileOpen.Visible" link="#lcl.actnlist.TCustomAction.Visible"/>
<element name="TFileOpen.BeforeExecute" link="#lcl.stdactns.TCommonDialogAction.BeforeExecute"/>
<element name="TFileOpen.OnAccept" link="#lcl.stdactns.TCommonDialogAction.OnAccept"/>
<element name="TFileOpen.OnCancel" link="#lcl.stdactns.TCommonDialogAction.OnCancel"/>
<element name="TFileOpen.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="TFileOpenWith">
<short>
<var>TFileOpenWith</var> - standard action (including opening a
dialog) associated with the <var>File Open With</var> menu option.
</short>
<descr>
<p>
<var>TFileOpenWith</var> is a standard action (including opening a
dialog) associated with the <var>File Open With</var> menu option.
Gives the User an opportunity to choose the application with which
to open a file.
</p>
</descr>
<seealso>
<link id="TFileOpen"/>
</seealso>
</element>
<element name="TFileOpenWith.FAfterOpen"/>
<element name="TFileOpenWith.FFileName"/>
<element name="TFileOpenWith.FileName">
<short>File name for the Open With action.</short>
<descr>
<var>FileName</var> is a <var>TFileName</var> property with the
file name used in the Open With action.
</descr>
<seealso/>
</element>
<element name="TFileOpenWith.AfterOpen">
<short>
<var>AfterOpen</var> - event handler to be performed after file
is opened.
</short>
<descr/>
<seealso/>
</element>
<element name="TFileSaveAs">
<short>
<var>TFileSaveAs</var> - standard action (including opening a dialog)
associated with the <var>File Save As</var> menu option.
</short>
<descr>
<p>
<var>TFileSaveAs</var> is a standard action (including opening a
dialog) associated with the <var>File Save As</var> menu option.
Gives the user an opportunity to select or enter a name to use for
saving the file.
</p>
</descr>
<seealso>
<link id="TFileAction"/>
</seealso>
</element>
<element name="TFileSaveAs.GetSaveDialog">
<short>Gets the value for the Dialog property.</short>
<descr/>
<seealso>
<link id="TFileSaveAs.Dialog"/>
</seealso>
</element>
<element name="TFileSaveAs.GetSaveDialog.Result">
<short>Value for the Dialog property.</short>
</element>
<element name="TFileSaveAs.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileSaveAs.GetDialogClass.Result">
<short/>
</element>
<element name="TFileSaveAs.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TFileSaveAs.Dialog">
<short>The Save <var>Dialog</var> to be used with this action.</short>
<descr/>
<seealso/>
</element>
<element name="TFileSaveAs.Enabled" link="#lcl.actnlist.TCustomAction.Enabled"/>
<element name="TFileSaveAs.HelpContext" link="#lcl.actnlist.TCustomAction.HelpContext"/>
<element name="TFileSaveAs.Hint" link="#lcl.actnlist.TCustomAction.Hint"/>
<element name="TFileSaveAs.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TFileSaveAs.ShortCut" link="#lcl.actnlist.TCustomAction.ShortCut"/>
<element name="TFileSaveAs.SecondaryShortCuts" link="#lcl.actnlist.TCustomAction.SecondaryShortCuts"/>
<element name="TFileSaveAs.Visible" link="#lcl.actnlist.TCustomAction.Visible"/>
<element name="TFileSaveAs.BeforeExecute" link="#lcl.stdactns.TCommonDialogAction.BeforeExecute"/>
<element name="TFileSaveAs.OnAccept" link="#lcl.stdactns.TCommonDialogAction.OnAccept"/>
<element name="TFileSaveAs.OnCancel" link="#lcl.stdactns.TCommonDialogAction.OnCancel"/>
<element name="TFileSaveAs.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="TFileExit">
<short>
<var>TFileExit</var> - standard action (closing file and terminating
application) associated with the <var>File Exit</var> menu option.
</short>
<descr/>
<seealso>
<link id="#lcl.actnlist.TCustomAction">TCustomAction</link>
</seealso>
</element>
<element name="TFileExit.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileExit.HandlesTarget.Result">
<short/>
</element>
<element name="TFileExit.HandlesTarget.Target">
<short/>
</element>
<element name="TFileExit.ExecuteTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFileExit.ExecuteTarget.Target">
<short/>
</element>
<element name="TFileExit.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TFileExit.Enabled" link="#lcl.actnlist.TCustomAction.Enabled"/>
<element name="TFileExit.HelpContext" link="#lcl.actnlist.TCustomAction.HelpContext"/>
<element name="TFileExit.HelpKeyword" link="#lcl.actnlist.TCustomAction.HelpKeyword"/>
<element name="TFileExit.HelpType" link="#lcl.actnlist.TCustomAction.HelpType"/>
<element name="TFileExit.Hint" link="#lcl.actnlist.TCustomAction.Hint"/>
<element name="TFileExit.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TFileExit.ShortCut" link="#lcl.actnlist.TCustomAction.ShortCut"/>
<element name="TFileExit.SecondaryShortCuts" link="#lcl.actnlist.TCustomAction.SecondaryShortCuts"/>
<element name="TFileExit.Visible" link="#lcl.actnlist.TCustomAction.Visible"/>
<element name="TFileExit.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="TSearchAction">
<short>
<var>TSearchAction</var> - base class for the actions associated
with the various <var>Search</var> menu options.
</short>
<descr/>
<seealso>
<link id="TCommonDialogAction"/>
</seealso>
</element>
<element name="TSearchAction.FControl">
<short>
<var>FControl</var> - local variable holding the control for
use with this action.
</short>
</element>
<element name="TSearchAction.CreateDialog">
<short>Creates the class instance used in the Dialog property.</short>
<descr>
<p>
Calls the inherited CreateDialog method, and assigns the Search
method as the OnFind event handler in Dialog.
</p>
</descr>
<seealso/>
</element>
<element name="TSearchAction.Notification">
<short>
Handles notifications when a control in the class instance is added
or removed.
</short>
<descr/>
<seealso>
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
</seealso>
</element>
<element name="TSearchAction.Notification.AComponent">
<short>Component for the notification.</short>
</element>
<element name="TSearchAction.Notification.Operation">
<short>Operation for the notification.</short>
</element>
<element name="TSearchAction.UpdateControl">
<short>
Updates the internal Control to the value in NewControl.
</short>
<descr/>
<seealso/>
</element>
<element name="TSearchAction.UpdateControl.NewControl">
<short>New value for the internal Control.</short>
</element>
<element name="TSearchAction.PerformSearch">
<short>Performs the search action using the Dialog options.</short>
<descr>
<p>
Performs the search action using the options and search criteria
set in the <var>Dialog</var> property. Called from the
<var>Search</var> method.
</p>
</descr>
<seealso/>
</element>
<element name="TSearchAction.PerformSearch.Result">
<short>
True when the search value is found in the text for the
internal Control.
</short>
</element>
<element name="TSearchAction.ShowNotFound">
<short>Displays a dialog with a "Not Found" message.</short>
<descr/>
<seealso/>
</element>
<element name="TSearchAction.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Calls the inherited constructor, and sets the value for the internal Control to <b>Nil</b>.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TBasicAction.Create">TBasicAction.Create</link>
</seealso>
</element>
<element name="TSearchAction.Create.TheOwner">
<short>Owner for the class instance.</short>
</element>
<element name="TSearchAction.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
Removes the free notification for the internal Control (when assigned), and calls the inherited destructor.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TBasicAction.Destroy">TBasicAction.Destroy</link>
</seealso>
</element>
<element name="TSearchAction.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget"/>
<element name="TSearchAction.HandlesTarget.Result"/>
<element name="TSearchAction.HandlesTarget.Target"/>
<element name="TSearchAction.Search">
<short>Performs the <var>Search</var> action.</short>
<descr/>
<seealso/>
</element>
<element name="TSearchAction.Search.Sender">
<short/>
</element>
<element name="TSearchAction.UpdateTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TSearchAction.UpdateTarget.Target"/>
<element name="TSearchAction.ExecuteTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TSearchAction.ExecuteTarget.Target"/>
<element name="TSearchFind">
<short>
<var>TSearchFind</var> - the action associated with a Search and
Find dialog (as opposed to search and replace).
</short>
<descr/>
<seealso>
<link id="TSearchAction"/>
</seealso>
</element>
<element name="TSearchFind.GetFindDialog"/>
<element name="TSearchFind.GetFindDialog.Result"/>
<element name="TSearchFind.GetDialogClass">
<short>
Gets the dialog class type.
</short>
<descr>
<p>
Returns the <var>TFindDialog</var> class type in <var>TSearchFind</var>.
</p>
</descr>
<seealso>
<link id="TCommonDialogAction.GetDialogClass"/>
</seealso>
</element>
<element name="TSearchFind.GetDialogClass.Result">
<short>Returns TFindDialog for the action.</short>
</element>
<element name="TSearchFind.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TSearchFind.Dialog">
<short>The Find<var>Dialog</var> to be used with this action.</short>
<descr/>
<seealso/>
</element>
<element name="TSearchFind.Enabled" link="#lcl.actnlist.TCustomAction.Enabled"/>
<element name="TSearchFind.HelpContext" link="#lcl.actnlist.TCustomAction.HelpContext"/>
<element name="TSearchFind.HelpKeyword" link="#lcl.actnlist.TCustomAction.HelpKeyword"/>
<element name="TSearchFind.HelpType" link="#lcl.actnlist.TCustomAction.HelpType"/>
<element name="TSearchFind.Hint" link="#lcl.actnlist.TCustomAction.Hint"/>
<element name="TSearchFind.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TSearchFind.ShortCut" link="#lcl.actnlist.TCustomAction.ShortCut"/>
<element name="TSearchFind.SecondaryShortCuts" link="#lcl.actnlist.TCustomAction.SecondaryShortCuts"/>
<element name="TSearchFind.Visible" link="#lcl.actnlist.TCustomAction.Visible"/>
<element name="TSearchFind.BeforeExecute" link="#lcl.stdactns.TCommonDialogAction.BeforeExecute"/>
<element name="TSearchFind.OnAccept" link="#lcl.stdactns.TCommonDialogAction.OnAccept"/>
<element name="TSearchFind.OnCancel" link="#lcl.stdactns.TCommonDialogAction.OnCancel"/>
<element name="TSearchFind.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="TSearchReplace">
<short>
<var>TSearchReplace</var> - action associated with the <var>Search
and Replace</var> menu option and dialogs.
</short>
<descr/>
<seealso>
<link id="TSearchAction"/>
</seealso>
</element>
<element name="TSearchReplace.GetReplaceDialog"/>
<element name="TSearchReplace.GetReplaceDialog.Result"/>
<element name="TSearchReplace.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
<short/>
<descr/>
<seealso/>
</element>
<element name="TSearchReplace.CreateDialog" link="#lcl.stdactns.TCommonDialogAction.CreateDialog"/>
<element name="TSearchReplace.Replace">
<short>
<var>Replace</var> - the method to perform the Replace action once
the specified text has been found.
</short>
<descr/>
<seealso/>
</element>
<element name="TSearchReplace.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TSearchReplace.Dialog">
<short>The Replace<var>Dialog</var> to be used with this action.</short>
<descr/>
<seealso/>
</element>
<element name="TSearchReplace.Enabled" link="#lcl.actnlist.TCustomAction.Enabled"/>
<element name="TSearchReplace.HelpContext" link="#lcl.actnlist.TCustomAction.HelpContext"/>
<element name="TSearchReplace.HelpKeyword" link="#lcl.actnlist.TCustomAction.HelpKeyword"/>
<element name="TSearchReplace.HelpType" link="#lcl.actnlist.TCustomAction.HelpType"/>
<element name="TSearchReplace.Hint" link="#lcl.actnlist.TCustomAction.Hint"/>
<element name="TSearchReplace.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TSearchReplace.ShortCut" link="#lcl.actnlist.TCustomAction.ShortCut"/>
<element name="TSearchReplace.SecondaryShortCuts" link="#lcl.actnlist.TCustomAction.SecondaryShortCuts"/>
<element name="TSearchReplace.Visible" link="#lcl.actnlist.TCustomAction.Visible"/>
<element name="TSearchReplace.BeforeExecute" link="#lcl.stdactns.TCommonDialogAction.BeforeExecute"/>
<element name="TSearchReplace.OnAccept" link="#lcl.stdactns.TCommonDialogAction.OnAccept"/>
<element name="TSearchReplace.OnCancel" link="#lcl.stdactns.TCommonDialogAction.OnCancel"/>
<element name="TSearchReplace.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="TSearchFindFirst">
<short>
<var>TSearchFindFirst</var> - Search action to find the first match.
</short>
<descr/>
<seealso>
<link id="TSearchFind"/>
</seealso>
</element>
<element name="TSearchFindNext">
<short>
<var>TSearchFindNext</var> - search action to find the next match.
</short>
<descr/>
<seealso>
<link id="TCustomAction"/>
</seealso>
</element>
<element name="TSearchFindNext.FSearchFind"/>
<element name="TSearchFindNext.SetSearchFind"/>
<element name="TSearchFindNext.SetSearchFind.AValue"/>
<element name="TSearchFindNext.Create" link="#rtl.classes.TBasicAction.Create">
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TSearchFindNext.Create.TheOwner">
<short>Owner of the class instance.</short>
</element>
<element name="TSearchFindNext.HandlesTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TSearchFindNext.HandlesTarget.Result"/>
<element name="TSearchFindNext.HandlesTarget.Target"/>
<element name="TSearchFindNext.UpdateTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TSearchFindNext.UpdateTarget.Target"/>
<element name="TSearchFindNext.ExecuteTarget">
<short/>
<descr/>
<seealso/>
</element>
<element name="TSearchFindNext.ExecuteTarget.Target"/>
<element name="TSearchFindNext.Notification">
<short>
Handles notifications when a component used in the class instance is
added or removed.
</short>
<descr/>
<seealso>
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
</seealso>
</element>
<element name="TSearchFindNext.Notification.AComponent"/>
<element name="TSearchFindNext.Notification.Operation"/>
<element name="TSearchFindNext.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TSearchFindNext.Enabled" link="#lcl.actnlist.TCustomAction.Enabled"/>
<element name="TSearchFindNext.HelpContext" link="#lcl.actnlist.TCustomAction.HelpContext"/>
<element name="TSearchFindNext.HelpKeyword" link="#lcl.actnlist.TCustomAction.HelpKeyword"/>
<element name="TSearchFindNext.HelpType" link="#lcl.actnlist.TCustomAction.HelpType"/>
<element name="TSearchFindNext.Hint" link="#lcl.actnlist.TCustomAction.Hint"/>
<element name="TSearchFindNext.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TSearchFindNext.SearchFind">
<short>The <var>SearchFind</var> action to use for searching.</short>
<descr/>
<seealso/>
</element>
<element name="TSearchFindNext.ShortCut" link="#lcl.actnlist.TCustomAction.ShortCut"/>
<element name="TSearchFindNext.SecondaryShortCuts" link="#lcl.actnlist.TCustomAction.SecondaryShortCuts"/>
<element name="TSearchFindNext.Visible" link="#lcl.actnlist.TCustomAction.Visible"/>
<element name="TSearchFindNext.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="TFontEdit">
<short>
<var>TFontEdit</var> - standard action for opening a
<var>Font Edit</var> dialog.
</short>
<descr/>
<seealso>
<link id="TCommonDialogAction"/>
</seealso>
</element>
<element name="TFontEdit.GetDialog">
<short>Gets the value for the Dialog property.</short>
<descr/>
<seealso>
<link id="TFontEdit.Dialog"/>
</seealso>
</element>
<element name="TFontEdit.GetDialog.Result">
<short>Value for the property.</short>
</element>
<element name="TFontEdit.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFontEdit.GetDialogClass.Result">
<short/>
</element>
<element name="TFontEdit.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TFontEdit.Dialog">
<short>The Font<var>Dialog</var> to use for this action.</short>
<descr/>
<seealso/>
</element>
<element name="TFontEdit.Enabled" link="#lcl.actnlist.TCustomAction.Enabled"/>
<element name="TFontEdit.HelpContext" link="#lcl.actnlist.TCustomAction.HelpContext"/>
<element name="TFontEdit.HelpKeyword" link="#lcl.actnlist.TCustomAction.HelpKeyword"/>
<element name="TFontEdit.HelpType" link="#lcl.actnlist.TCustomAction.HelpType"/>
<element name="TFontEdit.Hint" link="#lcl.actnlist.TCustomAction.Hint"/>
<element name="TFontEdit.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TFontEdit.ShortCut" link="#lcl.actnlist.TCustomAction.ShortCut"/>
<element name="TFontEdit.SecondaryShortCuts" link="#lcl.actnlist.TCustomAction.SecondaryShortCuts"/>
<element name="TFontEdit.Visible" link="#lcl.actnlist.TCustomAction.Visible"/>
<element name="TFontEdit.BeforeExecute" link="#lcl.stdactns.TCommonDialogAction.BeforeExecute"/>
<element name="TFontEdit.OnAccept" link="#lcl.stdactns.TCommonDialogAction.OnAccept"/>
<element name="TFontEdit.OnCancel" link="#lcl.stdactns.TCommonDialogAction.OnCancel"/>
<element name="TFontEdit.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="TColorSelect">
<short>
<var>TColorSelect</var> - standard action for opening a <var>Color
Selection</var> dialog.
</short>
<descr/>
<seealso>
<link id="TCommonDialogAction"/>
</seealso>
</element>
<element name="TColorSelect.GetDialog">
<short/>
<descr/>
<seealso/>
</element>
<element name="TColorSelect.GetDialog.Result">
<short/>
</element>
<element name="TColorSelect.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
<short/>
<descr/>
<seealso/>
</element>
<element name="TColorSelect.GetDialogClass.Result">
<short/>
</element>
<element name="TColorSelect.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TColorSelect.Dialog">
<short>The Color<var>Dialog</var> to use with this action.</short>
<descr/>
<seealso/>
</element>
<element name="TColorSelect.Enabled" link="#lcl.actnlist.TCustomAction.Enabled"/>
<element name="TColorSelect.HelpContext" link="#lcl.actnlist.TCustomAction.HelpContext"/>
<element name="TColorSelect.HelpKeyword" link="#lcl.actnlist.TCustomAction.HelpKeyword"/>
<element name="TColorSelect.HelpType" link="#lcl.actnlist.TCustomAction.HelpType"/>
<element name="TColorSelect.Hint" link="#lcl.actnlist.TCustomAction.Hint"/>
<element name="TColorSelect.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TColorSelect.ShortCut" link="#lcl.actnlist.TCustomAction.ShortCut"/>
<element name="TColorSelect.SecondaryShortCuts" link="#lcl.actnlist.TCustomAction.SecondaryShortCuts"/>
<element name="TColorSelect.Visible" link="#lcl.actnlist.TCustomAction.Visible"/>
<element name="TColorSelect.BeforeExecute" link="#lcl.stdactns.TCommonDialogAction.BeforeExecute"/>
<element name="TColorSelect.OnAccept" link="#lcl.stdactns.TCommonDialogAction.OnAccept"/>
<element name="TColorSelect.OnCancel" link="#lcl.stdactns.TCommonDialogAction.OnCancel"/>
<element name="TColorSelect.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="Register">
<short>Registers component for use in the Lazarus IDE.</short>
<descr>
<p>
The following components are registered but not displayed on the
Lazarus IDE component palette:
</p>
<p>
<b>Edit</b> Actions
</p>
<ul>
<li>TEditCut</li>
<li>TEditCopy</li>
<li>TEditPaste</li>
<li>TEditSelectAll</li>
<li>TEditUndo</li>
<li>TEditDelete</li>
</ul>
<p>
<b>Search</b> Actions
</p>
<ul>
<li>TSearchFind</li>
<li>TSearchReplace</li>
<li>TSearchFindFirst</li>
<li>TSearchFindNext</li>
</ul>
<p>
<b>Help</b> Actions
</p>
<ul>
<li>THelpAction</li>
<li>THelpContents</li>
<li>THelpTopicSearch</li>
<li>THelpOnHelp</li>
<li>THelpContextAction</li>
</ul>
<p>
<b>Dialog</b> Actions
</p>
<ul>
<li>TFontEdit</li>
<li>TColorSelect</li>
</ul>
<p>
<b>File</b> Actions
</p>
<ul>
<li>TFileOpen</li>
<li>TFileOpenWith</li>
<li>TFileSaveAs</li>
<li>TFileExit</li>
</ul>
</descr>
<seealso/>
</element>
</module>
<!-- StdActns -->
</package>
</fpdoc-descriptions>
|