forked from AuroraMiddleware/gtk
5a76c23600
Wed Dec 24 01:12:53 2003 Matthias Clasen <maclas@gmx.de> * gtk/gtkclipboard.[hc]: Add GtkClipboardTargetReceivedFunc, gtk_clipboard_request_targets() and gtk_clipboard_wait_for_targets(). (#101774, Dom Lachowicz)
1107 lines
32 KiB
C
1107 lines
32 KiB
C
/* GTK - The GIMP Toolkit
|
|
* Copyright (C) 2000 Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*
|
|
* Global clipboard abstraction.
|
|
*/
|
|
|
|
#include <string.h>
|
|
|
|
#include "gtkclipboard.h"
|
|
#include "gtkinvisible.h"
|
|
#include "gtkmain.h"
|
|
|
|
#ifdef GDK_WINDOWING_X11
|
|
#include "x11/gdkx.h"
|
|
#endif
|
|
|
|
#ifdef GDK_WINDOWING_WIN32
|
|
#include "win32/gdkwin32.h"
|
|
#endif
|
|
|
|
typedef struct _GtkClipboardClass GtkClipboardClass;
|
|
|
|
typedef struct _RequestContentsInfo RequestContentsInfo;
|
|
typedef struct _RequestTextInfo RequestTextInfo;
|
|
typedef struct _RequestTargetsInfo RequestTargetsInfo;
|
|
|
|
struct _GtkClipboard
|
|
{
|
|
GObject parent_instance;
|
|
|
|
GdkAtom selection;
|
|
|
|
GtkClipboardGetFunc get_func;
|
|
GtkClipboardClearFunc clear_func;
|
|
gpointer user_data;
|
|
gboolean have_owner;
|
|
|
|
guint32 timestamp;
|
|
|
|
gboolean have_selection;
|
|
GdkDisplay *display;
|
|
};
|
|
|
|
struct _GtkClipboardClass
|
|
{
|
|
GObjectClass parent_class;
|
|
};
|
|
|
|
struct _RequestContentsInfo
|
|
{
|
|
GtkClipboardReceivedFunc callback;
|
|
gpointer user_data;
|
|
};
|
|
|
|
struct _RequestTextInfo
|
|
{
|
|
GtkClipboardTextReceivedFunc callback;
|
|
gpointer user_data;
|
|
};
|
|
|
|
struct _RequestTargetsInfo
|
|
{
|
|
GtkClipboardTargetsReceivedFunc callback;
|
|
gpointer user_data;
|
|
};
|
|
|
|
static void gtk_clipboard_class_init (GtkClipboardClass *class);
|
|
static void gtk_clipboard_finalize (GObject *object);
|
|
|
|
static void clipboard_unset (GtkClipboard *clipboard);
|
|
static void selection_received (GtkWidget *widget,
|
|
GtkSelectionData *selection_data,
|
|
guint time);
|
|
|
|
enum {
|
|
TARGET_STRING,
|
|
TARGET_TEXT,
|
|
TARGET_COMPOUND_TEXT,
|
|
TARGET_UTF8_STRING
|
|
};
|
|
|
|
static const gchar request_contents_key[] = "gtk-request-contents";
|
|
static GQuark request_contents_key_id = 0;
|
|
|
|
static const gchar clipboards_owned_key[] = "gtk-clipboards-owned";
|
|
static GQuark clipboards_owned_key_id = 0;
|
|
|
|
static GObjectClass *parent_class;
|
|
|
|
GType
|
|
gtk_clipboard_get_type (void)
|
|
{
|
|
static GType clipboard_type = 0;
|
|
|
|
if (!clipboard_type)
|
|
{
|
|
static const GTypeInfo clipboard_info =
|
|
{
|
|
sizeof (GtkClipboardClass),
|
|
NULL, /* base_init */
|
|
NULL, /* base_finalize */
|
|
(GClassInitFunc) gtk_clipboard_class_init,
|
|
NULL, /* class_finalize */
|
|
NULL, /* class_data */
|
|
sizeof (GtkClipboard),
|
|
0, /* n_preallocs */
|
|
(GInstanceInitFunc) NULL,
|
|
};
|
|
|
|
clipboard_type = g_type_register_static (G_TYPE_OBJECT, "GtkClipboard",
|
|
&clipboard_info, 0);
|
|
}
|
|
|
|
return clipboard_type;
|
|
}
|
|
|
|
static void
|
|
gtk_clipboard_class_init (GtkClipboardClass *class)
|
|
{
|
|
GObjectClass *gobject_class = G_OBJECT_CLASS (class);
|
|
|
|
parent_class = g_type_class_peek_parent (class);
|
|
|
|
gobject_class->finalize = gtk_clipboard_finalize;
|
|
}
|
|
|
|
static void
|
|
gtk_clipboard_finalize (GObject *object)
|
|
{
|
|
clipboard_unset (GTK_CLIPBOARD (object));
|
|
}
|
|
|
|
static void
|
|
clipboard_display_closed (GdkDisplay *display,
|
|
gboolean is_error,
|
|
GtkClipboard *clipboard)
|
|
{
|
|
GSList *clipboards;
|
|
|
|
clipboards = g_object_get_data (G_OBJECT (display), "gtk-clipboard-list");
|
|
g_object_run_dispose (G_OBJECT (clipboard));
|
|
g_object_unref (clipboard);
|
|
clipboards = g_slist_remove (clipboards, clipboard);
|
|
|
|
g_object_set_data (G_OBJECT (display), "gtk-clipboard-list", clipboards);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_get_for_display:
|
|
* @display: the display for which the clipboard is to be retrieved or created
|
|
* @selection: a #GdkAtom which identifies the clipboard
|
|
* to use.
|
|
*
|
|
* 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 <literal>gdk_atom_intern
|
|
* ("CLIPBOARD", FALSE)</literal>. See
|
|
* <ulink url="http://www.freedesktop.org/standards/clipboards.txt">
|
|
* http://www.freedesktop.org/standards/clipboards.txt</ulink>
|
|
* 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".
|
|
*
|
|
* Return value: 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 for all time and
|
|
* cannot be freed.
|
|
*
|
|
* Since: 2.2
|
|
**/
|
|
GtkClipboard *
|
|
gtk_clipboard_get_for_display (GdkDisplay *display, GdkAtom selection)
|
|
{
|
|
GtkClipboard *clipboard = NULL;
|
|
GSList *clipboards;
|
|
GSList *tmp_list;
|
|
|
|
g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
|
|
g_return_val_if_fail (!display->closed, NULL);
|
|
|
|
if (selection == GDK_NONE)
|
|
selection = GDK_SELECTION_CLIPBOARD;
|
|
|
|
clipboards = g_object_get_data (G_OBJECT (display), "gtk-clipboard-list");
|
|
|
|
tmp_list = clipboards;
|
|
while (tmp_list)
|
|
{
|
|
clipboard = tmp_list->data;
|
|
if (clipboard->selection == selection)
|
|
break;
|
|
|
|
tmp_list = tmp_list->next;
|
|
}
|
|
|
|
if (!tmp_list)
|
|
{
|
|
clipboard = g_object_new (GTK_TYPE_CLIPBOARD, NULL);
|
|
clipboard->selection = selection;
|
|
clipboard->display = display;
|
|
clipboards = g_slist_prepend (clipboards, clipboard);
|
|
g_object_set_data (G_OBJECT (display), "gtk-clipboard-list", clipboards);
|
|
g_signal_connect (display, "closed",
|
|
G_CALLBACK (clipboard_display_closed), clipboard);
|
|
}
|
|
|
|
return clipboard;
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_get():
|
|
* @selection: a #GdkAtom which identifies the clipboard
|
|
* to use.
|
|
*
|
|
* Returns the clipboard object for the given selection.
|
|
* See gtk_clipboard_get_for_display() for complete details.
|
|
*
|
|
* Return value: 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 for all time and
|
|
* cannot be freed.
|
|
**/
|
|
GtkClipboard *
|
|
gtk_clipboard_get (GdkAtom selection)
|
|
{
|
|
return gtk_clipboard_get_for_display (gdk_display_get_default (), selection);
|
|
}
|
|
|
|
static void
|
|
selection_get_cb (GtkWidget *widget,
|
|
GtkSelectionData *selection_data,
|
|
guint info,
|
|
guint time)
|
|
{
|
|
GtkClipboard *clipboard = gtk_widget_get_clipboard (widget, selection_data->selection);
|
|
|
|
if (clipboard && clipboard->get_func)
|
|
clipboard->get_func (clipboard, selection_data, info, clipboard->user_data);
|
|
}
|
|
|
|
static gboolean
|
|
selection_clear_event_cb (GtkWidget *widget,
|
|
GdkEventSelection *event)
|
|
{
|
|
GtkClipboard *clipboard = gtk_widget_get_clipboard (widget, event->selection);
|
|
|
|
if (clipboard)
|
|
{
|
|
clipboard_unset (clipboard);
|
|
return TRUE;
|
|
}
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
static GtkWidget *
|
|
make_clipboard_widget (GdkDisplay *display,
|
|
gboolean provider)
|
|
{
|
|
GtkWidget *widget = gtk_invisible_new_for_screen (gdk_display_get_default_screen (display));
|
|
|
|
g_signal_connect (widget, "selection_received",
|
|
G_CALLBACK (selection_received), NULL);
|
|
|
|
if (provider)
|
|
{
|
|
/* We need this for gdk_x11_get_server_time() */
|
|
gtk_widget_add_events (widget, GDK_PROPERTY_CHANGE_MASK);
|
|
|
|
g_signal_connect (widget, "selection_get",
|
|
G_CALLBACK (selection_get_cb), NULL);
|
|
g_signal_connect (widget, "selection_clear_event",
|
|
G_CALLBACK (selection_clear_event_cb), NULL);
|
|
}
|
|
|
|
return widget;
|
|
}
|
|
|
|
static GtkWidget *
|
|
get_clipboard_widget (GdkDisplay *display)
|
|
{
|
|
GtkWidget *clip_widget = g_object_get_data (G_OBJECT (display), "gtk-clipboard-widget");
|
|
if (!clip_widget)
|
|
{
|
|
clip_widget = make_clipboard_widget (display, TRUE);
|
|
g_object_set_data (G_OBJECT (display), "gtk-clipboard-widget", clip_widget);
|
|
}
|
|
|
|
return clip_widget;
|
|
}
|
|
|
|
/* This function makes a very good guess at what the correct
|
|
* timestamp for a selection request should be. If there is
|
|
* a currently processed event, it uses the timestamp for that
|
|
* event, otherwise it uses the current server time. However,
|
|
* if the time resulting from that is older than the time used
|
|
* last time, it uses the time used last time instead.
|
|
*
|
|
* In order implement this correctly, we never use CurrentTime,
|
|
* but actually retrieve the actual timestamp from the server.
|
|
* This is a little slower but allows us to make the guarantee
|
|
* that the times used by this application will always ascend
|
|
* and we won't get selections being rejected just because
|
|
* we are using a correct timestamp from an event, but used
|
|
* CurrentTime previously.
|
|
*/
|
|
static guint32
|
|
clipboard_get_timestamp (GtkClipboard *clipboard)
|
|
{
|
|
GtkWidget *clipboard_widget = get_clipboard_widget (clipboard->display);
|
|
guint32 timestamp = gtk_get_current_event_time ();
|
|
|
|
if (timestamp == GDK_CURRENT_TIME)
|
|
{
|
|
#ifdef GDK_WINDOWING_X11
|
|
timestamp = gdk_x11_get_server_time (clipboard_widget->window);
|
|
#elif defined GDK_WINDOWING_WIN32
|
|
timestamp = GetMessageTime ();
|
|
#endif
|
|
}
|
|
else
|
|
{
|
|
if (clipboard->timestamp != GDK_CURRENT_TIME)
|
|
{
|
|
/* Check to see if clipboard->timestamp is newer than
|
|
* timestamp, accounting for wraparound.
|
|
*/
|
|
|
|
guint32 max = timestamp + 0x80000000;
|
|
|
|
if ((max > timestamp &&
|
|
(clipboard->timestamp > timestamp &&
|
|
clipboard->timestamp <= max)) ||
|
|
(max <= timestamp &&
|
|
(clipboard->timestamp > timestamp ||
|
|
clipboard->timestamp <= max)))
|
|
{
|
|
timestamp = clipboard->timestamp;
|
|
}
|
|
}
|
|
}
|
|
|
|
clipboard->timestamp = timestamp;
|
|
|
|
return timestamp;
|
|
}
|
|
|
|
static void
|
|
clipboard_owner_destroyed (gpointer data)
|
|
{
|
|
GSList *clipboards = data;
|
|
GSList *tmp_list;
|
|
|
|
tmp_list = clipboards;
|
|
while (tmp_list)
|
|
{
|
|
GtkClipboard *clipboard = tmp_list->data;
|
|
|
|
clipboard->get_func = NULL;
|
|
clipboard->clear_func = NULL;
|
|
clipboard->user_data = NULL;
|
|
clipboard->have_owner = FALSE;
|
|
|
|
gtk_clipboard_clear (clipboard);
|
|
|
|
tmp_list = tmp_list->next;
|
|
}
|
|
|
|
g_slist_free (clipboards);
|
|
}
|
|
|
|
static void
|
|
clipboard_add_owner_notify (GtkClipboard *clipboard)
|
|
{
|
|
if (!clipboards_owned_key_id)
|
|
clipboards_owned_key_id = g_quark_from_static_string (clipboards_owned_key);
|
|
|
|
if (clipboard->have_owner)
|
|
g_object_set_qdata_full (clipboard->user_data, clipboards_owned_key_id,
|
|
g_slist_prepend (g_object_steal_qdata (clipboard->user_data,
|
|
clipboards_owned_key_id),
|
|
clipboard),
|
|
clipboard_owner_destroyed);
|
|
}
|
|
|
|
static void
|
|
clipboard_remove_owner_notify (GtkClipboard *clipboard)
|
|
{
|
|
if (clipboard->have_owner)
|
|
g_object_set_qdata_full (clipboard->user_data, clipboards_owned_key_id,
|
|
g_slist_remove (g_object_steal_qdata (clipboard->user_data,
|
|
clipboards_owned_key_id),
|
|
clipboard),
|
|
clipboard_owner_destroyed);
|
|
}
|
|
|
|
static gboolean
|
|
gtk_clipboard_set_contents (GtkClipboard *clipboard,
|
|
const GtkTargetEntry *targets,
|
|
guint n_targets,
|
|
GtkClipboardGetFunc get_func,
|
|
GtkClipboardClearFunc clear_func,
|
|
gpointer user_data,
|
|
gboolean have_owner)
|
|
{
|
|
GtkWidget *clipboard_widget = get_clipboard_widget (clipboard->display);
|
|
|
|
if (gtk_selection_owner_set_for_display (clipboard->display,
|
|
clipboard_widget,
|
|
clipboard->selection,
|
|
clipboard_get_timestamp (clipboard)))
|
|
{
|
|
clipboard->have_selection = TRUE;
|
|
|
|
if (!(clipboard->have_owner && have_owner) ||
|
|
clipboard->user_data != user_data)
|
|
{
|
|
clipboard_unset (clipboard);
|
|
|
|
if (clipboard->get_func)
|
|
{
|
|
/* Calling unset() caused the clipboard contents to be reset!
|
|
* Avoid leaking and return
|
|
*/
|
|
if (!(clipboard->have_owner && have_owner) ||
|
|
clipboard->user_data != user_data)
|
|
{
|
|
(*clear_func) (clipboard, user_data);
|
|
return FALSE;
|
|
}
|
|
else
|
|
return TRUE;
|
|
}
|
|
else
|
|
{
|
|
clipboard->user_data = user_data;
|
|
clipboard->have_owner = have_owner;
|
|
if (have_owner)
|
|
clipboard_add_owner_notify (clipboard);
|
|
}
|
|
|
|
}
|
|
|
|
clipboard->get_func = get_func;
|
|
clipboard->clear_func = clear_func;
|
|
|
|
gtk_selection_clear_targets (clipboard_widget, clipboard->selection);
|
|
gtk_selection_add_targets (clipboard_widget, clipboard->selection,
|
|
targets, n_targets);
|
|
|
|
return TRUE;
|
|
}
|
|
else
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_set_with_data:
|
|
* @clipboard: a #GtkClipboard
|
|
* @targets: array containing information about the available forms for the
|
|
* clipboard data
|
|
* @n_targets: number of elements in @targets
|
|
* @get_func: function to call to get the actual clipboard data
|
|
* @clear_func: when the clipboard contents are set again, this function will
|
|
* be called, and @get_func will not be subsequently called.
|
|
* @user_data: user data to pass to @get_func and @clear_func.
|
|
*
|
|
* 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.
|
|
*
|
|
* Return value: %TRUE if setting the clipboard data succeeded. If setting
|
|
* the clipboard data failed the provided callback functions
|
|
* will be ignored.
|
|
**/
|
|
gboolean
|
|
gtk_clipboard_set_with_data (GtkClipboard *clipboard,
|
|
const GtkTargetEntry *targets,
|
|
guint n_targets,
|
|
GtkClipboardGetFunc get_func,
|
|
GtkClipboardClearFunc clear_func,
|
|
gpointer user_data)
|
|
{
|
|
g_return_val_if_fail (clipboard != NULL, FALSE);
|
|
g_return_val_if_fail (targets != NULL, FALSE);
|
|
g_return_val_if_fail (get_func != NULL, FALSE);
|
|
|
|
return gtk_clipboard_set_contents (clipboard, targets, n_targets,
|
|
get_func, clear_func, user_data,
|
|
FALSE);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_set_with_owner:
|
|
* @clipboard: a #GtkClipboard
|
|
* @targets: array containing information about the available forms for the
|
|
* clipboard data
|
|
* @n_targets: number of elements in @targets
|
|
* @get_func: function to call to get the actual clipboard data
|
|
* @clear_func: when the clipboard contents are set again, this function will
|
|
* be called, and @get_func will not be subsequently called.
|
|
* @owner: an object that "owns" the data. This object will be passed
|
|
* to the callbacks when called.
|
|
*
|
|
* 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.
|
|
*
|
|
* Return value: %TRUE if setting the clipboard data succeeded. If setting
|
|
* the clipboard data failed the provided callback functions
|
|
* will be ignored.
|
|
**/
|
|
gboolean
|
|
gtk_clipboard_set_with_owner (GtkClipboard *clipboard,
|
|
const GtkTargetEntry *targets,
|
|
guint n_targets,
|
|
GtkClipboardGetFunc get_func,
|
|
GtkClipboardClearFunc clear_func,
|
|
GObject *owner)
|
|
{
|
|
g_return_val_if_fail (clipboard != NULL, FALSE);
|
|
g_return_val_if_fail (targets != NULL, FALSE);
|
|
g_return_val_if_fail (get_func != NULL, FALSE);
|
|
g_return_val_if_fail (G_IS_OBJECT (owner), FALSE);
|
|
|
|
return gtk_clipboard_set_contents (clipboard, targets, n_targets,
|
|
get_func, clear_func, owner,
|
|
TRUE);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_get_owner:
|
|
* @clipboard: a #GtkClipboard
|
|
*
|
|
* 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 value: the owner of the clipboard, if any; otherwise %NULL.
|
|
**/
|
|
GObject *
|
|
gtk_clipboard_get_owner (GtkClipboard *clipboard)
|
|
{
|
|
g_return_val_if_fail (clipboard != NULL, NULL);
|
|
|
|
if (clipboard->have_owner)
|
|
return clipboard->user_data;
|
|
else
|
|
return NULL;
|
|
}
|
|
|
|
static void
|
|
clipboard_unset (GtkClipboard *clipboard)
|
|
{
|
|
GtkClipboardClearFunc old_clear_func;
|
|
gpointer old_data;
|
|
|
|
old_clear_func = clipboard->clear_func;
|
|
old_data = clipboard->user_data;
|
|
|
|
if (clipboard->have_owner)
|
|
{
|
|
clipboard_remove_owner_notify (clipboard);
|
|
clipboard->have_owner = FALSE;
|
|
}
|
|
|
|
clipboard->get_func = NULL;
|
|
clipboard->clear_func = NULL;
|
|
clipboard->user_data = NULL;
|
|
|
|
if (old_clear_func)
|
|
old_clear_func (clipboard, old_data);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_clear:
|
|
* @clipboard: a #GtkClipboard
|
|
*
|
|
* 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.
|
|
**/
|
|
void
|
|
gtk_clipboard_clear (GtkClipboard *clipboard)
|
|
{
|
|
g_return_if_fail (clipboard != NULL);
|
|
|
|
if (clipboard->have_selection)
|
|
gtk_selection_owner_set_for_display (clipboard->display,
|
|
NULL,
|
|
clipboard->selection,
|
|
clipboard_get_timestamp (clipboard));
|
|
}
|
|
|
|
static void
|
|
text_get_func (GtkClipboard *clipboard,
|
|
GtkSelectionData *selection_data,
|
|
guint info,
|
|
gpointer data)
|
|
{
|
|
gtk_selection_data_set_text (selection_data, data, -1);
|
|
}
|
|
|
|
static void
|
|
text_clear_func (GtkClipboard *clipboard,
|
|
gpointer data)
|
|
{
|
|
g_free (data);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_set_text:
|
|
* @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 <function>strlen()</function>.
|
|
*
|
|
* 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.
|
|
**/
|
|
void
|
|
gtk_clipboard_set_text (GtkClipboard *clipboard,
|
|
const gchar *text,
|
|
gint len)
|
|
{
|
|
static const GtkTargetEntry targets[] = {
|
|
{ "STRING", 0, TARGET_STRING },
|
|
{ "TEXT", 0, TARGET_TEXT },
|
|
{ "COMPOUND_TEXT", 0, TARGET_COMPOUND_TEXT },
|
|
{ "UTF8_STRING", 0, TARGET_UTF8_STRING }
|
|
};
|
|
|
|
g_return_if_fail (clipboard != NULL);
|
|
g_return_if_fail (text != NULL);
|
|
|
|
if (len < 0)
|
|
len = strlen (text);
|
|
|
|
gtk_clipboard_set_with_data (clipboard,
|
|
targets, G_N_ELEMENTS (targets),
|
|
text_get_func, text_clear_func,
|
|
g_strndup (text, len));
|
|
}
|
|
|
|
static void
|
|
set_request_contents_info (GtkWidget *widget,
|
|
RequestContentsInfo *info)
|
|
{
|
|
if (!request_contents_key_id)
|
|
request_contents_key_id = g_quark_from_static_string (request_contents_key);
|
|
|
|
g_object_set_qdata (G_OBJECT (widget), request_contents_key_id, info);
|
|
}
|
|
|
|
static RequestContentsInfo *
|
|
get_request_contents_info (GtkWidget *widget)
|
|
{
|
|
if (!request_contents_key_id)
|
|
return NULL;
|
|
else
|
|
return g_object_get_qdata (G_OBJECT (widget), request_contents_key_id);
|
|
}
|
|
|
|
static void
|
|
selection_received (GtkWidget *widget,
|
|
GtkSelectionData *selection_data,
|
|
guint time)
|
|
{
|
|
RequestContentsInfo *request_info = get_request_contents_info (widget);
|
|
set_request_contents_info (widget, NULL);
|
|
|
|
request_info->callback (gtk_widget_get_clipboard (widget, selection_data->selection),
|
|
selection_data,
|
|
request_info->user_data);
|
|
|
|
g_free (request_info);
|
|
|
|
if (widget != get_clipboard_widget (gtk_widget_get_display (widget)))
|
|
gtk_widget_destroy (widget);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_request_contents:
|
|
* @clipboard: a #GtkClipboard
|
|
* @target: an atom representing the form into which the clipboard
|
|
* owner should convert the selection.
|
|
* @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.
|
|
* @user_data: user data to pass to @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.
|
|
**/
|
|
void
|
|
gtk_clipboard_request_contents (GtkClipboard *clipboard,
|
|
GdkAtom target,
|
|
GtkClipboardReceivedFunc callback,
|
|
gpointer user_data)
|
|
{
|
|
RequestContentsInfo *info;
|
|
GtkWidget *widget;
|
|
GtkWidget *clipboard_widget;
|
|
|
|
g_return_if_fail (clipboard != NULL);
|
|
g_return_if_fail (target != GDK_NONE);
|
|
g_return_if_fail (callback != NULL);
|
|
|
|
clipboard_widget = get_clipboard_widget (clipboard->display);
|
|
|
|
if (get_request_contents_info (clipboard_widget))
|
|
widget = make_clipboard_widget (clipboard->display, FALSE);
|
|
else
|
|
widget = clipboard_widget;
|
|
|
|
info = g_new (RequestContentsInfo, 1);
|
|
info->callback = callback;
|
|
info->user_data = user_data;
|
|
|
|
set_request_contents_info (widget, info);
|
|
|
|
gtk_selection_convert (widget, clipboard->selection, target,
|
|
clipboard_get_timestamp (clipboard));
|
|
}
|
|
|
|
static void
|
|
request_text_received_func (GtkClipboard *clipboard,
|
|
GtkSelectionData *selection_data,
|
|
gpointer data)
|
|
{
|
|
RequestTextInfo *info = data;
|
|
gchar *result = NULL;
|
|
|
|
result = gtk_selection_data_get_text (selection_data);
|
|
|
|
if (!result)
|
|
{
|
|
/* If we asked for UTF8 and didn't get it, try compound_text;
|
|
* if we asked for compound_text and didn't get it, try string;
|
|
* If we asked for anything else and didn't get it, give up.
|
|
*/
|
|
if (selection_data->target == gdk_atom_intern ("UTF8_STRING", FALSE))
|
|
{
|
|
gtk_clipboard_request_contents (clipboard,
|
|
gdk_atom_intern ("COMPOUND_TEXT", FALSE),
|
|
request_text_received_func, info);
|
|
return;
|
|
}
|
|
else if (selection_data->target == gdk_atom_intern ("COMPOUND_TEXT", FALSE))
|
|
{
|
|
gtk_clipboard_request_contents (clipboard,
|
|
GDK_TARGET_STRING,
|
|
request_text_received_func, info);
|
|
return;
|
|
}
|
|
}
|
|
|
|
info->callback (clipboard, result, info->user_data);
|
|
g_free (info);
|
|
g_free (result);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_request_text:
|
|
* @clipboard: a #GtkClipboard
|
|
* @callback: a function to call when the text is received,
|
|
* or the retrieval fails. (It will always be called
|
|
* one way or the other.)
|
|
* @user_data: user data to pass to @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.
|
|
*
|
|
* 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.
|
|
**/
|
|
void
|
|
gtk_clipboard_request_text (GtkClipboard *clipboard,
|
|
GtkClipboardTextReceivedFunc callback,
|
|
gpointer user_data)
|
|
{
|
|
RequestTextInfo *info;
|
|
|
|
g_return_if_fail (clipboard != NULL);
|
|
g_return_if_fail (callback != NULL);
|
|
|
|
info = g_new (RequestTextInfo, 1);
|
|
info->callback = callback;
|
|
info->user_data = user_data;
|
|
|
|
gtk_clipboard_request_contents (clipboard, gdk_atom_intern ("UTF8_STRING", FALSE),
|
|
request_text_received_func,
|
|
info);
|
|
}
|
|
|
|
static void
|
|
request_targets_received_func (GtkClipboard *clipboard,
|
|
GtkSelectionData *selection_data,
|
|
gpointer data)
|
|
{
|
|
RequestTargetsInfo *info = data;
|
|
GdkAtom *targets = NULL;
|
|
gint n_targets = 0;
|
|
|
|
gtk_selection_data_get_targets (selection_data, &targets, &n_targets);
|
|
|
|
info->callback (clipboard, targets, n_targets, info->user_data);
|
|
|
|
g_free (info);
|
|
g_free (targets);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_request_targets:
|
|
* @clipboard: a #GtkClipboard
|
|
* @callback: a function to call when the targets are received,
|
|
* or the retrieval fails. (It will always be called
|
|
* one way or the other.)
|
|
* @user_data: user data to pass to @callback.
|
|
*
|
|
* 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
|
|
**/
|
|
void
|
|
gtk_clipboard_request_targets (GtkClipboard *clipboard,
|
|
GtkClipboardTargetsReceivedFunc callback,
|
|
gpointer user_data)
|
|
{
|
|
RequestTargetsInfo *info;
|
|
|
|
g_return_if_fail (clipboard != NULL);
|
|
g_return_if_fail (callback != NULL);
|
|
|
|
info = g_new (RequestTargetsInfo, 1);
|
|
info->callback = callback;
|
|
info->user_data = user_data;
|
|
|
|
gtk_clipboard_request_contents (clipboard, gdk_atom_intern ("TARGETS", FALSE),
|
|
request_targets_received_func,
|
|
info);
|
|
}
|
|
|
|
typedef struct
|
|
{
|
|
GMainLoop *loop;
|
|
gpointer data;
|
|
} WaitResults;
|
|
|
|
static void
|
|
clipboard_received_func (GtkClipboard *clipboard,
|
|
GtkSelectionData *selection_data,
|
|
gpointer data)
|
|
{
|
|
WaitResults *results = data;
|
|
|
|
if (selection_data->length >= 0)
|
|
results->data = gtk_selection_data_copy (selection_data);
|
|
|
|
g_main_loop_quit (results->loop);
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_wait_for_contents:
|
|
* @clipboard: a #GtkClipboard
|
|
* @target: an atom representing the form into which the clipboard
|
|
* owner should convert the selection.
|
|
*
|
|
* 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.
|
|
*
|
|
* Return value: 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.
|
|
**/
|
|
GtkSelectionData *
|
|
gtk_clipboard_wait_for_contents (GtkClipboard *clipboard,
|
|
GdkAtom target)
|
|
{
|
|
WaitResults results;
|
|
|
|
g_return_val_if_fail (clipboard != NULL, NULL);
|
|
g_return_val_if_fail (target != GDK_NONE, NULL);
|
|
|
|
results.data = NULL;
|
|
results.loop = g_main_loop_new (NULL, TRUE);
|
|
|
|
gtk_clipboard_request_contents (clipboard, target,
|
|
clipboard_received_func,
|
|
&results);
|
|
|
|
if (g_main_loop_is_running (results.loop))
|
|
{
|
|
GDK_THREADS_LEAVE ();
|
|
g_main_loop_run (results.loop);
|
|
GDK_THREADS_ENTER ();
|
|
}
|
|
|
|
g_main_loop_unref (results.loop);
|
|
|
|
return results.data;
|
|
}
|
|
|
|
static void
|
|
clipboard_text_received_func (GtkClipboard *clipboard,
|
|
const gchar *text,
|
|
gpointer data)
|
|
{
|
|
WaitResults *results = data;
|
|
|
|
results->data = g_strdup (text);
|
|
g_main_loop_quit (results->loop);
|
|
}
|
|
|
|
|
|
/**
|
|
* gtk_clipboard_wait_for_text:
|
|
* @clipboard: a #GtkClipboard
|
|
*
|
|
* 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 value: 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.)
|
|
**/
|
|
gchar *
|
|
gtk_clipboard_wait_for_text (GtkClipboard *clipboard)
|
|
{
|
|
WaitResults results;
|
|
|
|
g_return_val_if_fail (clipboard != NULL, NULL);
|
|
g_return_val_if_fail (clipboard != NULL, NULL);
|
|
|
|
results.data = NULL;
|
|
results.loop = g_main_loop_new (NULL, TRUE);
|
|
|
|
gtk_clipboard_request_text (clipboard,
|
|
clipboard_text_received_func,
|
|
&results);
|
|
|
|
if (g_main_loop_is_running (results.loop))
|
|
{
|
|
GDK_THREADS_LEAVE ();
|
|
g_main_loop_run (results.loop);
|
|
GDK_THREADS_ENTER ();
|
|
}
|
|
|
|
g_main_loop_unref (results.loop);
|
|
|
|
return results.data;
|
|
}
|
|
/**
|
|
* gtk_clipboard_get_display:
|
|
* @clipboard: a #GtkClipboard
|
|
*
|
|
* Gets the #GdkDisplay associated with @clipboard
|
|
*
|
|
* Return value: the #GdkDisplay associated with @clipboard
|
|
*
|
|
* Since: 2.2
|
|
**/
|
|
GdkDisplay *
|
|
gtk_clipboard_get_display (GtkClipboard *clipboard)
|
|
{
|
|
g_return_val_if_fail (clipboard != NULL, NULL);
|
|
|
|
return clipboard->display;
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_wait_is_text_available:
|
|
* @clipboard: a #GtkClipboard
|
|
*
|
|
* 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 names: STRING, TEXT, COMPOUND_TEXT,
|
|
* UTF8_STRING. 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 value: %TRUE is there is text available, %FALSE otherwise.
|
|
**/
|
|
gboolean
|
|
gtk_clipboard_wait_is_text_available (GtkClipboard *clipboard)
|
|
{
|
|
GtkSelectionData *data;
|
|
gboolean result = FALSE;
|
|
|
|
data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern ("TARGETS", FALSE));
|
|
if (data)
|
|
{
|
|
result = gtk_selection_data_targets_include_text (data);
|
|
gtk_selection_data_free (data);
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* gtk_clipboard_wait_for_targets
|
|
* @clipboard: a #GtkClipboard
|
|
* @targets: location to store an array of targets. The result
|
|
* stored here must be freed with g_free().
|
|
* @n_targets: location to store number of items in @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.
|
|
*
|
|
* Return value: %TRUE if any targets are present on the clipboard,
|
|
* otherwise %FALSE.
|
|
*
|
|
* Since: 2.4
|
|
*/
|
|
gboolean
|
|
gtk_clipboard_wait_for_targets (GtkClipboard *clipboard,
|
|
GdkAtom **targets,
|
|
gint *n_targets)
|
|
{
|
|
GtkSelectionData *data;
|
|
gboolean result = FALSE;
|
|
|
|
g_return_val_if_fail (clipboard != NULL, FALSE);
|
|
|
|
/* TODO: see http://bugzilla.gnome.org/show_bug.cgi?id=101774 with regard to XFIXES */
|
|
|
|
if (n_targets)
|
|
*n_targets = 0;
|
|
|
|
targets = NULL;
|
|
|
|
data = gtk_clipboard_wait_for_contents (clipboard, gdk_atom_intern ("TARGETS", FALSE));
|
|
|
|
if (data)
|
|
{
|
|
result = gtk_selection_data_get_targets (data, targets, n_targets);
|
|
gtk_selection_data_free (data);
|
|
}
|
|
|
|
return result;
|
|
}
|