mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-25 18:40:33 +02:00
FPDoc - Further updates to clipbrd.xml
git-svn-id: trunk@15075 -
This commit is contained in:
kirkpatc
parent
ad5051e06e
commit
a1c2e3700b
@ -145,9 +145,26 @@
|
||||
<element name="TClipboard">
|
||||
<short>
|
||||
<var>TClipboard</var> - area for holding information that has been cut or copied, ready for pasting</short>
|
||||
<descr/>
|
||||
<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/>
|
||||
<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">
|
||||
@ -406,7 +423,7 @@
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TClipboard.AddFormat.Result">
|
||||
<short/>
|
||||
<short>True if format added correctly</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TClipboard.AddFormat.FormatID">
|
||||
@ -425,7 +442,7 @@
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TClipboard.AddFormat.Result">
|
||||
<short/>
|
||||
<short>True if format added correctly</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TClipboard.AddFormat.FormatID">
|
||||
@ -496,7 +513,8 @@
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TClipboard.Create.AClipboardType">
|
||||
<short/>
|
||||
<short>
|
||||
<var>AClipboardType</var> - optional argument specifying type of clipboard to be created</short>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TClipboard.Destroy">
|
||||
@ -516,7 +534,7 @@
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TClipboard.FindPictureFormatID.Result">
|
||||
<short/>
|
||||
<short>Returns a Clipboard format</short>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TClipboard.FindFormatID">
|
||||
@ -528,7 +546,7 @@
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TClipboard.FindFormatID.Result">
|
||||
<short/>
|
||||
<short>Returns a Clipboard format</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TClipboard.FindFormatID.FormatName">
|
||||
@ -557,14 +575,14 @@
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TClipboard.GetFormat">
|
||||
<short>
|
||||
<var>GetFormat</var> - read data on format from the clipboard</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/>
|
||||
<short>True if Format found</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TClipboard.GetFormat.FormatID">
|
||||
@ -611,7 +629,7 @@
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TClipboard.GetTextBuf.Result">
|
||||
<short/>
|
||||
<short>Number of characters in text buffer</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TClipboard.GetTextBuf.Buffer">
|
||||
@ -631,7 +649,7 @@
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TClipboard.HasFormat.Result">
|
||||
<short/>
|
||||
<short>True if format is supported</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TClipboard.HasFormat.FormatID">
|
||||
@ -647,7 +665,7 @@
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TClipboard.HasFormatName.Result">
|
||||
<short/>
|
||||
<short>True if named format found</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TClipboard.HasFormatName.FormatName">
|
||||
@ -663,7 +681,7 @@
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TClipboard.HasPictureFormat.Result">
|
||||
<short/>
|
||||
<short>True if formatted as picture</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TClipboard.Open">
|
||||
@ -675,7 +693,7 @@
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TClipboard.SetComponent">
|
||||
<short/>
|
||||
<short>Write specified component to the Clipboard</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -704,13 +722,12 @@
|
||||
<short>
|
||||
<var>SetSupportedFormats</var> - set all supported formats at once</short>
|
||||
<descr>
|
||||
<var>
|
||||
<var>SetSupportedFormats</var> - set all supported formats at once </var>
|
||||
<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>
|
||||
<p>
|
||||
<code>procedure TCustomSynEdit.AquirePrimarySelection;
|
||||
<code>procedure TCustomSynEdit.AquirePrimarySelection;
|
||||
var
|
||||
FormatList: TClipboardFormat;
|
||||
begin
|
||||
@ -721,7 +738,6 @@
|
||||
PrimarySelection.OnRequest:=@PrimarySelectionRequest;
|
||||
end;
|
||||
</code>
|
||||
</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -798,81 +814,90 @@
|
||||
</element>
|
||||
<!-- function Visibility: default -->
|
||||
<element name="PrimarySelection">
|
||||
<short/>
|
||||
<short>
|
||||
<var>PrimarySelection</var> - the first selection if multiple clipboards exist</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="PrimarySelection.Result">
|
||||
<short/>
|
||||
<short>Returns a variable of type TClipboard</short>
|
||||
</element>
|
||||
<!-- function Visibility: default -->
|
||||
<element name="SecondarySelection">
|
||||
<short/>
|
||||
<short>
|
||||
<var>SecondarySelection</var> - the second selection if multiple clipboards exist</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="SecondarySelection.Result">
|
||||
<short/>
|
||||
<short>Returns a variable of type TClipboard</short>
|
||||
</element>
|
||||
<!-- function Visibility: default -->
|
||||
<element name="Clipboard">
|
||||
<short/>
|
||||
<short>
|
||||
<var>Clipboard</var> the function called to access the clipboard with an optional type specifier</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="Clipboard.Result">
|
||||
<short/>
|
||||
<short>Returns a variable of type TClipboard</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="Clipboard.ClipboardType">
|
||||
<short/>
|
||||
<short>
|
||||
<var>ClipboardType</var> - optional argument to specify type of clipboard</short>
|
||||
</element>
|
||||
<!-- function Visibility: default -->
|
||||
<element name="SetClipboard">
|
||||
<short/>
|
||||
<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/>
|
||||
<short>Returns a variable of type TClipboard</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SetClipboard.ClipboardType">
|
||||
<short/>
|
||||
<short>
|
||||
<var>ClipboardType</var> - optional argument to specify type of clipboard</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="SetClipboard.NewClipboard">
|
||||
<short/>
|
||||
<short>
|
||||
<var>NewClipboard</var> - the new clipboard to be set up</short>
|
||||
</element>
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="FreeAllClipboards">
|
||||
<short/>
|
||||
<short>
|
||||
<var>FreeAllClipboards</var> - frees all existing clipboards, releasing their resources</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function Visibility: default -->
|
||||
<element name="RegisterClipboardFormat">
|
||||
<short/>
|
||||
<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/>
|
||||
<short>Returns the registered clipoard format</short>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="RegisterClipboardFormat.Format">
|
||||
<short/>
|
||||
<short>The name of the required format as a string</short>
|
||||
</element>
|
||||
<element name="TClipboard.GetComponentAsText">
|
||||
<short>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user