Clipboard

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

class Clipboard : ObjectWrap {}

Constructors

this
this(void* ptr, Flag!"Take" take)

Members

Functions

clear
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 clear_func you supplied is called. Otherwise, the clipboard may be owned by someone else.

connectOwnerChange
gulong connectOwnerChange(T callback, Flag!"After" after)

Connect to OwnerChange signal.

getDisplay
gdk.display.Display getDisplay()

Gets the #GdkDisplay associated with clipboard

getOwner
gobject.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 called, returns the owner set by gtk.clipboard.Clipboard.setWithOwner.

getSelection
gdk.atom.Atom getSelection()

Gets the selection that this clipboard is for.

requestContents
void 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.

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

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

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

requestUris
void requestUris(gtk.types.ClipboardURIReceivedFunc callback)

Requests the contents of the clipboard as URIs. When the URIs are later received callback will be called.

self
Clipboard self()

Returns this, for use in with statements.

setCanStore
void setCanStore(gtk.target_entry.TargetEntry[] targets)

Hints that the clipboard data should be stored somewhere when the application exits or when gtk_clipboard_store () is called.

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

setText
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 the requested format.

store
void store()

Stores the current clipboard data somewhere so that it will stay around after the application has quit.

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

waitForImage
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 dispatched during the wait.

waitForRichText
ubyte[] waitForRichText(gtk.text_buffer.TextBuffer buffer, 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.

waitForText
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 dispatched during the wait.

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

waitIsImageAvailable
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 to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

waitIsRichTextAvailable
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 data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

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

waitIsTextAvailable
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 received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

waitIsUrisAvailable
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 received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

Properties

_gType
GType _gType [@property getter]

Static functions

_getGType
GType _getGType()
builder
ClipboardGidBuilder builder()

Get builder for gtk.clipboard.Clipboard

get
gtk.clipboard.Clipboard get(gdk.atom.Atom selection)

Returns the clipboard object for the given selection. See gtk.clipboard.Clipboard.getForDisplay for complete details.

getDefault
gtk.clipboard.Clipboard getDefault(gdk.display.Display display)

Returns the default clipboard object for use with cut/copy/paste menu items and keyboard shortcuts.

getForDisplay
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 GDK_SELECTION_CLIPBOARD for selection. (GDK_NONE is supported as a synonym for GDK_SELECTION_CLIPBOARD for backwards compatibility reasons.) The currently-selected object or text should be provided on the clipboard identified by #GDK_SELECTION_PRIMARY. Cut/copy/paste menu items conceptually copy the contents of the #GDK_SELECTION_PRIMARY clipboard to the default clipboard, i.e. they copy the selection to what the user sees as the clipboard.

Inherited Members

From ObjectWrap

_setGObject
void _setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectWrap wrapper.

_cPtr
void* _cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

_ref
void* _ref(void* gObj)

Calls g_object_ref() on a GObject.

_unref
_unref(void* gObj)

Calls g_object_unref() on a GObject.

_getGType
GType _getGType()

Get the GType of an object.

_gType
GType _gType [@property getter]

GObject GType property.

self
ObjectWrap self()

Convenience method to return this cast to a type. For use in D with statements.

_getDObject
T _getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectWrap refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
gulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.