TClipboard class

In unit Clipbrd

Represents the clipboard on platforms supported for the LCL.

Declaration

pascal

TClipboard = class(TPersistent)

Inheritance

TClipboard
TPersistent
TObject

Description

TClipboard is an area used to hold information that has been cut or copied, and is available for pasting.

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: 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

Properties

`AsText`	public	Text stored in the clipboard.
`ClipboardType`	public	Contains the clipboard type for the platform.
`FormatCount`	public	Contains the number of clipboard formats supported for the class instance.
`Formats`	public	Contains the clipboard formats currently in use for the class instance.

Methods

`AddFormat`	public	Acquires ownership of the Clipboard and adds a format.
`Assign`	public	Copies properties from the specified persistent object to the clipboard.
`AssignTo`	public	Copies property values into the specified persistent object.
`Clear`	public	Clears the content in the clipboard.
`Close`	public	Closes down the clipboard.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`FindPictureFormatID`	public	Gets the first format ID that is a graphic format supported in TPicture.
`FindFormatID`	public	Gets the clipboard format which used the specified name (MIME type).
`GetAsHtml`	public	Retrieves the HTML content of the clipboard (if available).
`GetComponent`	public	Gets a TComponent instance with the specified owner and parent from the clipboard.
`GetComponentAsText`	public	Loads a component instance from a textual representation stored in the clipboard.
`GetFormat`	public	Gets the data for the specified clipboard format from the LCL interface or cached clipboard data.
`SupportedFormats`	public	Gets the list of supported formats for the clipboard.
`GetTextBuf`	public	Reads text from the clipboard and returns the content and number of characters.
`HasFormat`	public	Determines whether the specified clipboard format is supported for the clipboard.
`HasFormatName`	public	Indicates whether a clipboard format exists with the specified name (MIME type).
`HasPictureFormat`	public	Indicates whether a clipboard format for graphical data is present in the supported formats.
`Open`	public	Open the clipboard to receive and transmit data.
`SetAsHtml`	public	Puts a HTML string on the clipboard.
`SetComponent`	public	Writes the specified component to the storage for the Clipboard format.
`SetComponentAsText`	public	Stores the specified Component in the clipboard.
`SetFormat`	public	Sets the clipboard format to the specified identifier and copies the value in Stream.
`SetSupportedFormats`	public	Sets all supported clipboard formats at once.
`SetTextBuf`	public	Loads the clipboard buffer using the text in the specified PChar value.

Events

OnRequest public OnRequest - event handler for a request for clipboard data.

Inherited

From TPersistent (6)

DefineProperties FPOAttachObserver FPODetachObserver FPONotifyObservers GetNamePath GetOwner

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.