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
|
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
Clipbrd
====================================================================
-->
<module name="Clipbrd">
<short>Definitions for the Clipboard to hold Cut or Copied data for Pasting</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="FPCAdds">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LResources">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLIntf">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="GraphType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="Graphics">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="CF_Text">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="CF_Text.Result">
<short/>
</element>
<!-- function Visibility: default -->
<element name="CF_Bitmap">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="CF_Bitmap.Result">
<short/>
</element>
<!-- function Visibility: default -->
<element name="CF_Picture">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="CF_Picture.Result">
<short/>
</element>
<!-- function Visibility: default -->
<element name="CF_MetaFilePict">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="CF_MetaFilePict.Result">
<short/>
</element>
<!-- function Visibility: default -->
<element name="CF_Object">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="CF_Object.Result">
<short/>
</element>
<!-- function Visibility: default -->
<element name="CF_Component">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="CF_Component.Result">
<short/>
</element>
<!-- record type Visibility: default -->
<element name="TClipboardData">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TClipboardData.FormatID">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: default -->
<element name="TClipboardData.Stream">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TClipboard">
<short>
<var>TClipboard</var> - area for holding information that has been cut or copied, ready for pasting</short>
<descr>
<p>
<var>TClipboard</var> - area for holding information that has been cut or copied, ready for pasting</p>
<p>The clipboard object encapsulates the Windows clipboard and the three standard Gtk selections. For each of the three clipboards/selections there is an object: <link id="PrimarySelection"/>, <link id="SecondarySelection"/> and <link id="Clipboard"/>. There is no difference between the three objects except their type.</p>
<p>A lot of information about Clipboard Formats, including pre-defined formats for Delphi/Kylix compatibility, is found in the LCLType unit, at
		 <link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>,
		 <link id="#lcl.lcltype.TClipboardType">TClipboardType</link>,
		 <link id="#lcl.lcltype.ClipboardTypeName">ClipboardTypeName</link>,
		 <link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>,
		 <link id="#lcl.lcltype.PredefinedClipboardMimeTypes">PredefinedClipboardMimeTypes</link>
</p>
</descr>
<errors/>
<seealso>
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>,
		<link id="#lcl.lcltype.TClipboardType">TClipboardType</link>,
		<link id="#lcl.lcltype.ClipboardTypeName">ClipboardTypeName</link>,
		<link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>,
		<link id="#lcl.lcltype.PredefinedClipboardMimeTypes">PredefinedClipboardMimeTypes</link>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TClipboard.FAllocated">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TClipboard.FClipboardType">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TClipboard.FCount">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TClipboard.FData">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TClipboard.FSupportedFormatsChanged">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TClipboard.FOnRequest">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TClipboard.FOpenRefCount">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TClipboard.AssignGraphic">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignGraphic.Source">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TClipboard.AssignGraphic">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignGraphic.Source">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignGraphic.FormatID">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TClipboard.AssignPicture">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignPicture.Source">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TClipboard.AssignToGraphic">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.AssignToGraphic.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignToGraphic.Dest">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TClipboard.AssignToGraphic">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.AssignToGraphic.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignToGraphic.Dest">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignToGraphic.FormatID">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TClipboard.AssignToPicture">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignToPicture.Dest">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TClipboard.GetAsText">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetAsText.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TClipboard.GetFormatCount">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetFormatCount.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TClipboard.GetFormats">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetFormats.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetFormats.Index">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TClipboard.GetOwnerShip">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetOwnerShip.Result">
