Clipboards: GTK+ 3 Reference Manual

Clipboards

Clipboards — Storing data on clipboards

Functions

void	(*GtkClipboardReceivedFunc) ()
void	(*GtkClipboardTextReceivedFunc) ()
void	(*GtkClipboardImageReceivedFunc) ()
void	(*GtkClipboardTargetsReceivedFunc) ()
void	(*GtkClipboardRichTextReceivedFunc) ()
void	(*GtkClipboardURIReceivedFunc) ()
void	(*GtkClipboardGetFunc) ()
void	(*GtkClipboardClearFunc) ()
GtkClipboard *	gtk_clipboard_get ()
GtkClipboard *	gtk_clipboard_get_for_display ()
GdkDisplay *	gtk_clipboard_get_display ()
GtkClipboard *	gtk_clipboard_get_default ()
gboolean	gtk_clipboard_set_with_data ()
gboolean	gtk_clipboard_set_with_owner ()
GObject *	gtk_clipboard_get_owner ()
void	gtk_clipboard_clear ()
void	gtk_clipboard_set_text ()
void	gtk_clipboard_set_image ()
void	gtk_clipboard_request_contents ()
void	gtk_clipboard_request_text ()
void	gtk_clipboard_request_image ()
void	gtk_clipboard_request_targets ()
void	gtk_clipboard_request_rich_text ()
void	gtk_clipboard_request_uris ()
GtkSelectionData *	gtk_clipboard_wait_for_contents ()
gchar *	gtk_clipboard_wait_for_text ()
GdkPixbuf *	gtk_clipboard_wait_for_image ()
guint8 *	gtk_clipboard_wait_for_rich_text ()
gchar **	gtk_clipboard_wait_for_uris ()
gboolean	gtk_clipboard_wait_is_text_available ()
gboolean	gtk_clipboard_wait_is_image_available ()
gboolean	gtk_clipboard_wait_is_rich_text_available ()
gboolean	gtk_clipboard_wait_is_uris_available ()
gboolean	gtk_clipboard_wait_for_targets ()
gboolean	gtk_clipboard_wait_is_target_available ()
void	gtk_clipboard_set_can_store ()
void	gtk_clipboard_store ()
GdkAtom	gtk_clipboard_get_selection ()

Signals

void

owner-change

Run First

Types and Values

GtkClipboard

Object Hierarchy

    GObject
    ╰── GtkClipboard

Includes

#include <gtk/gtk.h>

Description

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

Functions

GtkClipboardReceivedFunc ()

void
(*GtkClipboardReceivedFunc) (GtkClipboard *clipboard,
                             GtkSelectionData *selection_data,
                             gpointer data);

A function to be called when the results of gtk_clipboard_request_contents() are received, or when the request fails.

Parameters

clipboard	the GtkClipboard
selection_data	a GtkSelectionData containing the data was received. If retrieving the data failed, then then length field of `selection_data` will be negative.
data	the `user_data` supplied to `gtk_clipboard_request_contents()`.	[closure]

GtkClipboardTextReceivedFunc ()

void
(*GtkClipboardTextReceivedFunc) (GtkClipboard *clipboard,
                                 const gchar *text,
                                 gpointer data);

A function to be called when the results of gtk_clipboard_request_text() are received, or when the request fails.

Parameters

clipboard	the GtkClipboard
text	the text received, as a UTF-8 encoded string, or `NULL` if retrieving the data failed.	[nullable]
data	the `user_data` supplied to `gtk_clipboard_request_text()`.	[closure]

GtkClipboardImageReceivedFunc ()

void
(*GtkClipboardImageReceivedFunc) (GtkClipboard *clipboard,
                                  GdkPixbuf *pixbuf,
                                  gpointer data);

A function to be called when the results of gtk_clipboard_request_image() are received, or when the request fails.

Parameters

clipboard	the GtkClipboard
pixbuf	the received image
data	the `user_data` supplied to `gtk_clipboard_request_image()`.	[closure]

