GtkSocket

Name

GtkSocket -- Container for widgets from other processes.

Synopsis


#include <gtk/gtk.h>


struct      GtkSocket;
GtkWidget*  gtk_socket_new                  (void);
void        gtk_socket_steal                (GtkSocket *socket,
                                             GdkNativeWindow wid);
void        gtk_socket_add_id               (GtkSocket *socket,
                                             GdkNativeWindow id);
GdkNativeWindow gtk_socket_get_id           (GtkSocket *socket);


Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkSocket

Signal Prototypes


"plug-added"
            void        user_function      (GtkSocket *socket,
                                            gpointer user_data);
"plug-removed"
            gboolean    user_function      (GtkSocket *socket,
                                            gpointer user_data);

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 XID of that widget's window to the other process, which then creates a GtkPlug window with that XID. Any widgets contained in the GtkPlug then will appear inside the first applications window.

The XID of the socket's window is obtained by using the GTK_WINDOW_XWINDOW() macro from the header file <gdk/gdkx.h>. Before using this macro, the socket must have been realized, and for hence, have been added to its parent.

Example 1. Obtaining the XID of a socket

include <gdk/gdkx.h>

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 XID of the sockets window is %x\n",
         GDK_WINDOW_XWINDOW (socket->window));

Note that if you pass the XID 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 succesfully 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.

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.

Details

struct GtkSocket

struct GtkSocket;

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

GdkWindow *plug_window;the window embedded inside this GtkSocket.


gtk_socket_new ()

GtkWidget*  gtk_socket_new                  (void);

Create a new empty GtkSocket.

Returns : the new GtkSocket.


gtk_socket_steal ()

void        gtk_socket_steal                (GtkSocket *socket,
                                             GdkNativeWindow wid);

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.

socket : a GtkSocket
wid : the XID of an existing toplevel window.


gtk_socket_add_id ()

void        gtk_socket_add_id               (GtkSocket *socket,
                                             GdkNativeWindow id);

Adds an XEMBED client, such as a GtkPlug, to the GtkSocket. The client may be in the same process or in a different process.

To embed a GtkPlug in a GtkSocket, you can either create the GtkPlug with gtk_plug_new (0), call gtk_plug_get_id() to get the window ID of the plug, and then pass that to the gtk_socket_add_id(), or you can call gtk_socket_get_id() to get the window ID for the socket, and call gtk_plug_new() passing in that ID.

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

socket : a GtkSocket
id : the XID of a client participating in the XEMBED protocol.


gtk_socket_get_id ()

GdkNativeWindow gtk_socket_get_id           (GtkSocket *socket);

Gets the window ID of a GtkSocket widget, which can then be used to create a client embedded inside the socket, for instance with gtk_socket_new (id). The GtkSocket must have already be added into a toplevel window before you can make this call.

socket : a GtkSocket.
Returns : the window ID for the socket

Signals

The "plug-added" signal

void        user_function                  (GtkSocket *socket,
                                            gpointer user_data);

socket :the object which received the signal.
user_data :user data set when the signal handler was connected.


The "plug-removed" signal

gboolean    user_function                  (GtkSocket *socket,
                                            gpointer user_data);

socket :the object which received the signal.
user_data :user data set when the signal handler was connected.
Returns : 

See Also

GtkPlug

the widget that plugs into a GtkSocket.