GtkSocket
GtkSocket — Container for widgets from other processes
|
|
Implemented Interfaces
GtkSocket implements
AtkImplementorIface and GtkBuildable.
Includes
#include <gtk/gtkx.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.
Obtaining the window ID of a 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
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.
The GtkPlug and GtkSocket widgets are only available when GTK+
is compiled for the X11 platform and GDK_WINDOWING_X11 is defined.
They can only be used on a GdkX11Display. To use GtkPlug and
GtkSocket, you need to include the gtk/gtkx.h header.
Functions
gtk_socket_get_id ()
Window
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_plug_new().
The GtkSocket must have already be added into a toplevel window
before you can make this call.
Returns
the window ID for the socket
gtk_socket_get_plug_window ()
GdkWindow *
gtk_socket_get_plug_window (GtkSocket *socket_);
Retrieves the window of the plug. Use this to check if the plug has
been created inside of the socket.
Returns
the window of the plug if
available, or NULL.
[nullable][transfer none]
Since: 2.14
Types and Values
struct GtkSocket
struct GtkSocket;
Signal Details
The “plug-added” signal
void
user_function (GtkSocket *socket_,
gpointer user_data)
This signal is emitted when a client is successfully
added to the socket.
Flags: Run Last
The “plug-removed” signal
gboolean
user_function (GtkSocket *socket_,
gpointer user_data)
This signal is emitted when a client is removed from the socket.
The default action is to destroy the GtkSocket widget, so if you
want to reuse it you must add a signal handler that returns TRUE.
Returns
TRUE to stop other handlers from being invoked.
Flags: Run Last