Since: 2.6

GtkClipboardTargetsReceivedFunc ()

void
(*GtkClipboardTargetsReceivedFunc) (GtkClipboard *clipboard,
                                    GdkAtom *atoms,
                                    gint n_atoms,
                                    gpointer data);

A function to be called when the results of gtk_clipboard_request_targets() are received, or when the request fails.

Parameters

clipboard	the GtkClipboard
atoms	the supported targets, as array of GdkAtom, or `NULL` if retrieving the data failed.	[nullable][array length=n_atoms]
n_atoms	the length of the `atoms` array.
data	the `user_data` supplied to `gtk_clipboard_request_targets()`.	[closure]

Since: 2.4

GtkClipboardRichTextReceivedFunc ()

void
(*GtkClipboardRichTextReceivedFunc) (GtkClipboard *clipboard,
                                     GdkAtom format,
                                     const guint8 *text,
                                     gsize length,
                                     gpointer data);

A function to be called when the results of gtk_clipboard_request_rich_text() are received, or when the request fails.

Parameters

clipboard	the GtkClipboard
format	The format of the rich text
text	the rich text received, as a UTF-8 encoded string, or `NULL` if retrieving the data failed.	[nullable][type utf8]
length	Length of the text.
data	the `user_data` supplied to `gtk_clipboard_request_rich_text()`.	[closure]

Since: 2.10

GtkClipboardURIReceivedFunc ()

void
(*GtkClipboardURIReceivedFunc) (GtkClipboard *clipboard,
                                gchar **uris,
                                gpointer data);

A function to be called when the results of gtk_clipboard_request_uris() are received, or when the request fails.

Parameters

clipboard	the GtkClipboard
uris	the received URIs.	[array zero-terminated=1]
data	the `user_data` supplied to `gtk_clipboard_request_uris()`.	[closure]

Since: 2.14

GtkClipboardGetFunc ()

void
(*GtkClipboardGetFunc) (GtkClipboard *clipboard,
                        GtkSelectionData *selection_data,
                        guint info,
                        gpointer user_data_or_owner);

A function that will be called to provide the contents of the selection. If multiple types of data were advertised, the requested type can be determined from the info parameter or by checking the target field of selection_data . If the data could successfully be converted into then it should be stored into the selection_data object by calling gtk_selection_data_set() (or related functions such as gtk_selection_data_set_text()). If no data is set, the requestor will be informed that the attempt to get the data failed.

Parameters

clipboard	the GtkClipboard
selection_data	a GtkSelectionData argument in which the requested data should be stored.
info	the info field corresponding to the requested target from the GtkTargetEntry array passed to `gtk_clipboard_set_with_data()` or `gtk_clipboard_set_with_owner()`.
user_data_or_owner	the `user_data` argument passed to `gtk_clipboard_set_with_data()`, or the `owner` argument passed to `gtk_clipboard_set_with_owner()`

GtkClipboardClearFunc ()

void
(*GtkClipboardClearFunc) (GtkClipboard *clipboard,
                          gpointer user_data_or_owner);

A function that will be called when the contents of the clipboard are changed or cleared. Once this has called, the user_data_or_owner argument will not be used again.

Parameters

clipboard	the GtkClipboard
user_data_or_owner	the `user_data` argument passed to `gtk_clipboard_set_with_data()`, or the `owner` argument passed to `gtk_clipboard_set_with_owner()`

gtk_clipboard_get ()

GtkClipboard *
gtk_clipboard_get (GdkAtom selection);

Returns

[transfer none]

gtk_clipboard_get_for_display ()

GtkClipboard *
gtk_clipboard_get_for_display (GdkDisplay *display,
                               GdkAtom selection);

Returns

[transfer none]

Since: 2.2

gtk_clipboard_get_display ()

GdkDisplay *
gtk_clipboard_get_display (GtkClipboard *clipboard);

