gtk.Clipboard



class Clipboard : gobject.ObjectG.ObjectG;
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_intern() and gdk_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_set_text()), or you can supply a callback to be called at a later time when the data is needed (via gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().) Providing a callback also avoids having to make copies of the data when it is not needed.

gtk_clipboard_set_with_data() and gtk_clipboard_set_with_owner() 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_set_with_owner() 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_request_contents() 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_wait_for_contents(). 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_request_text() and gtk_clipboard_wait_for_text(). 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+.)

protected GtkClipboard* gtkClipboard ;
the main Gtk struct

GtkClipboard* getClipboardStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkClipboard* gtkClipboard, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

static GType getType ();


static Clipboard get (GdkAtom selection);
Returns the clipboard object for the given selection. See gtk_clipboard_get_for_display() for complete details.

Params:
GdkAtom selection a #GdkAtom which identifies the clipboard to use

Return:
the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent and, since it is owned by GTK+, must not be freed or unreffed.

static Clipboard getDefault (Display display);
Returns the default clipboard object for use with cut/copy/paste menu items and keyboard shortcuts.

Params:
Display display the #GdkDisplay for which the clipboard is to be retrieved.

Return:
the default clipboard object.

Since:
3.16

static Clipboard getForDisplay (Display display, GdkAtom 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.

(Passing #GDK_NONE is the same as using `gdk_atom_intern ("CLIPBOARD", FALSE)`.

See the [FreeDesktop Clipboard Specification](http://www.freedesktop.org/Standards/clipboards-spec) for a detailed discussion of the “CLIPBOARD” vs. “PRIMARY” selections under the X window system. On Win32 the #GDK_SELECTION_PRIMARY clipboard is essentially ignored.)

It’s possible to have arbitrary named clipboards; if you do invent new clipboards, you should prefix the selection name with an underscore (because the ICCCM requires that nonstandard atoms are underscore-prefixed), and namespace it as well. For example, if your application called “Foo” has a special-purpose clipboard, you might call it “FOO_SPECIAL_CLIPBOARD”.

Params:
Display display the #GdkDisplay for which the clipboard is to be retrieved or created.
GdkAtom selection a #GdkAtom which identifies the clipboard to use.

Return:
the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent and, since it is owned by GTK+, must not be freed or unrefd.

Since:
2.2

void clear ();
Clears the contents of the clipboard. Generally this should only be called between the time you call gtk_clipboard_set_with_owner() or gtk_clipboard_set_with_data(), and when the @clear_func you supplied is called. Otherwise, the clipboard may be owned by someone else.

Display getDisplay ();
Gets the #GdkDisplay associated with @clipboard

Return:
the #GdkDisplay associated with @clipboard

Since:
2.2

ObjectG getOwner ();
If the clipboard contents callbacks were set with gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or gtk_clipboard_clear() has not subsequently called, returns the owner set by gtk_clipboard_set_with_owner().

Return:
the owner of the clipboard, if any; otherwise %NULL.

GdkAtom getSelection ();
Gets the selection that this clipboard is for.

Return:
the selection

Since:
3.22

void requestContents (GdkAtom target, GtkClipboardReceivedFunc callback, void* userData);
Requests the contents of clipboard as the given target. When the results of the result are later received the supplied callback will be called.

Params:
GdkAtom target an atom representing the form into which the clipboard owner should convert the selection.
GtkClipboardReceivedFunc callback A function to call when the results are received (or the retrieval fails). If the retrieval fails the length field of @selection_data will be negative.
void* userData user data to pass to @callback

void requestImage (GtkClipboardImageReceivedFunc callback, void* userData);
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.

The @pixbuf parameter to @callback will contain the resulting #GdkPixbuf if the request succeeded, or %NULL if it failed. This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into an image.

Params:
GtkClipboardImageReceivedFunc callback a function to call when the image is received, or the retrieval fails. (It will always be called one way or the other.)
void* userData user data to pass to @callback.

Since:
2.6

void requestRichText (TextBuffer buffer, GtkClipboardRichTextReceivedFunc callback, void* userData);
Requests the contents of the clipboard as rich text. When the rich text is later received, @callback will be called.

The @text parameter to @callback will contain the resulting rich text if the request succeeded, or %NULL if it failed. The @length parameter will contain @text’s length. This function can fail for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into rich text form.

Params:
TextBuffer buffer a #GtkTextBuffer
GtkClipboardRichTextReceivedFunc callback a function to call when the text is received, or the retrieval fails. (It will always be called one way or the other.)
void* userData user data to pass to @callback.

Since:
2.10

void requestTargets (GtkClipboardTargetsReceivedFunc callback, void* userData);
Requests the contents of the clipboard as list of supported targets. When the list is later received, @callback will be called.

The @targets parameter to @callback will contain the resulting targets if the request succeeded, or %NULL if it failed.

Params:
GtkClipboardTargetsReceivedFunc callback a function to call when the targets are received, or the retrieval fails. (It will always be called one way or the other.)
void* userData user data to pass to @callback.

Since:
2.4

void requestText (GtkClipboardTextReceivedFunc callback, void* userData);
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.

The @text parameter to @callback will contain the resulting text if the request succeeded, or %NULL if it failed. This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into text form.

Params:
GtkClipboardTextReceivedFunc callback a function to call when the text is received, or the retrieval fails. (It will always be called one way or the other.)
void* userData user data to pass to @callback.

void requestUris (GtkClipboardURIReceivedFunc callback, void* userData);
Requests the contents of the clipboard as URIs. When the URIs are later received @callback will be called.

The @uris parameter to @callback will contain the resulting array of URIs if the request succeeded, or %NULL if it failed. This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into URI form.

Params:
GtkClipboardURIReceivedFunc callback a function to call when the URIs are received, or the retrieval fails. (It will always be called one way or the other.)
void* userData user data to pass to @callback.

Since:
2.14

void setCanStore (TargetEntry[] targets);
Hints that the clipboard data should be stored somewhere when the application exits or when gtk_clipboard_store () is called.

This value is reset when the clipboard owner changes. Where the clipboard data is stored is platform dependent, see gdk_display_store_clipboard () for more information.

Params:
TargetEntry[] targets array containing information about which forms should be stored or %NULL to indicate that all forms should be stored.
nTargets number of elements in @targets

Since:
2.6

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

Params:
Pixbuf pixbuf a #GdkPixbuf

Since:
2.6

void setText (string text, int len);
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.

Params:
string text a UTF-8 string.
int len length of @text, in bytes, or -1, in which case the length will be determined with strlen().

bool setWithData (TargetEntry[] targets, GtkClipboardGetFunc getFunc, GtkClipboardClearFunc clearFunc, void* userData);
Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested.

Params:
TargetEntry[] targets array containing information about the available forms for the clipboard data
nTargets number of elements in @targets
GtkClipboardGetFunc getFunc function to call to get the actual clipboard data
GtkClipboardClearFunc clearFunc when the clipboard contents are set again, this function will be called, and @get_func will not be subsequently called.
void* userData user data to pass to @get_func and @clear_func.

Return:
%TRUE if setting the clipboard data succeeded. If setting the clipboard data failed the provided callback functions will be ignored.

bool setWithOwner (TargetEntry[] targets, GtkClipboardGetFunc getFunc, GtkClipboardClearFunc clearFunc, ObjectG owner);
Virtually sets the contents of the specified clipboard by providing a list of supported formats for the clipboard data and a function to call to get the actual data when it is requested.

The difference between this function and gtk_clipboard_set_with_data() is that instead of an generic @user_data pointer, a #GObject is passed in.

Params:
TargetEntry[] targets array containing information about the available forms for the clipboard data
nTargets number of elements in @targets
GtkClipboardGetFunc getFunc function to call to get the actual clipboard data
GtkClipboardClearFunc clearFunc when the clipboard contents are set again, this function will be called, and @get_func will not be subsequently called
ObjectG owner an object that “owns” the data. This object will be passed to the callbacks when called

Return:
%TRUE if setting the clipboard data succeeded. If setting the clipboard data failed the provided callback functions will be ignored.

void store ();
Stores the current clipboard data somewhere so that it will stay around after the application has quit.

Since:
2.6

SelectionData waitForContents (GdkAtom 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.

Params:
GdkAtom target an atom representing the form into which the clipboard owner should convert the selection.

Return:
a newly-allocated #GtkSelectionData object or %NULL if retrieving the given target failed. If non-%NULL, this value must be freed with gtk_selection_data_free() when you are finished with it.

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.

Return:
a newly-allocated #GdkPixbuf object which must be disposed with g_object_unref(), or %NULL if retrieving the selection data failed. (This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into an image.)

Since:
2.6

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

Params:
TextBuffer buffer a #GtkTextBuffer
GdkAtom format return location for the format of the returned data

Return:
a newly-allocated binary block of data which must be freed with g_free(), or %NULL if retrieving the selection data failed. (This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into text form.)

Since:
2.10

bool waitForTargets (out GdkAtom[] targets);
Returns a list of targets that are present on the clipboard, or %NULL if there aren’t any targets available. The returned list must be freed with g_free(). This function waits for the data to be received using the main loop, so events, timeouts, etc, may be dispatched during the wait.

Params:
GdkAtom[] targets location to store an array of targets. The result stored here must be freed with g_free().
nTargets location to store number of items in @targets.

Return:
%TRUE if any targets are present on the clipboard, otherwise %FALSE.

Since:
2.4

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.

Return:
a newly-allocated UTF-8 string which must be freed with g_free(), or %NULL if retrieving the selection data failed. (This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into text form.)

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.

Return:
a newly-allocated %NULL-terminated array of strings which must be freed with g_strfreev(), or %NULL if retrieving the selection data failed. (This could happen for various reasons, in particular if the clipboard was empty or if the contents of the clipboard could not be converted into URI form.)

Since:
2.14

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.

This function is a little faster than calling gtk_clipboard_wait_for_image() since it doesn’t need to retrieve the actual image data.

Return:
%TRUE is there is an image available, %FALSE otherwise.

Since:
2.6

bool waitIsRichTextAvailable (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.

This function is a little faster than calling gtk_clipboard_wait_for_rich_text() since it doesn’t need to retrieve the actual text.

Params:
TextBuffer buffer a #GtkTextBuffer

Return:
%TRUE is there is rich text available, %FALSE otherwise.

Since:
2.10

bool waitIsTargetAvailable (GdkAtom 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.

If you want to see if there’s text available on the clipboard, use gtk_clipboard_wait_is_text_available () instead.

Params:
GdkAtom target A #GdkAtom indicating which target to look for.

Return:
%TRUE if the target is available, %FALSE otherwise.

Since:
2.6

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.

This function is a little faster than calling gtk_clipboard_wait_for_text() since it doesn’t need to retrieve the actual text.

Return:
%TRUE is there is text available, %FALSE otherwise.

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.

This function is a little faster than calling gtk_clipboard_wait_for_uris() since it doesn’t need to retrieve the actual URI data.

Return:
%TRUE is there is an URI list available, %FALSE otherwise.

Since:
2.14

gulong addOnOwnerChange (void delegate(GdkEventOwnerChange*, Clipboard) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::owner-change signal is emitted when GTK+ receives an event that indicates that the ownership of the selection associated with @clipboard has changed.

Params:
event the @GdkEventOwnerChange event

Since:
2.6

gulong addOnOwnerChange (void delegate(Event, Clipboard) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
The ::owner-change signal is emitted when GTK+ receives an event that indicates that the ownership of the selection associated with @clipboard has changed.

Params:
event the @GdkEventOwnerChange event

Since:
2.6

Page was generated with on Fri Jan 6 23:09:19 2017