Clipboards

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.

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.

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.

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.

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.

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.

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.

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.

gtk_clipboard_get ()

GtkClipboard *
gtk_clipboard_get (GdkAtom selection);

Returns the clipboard object for the given selection. See gtk_clipboard_get_for_display() for complete details.

gtk_clipboard_get_for_display ()

GtkClipboard *
gtk_clipboard_get_for_display (GdkDisplay *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 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”.

Since: 2.2

gtk_clipboard_get_display ()

GdkDisplay *
gtk_clipboard_get_display (GtkClipboard *clipboard);

Gets the GdkDisplay associated with clipboard

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.

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);

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.

[skip]

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);

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.

[skip]

gtk_clipboard_get_owner ()

GObject *
gtk_clipboard_get_owner (GtkClipboard *clipboard);

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

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.

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.

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.

Since: 2.6

gtk_clipboard_request_contents ()

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

Requests the contents of clipboard as the given target. When the results of the result are later received the supplied callback will be called.

gtk_clipboard_request_text ()

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

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.

gtk_clipboard_request_image ()

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

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.

Since: 2.6

gtk_clipboard_request_targets ()

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

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.

Since: 2.4

gtk_clipboard_request_rich_text ()

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

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.

Since: 2.10

gtk_clipboard_request_uris ()

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

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.

Since: 2.14

gtk_clipboard_wait_for_contents ()

GtkSelectionData *
gtk_clipboard_wait_for_contents (GtkClipboard *clipboard,
                                 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.

gtk_clipboard_wait_for_text ()

gchar *
gtk_clipboard_wait_for_text (GtkClipboard *clipboard);

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.

gtk_clipboard_wait_for_image ()

GdkPixbuf *
gtk_clipboard_wait_for_image (GtkClipboard *clipboard);

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.

Since: 2.6

gtk_clipboard_wait_for_rich_text ()

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

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.

Since: 2.10

gtk_clipboard_wait_for_uris ()

gchar **
gtk_clipboard_wait_for_uris (GtkClipboard *clipboard);

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.

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.

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.

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.

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.

Since: 2.14

gtk_clipboard_wait_for_targets ()

gboolean
gtk_clipboard_wait_for_targets (GtkClipboard *clipboard,
                                GdkAtom **targets,
                                gint *n_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.

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.

Since: 2.6

gtk_clipboard_set_can_store ()

void
gtk_clipboard_set_can_store (GtkClipboard *clipboard,
                             const GtkTargetEntry *targets,
                             gint n_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.

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.

Since: 2.6

gtk_clipboard_get_selection ()

GdkAtom
gtk_clipboard_get_selection (GtkClipboard *clipboard);

Gets the selection that this clipboard is for.

Since: 3.22

GtkClipboard

typedef struct _GtkClipboard GtkClipboard;

The “owner-change” signal

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

The ::owner-change signal is emitted when GTK+ receives an event that indicates that the ownership of the selection associated with clipboard has changed.

Flags: Run First

Since: 2.6