New upstream version 3.22.28
This commit is contained in:
Jeremy Bicha
@ -8,7 +8,7 @@
|
||||
<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.25.1 (XML mode)">
|
||||
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
|
||||
<link rel="stylesheet" href="style.css" type="text/css">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
@ -68,7 +68,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="function_type">
|
||||
<a href="../gdk4/gdk4-Windows.html#GdkWindow-struct"><span class="returnvalue">GdkWindow</span></a> *
|
||||
<span class="returnvalue">GdkWindow</span> *
|
||||
</td>
|
||||
<td class="function_name">
|
||||
<a class="link" href="GtkSocket.html#gtk-socket-get-plug-window" title="gtk_socket_get_plug_window ()">gtk_socket_get_plug_window</a> <span class="c_punctuation">()</span>
|
||||
@ -89,12 +89,12 @@
|
||||
<tr>
|
||||
<td class="signal_type"><span class="returnvalue">void</span></td>
|
||||
<td class="signal_name"><a class="link" href="GtkSocket.html#GtkSocket-plug-added" title="The “plug-added” signal">plug-added</a></td>
|
||||
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
|
||||
<td class="signal_flags">Run Last</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="signal_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a></td>
|
||||
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
|
||||
<td class="signal_name"><a class="link" href="GtkSocket.html#GtkSocket-plug-removed" title="The “plug-removed” signal">plug-removed</a></td>
|
||||
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
|
||||
<td class="signal_flags">Run Last</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
@ -114,8 +114,8 @@
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
<a name="GtkSocket.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||||
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
|
||||
<span class="lineart">╰──</span> <a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
|
||||
<pre class="screen"> GObject
|
||||
<span class="lineart">╰──</span> GInitiallyUnowned
|
||||
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
|
||||
<span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
|
||||
<span class="lineart">╰──</span> GtkSocket
|
||||
@ -158,15 +158,15 @@ and for hence, have been added to its parent.</p>
|
||||
7
|
||||
8
|
||||
9</pre></td>
|
||||
<td class="listing_code"><pre class="programlisting">GtkWidget <span class="gtkdoc opt">*</span>socket <span class="gtkdoc opt">=</span> <span class="function"><a href="GtkSocket.html#gtk-socket-new">gtk_socket_new</a></span> <span class="gtkdoc opt">();</span>
|
||||
<span class="function"><a href="GtkWidget.html#gtk-widget-show">gtk_widget_show</a></span> <span class="gtkdoc opt">(</span>socket<span class="gtkdoc opt">);</span>
|
||||
<span class="function"><a href="GtkContainer.html#gtk-container-add">gtk_container_add</a></span> <span class="gtkdoc opt">(</span><span class="function">GTK_CONTAINER</span> <span class="gtkdoc opt">(</span>parent<span class="gtkdoc opt">),</span> socket<span class="gtkdoc opt">);</span>
|
||||
<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="gtkdoc slc">// The following call is only necessary if one of</span>
|
||||
<span class="gtkdoc slc">// the ancestors of the socket is not yet visible.</span>
|
||||
<span class="function"><a href="GtkWidget.html#gtk-widget-realize">gtk_widget_realize</a></span> <span class="gtkdoc opt">(</span>socket<span class="gtkdoc opt">);</span>
|
||||
<span class="function"><a href="../glib/glib-Warnings-and-Assertions.html#g-print">g_print</a></span> <span class="gtkdoc opt">(</span><span class="string">"The ID of the sockets window is %#x</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="gtkdoc opt">,</span>
|
||||
<span class="function"><a href="GtkSocket.html#gtk-socket-get-id">gtk_socket_get_id</a></span> <span class="gtkdoc opt">(</span>socket<span class="gtkdoc opt">));</span></pre></td>
|
||||
<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="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">g_print</span><span class="normal"> </span><span class="symbol">(</span><span class="string">"The ID of the sockets window is %#x</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>
|
||||
@ -180,7 +180,7 @@ 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="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value, then the plug has been
|
||||
If it returns a non-<code class="literal">NULL</code> 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,
|
||||
@ -193,7 +193,7 @@ 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.</p>
|
||||
<p>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="../gdk4/gdk4-General.html#GDK-WINDOWING-X11:CAPS"><code class="literal">GDK_WINDOWING_X11</code></a> is defined.
|
||||
is compiled for the X11 platform and <code class="literal">GDK_WINDOWING_X11</code> 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="literal">gtk/gtkx.h</code> header.</p>
|
||||
</div>
|
||||
@ -282,7 +282,7 @@ before you can make this call.</p>
|
||||
<hr>
|
||||
<div class="refsect2">
|
||||
<a name="gtk-socket-get-plug-window"></a><h3>gtk_socket_get_plug_window ()</h3>
|
||||
<pre class="programlisting"><a href="../gdk4/gdk4-Windows.html#GdkWindow-struct"><span class="returnvalue">GdkWindow</span></a> *
|
||||
<pre class="programlisting"><span class="returnvalue">GdkWindow</span> *
|
||||
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>
|
||||
@ -303,8 +303,8 @@ been created inside of the socket.</p>
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="gtk-socket-get-plug-window.returns"></a><h4>Returns</h4>
|
||||
<p> the window of the plug if
|
||||
available, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
|
||||
<p>the window of the plug if
|
||||
available, or <code class="literal">NULL</code>. </p>
|
||||
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
|
||||
</div>
|
||||
<p class="since">Since: 2.14</p>
|
||||
@ -323,7 +323,7 @@ available, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class=
|
||||
<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="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
|
||||
<span class="type">gpointer</span> user_data)</pre>
|
||||
<p>This signal is emitted when a client is successfully
|
||||
added to the socket.</p>
|
||||
<div class="refsect3">
|
||||
@ -348,19 +348,19 @@ added to the socket.</p>
|
||||
</tbody>
|
||||
</table></div>
|
||||
</div>
|
||||
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
|
||||
<p>Flags: Run Last</p>
|
||||
</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="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||||
user_function (<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> *socket_,
|
||||
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
|
||||
<span class="type">gpointer</span> user_data)</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="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
|
||||
want to reuse it you must add a signal handler that returns <code class="literal">TRUE</code>.</p>
|
||||
<div class="refsect3">
|
||||
<a name="GtkSocket-plug-removed.parameters"></a><h4>Parameters</h4>
|
||||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||||
@ -385,9 +385,9 @@ want to reuse it you must add a signal handler that returns <a href="../glib/gli
|
||||
</div>
|
||||
<div class="refsect3">
|
||||
<a name="GtkSocket-plug-removed.returns"></a><h4>Returns</h4>
|
||||
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked.</p>
|
||||
<p> <code class="literal">TRUE</code> to stop other handlers from being invoked.</p>
|
||||
</div>
|
||||
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
|
||||
<p>Flags: Run Last</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="refsect1">
|
||||
@ -396,6 +396,6 @@ want to reuse it you must add a signal handler that returns <a href="../glib/gli
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<hr>Generated by GTK-Doc V1.25.1</div>
|
||||
<hr>Generated by GTK-Doc V1.27</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user