From 2fdb162980345ff1333150d470c727741de8e3ca Mon Sep 17 00:00:00 2001 From: dsiders Date: Wed, 15 Jun 2022 10:39:24 +0100 Subject: [PATCH] Docs: LCL/clipbrd. Removes extra spaces in topics. Updates tagging for True and False values. --- docs/xml/lcl/clipbrd.xml | 104 ++++++++++++++++++++++----------------- 1 file changed, 58 insertions(+), 46 deletions(-) diff --git a/docs/xml/lcl/clipbrd.xml b/docs/xml/lcl/clipbrd.xml index a8513496c5..8ed7f6facc 100644 --- a/docs/xml/lcl/clipbrd.xml +++ b/docs/xml/lcl/clipbrd.xml @@ -128,19 +128,10 @@ TClipboard - area for holding information that has been cut or copied, ready for pasting.

- The clipboard object encapsulates the Windows clipboard and the three standard Gtk selections. For each of the three clipboards/selections there is an object: - PrimarySelection, - SecondarySelection and - Clipboard. - There is no difference between the three objects except their type. + The clipboard object encapsulates the Windows clipboard and the three standard Gtk selections. For each of the three clipboards/selections there is an object: PrimarySelection, SecondarySelection and Clipboard. There is no difference between the three objects except their type.

- A lot of information about Clipboard Formats, including predefined formats for Delphi/Kylix compatibility, is found in the LCLType unit, at - TClipboardFormat, - TClipboardType, - ClipboardTypeName, - TPredefinedClipboardFormat, - PredefinedClipboardMimeTypes + A lot of information about Clipboard Formats, including predefined formats for Delphi/Kylix compatibility, is found in the LCLType unit, at TClipboardFormat, TClipboardType, ClipboardTypeName, TPredefinedClipboardFormat, PredefinedClipboardMimeTypes

@@ -385,7 +376,7 @@ - True if format added correctly. + True if format added correctly. @@ -457,7 +448,8 @@ - AClipboardType - optional argument specifying type of clipboard to be created. + AClipboardType - optional argument specifying type of clipboard to be created. + @@ -472,7 +464,8 @@ - FindPictureFormatID - search for the first format ID that is a graphic. + FindPictureFormatID - search for the first format ID that is a graphic. + @@ -484,7 +477,8 @@ - FindFormatID - find a Format ID that has the specified name. + FindFormatID - find a Format ID that has the specified name. + @@ -500,7 +494,8 @@ - GetComponent - reads a component from the clipboard. + GetComponent - reads a component from the clipboard. + @@ -520,14 +515,15 @@ - GetFormat - read information on format from the clipboard. + GetFormat - read information on format from the clipboard. + - True if Format found. + True if Format found. @@ -540,7 +536,8 @@ - SupportedFormats - fills a stringlist with the names of the supported MIME types. + SupportedFormats - fills a stringlist with the names of the supported MIME types. + @@ -560,7 +557,8 @@ - GetTextBuf - reads text from the clipboard and returns the number of characters. + GetTextBuf - reads text from the clipboard and returns the number of characters. + @@ -580,14 +578,15 @@ - HasFormat - look up the list to see if the format is supported. If a TPicture format is specified, all graphic formats are searched. + HasFormat - look up the list to see if the format is supported. If a TPicture format is specified, all graphic formats are searched. + - True if format is supported. + True if format is supported. @@ -603,7 +602,7 @@ - True if named format found. + True if named format found. @@ -612,14 +611,15 @@ - HasPictureFormat - checks whether data are formatted as a picture. + HasPictureFormat - checks whether data are formatted as a picture. + - True if formatted as picture. + True if formatted as picture. @@ -665,7 +665,7 @@ - True when no other updates are pending for the clipboard, and its ownership has not changed. + True when no other updates are pending for the clipboard, and its ownership has not changed. @@ -772,19 +772,20 @@ Optional plain text (string) representation of the HTML. - 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 - AsText 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. + +

+ 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 AsText 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. +

+ Retrieves the HTML content of the clipboard (if available). - 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. + +

+ 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. +

+ @@ -812,9 +813,14 @@ Formats - the formats being used in the current clipboard.

- Formats - the formats being used in the current clipboard

-

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).

-

Better use "SupportedFormats".

+ Formats - the formats being used in the current clipboard. +

+

+ 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). +

+

+ Better to use "SupportedFormats". +

@@ -832,9 +838,9 @@ OnRequest - event handler for a request for clipboard data.

- 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. + 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.

-

There is one special case:

+

There is one special case:

If the clipboard loses ownership the OnRequest event will be called with FormatID=0. This event will be erased on lost of ownership.

@@ -898,12 +904,14 @@ - ClipboardType - optional argument to specify type of clipboard. + ClipboardType - optional argument to specify type of clipboard. + - SetClipboard - sets up and returns a NewClipboard, with an optional type specifier. + SetClipboard - sets up and returns a NewClipboard, with an optional type specifier. + @@ -920,12 +928,14 @@ - NewClipboard - the new clipboard to be set up. + NewClipboard - the new clipboard to be set up. + - FreeAllClipboards - frees all existing clipboards, releasing their resources. + FreeAllClipboards - frees all existing clipboards, releasing their resources. + @@ -933,7 +943,8 @@ - RegisterClipboardFormat add the supplied format name to the register of clipboard formats. + RegisterClipboardFormat add the supplied format name to the register of clipboard formats. + @@ -948,7 +959,8 @@ - GetComponentAsText - read the component as text, if supported. + GetComponentAsText - read the component as text, if supported. +