<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkPlug: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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="PlugSocket.html" title="Cross-process Embedding">
<link rel="next" href="GtkSocket.html" title="GtkSocket">
<meta name="generator" content="GTK-Doc V1.25.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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkPlug.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkPlug.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkPlug.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkPlug.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GtkPlug.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="PlugSocket.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="PlugSocket.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkSocket.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkPlug"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkPlug.top_of_page"></a>GtkPlug</span></h2>
<p>GtkPlug — Toplevel for embedding into other processes</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkPlug.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlug.html#gtk-plug-construct" title="gtk_plug_construct ()">gtk_plug_construct</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlug.html#gtk-plug-construct-for-display" title="gtk_plug_construct_for_display ()">gtk_plug_construct_for_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPlug.html#gtk-plug-new" title="gtk_plug_new ()">gtk_plug_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPlug.html#gtk-plug-new-for-display" title="gtk_plug_new_for_display ()">gtk_plug_new_for_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Window</span>
</td>
<td class="function_name">
<a class="link" href="GtkPlug.html#gtk-plug-get-id" title="gtk_plug_get_id ()">gtk_plug_get_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkPlug.html#gtk-plug-get-embedded" title="gtk_plug_get_embedded ()">gtk_plug_get_embedded</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://developer.gnome.org/gdk3/gdk4-Windows.html#GdkWindow-struct"><span class="returnvalue">GdkWindow</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkPlug.html#gtk-plug-get-socket-window" title="gtk_plug_get_socket_window ()">gtk_plug_get_socket_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPlug.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkPlug.html#GtkPlug--embedded" title="The “embedded” property">embedded</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="http://developer.gnome.org/gdk3/gdk4-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> *</td>
<td class="property_name"><a class="link" href="GtkPlug.html#GtkPlug--socket-window" title="The “socket-window” property">socket-window</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPlug.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkPlug.html#GtkPlug-embedded" title="The “embedded” signal">embedded</a></td>
<td class="signal_flags"><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPlug.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkPlug.html#GtkPlug-struct" title="struct GtkPlug">GtkPlug</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkPlug.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<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> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
<span class="lineart">╰──</span> <a class="link" href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
<span class="lineart">╰──</span> GtkPlug
</pre>
</div>
<div class="refsect1">
<a name="GtkPlug.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkPlug implements
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkPlug.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtkx.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkPlug.description"></a><h2>Description</h2>
<p>Together with <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>, <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</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 the ID of that widget’s window 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 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 Protocol</a>.
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="http://developer.gnome.org/gdk3/gdk4-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="literal">gtk/gtkx.h</code> header.</p>
</div>
<div class="refsect1">
<a name="GtkPlug.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-plug-construct"></a><h3>gtk_plug_construct ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_plug_construct (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
<em class="parameter"><code><span class="type">Window</span> socket_id</code></em>);</pre>
<p>Finish the initialization of <em class="parameter"><code>plug</code></em>
for a given <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by
<em class="parameter"><code>socket_id</code></em>
. This function will generally only be used by classes deriving from <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</p>
<div class="refsect3">
<a name="gtk-plug-construct.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plug</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>socket_id</p></td>
<td class="parameter_description"><p>the XID of the socket’s window.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-construct-for-display"></a><h3>gtk_plug_construct_for_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_plug_construct_for_display (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/gdk3/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> *display</code></em>,
<em class="parameter"><code><span class="type">Window</span> socket_id</code></em>);</pre>
<p>Finish the initialization of <em class="parameter"><code>plug</code></em>
for a given <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by
<em class="parameter"><code>socket_id</code></em>
which is currently displayed on <em class="parameter"><code>display</code></em>
.
This function will generally only be used by classes deriving from <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</p>
<div class="refsect3">
<a name="gtk-plug-construct-for-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plug</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>the <a href="http://developer.gnome.org/gdk3/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> associated with <em class="parameter"><code>socket_id</code></em>
’s
<a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>socket_id</p></td>
<td class="parameter_description"><p>the XID of the socket’s window.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-new"></a><h3>gtk_plug_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_plug_new (<em class="parameter"><code><span class="type">Window</span> socket_id</code></em>);</pre>
<p>Creates a new plug widget inside the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified
by <em class="parameter"><code>socket_id</code></em>
. If <em class="parameter"><code>socket_id</code></em>
is 0, the plug is left “unplugged” and
can later be plugged into a <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> by <a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>.</p>
<div class="refsect3">
<a name="gtk-plug-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>socket_id</p></td>
<td class="parameter_description"><p>the window ID of the socket, or 0.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-plug-new.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-new-for-display"></a><h3>gtk_plug_new_for_display ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_plug_new_for_display (<em class="parameter"><code><a href="http://developer.gnome.org/gdk3/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> *display</code></em>,
<em class="parameter"><code><span class="type">Window</span> socket_id</code></em>);</pre>
<p>Create a new plug widget inside the <a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a> identified by socket_id.</p>
<div class="refsect3">
<a name="gtk-plug-new-for-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>display</p></td>
<td class="parameter_description"><p>the <a href="http://developer.gnome.org/gdk3/GdkDisplay.html#GdkDisplay-struct"><span class="type">GdkDisplay</span></a> on which <em class="parameter"><code>socket_id</code></em>
is displayed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>socket_id</p></td>
<td class="parameter_description"><p>the XID of the socket’s window.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-plug-new-for-display.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget.</p>
</div>
<p class="since">Since: 2.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-get-id"></a><h3>gtk_plug_get_id ()</h3>
<pre class="programlisting"><span class="returnvalue">Window</span>
gtk_plug_get_id (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
<p>Gets the window ID of a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> widget, which can then
be used to embed this window inside another window, for
instance with <a class="link" href="GtkSocket.html#gtk-socket-add-id" title="gtk_socket_add_id ()"><code class="function">gtk_socket_add_id()</code></a>.</p>
<div class="refsect3">
<a name="gtk-plug-get-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>plug</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-plug-get-id.returns"></a><h4>Returns</h4>
<p> the window ID for the plug</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-get-embedded"></a><h3>gtk_plug_get_embedded ()</h3>
<pre class="programlisting"><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_plug_get_embedded (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
<p>Determines whether the plug is embedded in a socket.</p>
<div class="refsect3">
<a name="gtk-plug-get-embedded.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>plug</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-plug-get-embedded.returns"></a><h4>Returns</h4>
<p> <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the plug is embedded in a socket</p>
</div>
<p class="since">Since: 2.14</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-plug-get-socket-window"></a><h3>gtk_plug_get_socket_window ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/gdk3/gdk4-Windows.html#GdkWindow-struct"><span class="returnvalue">GdkWindow</span></a> *
gtk_plug_get_socket_window (<em class="parameter"><code><a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug</code></em>);</pre>
<p>Retrieves the socket the plug is embedded in.</p>
<div class="refsect3">
<a name="gtk-plug-get-socket-window.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>plug</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-plug-get-socket-window.returns"></a><h4>Returns</h4>
<p> the window of the socket, or <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
</div>
</div>
<div class="refsect1">
<a name="GtkPlug.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkPlug-struct"></a><h3>struct GtkPlug</h3>
<pre class="programlisting">struct GtkPlug;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkPlug.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkPlug--embedded"></a><h3>The <code class="literal">“embedded”</code> property</h3>
<pre class="programlisting"> “embedded” <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p><a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the plug is embedded in a socket.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since: 2.12</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkPlug--socket-window"></a><h3>The <code class="literal">“socket-window”</code> property</h3>
<pre class="programlisting"> “socket-window” <a href="http://developer.gnome.org/gdk3/gdk4-Windows.html#GdkWindow-struct"><span class="type">GdkWindow</span></a> *</pre>
<p>The window of the socket the plug is embedded in.</p>
<p>Flags: Read</p>
<p class="since">Since: 2.14</p>
</div>
</div>
<div class="refsect1">
<a name="GtkPlug.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkPlug-embedded"></a><h3>The <code class="literal">“embedded”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkPlug.html" title="GtkPlug"><span class="type">GtkPlug</span></a> *plug,
<a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Gets emitted when the plug becomes embedded in a socket.</p>
<div class="refsect3">
<a name="GtkPlug-embedded.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>plug</p></td>
<td class="parameter_description"><p>the object on which the signal was emitted</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/home/vagrant/ruby-gnome2.win32/glib2/vendor/local/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkPlug.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkSocket.html" title="GtkSocket"><span class="type">GtkSocket</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>