/usr/share/gtk-doc/html/pygtk/class-gtkplug.html is in python-gtk2-doc 2.24.0-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Plug</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkpapersize.html" title="gtk.PaperSize"><link rel="next" href="class-gtkprintcontext.html" title="gtk.PrintContext"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Plug</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkpapersize.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkprintcontext.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Plug"><a name="class-gtkplug"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Plug</h2><p>gtk.Plug — A toplevel window for embedding into other
processes.</p></div><div class="refsect1" title="Synopsis"><a name="id3829701"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Plug</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkplug.html#constructor-gtkplug" title="Constructor">gtk.Plug</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>socket_id</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkplug.html#method-gtkplug--construct" title="gtk.Plug.construct">construct</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>socket_id</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkplug.html#method-gtkplug--get-id" title="gtk.Plug.get_id">get_id</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkplug.html#method-gtksocket--get-embedded" title="gtk.Socket.get_embedded">get_embedded</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkplug.html#method-gtksocket--get-socket-window" title="gtk.Socket.get_socket_window">get_socket_window</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkplug.html#function-gtk--plug-new-for-display" title="gtk.plug_new_for_display">gtk.plug_new_for_display</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>socket_id</code></strong></span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id3829898"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a class="link" href="class-gtkwindow.html" title="gtk.Window">gtk.Window</a>
+-- <a class="link" href="class-gtkplug.html" title="gtk.Plug">gtk.Plug</a>
</pre></div><div class="refsect1" title="gtk.Plug Properties"><a name="properties-gtkplug"></a><h2>gtk.Plug Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtkwindow.html#properties-gtkwindow" title="gtk.Window Properties">gtk.Window Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"embedded"</td><td valign="top">Read</td><td valign="top"><code class="literal">True</code> if the plug is embedded in a socket.
Default value: <code class="literal">False</code>
Available in GTK+ 2.12.</td></tr><tr valign="top"><td valign="top">"socket-window"</td><td valign="top">Read</td><td valign="top">The window of the socket the plug is embedded in.
Available in GTK+ 2.14.
</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Plug Style Properties"><a name="style-properties-gtkplug"></a><h2>gtk.Plug Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p></div><div class="refsect1" title="gtk.Plug Signal Prototypes"><a name="signal-prototypes-gtkplug"></a><h2>gtk.Plug Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><p><a class="link" href="class-gtkwindow.html#signal-prototypes-gtkwindow" title="gtk.Window Signal Prototypes">gtk.Window Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkplug.html#signal-gtkplug--embedded" title='The "embedded" gtk.Plug Signal'>embedded</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>plug</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3830225"></a><h2>Description</h2><p>Together with <a class="link" href="class-gtksocket.html" title="gtk.Socket"><code class="classname">gtk.Socket</code></a>, <a class="link" href="class-gtkplug.html" title="gtk.Plug"><code class="classname">gtk.Plug</code></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="class-gtksocket.html" title="gtk.Socket"><code class="classname">gtk.Socket</code></a> widget
and, passes the ID of that widgets window to the other process, which then
creates a <a class="link" href="class-gtkplug.html" title="gtk.Plug"><code class="classname">gtk.Plug</code></a> with that
window ID. Any widgets contained in the <a class="link" href="class-gtkplug.html" title="gtk.Plug"><code class="classname">gtk.Plug</code></a> then will
appear inside the first applications window.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkplug"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Plug</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>socket_id</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>socket_id</code></strong> :</span></p></td><td> the window ID of the socket, or
0.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtkwidget.html" title="gtk.Widget"><code class="classname">gtk.Widget</code></a></td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkplug.html" title="gtk.Plug"><code class="classname">gtk.Plug</code></a> widget inside
the <a class="link" href="class-gtksocket.html" title="gtk.Socket"><code class="classname">gtk.Socket</code></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="class-gtksocket.html" title="gtk.Socket"><code class="classname">gtk.Socket</code></a> by the
<a class="link" href="class-gtksocket.html#method-gtksocket--add-id" title="gtk.Socket.add_id"><code class="methodname">gtk.Socket.add_id</code>()</a>
method.</p></div><div class="refsect1" title="Methods"><a name="id3830407"></a><h2>Methods</h2><div class="refsect2" title="gtk.Plug.construct"><a name="method-gtkplug--construct"></a><h3>gtk.Plug.construct</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">construct</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>socket_id</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>socket_id</code></strong> :</span></p></td><td>the window ID of the
socket</td></tr></tbody></table><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is <span class="emphasis"><em>not</em></span> available in PyGTK 2.2
and above.</p></div><p>The <code class="methodname">construct</code>() method finishes the
initialization of plug for the <a class="link" href="class-gtksocket.html" title="gtk.Socket"><code class="classname">gtk.Socket</code></a>
identified by <em class="parameter"><code>socket_id</code></em>. This method will generally
only be used by subclasses of <a class="link" href="class-gtkplug.html" title="gtk.Plug"><code class="classname">gtk.Plug</code></a>.</p></div><div class="refsect2" title="gtk.Plug.get_id"><a name="method-gtkplug--get-id"></a><h3>gtk.Plug.get_id</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_id</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the window ID for the plug</td></tr></tbody></table><p>The <code class="methodname">get_id</code>() method returns the window
ID of the <a class="link" href="class-gtkplug.html" title="gtk.Plug"><code class="classname">gtk.Plug</code></a> widget, which
can be used to embed this window inside another window, for instance with
<a class="link" href="class-gtksocket.html#method-gtksocket--add-id" title="gtk.Socket.add_id"><code class="methodname">gtk.Socket.add_id</code>()</a>.</p></div><div class="refsect2" title="gtk.Socket.get_embedded"><a name="method-gtksocket--get-embedded"></a><h3>gtk.Socket.get_embedded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_embedded</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the plug is embedded in
a socket.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">get_embedded</code>() method determines whether
the plug is embedded in a socket.
</p></div><div class="refsect2" title="gtk.Socket.get_socket_window"><a name="method-gtksocket--get-socket-window"></a><h3>gtk.Socket.get_socket_window</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_socket_window</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the window of the socket if available, or
<code class="literal">None</code>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">get_socket_window</code>() method retrieves the
socket the plug is embedded in.
</p></div></div><div class="refsect1" title="Functions"><a name="id3830741"></a><h2>Functions</h2><div class="refsect2" title="gtk.plug_new_for_display"><a name="function-gtk--plug-new-for-display"></a><h3>gtk.plug_new_for_display</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.plug_new_for_display</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>socket_id</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>display</code></strong> :</span></p></td><td>the <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
associated with
<em class="parameter"><code>socket_id's</code></em>.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>socket_id</code></strong> :</span></p></td><td> the window ID of the socket's
window.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtkplug.html" title="gtk.Plug"><code class="classname">gtk.Plug</code></a>
object</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.2 and above.</p></div><p>The <code class="function">gtk.plug_new_for_display</code>() function
creates a new plug widget inside the <a class="link" href="class-gtksocket.html" title="gtk.Socket"><code class="classname">gtk.Socket</code></a> specified
by <em class="parameter"><code>socket_id</code></em> on the <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
specified by display.</p></div></div><div class="refsect1" title="Signals"><a name="id3830919"></a><h2>Signals</h2><div class="refsect2" title='The "embedded" gtk.Plug Signal'><a name="signal-gtkplug--embedded"></a><h3>The "embedded" gtk.Plug Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>plug</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>plug</code></em> :</span></p></td><td>the plug that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "embedded" signal is emitted when the plug window is
reparented to the socket window.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkpapersize.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkprintcontext.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.PaperSize </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.PrintContext</td></tr></table></div></body></html>
|