← Back to branch summary

~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-gtkplug.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-06-22 16:49:42 UTC
  • mfrom: (1.2.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20090622164942-19zeltp4z0u5iw72
Tags: 2.15.2-0ubuntu1
* New upstream version:
  - Rename gtk.Statusbar.remove() to gtk.Statusbar.remove_message
  - Allow pango.Context creation 
  - Make gtk.gdk.Pixbuf.add_alpha accept integers, retaining backward
    compatibility accepting also chars 
  - Protect window obj from GC in gtk.window_get_toplevels 
  - Plug huge number of memory leaks in Pango wrappers 
  - Add gtk.gdk.WINDOWING constant 
  - Wrap gdk_pixbuf_apply_embedded_orientation 
  - Modernize constructors of seven more types 
  - Don't free a string we don't own 
  - Some docs tweaking 
* debian/control.in:
  - set vcs location
* debian/patches/02_fix_get_application_info_crash.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/class-gtkplug.html
1
1
<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.73.2"><link rel="start" 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" lang="en"><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
2
 
processes.</p></div><div class="refsect1" lang="en"><a name="id3591480"></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>):
 
2
processes.</p></div><div class="refsect1" lang="en"><a name="id3792286"></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>):
3
3
<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">
4
4
<span class="bold"><strong>Functions</strong></span>
5
5
 
6
 
<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" lang="en"><a name="id3591677"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
6
<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" lang="en"><a name="id3792483"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
7
7
  +-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
8
8
    +-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
9
9
      +-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
14
14
                    Default value: <code class="literal">False</code>
15
15
                    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.
16
16
                    Available in GTK+ 2.14.
17
 
                    </td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><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" lang="en"><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" lang="en"><a name="id3592004"></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
 
17
                    </td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><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" lang="en"><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" lang="en"><a name="id3792810"></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
18
18
ability to embed widgets from one process into another process in a fashion
19
19
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
20
20
and, passes the ID of that widgets window to the other process, which then
27
27
<em class="parameter"><code>socket_id</code></em> is 0, the plug is left "unplugged" and can
28
28
later be plugged into a <a class="link" href="class-gtksocket.html" title="gtk.Socket"><code class="classname">gtk.Socket</code></a> by the
29
29
<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> 
30
 
method.</p></div><div class="refsect1" lang="en"><a name="id3592187"></a><h2>Methods</h2><div class="refsect2" lang="en"><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
 
30
method.</p></div><div class="refsect1" lang="en"><a name="id3792992"></a><h2>Methods</h2><div class="refsect2" lang="en"><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
31
31
socket</td></tr></tbody></table><div class="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
32
32
and above.</p></div><p>The <code class="methodname">construct</code>() method finishes the
33
33
initialization of plug for the <a class="link" href="class-gtksocket.html" title="gtk.Socket"><code class="classname">gtk.Socket</code></a>
43
43
          <code class="literal">None</code>.</td></tr></tbody></table><div class="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>
44
44
        The <code class="methodname">get_socket_window</code>() method retrieves the
45
45
        socket the plug is embedded in.
46
 
      </p></div></div><div class="refsect1" lang="en"><a name="id3592520"></a><h2>Functions</h2><div class="refsect2" lang="en"><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>
 
46
      </p></div></div><div class="refsect1" lang="en"><a name="id3793326"></a><h2>Functions</h2><div class="refsect2" lang="en"><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>
47
47
          associated with
48
48
          <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
49
49
          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>
50
50
          object</td></tr></tbody></table><div class="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
51
51
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
52
52
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>
53
 
specified by display.</p></div></div><div class="refsect1" lang="en"><a name="id3592699"></a><h2>Signals</h2><div class="refsect2" lang="en"><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
 
53
specified by display.</p></div></div><div class="refsect1" lang="en"><a name="id3793504"></a><h2>Signals</h2><div class="refsect2" lang="en"><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
54
54
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
55
55
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
56
56
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if