Functions

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkSocket

Implemented Interfaces

GtkSocket implements AtkImplementorIface and GtkBuildable.

Includes

#include <gtk/gtk.h>

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 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 application's 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.

1
2
3
4
5
6
7
8
9
10

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 %<GTKDOCLINK HREF="x">x</GTKDOCLINK>\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 using gtk_socket_get_plug_window(). If it returns a non-NULL value, 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

protocol. This protocol has also been implemented in other toolkits, e.g.

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.

Functions

GtkWidget *
gtk_socket_new (void);

void
gtk_socket_steal (GtkSocket *socket_,
                  GdkNativeWindow wid);

void
gtk_socket_add_id (GtkSocket *socket_,
                   GdkNativeWindow window_id);

GdkNativeWindow
gtk_socket_get_id (GtkSocket *socket_);

GdkWindow *
gtk_socket_get_plug_window (GtkSocket *socket_);

Types and Values

struct GtkSocket;

Signal Details

void
user_function (GtkSocket *socket_,
               gpointer   user_data)

gboolean
user_function (GtkSocket *socket_,
               gpointer   user_data)

See Also

GtkPlug, XEmbed