Gtk-- Reference: Gtk::Socket

Class Index | Cross Index | Namespace Index

# Class Gtk::Socket

Container for widgets from other processes.
Contained in: Gtk
Derived from: Gtk::Container
Derived by: none

#include <gtk--/socket.h>

### public function member index:
`` | `Socket` | `()`;
``GtkSocket`*` | `gtkobj` | `()`;
``const` `GtkSocket`*` | `gtkobj` | `() `const``;
``static` `bool`` | `isA` | `(`Object`* `object`)`;
``void`` | `steal` | `(`guint32` `wid`)`;
``virtual`` | `~Socket` | `()`;

## Description:

Together with ``Gtk`::`Plug``, `Gtk::Socket` 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 ``Gtk::Socket`` widget and, passes the XID of that widget's window to the other process, which then creates a ``Gtk`::`Plug`` window with that XID. Any widgets contained in the ``Gtk`::`Plug`` then will appear inside the first applications window.

The XID of the socket's window is obtained by using the GTK_WINDOW_XWINDOW() macro. Before using this macro, the socket must have been realized, and for hence, have been added to its parent.

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 `Gtk::Socket` 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 `steal`, though the integration when this is done will not be as close as between a ``Gtk`::`Plug`` and a `Gtk::Socket`.

## Function Member Descriptions:

Gtk::Socket::gtkobj - Returns the underlaying gtk+ object.

``GtkSocket`*` `gtkobj``()`;
Gtk::Socket::isA - Returns true if object is this type.

``static` `bool`` `isA``(`Object`* `object`)`;
Gtk::Socket::steal - Reparents a pre-existing toplevel window into a GtkSocket.

``void`` `steal``(`guint32` `wid`)`;

> `wid`: The XID of an existing toplevel window.