|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21585/root/usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkSocket</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="prev" href="GtkPlug.html" title="GtkPlug">
<link rel="next" href="SpecialObjects.html" title="Special-purpose features">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkPlug.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="PlugSocket.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="SpecialObjects.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3768274" class="shortcut">Top</a>
 | 
<a href="#id3768550" class="shortcut">Description</a>
 | 
<a href="#id3768393" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3768447" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3768470" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkSocket"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3768274"></a><span class="refentrytitle">GtkSocket</span>
</h2>
<p>GtkSocket — Container for widgets from other processes</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkSocket.html#GtkSocket-struct">GtkSocket</a>;
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkSocket.html#gtk-socket-new">gtk_socket_new</a> (void);
void <a href="GtkSocket.html#gtk-socket-steal">gtk_socket_steal</a> (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket_,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> wid);
void <a href="GtkSocket.html#gtk-socket-add-id">gtk_socket_add_id</a> (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket_,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> window_id);
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> <a href="GtkSocket.html#gtk-socket-get-id">gtk_socket_get_id</a> (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket_);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3768393"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----GtkSocket
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3768447"></a><h2>Implemented Interfaces</h2>
<p>
GtkSocket implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3768470"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkSocket.html#GtkSocket-plug-added">plug-added</a>"
void user_function (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
"<a href="GtkSocket.html#GtkSocket-plug-removed">plug-removed</a>"
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3768550"></a><h2>Description</h2>
<p>
Together with <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> 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 <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget and, passes the
that widget's window ID to the other process,
which then creates a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with that window ID.
Any widgets contained in the <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> then will appear
inside the first applications window.
</p>
<p>
The socket's window ID is obtained by using
<a href="GtkSocket.html#gtk-socket-get-id"><code class="function">gtk_socket_get_id()</code></a>. Before using this function,
the socket must have been realized, and for hence,
have been added to its parent.
</p>
<div class="example">
<a name="id3768624"></a><p class="title"><b>Example 1. Obtaining the window ID of a socket.</b></p>
<pre class="programlisting">
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 %<span class="type">x</span>\n",
gtk_socket_get_id (socket));
</pre>
</div>
<p>
</p>
<p>
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 examining the
<em class="structfield"><code>plug_window</code></em> field of the
<a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> structure. If this field is non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>,
then the plug has been successfully created inside
of the socket.
</p>
<p>
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.
</p>
<p>
The communication between a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> and a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> follows the
<a href="http://www.freedesktop.org/standards/xembed-spec" target="_top">XEmbed</a>
protocol. This protocol has also been implemented in other toolkits, e.g.
<span class="application">Qt</span>, allowing the same level of integration
when embedding a <span class="application">Qt</span> widget in GTK or vice versa.</p>
<p>
A socket can also be used to swallow arbitrary
pre-existing top-level windows using <a href="GtkSocket.html#gtk-socket-steal"><code class="function">gtk_socket_steal()</code></a>,
though the integration when this is done will not be as close
as between a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
The <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widgets are currently not available
on all platforms supported by GTK+.
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3768794"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3768804"></a><h3>
<a name="GtkSocket-struct"></a>GtkSocket</h3>
<a class="indexterm" name="id3768817"></a><pre class="programlisting">typedef struct _GtkSocket GtkSocket;</pre>
<p>
The <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> structure contains the <em class="structfield"><code>plug_window</code></em>
field. (This field should be considered read-only. It should
never be set by an application.)
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3768846"></a><h3>
<a name="gtk-socket-new"></a>gtk_socket_new ()</h3>
<a class="indexterm" name="id3768859"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_socket_new (void);</pre>
<p>
Create a new empty <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the new <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3768914"></a><h3>
<a name="gtk-socket-steal"></a>gtk_socket_steal ()</h3>
<a class="indexterm" name="id3768929"></a><pre class="programlisting">void gtk_socket_steal (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket_,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> wid);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_socket_steal</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Reparents a pre-existing toplevel window into a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>. This is
meant to embed clients that do not know about embedding into a
<a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, however doing so is inherently unreliable, and using
this function is not recommended.
</p>
<p>
The <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> must have already be added into a toplevel window
before you can make this call.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket_</code></em> :</span></td>
<td> a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>wid</code></em> :</span></td>
<td> the window ID of an existing toplevel window.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3769052"></a><h3>
<a name="gtk-socket-add-id"></a>gtk_socket_add_id ()</h3>
<a class="indexterm" name="id3769066"></a><pre class="programlisting">void gtk_socket_add_id (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket_,
<a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> window_id);</pre>
<p>
Adds an XEMBED client, such as a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, to the <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>. The
client may be in the same process or in a different process.
</p>
<p>
To embed a <a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> in a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, you can either create the
<a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with <code class="literal">gtk_plug_new (0)</code>, call
<a href="GtkPlug.html#gtk-plug-get-id"><code class="function">gtk_plug_get_id()</code></a> to get the window ID of the plug, and then pass that to the
<a href="GtkSocket.html#gtk-socket-add-id"><code class="function">gtk_socket_add_id()</code></a>, or you can call <a href="GtkSocket.html#gtk-socket-get-id"><code class="function">gtk_socket_get_id()</code></a> to get the
window ID for the socket, and call <a href="GtkPlug.html#gtk-plug-new"><code class="function">gtk_plug_new()</code></a> passing in that
ID.
</p>
<p>
The <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> must have already be added into a toplevel window
before you can make this call.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket_</code></em> :</span></td>
<td> a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>window_id</code></em> :</span></td>
<td> the window ID of a client participating in the XEMBED protocol.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3769254"></a><h3>
<a name="gtk-socket-get-id"></a>gtk_socket_get_id ()</h3>
<a class="indexterm" name="id3769268"></a><pre class="programlisting"><a
href="../gdk/gdk-Event-Structures.html#GdkNativeWindow"
>GdkNativeWindow</a> gtk_socket_get_id (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket_);</pre>
<p>
Gets the window ID of a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget, which can then
be used to create a client embedded inside the socket, for
instance with <a href="GtkPlug.html#gtk-plug-new"><code class="function">gtk_plug_new()</code></a>.
</p>
<p>
The <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> must have already be added into a toplevel window
before you can make this call.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket_</code></em> :</span></td>
<td> a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the window ID for the socket
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3769370"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3769380"></a><h3>
<a name="GtkSocket-plug-added"></a>The "plug-added" signal</h3>
<a class="indexterm" name="id3769391"></a><pre class="programlisting">void user_function (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
This signal is emitted when a client is successfully
added to the socket.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3769460"></a><h3>
<a name="GtkSocket-plug-removed"></a>The "plug-removed" signal</h3>
<a class="indexterm" name="id3769471"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GtkSocket.html" title="GtkSocket">GtkSocket</a> *socket,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
This signal is emitted when a client is removed from the socket. The
default action is to destroy the <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget, so if you want to
reuse it you must add a signal handler that returns <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>socket</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3769572"></a><h2>See Also</h2>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a></span></td>
<td><p>the widget that plugs into a <a href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</p></td>
</tr>
<tr>
<td>
<span class="term"><a href="http://www.freedesktop.org/standards/xembed-spec" target="_top">XEmbed</a></span></td>
<td><p>the XEmbed Protocol Specification.</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
</div>
</body>
</html>