Returns

[transfer none]

Since: 2.2

gtk_clipboard_get_default ()

GtkClipboard *
gtk_clipboard_get_default (GdkDisplay *display);

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

Parameters

display

the GdkDisplay for which the clipboard is to be retrieved.

Returns

the default clipboard object.

[transfer none]

Since: 3.16

gtk_clipboard_set_with_data ()

gboolean
gtk_clipboard_set_with_data (GtkClipboard *clipboard,
                             const GtkTargetEntry *targets,
                             guint n_targets,
                             GtkClipboardGetFunc get_func,
                             GtkClipboardClearFunc clear_func,
                             gpointer user_data);

[skip]

Parameters

targets	.	[array length=n_targets]
get_func	.	[scope async]
clear_func	.	[scope async]

gtk_clipboard_set_with_owner ()

gboolean
gtk_clipboard_set_with_owner (GtkClipboard *clipboard,
                              const GtkTargetEntry *targets,
                              guint n_targets,
                              GtkClipboardGetFunc get_func,
                              GtkClipboardClearFunc clear_func,
                              GObject *owner);

[skip]

Parameters

targets	.	[array length=n_targets]
get_func	.	[scope async]
clear_func	.	[scope async]

gtk_clipboard_get_owner ()

GObject *
gtk_clipboard_get_owner (GtkClipboard *clipboard);

Returns

[transfer none]

gtk_clipboard_clear ()

void
gtk_clipboard_clear (GtkClipboard *clipboard);

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.

Parameters

clipboard

a GtkClipboard

gtk_clipboard_set_text ()

