Implemented Interfaces

Signals

Description

Together with GtkPlug, GtkSocket 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
that widget's window ID 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 applications window.

The socket's window ID is obtained by using
gtk_socket_get_id(). Before using this function,
the socket must have been realized, and for hence,
have been added to its parent.

Example 55. Obtaining the window ID of a socket.

GtkWidget *socket = gtk_socket_new ();
gtk_widget_show (socket);
gtk_container_add (GTK_CONTAINER (parent), socket);
/* The following call is only necessary if one of
* the ancestors of the socket is not yet visible.
*/
gtk_widget_realize (socket);
g_print ("The ID of the sockets window is %x\n",
gtk_socket_get_id (socket));

Note that if you pass the window ID of the socket to another
process that will create a plug in the socket, you
must make sure that the socket widget is not destroyed
until that plug is created. Violating this rule will
cause unpredictable consequences, the most likely
consequence being that the plug will appear as a
separate toplevel window. You can check if the plug
has been created by examining the
plug_window field of the
GtkSocket structure. If this field is non-NULL,
then the plug has been successfully created inside
of the socket.

When GTK+ is notified that the embedded window has been
destroyed, then it will destroy the socket as well. You
should always, therefore, be prepared for your sockets
to be destroyed at any time when the main event loop
is running. To prevent this from happening, you can
connect to the "plug-removed" signal.

The communication between a GtkSocket and a GtkPlug follows the
XEmbed
protocol. This protocol has also been implemented in other toolkits, e.g.
Qt, allowing the same level of integration
when embedding a Qt widget in GTK or vice versa.

A socket can also be used to swallow arbitrary
pre-existing top-level windows using gtk_socket_steal(),
though the integration when this is done will not be as close
as between a GtkPlug and a GtkSocket.

Note

The GtkPlug and GtkSocket widgets are currently not available
on all platforms supported by GTK+.

Details

GtkSocket

typedef struct _GtkSocket GtkSocket;

The GtkSocket structure contains the plug_window
field. (This field should be considered read-only. It should
never be set by an application.)

gtk_socket_new ()

gtk_socket_steal ()

Warning

gtk_socket_steal is deprecated and should not be used in newly-written code.

Reparents a pre-existing toplevel window into a GtkSocket. This is
meant to embed clients that do not know about embedding into a
GtkSocket, however doing so is inherently unreliable, and using
this function is not recommended.

The GtkSocket must have already be added into a toplevel window
before you can make this call.