mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-09-12 05:21:27 +02:00
1164 lines
35 KiB
XML
1164 lines
35 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
|
|
Documentation for LCL (Lazarus Component Library) and LazUtils (Lazarus
|
|
Utilities) are published under the Creative Commons Attribution-ShareAlike 4.0
|
|
International public license.
|
|
|
|
https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt
|
|
https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/docs/cc-by-sa-4-0.txt
|
|
|
|
Copyright (c) 1997-2025, by the Lazarus Development Team.
|
|
|
|
-->
|
|
<fpdoc-descriptions>
|
|
<package name="lcl">
|
|
<!--
|
|
====================================================================
|
|
Clipbrd
|
|
====================================================================
|
|
-->
|
|
<module name="Clipbrd">
|
|
<short>
|
|
Definitions for the Clipboard to hold Cut or Copied data for Pasting.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<file>clipbrd.pp</file> contains classes, types, and routines used to
|
|
implement TClipboard. TClipboard encapsulates the system clipboard for
|
|
supported platforms. <file>clipbrd.pp</file> is part of the Lazarus Component
|
|
Library (<b>LCL</b>).
|
|
</p>
|
|
</descr>
|
|
|
|
<!-- unresolved references -->
|
|
<element name="UTF8BIDI"/>
|
|
<element name="Windows"/>
|
|
<element name="Classes"/>
|
|
<element name="SysUtils"/>
|
|
|
|
<element name="CF_Text">
|
|
<short>Gets the pre-defined clipboard format used for plain text.</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>
|
|
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="CF_Text.Result">
|
|
<short>
|
|
TClipboardFormat value registered for the clipboard format.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="CF_Bitmap">
|
|
<short>Gets the pre-defined clipboard format used for bitmap images.</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>
|
|
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="CF_Bitmap.Result">
|
|
<short>
|
|
TClipboardFormat value registered for the clipboard format.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="CF_Picture">
|
|
<short>
|
|
Gets the pre-defined clipboard format used for the LCL Picture type.
|
|
</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>
|
|
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="CF_Picture.Result">
|
|
<short>
|
|
TClipboardFormat value registered for the clipboard format.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="CF_MetaFilePict">
|
|
<short>
|
|
Gets the pre-defined clipboard format used for the LCL Meta-File Picture type.
|
|
</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>
|
|
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="CF_MetaFilePict.Result">
|
|
<short>
|
|
TClipboardFormat value registered for the clipboard format.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="CF_Object">
|
|
<short>
|
|
Gets the pre-defined clipboard format used for the LCL Object type.
|
|
</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>
|
|
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="CF_Object.Result">
|
|
<short>
|
|
TClipboardFormat value registered for the clipboard format.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="CF_Component">
|
|
<short>
|
|
Gets the pre-defined clipboard format used for the LCL Component type.
|
|
</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>
|
|
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="CF_Component.Result">
|
|
<short>
|
|
TClipboardFormat value registered for the clipboard format.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="CF_HTML">
|
|
<short>Gets the pre-defined clipboard format used for HTML content.</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#lcl.lcltype.TPredefinedClipboardFormat">TPredefinedClipboardFormat</link>
|
|
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="CF_HTML.Result">
|
|
<short>
|
|
TClipboardFormat value registered for the clipboard format.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboardData">
|
|
<short>
|
|
Record type with the format identifier and data for cached clipboard content.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboardData.FormatID">
|
|
<short>Clipboard format identifier.</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboardData.Stream">
|
|
<short>
|
|
Stream with the content stored for the associated clipboard format.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="TClipboard">
|
|
<short>
|
|
Represents the clipboard on platforms supported for the LCL.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TClipboard</var> is an area used to hold information that has been cut or
|
|
copied, and is available for pasting.
|
|
</p>
|
|
<p>
|
|
The clipboard object encapsulates the Windows clipboard as well as the three
|
|
standard Gtk selections. For each of the three clipboards/selections there is
|
|
an object: <link id="PrimarySelection">PrimarySelection</link>, <link
|
|
id="SecondarySelection">SecondarySelection</link> and <link
|
|
id="Clipboard">Clipboard</link>. There is no difference between the three
|
|
objects except their type.
|
|
</p>
|
|
<p>
|
|
A lot of information about Clipboard Formats, including predefined 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>
|
|
<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>
|
|
|
|
<!-- private -->
|
|
<element name="TClipboard.FAllocated"/>
|
|
<element name="TClipboard.FClipboardType"/>
|
|
<element name="TClipboard.FCount"/>
|
|
<element name="TClipboard.FData"/>
|
|
<element name="TClipboard.FSupportedFormatsChanged"/>
|
|
<element name="TClipboard.FOnRequest"/>
|
|
<element name="TClipboard.FOpenRefCount"/>
|
|
<element name="TClipboard.AssignGraphic"/>
|
|
<element name="TClipboard.AssignGraphic.Source"/>
|
|
<element name="TClipboard.AssignGraphic.FormatID"/>
|
|
<element name="TClipboard.AssignPicture"/>
|
|
<element name="TClipboard.AssignPicture.Source"/>
|
|
<element name="TClipboard.AssignToGraphic"/>
|
|
<element name="TClipboard.AssignToGraphic.Result"/>
|
|
<element name="TClipboard.AssignToGraphic.FormatID"/>
|
|
<element name="TClipboard.AssignToGraphic.Dest"/>
|
|
<element name="TClipboard.AssignToPicture"/>
|
|
<element name="TClipboard.AssignToPicture.Dest"/>
|
|
<element name="TClipboard.GetAsText"/>
|
|
<element name="TClipboard.GetAsText.Result"/>
|
|
<element name="TClipboard.GetFormatCount"/>
|
|
<element name="TClipboard.GetFormatCount.Result"/>
|
|
<element name="TClipboard.GetFormats"/>
|
|
<element name="TClipboard.GetFormats.Result"/>
|
|
<element name="TClipboard.GetFormats.Index"/>
|
|
<element name="TClipboard.GetOwnerShip"/>
|
|
<element name="TClipboard.GetOwnerShip.Result"/>
|
|
<element name="TClipboard.IndexOfCachedFormatID"/>
|
|
<element name="TClipboard.IndexOfCachedFormatID.Result"/>
|
|
<element name="TClipboard.IndexOfCachedFormatID.FormatID"/>
|
|
<element name="TClipboard.IndexOfCachedFormatID.CreateIfNotExists"/>
|
|
<element name="TClipboard.InternalOnRequest"/>
|
|
<element name="TClipboard.InternalOnRequest.RequestedFormatID"/>
|
|
<element name="TClipboard.InternalOnRequest.AStream"/>
|
|
<element name="TClipboard.SetAsText"/>
|
|
<element name="TClipboard.SetAsText.Value"/>
|
|
<element name="TClipboard.SetBuffer"/>
|
|
<element name="TClipboard.SetBuffer.FormatID"/>
|
|
<element name="TClipboard.SetBuffer.Buffer"/>
|
|
<element name="TClipboard.SetBuffer.Size"/>
|
|
<element name="TClipboard.SetOnRequest"/>
|
|
<element name="TClipboard.SetOnRequest.AnOnRequest"/>
|
|
|
|
<!-- public -->
|
|
<element name="TClipboard.AddFormat">
|
|
<short>Acquires ownership of the Clipboard and adds a format.</short>
|
|
<descr>
|
|
<p>
|
|
If not already done, this function acquires ownership of the clipboard.
|
|
Acquiring ownership clears the clipboard. If the format already exists, it
|
|
replaces the old content. Otherwise, it is added. The format CF_TEXT is
|
|
handled by the private AsText and SetTextBuf.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.AddFormat.Result">
|
|
<short><b>True</b> if format added correctly.</short>
|
|
</element>
|
|
<element name="TClipboard.AddFormat.FormatID">
|
|
<short>
|
|
Clipboard format identifier (TClipboardFormat) updated in the method.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.AddFormat.Stream">
|
|
<short>
|
|
TStream instance with the content for the specified clipboard format.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.AddFormat.Buffer">
|
|
<short>
|
|
Untyped, updatable buffer with the content stored for the clipboard format.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.AddFormat.Size">
|
|
<short>
|
|
Number of bytes in Buffer stored in the method.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.Assign">
|
|
<short>
|
|
Copies properties from the specified persistent object to the clipboard.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Assign</var> is an overridden method in <var>TClipboard</var> used to
|
|
copy properties from the persistent object in <var>Source</var> to the
|
|
clipboard instance. It provides support for using <var>TPicture</var> and
|
|
<var>TGraphic</var> types in Source, and calls private methods used to copy
|
|
the properties specific to the class types. If Source is not one of these
|
|
class types, the inherited method is called.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.classes.TPersistent.Assign">TPersistent.Assign</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.Assign.Source">
|
|
<short>
|
|
Persistent object with the property values copied in the method.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.AssignTo">
|
|
<short>Copies property values into the specified persistent object.</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#rtl.classes.TPersistent">TPersistent</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.AssignTo.Dest">
|
|
<short>
|
|
Persistent object where the properties in the class instance are stored.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.Clear">
|
|
<short>
|
|
Clears the content in the clipboard.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
No actions are performed in the method if nothing has been stored in the cached
|
|
clipboard data.
|
|
</p>
|
|
<p>
|
|
If the internal cache has format identifiers and data, each TClipboardData
|
|
instance is visited to free the TStream with its content. On completion, the
|
|
cache is freed and <b>Nil</b>'d and the number of cached clipboard formats is
|
|
reset to 0 (zero).
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TClipboard.Formats"/>
|
|
<link id="TClipboard.FormatCount"/>
|
|
<link id="TClipboardData"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="TClipboard.Close">
|
|
<short>Closes down the clipboard.</short>
|
|
<descr>
|
|
<p>
|
|
Calls the EndUpdate method for the clipboard instance.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="TClipboard.Create">
|
|
<short>
|
|
Constructor for the class instance.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Create</var> is the overloaded constructor for the class instance.
|
|
</p>
|
|
<p>
|
|
There is a parameterless variant that reimplements the method from TPersistent
|
|
to use the ctClipboard type. A variant which includes the AClipboardType
|
|
argument is available; the argument value is stored in the ClipboardType
|
|
property for the class instance. It allows creation of clipboard instances used
|
|
on the GTK platform.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TClipboard.ClipboardType"/>
|
|
<link id="#lcl.lcltype.TClipboardType">TClipboardType</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.Create.AClipboardType">
|
|
<short>
|
|
Specified the type of clipboard to be created (normal, primary, or secondary).
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.Destroy">
|
|
<short>Destructor for the class instance.</short>
|
|
<descr>
|
|
<p>
|
|
<var>Destroy</var> is the overridden destructor for the class instance. It
|
|
frees resources allocated in the class instance, and calls the inherited
|
|
destructor prior to exiting from the method.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="TClipboard.FindPictureFormatID">
|
|
<short>
|
|
Gets the first format ID that is a graphic format supported in TPicture.
|
|
</short>
|
|
<descr/>
|
|
<seealso>
|
|
<link id="#lcl.graphics.TPicture">TPicture</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.FindPictureFormatID.Result">
|
|
<short>Returns a Clipboard format which supports graphic content.</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.FindFormatID">
|
|
<short>
|
|
Gets the clipboard format which used the specified name (MIME type).
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Used to implement the HasFormatName method, and when assigning the clipboard
|
|
content to a TGraphic instance.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TClipboard.HasFormatName"/>
|
|
<link id="#lcl.graphics.TGraphic">TGraphic</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.FindFormatID.Result">
|
|
<short>
|
|
Clipboard format with the specified name (MIME type), or 0 (for the Text
|
|
format) when not found.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.FindFormatID.FormatName">
|
|
<short>
|
|
Name (MIME type) for the clipboard format to locate in the supported Formats.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.GetComponent">
|
|
<short>
|
|
Gets a TComponent instance with the specified owner and parent from the
|
|
clipboard.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>GetComponent</var> is an overloaded method in TClipboard used to read a
|
|
TComponent instance that was previously stored to the clipboard.
|
|
</p>
|
|
<p>
|
|
GetComponent allocates a temporary TMemoryStream which is used to read the
|
|
content stored to a pcfComponent clipboard format (when found). The
|
|
OnFindComponentClass argument is called to retrieve the class type needed to
|
|
re-create the TComponent instance. The ReadComponentFromBinaryStream routine
|
|
(in LResources) is called to create the component in the return value using the
|
|
arguments to the method.
|
|
</p>
|
|
<p>
|
|
The return value is <b>Nil</b> if there is no component on the clipboard with
|
|
the <var>Owner</var> and <var>Parent</var> specified in the arguments to the
|
|
method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#lcl.lresources.ReadComponentFromBinaryStream">ReadComponentFromBinaryStream</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.GetComponent.Result">
|
|
<short>
|
|
TComponent instance created from the clipboard data, or <b>Nil</b> when not
|
|
found.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetComponent.Owner">
|
|
<short>
|
|
TComponent instance which owns the component on the clipboard.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetComponent.Parent">
|
|
<short>
|
|
TComponent instance which is the parent for the component on the clipboard.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.GetComponentAsText">
|
|
<short>
|
|
Loads a component instance from a textual representation stored in the
|
|
clipboard.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>GetComponentAsText</var> creates a temporary TMemoryStream used to load
|
|
the pcfText clipboard content returned by AsText. ReadComponentFromTextStream
|
|
(in <file>lresources.pp</file>) is called to get the component class reference
|
|
needed to instantiate and load the component in RootComponent. <var>Owner</var>
|
|
and <var>Parent</var> contain the values stored to the corresponding properties
|
|
in the newly created component instance.
|
|
</p>
|
|
<p>
|
|
Use GetComponent to create and load a component instance from a pcfComponent
|
|
format stored in the clipboard.
|
|
</p>
|
|
<p>
|
|
Use SetComponentAsText and SetComponent to store a component instance to the
|
|
clipboard using with the pcfText or pcfComponent format.
|
|
</p>
|
|
<p>
|
|
Use SupportedFormats to determine which storage formats are supported in the
|
|
clipboard.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TClipboard.AsText"/>
|
|
<link id="TClipboard.SupportedFormats"/>
|
|
<link id="TClipboard.SetComponent"/>
|
|
<link id="TClipboard.SetComponentAsText"/>
|
|
<link id="#lcl.lresources.ReadComponentFromTextStream">ReadComponentFromTextStream</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.GetComponentAsText.RootComponent">
|
|
<short>
|
|
Variable argument where the component loaded from the clipboard is stored.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetComponentAsText.OnFindComponentClass">
|
|
<short>
|
|
Routine used to the locate the component class reference need to create a new
|
|
component instance.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetComponentAsText.Owner">
|
|
<short>
|
|
Owner of the newly created component instance.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetComponentAsText.Parent">
|
|
<short>
|
|
Parent for the newly created component instance.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.GetFormat">
|
|
<short>
|
|
Gets the data for the specified clipboard format from the LCL interface or
|
|
cached clipboard data.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>GetFormat</var> is a <var>Boolean</var> function used to retrieve
|
|
clipboard data for the specified format into the specified stream. It uses
|
|
cached clipboard data when available, or calls ClipboardGetData in the LCL
|
|
interface to retrieve the data for the ClipboardType.
|
|
</p>
|
|
<p>
|
|
The return value is <b>True</b> for the following conditions:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
Cached data is available and an assigned OnRequest handler was signalled to get
|
|
the data for the specified format identifier.
|
|
</li>
|
|
<li>
|
|
Cached data is available and used to load the content in the Stream argument.
|
|
</li>
|
|
<li>
|
|
ClipboardGetData indicates that data has been returned in Stream from the LCL
|
|
interface.
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
GetFormat is used in the implementation of methods like GetComponent,
|
|
GetTextBuf, and GetAsHtml. It is also called when reading the value for the
|
|
AsText property.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TClipboard.AsText"/>
|
|
<link id="TClipboard.GetComponent"/>
|
|
<link id="TClipboard.GetTextBuf"/>
|
|
<link id="TClipboard.GetAsHtml"/>
|
|
<link id="TClipboard.Formats"/>
|
|
<link id="TClipboard.OnRequest"/>
|
|
<link id="TClipboardFormat"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.GetFormat.Result">
|
|
<short>
|
|
Returns <b>True</b> if data for the format is available, or <b>False</b> when
|
|
not found.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetFormat.FormatID">
|
|
<short>
|
|
Format ID for the requested clipboard data.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetFormat.Stream">
|
|
<short>
|
|
TStream instance where the data for the format is stored.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.SupportedFormats">
|
|
<short>
|
|
Gets the list of supported formats for the clipboard.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>SupportedFormats</var> is an overloaded method in <var>TClipboard</var>.
|
|
One variant accepts a TStrings argument where the MIME types for the supported
|
|
clipboard formats is stored. The other variant provides updatable variable
|
|
arguments which contain the number of supported formats and a pointer to a list
|
|
of the supported TClipboardFormat instances.
|
|
</p>
|
|
<p>
|
|
Both versions use cached data when available, or call ClipboardGetFormats
|
|
in the LCL interface to retrieve the supported clipboard formats.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.SupportedFormats.List">
|
|
<short>
|
|
TStrings instance with the MIME types for the supported clipboard formats.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.SupportedFormats.AFormatCount">
|
|
<short>
|
|
Returns the number of TClipboardFormat instances in FormatList.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.SupportedFormats.FormatList">
|
|
<short>
|
|
Pointer to a block of TClipboardFormat instances with the supported clipboard
|
|
formats.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.GetTextBuf">
|
|
<short>
|
|
Reads text from the clipboard and returns the content and number of characters.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>GetTextBuf</var> is method used to retrieve text stored in the clipboard
|
|
and store it in the <var>Buffer</var> argument. Buffer cannot be <b>Nil</b>,
|
|
and must be large enough to store the number of characters requested in the
|
|
<var>BufSize</var> argument.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the method if Buffer is unassigned or BufSize is
|
|
set to 0.
|
|
</p>
|
|
<p>
|
|
GetTextBuf use a temporary TMemoryStream instance to load the content from the
|
|
text clipboard format, and to store the content to the specified buffer. Buffer
|
|
is terminated with a #0 (NUL) character to indicate the end of the data in the
|
|
buffer.
|
|
</p>
|
|
<p>
|
|
The return value is set to the number characters read from the buffer, or the
|
|
number of characters available for the clipboard format when it differs from
|
|
the requested size. It is set to 0 (zero) if no data was available on the
|
|
clipboard.
|
|
</p>
|
|
<p>
|
|
Use the AsText property to retrieve the clipboard content as a String value.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.GetTextBuf.Result">
|
|
<short>
|
|
Number of characters stored in the Buffer argument in the method.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetTextBuf.Buffer">
|
|
<short>
|
|
Pointer to the buffer where the text read from the clipboard is stored.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.GetTextBuf.BufSize">
|
|
<short>
|
|
Number of characters requested from the clipboard.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.HasFormat">
|
|
<short>
|
|
Determines whether the specified clipboard format is supported for the
|
|
clipboard.
|
|
</short>
|
|
<descr/>
|
|
<p>
|
|
If a format for graphics is specified, all graphic formats supported in
|
|
TPicture are searched.
|
|
</p>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.HasFormat.Result">
|
|
<short>
|
|
<b>True</b> if the requested format is supported.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.HasFormat.FormatID">
|
|
<short>
|
|
TClipboardFormat requested in the method.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.HasFormatName">
|
|
<short>
|
|
Indicates whether a clipboard format exists with the specified name (MIME type).
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Calls FindFormatID to get a TClipBoardFormat using the specified MIME type in
|
|
FormatName. Returns True if a clipboard format for the name specified in
|
|
FormatName exists in the supported formats for the clipboard.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.HasFormatName.Result">
|
|
<short>
|
|
<b>True</b> if the named format is found.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.HasFormatName.FormatName">
|
|
<short>
|
|
Name for the clipboard format (MIME type) requested3 in the method.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.HasPictureFormat">
|
|
<short>
|
|
Indicates whether a clipboard format for graphical data is present in the
|
|
supported formats.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.HasPictureFormat.Result">
|
|
<short>
|
|
Returns <b>True</b> if a clipboard format supported in TPicture is found.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.Open">
|
|
<short>
|
|
<var>Open</var> the clipboard to receive and transmit data.</short>
|
|
<descr>
|
|
<p>
|
|
Used along with Close to control reading and writing to / from the LCL
|
|
interface. If Open has been called, the clipboard will not read from or write
|
|
to the LCL interface. Instead it will collect all changes until Close is called.
|
|
It will then try to commit all changes as one block.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="TClipboard.SetComponent">
|
|
<short>
|
|
Writes the specified component to the storage for the Clipboard format.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Clears any existing data stored in the component clipboard format before
|
|
storing the binary content in the Component argument. Calls BeginUpdate and
|
|
EndUpdate to perform the operation as a single write.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.SetComponent.Component">
|
|
<short>
|
|
Component stored in the clipboard.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.SetComponentAsText">
|
|
<short>Stores the specified Component in the clipboard.</short>
|
|
<descr>
|
|
<p>
|
|
<var>SetComponentAsText</var> is a <var>Boolean</var> function used to store
|
|
the specified <var>Component</var> to the <var>TClipboard</var> instance.
|
|
</p>
|
|
<p>
|
|
SetComponentAsText calls the <var>WriteComponentAsTextToStream</var> routine
|
|
in the <file>lresources.pp</file> unit to store Component to a
|
|
<var>TMemoryStream</var>. The String value in the stream is assigned to the
|
|
<var>AsText</var> property to store the value in the clipboard.
|
|
</p>
|
|
<p>
|
|
SetComponentAsText calls BeginUpdate prior to storing the component to the
|
|
clipboard, and EndUpdate when the operation has been completed. The return
|
|
value for the method is the value returned from EndUpdate.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TClipBoard.AsText"/>
|
|
<link id="#lcl.lresources.WriteComponentAsTextToStream">WriteComponentAsTextToStream</link>
|
|
<link id="#rtl.classes.TMemoryStream">TMemoryStream</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.SetComponentAsText.Component">
|
|
<short>Component instance stored to the clipboard in the method.</short>
|
|
</element>
|
|
<element name="TClipboard.SetComponentAsText.Result">
|
|
<short>
|
|
<b>True</b> when no other updates are pending for the clipboard, and its
|
|
ownership has not changed.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.SetFormat">
|
|
<short>
|
|
Sets the clipboard format to the specified identifier and copies the value in
|
|
Stream.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>SetFormat</var> is a <var>Boolean</var> function used to select the
|
|
clipboard format for the format identifier in <var>FormatID</var>, and load
|
|
the content in <var>Stream</var>. It calls <var>AddFormat</var> to select the
|
|
supported format in FormatID, and to cache values in Stream to its
|
|
<var>TClipboardData</var> record instance.
|
|
</p>
|
|
<p>
|
|
SetFormat calls <var>BeginUpdate</var> prior to activating the format and
|
|
loading its value. It calls <var>EndUpdate</var> when the operation has been
|
|
completed. The value from EndUpdate is used as the return value for the
|
|
method.
|
|
</p>
|
|
<p>
|
|
SetFormat is called when <var>TGraphic</var> or <var>TPicture</var> class
|
|
instances are loaded to the clipboard in the <var>Assign</var> method.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TClipBoard.AddFormat"/>
|
|
<link id="TClipBoard.Assign"/>
|
|
<link id="#lcl.lcltype.TClipboardFormat">TClipboardFormat</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.SetFormat.FormatID">
|
|
<short>Format identifier needed for the specified stream.</short>
|
|
</element>
|
|
<element name="TClipboard.SetFormat.Stream">
|
|
<short>Stream with the content loaded in the method.</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.SetSupportedFormats">
|
|
<short>
|
|
Sets all supported clipboard formats at once.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>SetSupportedFormats</var> sets all supported formats at once All data
|
|
will be empty. 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.AcquirePrimarySelection;
|
|
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>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.SetSupportedFormats.AFormatCount">
|
|
<short>
|
|
Number of clipboard formats in the FormatList argument.
|
|
</short>
|
|
</element>
|
|
<element name="TClipboard.SetSupportedFormats.FormatList">
|
|
<short>
|
|
Pointer to the list of TClipboardFormat instances stored in the method.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.SetTextBuf">
|
|
<short>
|
|
Loads the clipboard buffer using the text in the specified PChar value.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>SetTextBuf</var> is a method used to load the text specified in
|
|
<var>Buffer</var> into the clipboard. Buffer is a <var>PChar</var> type, and
|
|
when not assigned (<b>Nil</b>), is set to <b>#0</b> in the method. Its value
|
|
is loaded in the <var>TClipboardData</var> instances used for the text
|
|
clipboard format.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.system.SetTextBuf">SetTextBuf</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TClipboard.SetTextBuf.Buffer">
|
|
<short>PChar value loaded into the clipboard.</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.AsText">
|
|
<short>
|
|
Text stored in the clipboard.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>AsText</var> is a <var>String</var> property with the textual data stored
|
|
on the clipboard. The property value is read from an existing pcfText clipboard
|
|
format. The return value is an empty string ('') if a clipboard format is not
|
|
found for the MIME text type.
|
|
</p>
|
|
<p>
|
|
Changing the value for the property causes an assigned OnRequest handler to be
|
|
signalled to perform the update. If OnRequest is not assigned, the Clear method
|
|
to be called to clear all formats and the data is stored on the clipboard using
|
|
the pcfText clipboard format.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="TClipboard.SetAsHtml">
|
|
<short>Puts a HTML string on the clipboard.</short>
|
|
<descr>
|
|
<p>
|
|
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 HTML on the ClipBoard.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<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>
|
|
<p>
|
|
The optional string parameter PlainText is meant to be a plain text
|
|
representation of the HTML 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.
|
|
</p>
|
|
</descr>
|
|
</element>
|
|
|
|
<element name="TClipboard.GetAsHtml">
|
|
<short>Retrieves the HTML content of the clipboard (if available).</short>
|
|
<descr>
|
|
<p>
|
|
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.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.GetAsHtml.Result">
|
|
<short>
|
|
The HTML content of the clipboard as a string. Empty string if the function
|
|
fails.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TClipboard.ClipboardType">
|
|
<short>
|
|
Contains the clipboard type for the platform.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>ClipboardType</var> is a <var>TClipboardType</var> property which contains
|
|
the clipboard type requested in the Create constructor. Some platforms, like
|
|
GTK, support more than one clipboard; e. g. normal, primary selection, or
|
|
secondary selection clipboard.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="TClipboard.FormatCount">
|
|
<short>
|
|
Contains the number of clipboard formats supported for the class instance.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>FormatCount</var> is a read-only <var>Integer</var> property with the
|
|
number of TClipboardFormat instances found in the cache or returned from the
|
|
LCL interface. Calls ClipboardGetFormats to read the supported formats from the
|
|
LCL interface.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="TClipboard.Formats">
|
|
<short>
|
|
Contains the clipboard formats currently in use for the class instance.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>Formats</var> is an indexed read-only TClipBoardFormat property which
|
|
returns 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 to use the SupportedFormats method.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="TClipboard.Formats.Index">
|
|
<short>
|
|
Ordinal position for the supported clipboard format requested.
|
|
</short>
|
|
</element>
|
|
|
|
<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>
|
|
|
|
<element name="PrimarySelection">
|
|
<short>
|
|
<var>PrimarySelection</var> - the first selection if multiple clipboards
|
|
exist.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
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.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="PrimarySelection.Result">
|
|
<short>Returns a variable of type TClipboard.</short>
|
|
</element>
|
|
|
|
<element name="SecondarySelection">
|
|
<short>
|
|
<var>SecondarySelection</var> - the second selection if multiple clipboards
|
|
exist.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
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.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="SecondarySelection.Result">
|
|
<short>Returns a variable of type TClipboard.</short>
|
|
</element>
|
|
|
|
<element name="Clipboard">
|
|
<short>
|
|
<var>Clipboard</var> the function called to access the clipboard with an
|
|
optional type specifier.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
The Clipboard is available on most platforms and normally used by Copy/Paste.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="Clipboard.Result">
|
|
<short>Returns a variable of type TClipboard.</short>
|
|
</element>
|
|
<element name="Clipboard.ClipboardType">
|
|
<short>
|
|
<var>ClipboardType</var> - optional argument to specify type of clipboard.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="SetClipboard">
|
|
<short>
|
|
<var>SetClipboard</var> - sets up and returns a <var>NewClipboard</var>, with
|
|
an optional type specifier.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="SetClipboard.Result">
|
|
<short>Returns a variable of type TClipboard.</short>
|
|
</element>
|
|
<element name="SetClipboard.ClipboardType">
|
|
<short>
|
|
<var>ClipboardType</var> - optional argument to specify type of
|
|
clipboard.</short>
|
|
</element>
|
|
<element name="SetClipboard.NewClipboard">
|
|
<short>
|
|
<var>NewClipboard</var> - the new clipboard to be set up.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="FreeAllClipboards">
|
|
<short>
|
|
<var>FreeAllClipboards</var> - frees all existing clipboards, releasing their
|
|
resources.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="RegisterClipboardFormat">
|
|
<short>
|
|
<var>RegisterClipboardFormat</var> add the supplied format name to the
|
|
register of clipboard formats.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="RegisterClipboardFormat.Result">
|
|
<short>Returns the registered clipboard format.</short>
|
|
</element>
|
|
<element name="RegisterClipboardFormat.Format">
|
|
<short>The name of the required format as a string.</short>
|
|
</element>
|
|
|
|
</module>
|
|
<!-- Clipbrd -->
|
|
</package>
|
|
</fpdoc-descriptions>
|