diff options
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gtk3/GtkSocket.html')
| -rw-r--r-- | gtk+-mingw/share/gtk-doc/html/gtk3/GtkSocket.html | 342 |
1 files changed, 0 insertions, 342 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gtk3/GtkSocket.html b/gtk+-mingw/share/gtk-doc/html/gtk3/GtkSocket.html deleted file mode 100644 index 45f196e..0000000 --- a/gtk+-mingw/share/gtk-doc/html/gtk3/GtkSocket.html +++ /dev/null @@ -1,342 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>GtkSocket</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="GTK+ 3 Reference Manual"> -<link rel="up" href="PlugSocket.html" title="Cross-process Embedding"> -<link rel="prev" href="GtkPlug.html" title="GtkPlug"> -<link rel="next" href="RecentDocuments.html" title="Recently Used Documents"> -<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -</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+ 3 Reference Manual</th> -<td><a accesskey="n" href="RecentDocuments.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#GtkSocket.synopsis" class="shortcut">Top</a> - | - <a href="#GtkSocket.description" class="shortcut">Description</a> - | - <a href="#GtkSocket.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#GtkSocket.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#GtkSocket.signals" class="shortcut">Signals</a> -</td></tr> -</table> -<div class="refentry"> -<a name="GtkSocket"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="GtkSocket.top_of_page"></a>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"> -<a name="GtkSocket.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <gtk/gtkx.h> - -struct <a class="link" href="GtkSocket.html#GtkSocket-struct" title="struct GtkSocket">GtkSocket</a>; -<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkSocket.html#gtk-socket-new" title="gtk_socket_new ()">gtk_socket_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -<span class="returnvalue">void</span> <a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()">gtk_socket_add_id</a> (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>, - <em class="parameter"><code><span class="type">Window</span> window</code></em>); -<span class="returnvalue">Window</span> <a class="link" href="GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()">gtk_socket_get_id</a> (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>); -<a href="http://developer.gnome.org/gdk/gdk3-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * <a class="link" href="GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()">gtk_socket_get_plug_window</a> (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="GtkSocket.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> - +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> - +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a> - +----GtkSocket -</pre> -</div> -<div class="refsect1"> -<a name="GtkSocket.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -GtkSocket implements - AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p> -</div> -<div class="refsect1"> -<a name="GtkSocket.signals"></a><h2>Signals</h2> -<pre class="synopsis"> - "<a class="link" href="GtkSocket.html#GtkSocket-plug-added" title='The "plug-added" signal'>plug-added</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a> - "<a class="link" href="GtkSocket.html#GtkSocket-plug-removed" title='The "plug-removed" signal'>plug-removed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a> -</pre> -</div> -<div class="refsect1"> -<a name="GtkSocket.description"></a><h2>Description</h2> -<p> -Together with <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, <a class="link" 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 class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widget -and passes that widget's window ID to the other process, which then -creates a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with that window ID. Any widgets contained in the -<a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> then will appear inside the first application's window. -</p> -<p> -The socket's window ID is obtained by using <a class="link" href="GtkSocket.html#gtk-socket-get-id" title="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> -<p> -</p> -<div class="example"> -<a name="id1351888"></a><p class="title"><b>Example 106. Obtaining the window ID of a socket.</b></p> -<div class="example-contents"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6 -7 -8 -9 -10</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">socket </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkSocket.html#gtk-socket-new">gtk_socket_new</a></span><span class="normal"> </span><span class="symbol">();</span> -<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">socket</span><span class="symbol">);</span> -<span class="function"><a href="GtkContainer.html#gtk-container-add">gtk_container_add</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">parent</span><span class="symbol">),</span><span class="normal"> socket</span><span class="symbol">);</span> - -<span class="comment">/* The following call is only necessary if one of</span> -<span class="comment"> * the ancestors of the socket is not yet visible.</span> -<span class="comment"> */</span> -<span class="function"><a href="GtkWidget.html#gtk-widget-realize">gtk_widget_realize</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">socket</span><span class="symbol">);</span> -<span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"The ID of the sockets window is %<GTKDOCLINK HREF="</span><span class="normal">x</span><span class="string">">x</GTKDOCLINK></span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">,</span> -<span class="normal"> </span><span class="function"><a href="GtkSocket.html#gtk-socket-get-id">gtk_socket_get_id</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">socket</span><span class="symbol">));</span></pre></td> - </tr> - </tbody> - </table> -</div> - -</div> -<p><br class="example-break"> -</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 using <a class="link" href="GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()"><code class="function">gtk_socket_get_plug_window()</code></a>. -If it returns a non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value, 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. To prevent this from -happening, you can connect to the <a class="link" href="GtkSocket.html#GtkSocket-plug-removed" title='The "plug-removed" signal'><span class="type">"plug-removed"</span></a> signal. -</p> -<p> -The communication between a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> and a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> follows the -<a class="ulink" 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> -</p> -<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Note</h3> -The <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> widgets are only available when GTK+ -is compiled for the X11 platform and <a href="http://developer.gnome.org/gdk/gdk3-General.html#GDK-WINDOWING-X11:CAPS"><code class="literal">GDK_WINDOWING_X11</code></a> is defined. -They can only be used on a <span class="type">GdkX11Display</span>. To use <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> and -<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, you need to include the <code class="filename">gtk/gtkx.h</code> -header. -</div> -<p> -</p> -</div> -<div class="refsect1"> -<a name="GtkSocket.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="GtkSocket-struct"></a><h3>struct GtkSocket</h3> -<pre class="programlisting">struct GtkSocket;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-socket-new"></a><h3>gtk_socket_new ()</h3> -<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_socket_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Create a new empty <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the new <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-socket-add-id"></a><h3>gtk_socket_add_id ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gtk_socket_add_id (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>, - <em class="parameter"><code><span class="type">Window</span> window</code></em>);</pre> -<p> -Adds an XEMBED client, such as a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, to the <a class="link" 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 class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> in a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, you can either create the -<a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> with <code class="literal">gtk_plug_new (0)</code>, call -<a class="link" href="GtkPlug.html#gtk-plug-get-id" title="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 class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>, or you can call <a class="link" href="GtkSocket.html#gtk-socket-get-id" title="gtk_socket_get_id ()"><code class="function">gtk_socket_get_id()</code></a> to get the -window ID for the socket, and call <a class="link" href="GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()"><code class="function">gtk_plug_new()</code></a> passing in that -ID. -</p> -<p> -The <a class="link" 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> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>socket_</code></em> :</span></p></td> -<td>a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td> -<td>the Window of a client participating in the XEMBED protocol.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-socket-get-id"></a><h3>gtk_socket_get_id ()</h3> -<pre class="programlisting"><span class="returnvalue">Window</span> gtk_socket_get_id (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre> -<p> -Gets the window ID of a <a class="link" 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 class="link" href="GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()"><code class="function">gtk_plug_new()</code></a>. -</p> -<p> -The <a class="link" 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> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>socket_</code></em> :</span></p></td> -<td>a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the window ID for the socket</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-socket-get-plug-window"></a><h3>gtk_socket_get_plug_window ()</h3> -<pre class="programlisting"><a href="http://developer.gnome.org/gdk/gdk3-Windows.html#GdkWindow"><span class="returnvalue">GdkWindow</span></a> * gtk_socket_get_plug_window (<em class="parameter"><code><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_</code></em>);</pre> -<p> -Retrieves the window of the plug. Use this to check if the plug has -been created inside of the socket. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>socket_</code></em> :</span></p></td> -<td>a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the window of the plug if available, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.14</p> -</div> -</div> -<div class="refsect1"> -<a name="GtkSocket.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="GtkSocket-plug-added"></a><h3>The <code class="literal">"plug-added"</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></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><p><span class="term"><em class="parameter"><code>socket_</code></em> :</span></p></td> -<td>the object which received the signal</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>user data set when the signal handler was connected.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="GtkSocket-plug-removed"></a><h3>The <code class="literal">"plug-removed"</code> signal</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> user_function (<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre> -<p> -This signal is emitted when a client is removed from the socket. -The default action is to destroy the <a class="link" 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="http://library.gnome.org/devel/glib/unstable/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><p><span class="term"><em class="parameter"><code>socket_</code></em> :</span></p></td> -<td>the object which received the signal</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>user data set when the signal handler was connected.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked.</td> -</tr> -</tbody> -</table></div> -</div> -</div> -<div class="refsect1"> -<a name="GtkSocket.see-also"></a><h2>See Also</h2> -<a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>, <a class="ulink" href="http://www.freedesktop.org/Standards/xembed-spec" target="_top">XEmbed</a> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file |