gtk.clipboard
Module for [Clipboard] class
Types 3
The #GtkClipboard object represents a clipboard of data shared between different processes or between different widgets in the same process. Each clipboard is identified by a name encoded as a #GdkAtom. (Conversion to and from strings can be done with [gdk.atom.Atom.intern] and [gdk.atom.Atom.name].) The default clipboard corresponds to the “CLIPBOARD” atom; another commonly used clipboard is the “PRIMARY” clipboard, which, in X, traditionally contains the currently selected text.
To support having a number of different formats on the clipboard at the same time, the clipboard mechanism allows providing callbacks instead of the actual data. When you set the contents of the clipboard, you can either supply the data directly (via functions like [gtk.clipboard.Clipboard.setText]), or you can supply a callback to be called at a later time when the data is needed (via [gtk.clipboard.Clipboard.setWithData] or [gtk.clipboard.Clipboard.setWithOwner].) Providing a callback also avoids having to make copies of the data when it is not needed.
[gtk.clipboard.Clipboard.setWithData] and [gtk.clipboard.Clipboard.setWithOwner] are quite similar; the choice between the two depends mostly on which is more convenient in a particular situation. The former is most useful when you want to have a blob of data with callbacks to convert it into the various data types that you advertise. When the @clear_func you provided is called, you simply free the data blob. The latter is more useful when the contents of clipboard reflect the internal state of a #GObject (As an example, for the PRIMARY clipboard, when an entry widget provides the clipboard’s contents the contents are simply the text within the selected region.) If the contents change, the entry widget can call [gtk.clipboard.Clipboard.setWithOwner] to update the timestamp for clipboard ownership, without having to worry about @clear_func being called.
Requesting the data from the clipboard is essentially asynchronous. If the contents of the clipboard are provided within the same process, then a direct function call will be made to retrieve the data, but if they are provided by another process, then the data needs to be retrieved from the other process, which may take some time. To avoid blocking the user interface, the call to request the selection, [gtk.clipboard.Clipboard.requestContents] takes a callback that will be called when the contents are received (or when the request fails.) If you don’t want to deal with providing a separate callback, you can also use [gtk.clipboard.Clipboard.waitForContents]. What this does is run the GLib main loop recursively waiting for the contents. This can simplify the code flow, but you still have to be aware that other callbacks in your program can be called while this recursive mainloop is running.
Along with the functions to get the clipboard contents as an arbitrary data chunk, there are also functions to retrieve it as text, [gtk.clipboard.Clipboard.requestText] and [gtk.clipboard.Clipboard.waitForText]. These functions take care of determining which formats are advertised by the clipboard provider, asking for the clipboard in the best available format and converting the results into the UTF-8 encoding. (The standard form for representing strings in GTK+.)
ClipboardGidBuilder builder()Get builder for [gtk.clipboard.Clipboard] Returns: New builder objectgtk.clipboard.Clipboard get(gdk.atom.Atom selection)Returns the clipboard object for the given selection. See [gtk.clipboard.Clipboard.getForDisplay] for complete details.gtk.clipboard.Clipboard getDefault(gdk.display.Display display)Returns the default clipboard object for use with cut/copy/paste menu items and keyboard shortcuts.gtk.clipboard.Clipboard getForDisplay(gdk.display.Display display, gdk.atom.Atom selection)Returns the clipboard object for the given selection. Cut/copy/paste menu items and keyboard shortcuts should use the default clipboard, returned by passing `GDKSELECTIONCLIPBOARD` for selection. (...void clear()Clears the contents of the clipboard. Generally this should only be called between the time you call [gtk.clipboard.Clipboard.setWithOwner] or [gtk.clipboard.Clipboard.setWithData], and when the cl...gdk.display.Display getDisplay()Gets the #GdkDisplay associated with clipboard Returns: the #GdkDisplay associated with clipboardgobject.object.ObjectWrap getOwner()If the clipboard contents callbacks were set with [gtk.clipboard.Clipboard.setWithOwner], and the [gtk.clipboard.Clipboard.setWithData] or [gtk.clipboard.Clipboard.clear] has not subsequently calle...gdk.atom.Atom getSelection()Gets the selection that this clipboard is for. Returns: the selectionvoid requestContents(gdk.atom.Atom target, gtk.types.ClipboardReceivedFunc callback)Requests the contents of clipboard as the given target. When the results of the result are later received the supplied callback will be called.void requestImage(gtk.types.ClipboardImageReceivedFunc callback)Requests the contents of the clipboard as image. When the image is later received, it will be converted to a #GdkPixbuf, and callback will be called.void requestRichText(gtk.text_buffer.TextBuffer buffer, gtk.types.ClipboardRichTextReceivedFunc callback)Requests the contents of the clipboard as rich text. When the rich text is later received, callback will be called.void requestText(gtk.types.ClipboardTextReceivedFunc callback)Requests the contents of the clipboard as text. When the text is later received, it will be converted to UTF-8 if necessary, and callback will be called.void requestUris(gtk.types.ClipboardURIReceivedFunc callback)Requests the contents of the clipboard as URIs. When the URIs are later received callback will be called.void setCanStore(gtk.target_entry.TargetEntry[] targets = null)Hints that the clipboard data should be stored somewhere when the application exits or when gtkclipboardstore () is called.void setImage(gdkpixbuf.pixbuf.Pixbuf pixbuf)Sets the contents of the clipboard to the given #GdkPixbuf. GTK+ will take responsibility for responding for requests for the image, and for converting the image into the requested format.void setText(string text)Sets the contents of the clipboard to the given UTF-8 string. GTK+ will make a copy of the text and take responsibility for responding for requests for the text, and for converting the text into th...void store()Stores the current clipboard data somewhere so that it will stay around after the application has quit.gtk.selection_data.SelectionData waitForContents(gdk.atom.Atom target)Requests the contents of the clipboard using the given target. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.gdkpixbuf.pixbuf.Pixbuf waitForImage()Requests the contents of the clipboard as image and converts the result to a #GdkPixbuf. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispat...ubyte[] waitForRichText(gtk.text_buffer.TextBuffer buffer, out gdk.atom.Atom format)Requests the contents of the clipboard as rich text. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.string waitForText()Requests the contents of the clipboard as text and converts the result to UTF-8 if necessary. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be d...string[] waitForUris()Requests the contents of the clipboard as URIs. This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait. Returns: a newly-al...bool waitIsImageAvailable()Test to see if there is an image available to be pasted This is done by requesting the TARGETS atom and checking if it contains any of the supported image targets. This function waits for the data ...bool waitIsRichTextAvailable(gtk.text_buffer.TextBuffer buffer)Test to see if there is rich text available to be pasted This is done by requesting the TARGETS atom and checking if it contains any of the supported rich text targets. This function waits for the ...bool waitIsTargetAvailable(gdk.atom.Atom target)Checks if a clipboard supports pasting data of a given type. This function can be used to determine if a “Paste” menu item should be insensitive or not.bool waitIsTextAvailable()Test to see if there is text available to be pasted This is done by requesting the TARGETS atom and checking if it contains any of the supported text targets. This function waits for the data to be...bool waitIsUrisAvailable()Test to see if there is a list of URIs available to be pasted This is done by requesting the TARGETS atom and checking if it contains the URI targets. This function waits for the data to be receive...gulong connectOwnerChange(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == gdk.event_owner_change.EventOwnerChange)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] : gtk.clipboard.Clipboard)))
&& Parameters!T.length < 3)Connect to `OwnerChange` signal.