void
gtk_clipboard_set_text (GtkClipboard *clipboard,
                        const gchar *text,
                        gint 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.

Parameters

clipboard	a GtkClipboard object
text	a UTF-8 string.
len	length of `text` , in bytes, or -1, in which case the length will be determined with `strlen()`.

gtk_clipboard_set_image ()

void
gtk_clipboard_set_image (GtkClipboard *clipboard,
                         GdkPixbuf *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.

Parameters

clipboard	a GtkClipboard object
pixbuf	a GdkPixbuf

Since: 2.6

gtk_clipboard_request_contents ()

void
gtk_clipboard_request_contents (GtkClipboard *clipboard,
                                GdkAtom target,
                                GtkClipboardReceivedFunc callback,
                                gpointer user_data);

Parameters

callback

[scope async]

gtk_clipboard_request_text ()

void
gtk_clipboard_request_text (GtkClipboard *clipboard,
                            GtkClipboardTextReceivedFunc callback,
                            gpointer user_data);

Parameters

callback

[scope async]

gtk_clipboard_request_image ()

void
gtk_clipboard_request_image (GtkClipboard *clipboard,
                             GtkClipboardImageReceivedFunc callback,
                             gpointer user_data);

Parameters

callback

[scope async]

Since: 2.6

gtk_clipboard_request_targets ()

void
gtk_clipboard_request_targets (GtkClipboard *clipboard,
                               GtkClipboardTargetsReceivedFunc callback,
                               gpointer user_data);

Parameters

callback

[scope async]

Since: 2.4

gtk_clipboard_request_rich_text ()

void
gtk_clipboard_request_rich_text (GtkClipboard *clipboard,
                                 GtkTextBuffer *buffer,
                                 GtkClipboardRichTextReceivedFunc callback,
                                 gpointer user_data);

Parameters

callback

[scope async]

Since: 2.10

gtk_clipboard_request_uris ()

void
gtk_clipboard_request_uris (GtkClipboard *clipboard,
                            GtkClipboardURIReceivedFunc callback,
                            gpointer user_data);

Parameters

callback

[scope async]

Since: 2.14

gtk_clipboard_wait_for_contents ()

GtkSelectionData *
gtk_clipboard_wait_for_contents (GtkClipboard *clipboard,
                                 GdkAtom target);

Returns

[nullable]

gtk_clipboard_wait_for_text ()

gchar *
gtk_clipboard_wait_for_text (GtkClipboard *clipboard);

Returns

[nullable]

gtk_clipboard_wait_for_image ()

GdkPixbuf *
gtk_clipboard_wait_for_image (GtkClipboard *clipboard);

Returns

[nullable][transfer full]

Since: 2.6

gtk_clipboard_wait_for_rich_text ()

guint8 *
gtk_clipboard_wait_for_rich_text (GtkClipboard *clipboard,
                                  GtkTextBuffer *buffer,
                                  GdkAtom *format,
                                  gsize *length);

Parameters

format	.	[out]
length	.	[out]

Returns

[nullable]

Since: 2.10

gtk_clipboard_wait_for_uris ()

gchar **
gtk_clipboard_wait_for_uris (GtkClipboard *clipboard);

Returns

[nullable][array zero-terminated=1]

Since: 2.14

gtk_clipboard_wait_is_text_available ()

gboolean
gtk_clipboard_wait_is_text_available (GtkClipboard *clipboard);

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.

Parameters

clipboard

a GtkClipboard

Returns

TRUE is there is text available, FALSE otherwise.

gtk_clipboard_wait_is_image_available ()

gboolean
gtk_clipboard_wait_is_image_available (GtkClipboard *clipboard);

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.

Parameters

clipboard

a GtkClipboard

Returns

TRUE is there is an image available, FALSE otherwise.

Since: 2.6

gtk_clipboard_wait_is_rich_text_available ()

gboolean
gtk_clipboard_wait_is_rich_text_available
                               (GtkClipboard *clipboard,
                                GtkTextBuffer *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.

Parameters

clipboard	a GtkClipboard
buffer	a GtkTextBuffer

Returns

TRUE is there is rich text available, FALSE otherwise.

Since: 2.10

gtk_clipboard_wait_is_uris_available ()

gboolean
gtk_clipboard_wait_is_uris_available (GtkClipboard *clipboard);

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.

Parameters

clipboard

a GtkClipboard

Returns

TRUE is there is an URI list available, FALSE otherwise.

Since: 2.14

gtk_clipboard_wait_for_targets ()

gboolean
gtk_clipboard_wait_for_targets (GtkClipboard *clipboard,
                                GdkAtom **targets,
                                gint *n_targets);

Parameters

targets	.	[out][array length=n_targets]
n_targets	.	[out]

Since: 2.4

gtk_clipboard_wait_is_target_available ()

gboolean
gtk_clipboard_wait_is_target_available
                               (GtkClipboard *clipboard,
                                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.

Parameters

clipboard	a GtkClipboard
target	A GdkAtom indicating which target to look for.

Returns

TRUE if the target is available, FALSE otherwise.

Since: 2.6

gtk_clipboard_set_can_store ()

void
gtk_clipboard_set_can_store (GtkClipboard *clipboard,
                             const GtkTargetEntry *targets,
                             gint n_targets);

Parameters

targets

[allow-none][array length=n_targets]

Since: 2.6

gtk_clipboard_store ()

void
gtk_clipboard_store (GtkClipboard *clipboard);

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

Parameters

clipboard

a GtkClipboard

Since: 2.6

gtk_clipboard_get_selection ()

GdkAtom
gtk_clipboard_get_selection (GtkClipboard *clipboard);

Gets the selection that this clipboard is for.

Parameters

clipboard

a GtkClipboard

Returns

the selection

Since: 3.22

Types and Values

GtkClipboard

typedef struct _GtkClipboard GtkClipboard;

Signal Details

The `“owner-change”` signal

void
user_function (GtkClipboard *clipboard,
               GdkEvent     *event,
               gpointer      user_data)

Parameters

event	.	[type GdkEventOwnerChange]
user_data	user data set when the signal handler was connected.

Flags: Run First

Since: 2.6