Obtaining the window ID of a socket.

1
2
3
4
5
6
7
8
9

CtkWidget *socket = ctk_socket_new ();
ctk_widget_show (socket);
ctk_container_add (CTK_CONTAINER (parent), socket);

// The following call is only necessary if one of
// the ancestors of the socket is not yet visible.
ctk_widget_realize (socket);
g_print ("The ID of the sockets window is %#x\n",
         ctk_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 ctk_socket_get_plug_window(). If it returns a non-NULL value, then the plug has been successfully created inside of the socket.

When CTK+ 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 CtkSocket and a CtkPlug 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 CTK or vice versa.

The CtkPlug and CtkSocket widgets are only available when CTK+ is compiled for the X11 platform and CDK_WINDOWING_X11 is defined. They can only be used on a CdkX11Display. To use CtkPlug and CtkSocket, you need to include the ctk/ctkx.h header.

ctk_socket_new ()

CtkWidget *
ctk_socket_new (void);

Create a new empty CtkSocket.

ctk_socket_add_id ()

void
ctk_socket_add_id (CtkSocket *socket_,
                   Window window);

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

To embed a CtkPlug in a CtkSocket, you can either create the CtkPlug with ctk_plug_new (0), call ctk_plug_get_id() to get the window ID of the plug, and then pass that to the ctk_socket_add_id(), or you can call ctk_socket_get_id() to get the window ID for the socket, and call ctk_plug_new() passing in that ID.

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

ctk_socket_get_id ()

Window
ctk_socket_get_id (CtkSocket *socket_);

Gets the window ID of a CtkSocket widget, which can then be used to create a client embedded inside the socket, for instance with ctk_plug_new().

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

ctk_socket_get_plug_window ()

CdkWindow *
ctk_socket_get_plug_window (CtkSocket *socket_);

Retrieves the window of the plug. Use this to check if the plug has been created inside of the socket.

Since: 2.14

struct CtkSocket

struct CtkSocket;

The “plug-added” signal

void
user_function (CtkSocket *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 (CtkSocket *socket_,
               gpointer   user_data)

This signal is emitted when a client is removed from the socket. The default action is to destroy the CtkSocket widget, so if you want to reuse it you must add a signal handler that returns TRUE.

Flags: Run Last