* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+#include "config.h"
+
#include "gtkmain.h"
#include "gtkmarshalers.h"
#include "gtkplug.h"
+#include "gtkintl.h"
#include "gtkprivate.h"
#include "gtkplugprivate.h"
-#include "gtkalias.h"
+/**
+ * SECTION:gtkplug
+ * @Short_description: Toplevel for embedding into other processes
+ * @Title: GtkPlug
+ * @See_also: #GtkSocket
+ *
+ * Together with #GtkSocket, #GtkPlug provides the ability
+ * to embed widgets from one process into another process
+ * in a fashion that is transparent to the user. One
+ * process creates a #GtkSocket widget and passes the
+ * ID of that widget's window to the other process,
+ * which then creates a #GtkPlug with that window ID.
+ * Any widgets contained in the #GtkPlug then will appear
+ * inside the first application's window.
+ *
+ * <note>
+ * The #GtkPlug and #GtkSocket widgets are currently not available
+ * on all platforms supported by GTK+.
+ * </note>
+ */
-static void gtk_plug_class_init (GtkPlugClass *klass);
-static void gtk_plug_init (GtkPlug *plug);
+static void gtk_plug_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec);
static void gtk_plug_finalize (GObject *object);
static void gtk_plug_realize (GtkWidget *widget);
static void gtk_plug_unrealize (GtkWidget *widget);
static void gtk_plug_check_resize (GtkContainer *container);
static void gtk_plug_keys_changed (GtkWindow *window);
-static GtkWindowClass *parent_class = NULL;
static GtkBinClass *bin_class = NULL;
typedef struct
GdkModifierType accelerator_mods;
} GrabbedKey;
+enum {
+ PROP_0,
+ PROP_EMBEDDED,
+ PROP_SOCKET_WINDOW
+};
+
enum {
EMBEDDED,
LAST_SIGNAL
static guint plug_signals[LAST_SIGNAL] = { 0 };
-GType
-gtk_plug_get_type (void)
+G_DEFINE_TYPE (GtkPlug, gtk_plug, GTK_TYPE_WINDOW)
+
+static void
+gtk_plug_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
{
- static GType plug_type = 0;
+ GtkPlug *plug = GTK_PLUG (object);
- if (!plug_type)
+ switch (prop_id)
{
- static const GTypeInfo plug_info =
- {
- sizeof (GtkPlugClass),
- NULL, /* base_init */
- NULL, /* base_finalize */
- (GClassInitFunc) gtk_plug_class_init,
- NULL, /* class_finalize */
- NULL, /* class_data */
- sizeof (GtkPlug),
- 16, /* n_preallocs */
- (GInstanceInitFunc) gtk_plug_init,
- };
-
- plug_type = g_type_register_static (GTK_TYPE_WINDOW, "GtkPlug",
- &plug_info, 0);
+ case PROP_EMBEDDED:
+ g_value_set_boolean (value, plug->socket_window != NULL);
+ break;
+ case PROP_SOCKET_WINDOW:
+ g_value_set_object (value, plug->socket_window);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
}
-
- return plug_type;
}
static void
GtkWindowClass *window_class = (GtkWindowClass *)class;
GtkContainerClass *container_class = (GtkContainerClass *)class;
- parent_class = g_type_class_peek_parent (class);
bin_class = g_type_class_peek (GTK_TYPE_BIN);
+ gobject_class->get_property = gtk_plug_get_property;
gobject_class->finalize = gtk_plug_finalize;
widget_class->realize = gtk_plug_realize;
window_class->set_focus = gtk_plug_set_focus;
window_class->keys_changed = gtk_plug_keys_changed;
+ /**
+ * GtkPlug:embedded:
+ *
+ * %TRUE if the plug is embedded in a socket.
+ *
+ * Since: 2.12
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_EMBEDDED,
+ g_param_spec_boolean ("embedded",
+ P_("Embedded"),
+ P_("Whether or not the plug is embedded"),
+ FALSE,
+ GTK_PARAM_READABLE));
+
+ /**
+ * GtkPlug:socket-window:
+ *
+ * The window of the socket the plug is embedded in.
+ *
+ * Since: 2.14
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_SOCKET_WINDOW,
+ g_param_spec_object ("socket-window",
+ P_("Socket Window"),
+ P_("The window of the socket the plug is embedded in"),
+ GDK_TYPE_WINDOW,
+ GTK_PARAM_READABLE));
+
+ /**
+ * GtkPlug::embedded:
+ * @plug: the object on which the signal was emitted
+ *
+ * Gets emitted when the plug becomes embedded in a socket.
+ */
plug_signals[EMBEDDED] =
- g_signal_new ("embedded",
+ g_signal_new (I_("embedded"),
G_OBJECT_CLASS_TYPE (class),
G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GtkPlugClass, embedded),
* here, but don't bother remapping -- we will get mapped
* by gtk_widget_set_parent ().
*/
- if (GTK_WIDGET_MAPPED (plug))
+ if (gtk_widget_get_mapped (GTK_WIDGET (plug)))
gtk_widget_unmap (GTK_WIDGET (plug));
- GTK_WIDGET_UNSET_FLAGS (plug, GTK_TOPLEVEL);
+ _gtk_window_set_is_toplevel (GTK_WINDOW (plug), FALSE);
gtk_container_set_resize_mode (GTK_CONTAINER (plug), GTK_RESIZE_PARENT);
_gtk_widget_propagate_hierarchy_changed (GTK_WIDGET (plug), GTK_WIDGET (plug));
plug->modality_group = gtk_window_group_new ();
gtk_window_group_add_window (plug->modality_group, GTK_WINDOW (plug));
- GTK_WIDGET_SET_FLAGS (plug, GTK_TOPLEVEL);
+ _gtk_window_set_is_toplevel (GTK_WINDOW (plug), TRUE);
gtk_container_set_resize_mode (GTK_CONTAINER (plug), GTK_RESIZE_QUEUE);
_gtk_widget_propagate_hierarchy_changed (GTK_WIDGET (plug), NULL);
{
g_return_val_if_fail (GTK_IS_PLUG (plug), 0);
- if (!GTK_WIDGET_REALIZED (plug))
+ if (!gtk_widget_get_realized (GTK_WIDGET (plug)))
gtk_widget_realize (GTK_WIDGET (plug));
return _gtk_plug_windowing_get_id (plug);
}
+/**
+ * gtk_plug_get_embedded:
+ * @plug: a #GtkPlug
+ *
+ * Determines whether the plug is embedded in a socket.
+ *
+ * Return value: %TRUE if the plug is embedded in a socket
+ *
+ * Since: 2.14
+ **/
+gboolean
+gtk_plug_get_embedded (GtkPlug *plug)
+{
+ g_return_val_if_fail (GTK_IS_PLUG (plug), FALSE);
+
+ return plug->socket_window != NULL;
+}
+
+/**
+ * gtk_plug_get_socket_window:
+ * @plug: a #GtkPlug
+ *
+ * Retrieves the socket the plug is embedded in.
+ *
+ * Return value: the window of the socket, or %NULL
+ *
+ * Since: 2.14
+ **/
+GdkWindow *
+gtk_plug_get_socket_window (GtkPlug *plug)
+{
+ g_return_val_if_fail (GTK_IS_PLUG (plug), NULL);
+
+ return plug->socket_window;
+}
+
/**
* _gtk_plug_add_to_socket:
* @plug: a #GtkPlug
**/
void
_gtk_plug_add_to_socket (GtkPlug *plug,
- GtkSocket *socket)
+ GtkSocket *socket_)
{
GtkWidget *widget;
gint w, h;
g_return_if_fail (GTK_IS_PLUG (plug));
- g_return_if_fail (GTK_IS_SOCKET (socket));
- g_return_if_fail (GTK_WIDGET_REALIZED (socket));
+ g_return_if_fail (GTK_IS_SOCKET (socket_));
+ g_return_if_fail (gtk_widget_get_realized (GTK_WIDGET (socket_)));
widget = GTK_WIDGET (plug);
gtk_plug_set_is_child (plug, TRUE);
plug->same_app = TRUE;
- socket->same_app = TRUE;
- socket->plug_widget = widget;
+ socket_->same_app = TRUE;
+ socket_->plug_widget = widget;
- plug->socket_window = GTK_WIDGET (socket)->window;
+ plug->socket_window = GTK_WIDGET (socket_)->window;
+ g_object_ref (plug->socket_window);
+ g_signal_emit (plug, plug_signals[EMBEDDED], 0);
+ g_object_notify (G_OBJECT (plug), "embedded");
- if (GTK_WIDGET_REALIZED (widget))
+ if (gtk_widget_get_realized (widget))
{
gdk_drawable_get_size (GDK_DRAWABLE (widget->window), &w, &h);
gdk_window_reparent (widget->window, plug->socket_window, -w, -h);
}
- gtk_widget_set_parent (widget, GTK_WIDGET (socket));
+ gtk_widget_set_parent (widget, GTK_WIDGET (socket_));
- g_signal_emit_by_name (socket, "plug_added");
+ g_signal_emit_by_name (socket_, "plug-added");
}
/**
* _gtk_plug_send_delete_event:
- * widget: a #GtkWidget
+ * @widget: a #GtkWidget
*
* Send a GDK_DELETE event to the @widget and destroy it if
* necessary. Internal GTK function, called from this file or the
_gtk_plug_send_delete_event (GtkWidget *widget)
{
GdkEvent *event = gdk_event_new (GDK_DELETE);
-
+
event->any.window = g_object_ref (widget->window);
event->any.send_event = FALSE;
- gtk_widget_ref (widget);
-
+ g_object_ref (widget);
+
if (!gtk_widget_event (widget, event))
gtk_widget_destroy (widget);
-
- gtk_widget_unref (widget);
+
+ g_object_unref (widget);
gdk_event_free (event);
}
/**
* _gtk_plug_remove_from_socket:
* @plug: a #GtkPlug
- * @socket: a #GtkSocket
+ * @socket_: a #GtkSocket
*
* Removes a plug from a socket within the same application.
**/
void
_gtk_plug_remove_from_socket (GtkPlug *plug,
- GtkSocket *socket)
+ GtkSocket *socket_)
{
GtkWidget *widget;
gboolean result;
gboolean widget_was_visible;
g_return_if_fail (GTK_IS_PLUG (plug));
- g_return_if_fail (GTK_IS_SOCKET (socket));
- g_return_if_fail (GTK_WIDGET_REALIZED (plug));
+ g_return_if_fail (GTK_IS_SOCKET (socket_));
+ g_return_if_fail (gtk_widget_get_realized (GTK_WIDGET (plug)));
widget = GTK_WIDGET (plug);
return;
g_object_ref (plug);
- g_object_ref (socket);
+ g_object_ref (socket_);
- widget_was_visible = GTK_WIDGET_VISIBLE (plug);
+ widget_was_visible = gtk_widget_get_visible (widget);
gdk_window_hide (widget->window);
GTK_PRIVATE_SET_FLAG (plug, GTK_IN_REPARENT);
gtk_widget_unparent (GTK_WIDGET (plug));
GTK_PRIVATE_UNSET_FLAG (plug, GTK_IN_REPARENT);
- socket->plug_widget = NULL;
- if (socket->plug_window != NULL)
+ socket_->plug_widget = NULL;
+ if (socket_->plug_window != NULL)
{
- g_object_unref (socket->plug_window);
- socket->plug_window = NULL;
+ g_object_unref (socket_->plug_window);
+ socket_->plug_window = NULL;
}
- socket->same_app = FALSE;
+ socket_->same_app = FALSE;
plug->same_app = FALSE;
- plug->socket_window = NULL;
-
+ if (plug->socket_window != NULL)
+ {
+ g_object_unref (plug->socket_window);
+ plug->socket_window = NULL;
+ }
gtk_plug_set_is_child (plug, FALSE);
-
- g_signal_emit_by_name (socket, "plug_removed", &result);
+
+ g_signal_emit_by_name (socket_, "plug-removed", &result);
if (!result)
- gtk_widget_destroy (GTK_WIDGET (socket));
+ gtk_widget_destroy (GTK_WIDGET (socket_));
if (widget->window)
_gtk_plug_send_delete_event (widget);
g_object_unref (plug);
- if (widget_was_visible && GTK_WIDGET_VISIBLE (socket))
- gtk_widget_queue_resize (GTK_WIDGET (socket));
+ if (widget_was_visible && gtk_widget_get_visible (GTK_WIDGET (socket_)))
+ gtk_widget_queue_resize (GTK_WIDGET (socket_));
- g_object_unref (socket);
+ g_object_unref (socket_);
}
/**
gpointer user_data = NULL;
plug->socket_window = gdk_window_lookup_for_display (display, socket_id);
-
if (plug->socket_window)
- gdk_window_get_user_data (plug->socket_window, &user_data);
- else
- plug->socket_window = gdk_window_foreign_new_for_display (display, socket_id);
-
- if (user_data)
{
- if (GTK_IS_SOCKET (user_data))
- _gtk_plug_add_to_socket (plug, user_data);
- else
+ gdk_window_get_user_data (plug->socket_window, &user_data);
+
+ if (user_data)
{
- g_warning (G_STRLOC "Can't create GtkPlug as child of non-GtkSocket");
- plug->socket_window = NULL;
+ if (GTK_IS_SOCKET (user_data))
+ _gtk_plug_add_to_socket (plug, user_data);
+ else
+ {
+ g_warning (G_STRLOC "Can't create GtkPlug as child of non-GtkSocket");
+ plug->socket_window = NULL;
+ }
}
+ else
+ g_object_ref (plug->socket_window);
}
+ else
+ plug->socket_window = gdk_window_foreign_new_for_display (display, socket_id);
- if (plug->socket_window)
+ if (plug->socket_window) {
g_signal_emit (plug, plug_signals[EMBEDDED], 0);
+
+ g_object_notify (G_OBJECT (plug), "embedded");
+ }
}
}
plug->grabbed_keys = NULL;
}
- G_OBJECT_CLASS (parent_class)->finalize (object);
+ G_OBJECT_CLASS (gtk_plug_parent_class)->finalize (object);
}
static void
gtk_plug_unrealize (GtkWidget *widget)
{
- GtkPlug *plug;
-
- g_return_if_fail (GTK_IS_PLUG (widget));
-
- plug = GTK_PLUG (widget);
+ GtkPlug *plug = GTK_PLUG (widget);
if (plug->socket_window != NULL)
{
gdk_window_set_user_data (plug->socket_window, NULL);
g_object_unref (plug->socket_window);
plug->socket_window = NULL;
+
+ g_object_notify (G_OBJECT (widget), "embedded");
}
if (!plug->same_app)
gtk_window_group_remove_window (plug->modality_group, GTK_WINDOW (plug));
g_object_unref (plug->modality_group);
}
-
- if (GTK_WIDGET_CLASS (parent_class)->unrealize)
- (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
+
+ GTK_WIDGET_CLASS (gtk_plug_parent_class)->unrealize (widget);
}
static void
gtk_plug_realize (GtkWidget *widget)
{
- GtkWindow *window;
- GtkPlug *plug;
+ GtkWindow *window = GTK_WINDOW (widget);
+ GtkPlug *plug = GTK_PLUG (widget);
GdkWindowAttr attributes;
gint attributes_mask;
- g_return_if_fail (GTK_IS_PLUG (widget));
-
- GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
- window = GTK_WINDOW (widget);
- plug = GTK_PLUG (widget);
+ gtk_widget_set_realized (widget, TRUE);
attributes.window_type = GDK_WINDOW_CHILD; /* XXX GDK_WINDOW_PLUG ? */
attributes.title = window->title;
attributes_mask |= (window->title ? GDK_WA_TITLE : 0);
attributes_mask |= (window->wmclass_name ? GDK_WA_WMCLASS : 0);
- if (GTK_WIDGET_TOPLEVEL (widget))
+ if (gtk_widget_is_toplevel (widget))
{
attributes.window_type = GDK_WINDOW_TOPLEVEL;
static void
gtk_plug_show (GtkWidget *widget)
{
- if (GTK_WIDGET_TOPLEVEL (widget))
- GTK_WIDGET_CLASS (parent_class)->show (widget);
+ if (gtk_widget_is_toplevel (widget))
+ GTK_WIDGET_CLASS (gtk_plug_parent_class)->show (widget);
else
GTK_WIDGET_CLASS (bin_class)->show (widget);
}
static void
gtk_plug_hide (GtkWidget *widget)
{
- if (GTK_WIDGET_TOPLEVEL (widget))
- GTK_WIDGET_CLASS (parent_class)->hide (widget);
+ if (gtk_widget_is_toplevel (widget))
+ GTK_WIDGET_CLASS (gtk_plug_parent_class)->hide (widget);
else
GTK_WIDGET_CLASS (bin_class)->hide (widget);
}
static void
gtk_plug_map (GtkWidget *widget)
{
- if (GTK_WIDGET_TOPLEVEL (widget))
+ if (gtk_widget_is_toplevel (widget))
{
GtkBin *bin = GTK_BIN (widget);
GtkPlug *plug = GTK_PLUG (widget);
+ GtkWidget *child;
- GTK_WIDGET_SET_FLAGS (widget, GTK_MAPPED);
+ gtk_widget_set_mapped (widget, TRUE);
- if (bin->child &&
- GTK_WIDGET_VISIBLE (bin->child) &&
- !GTK_WIDGET_MAPPED (bin->child))
- gtk_widget_map (bin->child);
+ child = gtk_bin_get_child (bin);
+ if (gtk_widget_get_visible (child) &&
+ !gtk_widget_get_mapped (child))
+ gtk_widget_map (child);
_gtk_plug_windowing_map_toplevel (plug);
static void
gtk_plug_unmap (GtkWidget *widget)
{
- if (GTK_WIDGET_TOPLEVEL (widget))
+ if (gtk_widget_is_toplevel (widget))
{
GtkPlug *plug = GTK_PLUG (widget);
- GTK_WIDGET_UNSET_FLAGS (widget, GTK_MAPPED);
+ gtk_widget_set_mapped (widget, FALSE);
gdk_window_hide (widget->window);
gtk_plug_size_allocate (GtkWidget *widget,
GtkAllocation *allocation)
{
- if (GTK_WIDGET_TOPLEVEL (widget))
- GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
+ GtkWidget *child;
+
+ if (gtk_widget_is_toplevel (widget))
+ GTK_WIDGET_CLASS (gtk_plug_parent_class)->size_allocate (widget, allocation);
else
{
GtkBin *bin = GTK_BIN (widget);
widget->allocation = *allocation;
- if (GTK_WIDGET_REALIZED (widget))
+ if (gtk_widget_get_realized (widget))
gdk_window_move_resize (widget->window,
allocation->x, allocation->y,
allocation->width, allocation->height);
- if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
+ child = gtk_bin_get_child (bin);
+ if (gtk_widget_get_visible (child))
{
GtkAllocation child_allocation;
- child_allocation.x = child_allocation.y = GTK_CONTAINER (widget)->border_width;
+ child_allocation.x = child_allocation.y = gtk_container_get_border_width (GTK_CONTAINER (widget));
child_allocation.width =
MAX (1, (gint)allocation->width - child_allocation.x * 2);
child_allocation.height =
MAX (1, (gint)allocation->height - child_allocation.y * 2);
- gtk_widget_size_allocate (bin->child, &child_allocation);
+ gtk_widget_size_allocate (child, &child_allocation);
}
}
gtk_plug_key_press_event (GtkWidget *widget,
GdkEventKey *event)
{
- if (GTK_WIDGET_TOPLEVEL (widget))
- return GTK_WIDGET_CLASS (parent_class)->key_press_event (widget, event);
+ if (gtk_widget_is_toplevel (widget))
+ return GTK_WIDGET_CLASS (gtk_plug_parent_class)->key_press_event (widget, event);
else
return FALSE;
}
{
GtkPlug *plug = GTK_PLUG (window);
- GTK_WINDOW_CLASS (parent_class)->set_focus (window, focus);
+ GTK_WINDOW_CLASS (gtk_plug_parent_class)->set_focus (window, focus);
/* Ask for focus from embedder
*/
gpointer data)
{
GHashTable *new_grabbed_keys = data;
- GrabbedKey *key = g_new (GrabbedKey, 1);
+ GrabbedKey *key = g_slice_new (GrabbedKey);
key->accelerator_key = keyval;
key->accelerator_mods = modifiers;
g_hash_table_replace (new_grabbed_keys, key, key);
}
+static void
+grabbed_key_free (gpointer data)
+{
+ g_slice_free (GrabbedKey, data);
+}
+
static void
gtk_plug_keys_changed (GtkWindow *window)
{
GHashTable *new_grabbed_keys, *old_grabbed_keys;
GtkPlug *plug = GTK_PLUG (window);
- new_grabbed_keys = g_hash_table_new_full (grabbed_key_hash, grabbed_key_equal, (GDestroyNotify)g_free, NULL);
+ new_grabbed_keys = g_hash_table_new_full (grabbed_key_hash, grabbed_key_equal, (GDestroyNotify)grabbed_key_free, NULL);
_gtk_window_keys_foreach (window, keys_foreach, new_grabbed_keys);
if (plug->socket_window)
GtkPlug *plug = GTK_PLUG (widget);
GtkWindow *window = GTK_WINDOW (widget);
GtkContainer *container = GTK_CONTAINER (widget);
- GtkWidget *old_focus_child = container->focus_child;
+ GtkWidget *child;
+ GtkWidget *old_focus_child;
GtkWidget *parent;
-
+
+ old_focus_child = gtk_container_get_focus_child (container);
/* We override GtkWindow's behavior, since we don't want wrapping here.
*/
if (old_focus_child)
else
{
/* Try to focus the first widget in the window */
- if (bin->child && gtk_widget_child_focus (bin->child, direction))
+ child = gtk_bin_get_child (bin);
+ if (child && gtk_widget_child_focus (child, direction))
return TRUE;
}
- if (!GTK_CONTAINER (window)->focus_child)
+ if (!gtk_container_get_focus_child (GTK_CONTAINER (window)))
_gtk_plug_windowing_focus_to_parent (plug, direction);
return FALSE;
static void
gtk_plug_check_resize (GtkContainer *container)
{
- if (GTK_WIDGET_TOPLEVEL (container))
- GTK_CONTAINER_CLASS (parent_class)->check_resize (container);
+ if (gtk_widget_is_toplevel (GTK_WIDGET (container)))
+ GTK_CONTAINER_CLASS (gtk_plug_parent_class)->check_resize (container);
else
GTK_CONTAINER_CLASS (bin_class)->check_resize (container);
}
gtk_widget_child_focus (GTK_WIDGET (plug), direction);
}
-
-#define __GTK_PLUG_C__
-#include "gtkaliasdef.c"
projects / ~andy / gtk / blobdiff