<short/>
</element>
<!-- function Visibility: private -->
<element name="TClipboard.IndexOfCachedFormatID">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.IndexOfCachedFormatID.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.IndexOfCachedFormatID.FormatID">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.IndexOfCachedFormatID.CreateIfNotExists">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TClipboard.InternalOnRequest">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.InternalOnRequest.RequestedFormatID">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.InternalOnRequest.AStream">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TClipboard.SetAsText">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetAsText.Value">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TClipboard.SetBuffer">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetBuffer.FormatID">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetBuffer.Buffer">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetBuffer.Size">
<short/>
</element>
<!-- procedure Visibility: private -->
<element name="TClipboard.SetOnRequest">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetOnRequest.AnOnRequest">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.AddFormat">
<descr>If not already done this functions aquires ownership of the clipboard. Aquiring ownership clears the clipbaord.
If the format already exists it replaces the old content otherwise it is added.
The format CF_TEXT is handled by AsText and SetTextBuf. Use those functions instead.</descr>
<errors/>
<seealso/>
<short>Aquires ownership of the Clipboard and adds a format</short>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.AddFormat.Result">
<short>True if format added correctly</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AddFormat.FormatID">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AddFormat.Stream">
<short/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.AddFormat.Result">
<short>True if format added correctly</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AddFormat.FormatID">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AddFormat.Buffer">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AddFormat.Size">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.Assign" link="#rtl.Classes.TPersistent.Assign">
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.Assign.Source">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.AssignTo" link="#rtl.Classes.TPersistent.AssignTo">
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.AssignTo.Dest">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.Clear">
<short>
<var>Clear</var> the clipboard</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.Close">
<short>
<var>Close</var> down the clipboard</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TClipboard.Create">
<short>
<var>Create</var> - Constructor: make a new instance of a clipboard</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public -->
<element name="TClipboard.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.Create.AClipboardType">
<short>
<var>AClipboardType</var> - optional argument specifying type of clipboard to be created</short>
</element>
<!-- destructor Visibility: public -->
<element name="TClipboard.Destroy" link="#rtl.Classes.TPersistent.Destroy">
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.FindPictureFormatID">
<short>
<var>FindPictureFormatID</var> - search for the first format ID that is a graphic</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.FindPictureFormatID.Result">
<short>Returns a Clipboard format</short>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.FindFormatID">
<short>
<var>FindFormatID</var> - find a Format ID that has the specified name</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.FindFormatID.Result">
<short>Returns a Clipboard format</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.FindFormatID.FormatName">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.GetComponent">
<short>
<var>GetComponent</var> - read a component from the clipboard</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetComponent.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetComponent.Owner">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetComponent.Parent">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.GetFormat">
<short>
<var>GetFormat</var> - read information on format from the clipboard</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetFormat.Result">
<short>True if Format found</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetFormat.FormatID">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetFormat.Stream">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SupportedFormats">
<short>
<var>SupportedFormats</var> - fills a stringlist with the names of the supported MIME types</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SupportedFormats.List">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SupportedFormats">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SupportedFormats.AFormatCount">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SupportedFormats.FormatList">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.GetTextBuf">
<short>
<var>GetTextBuf</var> - reads text from the clipboard and returns the number of characters</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetTextBuf.Result">
<short>Number of characters in text buffer</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetTextBuf.Buffer">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.GetTextBuf.BufSize">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.HasFormat">
<short>
<var>HasFormat</var> - look up the list to see if the format is supported. If a <var>TPicture</var> format is specified, all graphic formats are searched.</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.HasFormat.Result">
<short>True if format is supported</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.HasFormat.FormatID">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.HasFormatName">
<short>
<var>HasFormatName</var> - checks if data have format with specified name</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.HasFormatName.Result">
<short>True if named format found</short>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.HasFormatName.FormatName">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.HasPictureFormat">
<short>
<var>HasPictureFormat</var> - checks whether data are formatted as a picture</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.HasPictureFormat.Result">
<short>True if formatted as picture</short>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.Open">
<short>
<var>Open</var> the clipboard to receive and transmit data</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SetComponent">
<short>Write specified component to the Clipboard</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetComponent.Component">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SetFormat">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetFormat.FormatID">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetFormat.Stream">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SetSupportedFormats">
<short>
<var>SetSupportedFormats</var> - set all supported formats at once</short>
<descr>
<p>
<var>SetSupportedFormats</var> - set all supported formats at once </p>
<p>All data will be empty.</p>
<p>This procedure is useful if setting the <var>OnRequest</var> event to put the data on the fly.</p>
<p>Example: Using the PrimarySelection from synedit.pp</p>
<code>procedure TCustomSynEdit.AquirePrimarySelection;
var
FormatList: TClipboardFormat;
begin
if (not SelAvail)
or (PrimarySelection.OnRequest=@PrimarySelectionRequest) then exit;
FormatList:=CF_TEXT;
PrimarySelection.SetSupportedFormats(1,@FormatList);
PrimarySelection.OnRequest:=@PrimarySelectionRequest;
end;
</code>
</descr>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetSupportedFormats.AFormatCount">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetSupportedFormats.FormatList">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SetTextBuf" link="#rtl.System.SetTextBuf">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetTextBuf.Buffer">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TClipboard.AsText">
<short>
<var>AsText</var> - holds the textual data in the clipboard as a string</short>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TClipboard.SetAsHtml">
<short>Puts a HTML string on the clipboard.</short>
<descr>Puts a HTML string on the clipboard. On Windows it will automatically insert a
ClipBoard Header.
The procedure can also (optionally) set a provided plaintext representation
of the HTLM on the ClipBoard.</descr>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.SetAsHtml.HTML">
<short>The Html string that shall be put on the ClipBoard</short>
</element>
<element name="TClipboard.SetAsHtml.PlainText">
<short>Optional plain text (string) representation of the HTML</short>
<descr>The optioal string paramater PlainText is meant to be a plain text representation
of the HTM string. The user is responsible for the contents of this variable.
The value of PlainText can later be retrieved via the
<link id="#TClipBoard.AsText">AsText</link> property.
If PlainText is an empty string, no plain text is added to the ClipBoard, nor is the
current plain text content of the ClipBoard cleared.</descr>
</element>
<!-- function Visibility: public -->
<element name="TClipboard.GetAsHtml">
<short>Retrieves the HTML content of the clipboard (if available)</short>
<descr>Retrieves the HTML content of the clipboard (if available).
On Windows it will automatically remove the clipboard header that Windows inserts.
The resulting HTML string will be UTF-8 encoded.</descr>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TClipboard.GetAsHtml.Result">
<short>The HTML content of the clipboard as a string. Empty string if the function fails.</short>
</element>
<!-- property Visibility: public -->
<element name="TClipboard.ClipboardType">
<short>
<var>ClipboardType</var> - ctPrimarySelection, ctSecondarySelection, ctClipboard</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TClipboard.FormatCount">
<short>
<var>FormatCount</var> - the number of formats available</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TClipboard.Formats">
<short>
<var>Formats</var> - the formats being used in the current clipboard</short>
<descr>
<p>
<var>Formats</var> - the formats being used in the current clipboard</p>
<p>You can read the formats with this property one by one. But this will result in many requests, which can be very slow (especially on terminals).</p>
<p>Better use "SupportedFormats". </p>
</descr>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TClipboard.Formats.Index">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TClipboard.OnRequest">
<short>
<var>OnRequest</var> - event handler for a request for clipboard data</short>
<descr>
<p>
<var>OnRequest</var> - event handler for a request for clipboard data</p>
<p>If the clipboard has the ownership, this event will be called each time data are requested from the clipboard by the application or another application. </p>
<p>There is one special case: </p>
<p>If the clipboard loses ownership the <var>OnRequest</var> event will be called with FormatID=0. This event will be erased on lost of ownership.</p>
<p>If the <var>OnRequest</var> event was already set before, the prior method will be called with FormatID=0 to be notified of the loss.</p>
</descr>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="PrimarySelection">
<short>
<var>PrimarySelection</var> - the first selection if multiple clipboards exist</short>
<descr>The PrimarySelection is available on platforms like X. Normally when the user selects some text with the mouse the primary selection is set and when the user clicks the middle mouse button the text is copied to the mouse position. On platforms without multiple clipboards, the PrimarySelection still works in the LCL application, but does not communicate with other applications.</descr>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="PrimarySelection.Result">
<short>Returns a variable of type TClipboard</short>
</element>
<!-- function Visibility: default -->
<element name="SecondarySelection">
<short>
<var>SecondarySelection</var> - the second selection if multiple clipboards exist</short>
<descr>The SecondarySelection is available on platforms like X. See PrimarySelection for more details. There is no standard how to use the secondary selection, so it is free to use. X supports a dozen more selections, but they are not supported by the LCL.</descr>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="SecondarySelection.Result">
<short>Returns a variable of type TClipboard</short>
</element>
<!-- function Visibility: default -->
<element name="Clipboard">
<short>
<var>Clipboard</var> the function called to access the clipboard with an optional type specifier</short>
<descr>The Clipboard is available on most platforms and normally used by Copy/Paste.</descr>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="Clipboard.Result">
<short>Returns a variable of type TClipboard</short>
</element>
<!-- argument Visibility: default -->
<element name="Clipboard.ClipboardType">
<short>
<var>ClipboardType</var> - optional argument to specify type of clipboard</short>
</element>
<!-- function Visibility: default -->
<element name="SetClipboard">
<short>
<var>SetClipboard</var> - sets up and returns a <var>NewClipboard</var>, with an optional type specifier</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="SetClipboard.Result">
<short>Returns a variable of type TClipboard</short>
</element>
<!-- argument Visibility: default -->
<element name="SetClipboard.ClipboardType">
<short>
<var>ClipboardType</var> - optional argument to specify type of clipboard</short>
</element>
<!-- argument Visibility: default -->
<element name="SetClipboard.NewClipboard">
<short>
<var>NewClipboard</var> - the new clipboard to be set up</short>
</element>
<!-- procedure Visibility: default -->
<element name="FreeAllClipboards">
<short>
<var>FreeAllClipboards</var> - frees all existing clipboards, releasing their resources</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="RegisterClipboardFormat">
<short>
<var>RegisterClipboardFormat</var> add the supplied format name to the register of clipboard formats</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="RegisterClipboardFormat.Result">
<short>Returns the registered clipoard format</short>
</element>
<!-- argument Visibility: default -->
<element name="RegisterClipboardFormat.Format">
<short>The name of the required format as a string</short>
</element>
<element name="TClipboard.GetComponentAsText">
<short>
<var>GetComponentAsText</var> - read the component as text, if supported</short>
</element>
</module>
<!-- Clipbrd -->
</package>
</fpdoc-descriptions>
|