Class
GtkClipboard
Description [src]
final class Gtk.Clipboard : GObject.Object
{
/* No available fields */
}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
gtk_clipboard_get
Returns the clipboard object for the given selection.
See gtk_clipboard_get_for_display() for complete details.
gtk_clipboard_get_default
Returns the default clipboard object for use with cut/copy/paste menu items and keyboard shortcuts.
since: 3.16
gtk_clipboard_get_for_display
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.
since: 2.2
Instance methods
gtk_clipboard_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.
gtk_clipboard_get_owner
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_request_contents
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_image
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.
since: 2.6
gtk_clipboard_request_rich_text
Requests the contents of the clipboard as rich text. When the rich
text is later received, callback will be called.
since: 2.10
gtk_clipboard_request_targets
Requests the contents of the clipboard as list of supported targets.
When the list is later received, callback will be called.
since: 2.4
gtk_clipboard_request_text
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.
gtk_clipboard_request_uris
Requests the contents of the clipboard as URIs. When the URIs are
later received callback will be called.
since: 2.14
gtk_clipboard_set_can_store
Hints that the clipboard data should be stored somewhere when the application exits or when gtk_clipboard_store () is called.
since: 2.6
gtk_clipboard_set_image
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_set_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.
gtk_clipboard_set_with_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.
gtk_clipboard_set_with_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.
gtk_clipboard_store
Stores the current clipboard data somewhere so that it will stay around after the application has quit.
since: 2.6
gtk_clipboard_wait_for_contents
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_image
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
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_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_for_text
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_uris
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_image_available
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.
since: 2.6
gtk_clipboard_wait_is_rich_text_available
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.
since: 2.10
gtk_clipboard_wait_is_target_available
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.
since: 2.6
gtk_clipboard_wait_is_text_available
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.
gtk_clipboard_wait_is_uris_available
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.
since: 2.14
Signals
Gtk.Clipboard::owner-change
The ::owner-change signal is emitted when GTK+ receives an
event that indicates that the ownership of the selection
associated with clipboard has changed.
since: 2.6
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.